Class: Solargraph::Pin::Method

Inherits:
Callable show all
Includes:
ParserGem::NodeMethods
Defined in:
lib/solargraph/pin/method.rb

Overview

The base class for method and attribute pins.

Direct Known Subclasses

DelegatedMethod, DuckMethod, MethodAlias

Constant Summary

Constants included from Logging

Logging::DEFAULT_LOG_LEVEL, Logging::LOG_LEVELS

Instance Attribute Summary collapse

Attributes inherited from Callable

#parameters

Attributes inherited from Closure

#scope

Attributes inherited from Base

#code_object, #combine_priority, #directives, #docstring, #location, #name, #source, #type_location

Attributes included from Common

#context, #location

Instance Method Summary collapse

Methods inherited from Callable

#arity, #arity_matches?, #blockless_parameters, #choose_parameters, #combine_blocks, #generics, #mandatory_positional_param_count, #parameter_names, #resolve_generics_from_context, #resolve_generics_from_context_until_complete

Methods inherited from Closure

#binder, #context, #generic_defaults, #generics, #rbs_generics, #rebind

Methods inherited from Base

#all_location_text, #assert_location_provided, #assert_same, #assert_same_array_content, #assert_same_count, #assert_same_macros, #assert_source_provided, #best_location, #choose, #choose_longer, #choose_node, #choose_pin_attr, #choose_pin_attr_with_same_name, #choose_priority, #closure, #combine_directives, #combine_name, #combine_return_type, #comments, #deprecated?, #desc, #dodgy_return_type_source?, #erase_generics, #filename, #gates, #identity, #infer, #inspect, #macros, #maybe_directives?, #needs_consistent_name?, #prefer_rbs_location, #presence_certain?, #probed?, #proxied?, #proxy, #rbs_location?, #realize, #resolve_generics, #resolve_generics_from_context, #to_s, #type_desc, #variable?

Methods included from Logging

logger

Methods included from Documenting

normalize_indentation, strip_html_comments

Methods included from Conversions

#completion_item, #deprecated?, #link_documentation, #probed?, #proxied?, #reset_conversions, #resolve_completion_item, #text_documentation

Methods included from Common

#binder, #closure, #comments, #name, #namespace, #source

Constructor Details

#initialize(visibility: :public, explicit: true, block: :undefined, node: nil, attribute: false, signatures: nil, anon_splat: false, **splat) ⇒ Method

Returns a new instance of Method.

Parameters:

  • (defaults to: :public)

    :public, :protected, or :private

  • (defaults to: true)
  • (defaults to: :undefined)
  • (defaults to: nil)
  • (defaults to: false)
  • (defaults to: nil)
  • (defaults to: false) 


25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/solargraph/pin/method.rb', line 25

def initialize visibility: :public, explicit: true, block: :undefined, node: nil, attribute: false, signatures: nil, anon_splat: false,
               **splat
  super(**splat)
  @visibility = visibility
  @explicit = explicit
  @block = block
  @node = node
  @attribute = attribute
  @signatures = signatures
  @anon_splat = anon_splat
end

Instance Attribute Details

#block ⇒ Pin::Signature?

Returns:



164
165
166
167
 
# File 'lib/solargraph/pin/method.rb', line 164

def block
  return @block unless @block == :undefined
  @block = signatures.first&.block
end

#documentation ⇒ Object 



313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
 
# File 'lib/solargraph/pin/method.rb', line 313

def documentation
  if @documentation.nil?
    method_docs ||= super || ''
    param_tags = docstring.tags(:param)
    unless param_tags.nil? or param_tags.empty?
      method_docs += "\n\n" unless method_docs.empty?
      method_docs += "Params:\n"
      lines = []
      param_tags.each do |p|
        l = "* #{p.name}"
        l += " [#{escape_brackets(p.types.join(', '))}]" unless p.types.nil? or p.types.empty?
        l += " #{p.text}"
        lines.push l
      end
      method_docs += lines.join("\n")
    end
    yieldparam_tags = docstring.tags(:yieldparam)
    unless yieldparam_tags.nil? or yieldparam_tags.empty?
      method_docs += "\n\n" unless method_docs.empty?
      method_docs += "Block Params:\n"
      lines = []
      yieldparam_tags.each do |p|
        l = "* #{p.name}"
        l += " [#{escape_brackets(p.types.join(', '))}]" unless p.types.nil? or p.types.empty?
        l += " #{p.text}"
        lines.push l
      end
      method_docs += lines.join("\n")
    end
    yieldreturn_tags = docstring.tags(:yieldreturn)
    unless yieldreturn_tags.empty?
      method_docs += "\n\n" unless method_docs.empty?
      method_docs += "Block Returns:\n"
      lines = []
      yieldreturn_tags.each do |r|
        l = "*"
        l += " [#{escape_brackets(r.types.join(', '))}]" unless r.types.nil? or r.types.empty?
        l += " #{r.text}"
        lines.push l
      end
      method_docs += lines.join("\n")
    end
    return_tags = docstring.tags(:return)
    unless return_tags.empty?
      method_docs += "\n\n" unless method_docs.empty?
      method_docs += "Returns:\n"
      lines = []
      return_tags.each do |r|
        l = "*"
        l += " [#{escape_brackets(r.types.join(', '))}]" unless r.types.nil? or r.types.empty?
        l += " #{r.text}"
        lines.push l
      end
      method_docs += lines.join("\n")
    end
    method_docs += "\n\n" unless method_docs.empty?
    method_docs += "Visibility: #{visibility}"
    @documentation = method_docs
    concat_example_tags
  end
  @documentation.to_s
end

#node ⇒ Parser::AST::Node (readonly)

Returns:



16
17
18
 
# File 'lib/solargraph/pin/method.rb', line 16

def node
  @node
end

#return_type ⇒ Object 



177
178
179
 
# File 'lib/solargraph/pin/method.rb', line 177

def return_type
  @return_type ||= ComplexType.new(signatures.map(&:return_type).flat_map(&:items))
end

#signature_help ⇒ ::Array<Hash>

Returns:



257
258
259
260
261
262
263
264
 
# File 'lib/solargraph/pin/method.rb', line 257

def signature_help
  @signature_help ||= signatures.map do |sig|
    {
      label: name + '(' + sig.parameters.map(&:full).join(', ') + ')',
      documentation: documentation
    }
  end
end

#signatures ⇒ ::Array<Signature>

Returns:



221
222
223
224
225
226
227
228
229
230
 
# File 'lib/solargraph/pin/method.rb', line 221

def signatures
  @signatures ||= begin
    top_type = generate_complex_type
    result = []
    result.push generate_signature(parameters, top_type) if top_type.defined?
    result.concat(overloads.map { |meth| generate_signature(meth.parameters, meth.return_type) }) unless overloads.empty?
    result.push generate_signature(parameters, @return_type || ComplexType::UNDEFINED) if result.empty?
    result
  end
end

#visibility ⇒ ::Symbol (readonly)

Returns :public, :private, or :protected.

Returns:

  • :public, :private, or :protected



11
12
13
 
# File 'lib/solargraph/pin/method.rb', line 11

def visibility
  @visibility
end

Instance Method Details

#==(other) ⇒ Object

Parameters:



109
110
111
 
# File 'lib/solargraph/pin/method.rb', line 109

def == other
  super && other.node == node
end

#all_rooted? ⇒ Boolean

Returns:



138
139
140
 
# File 'lib/solargraph/pin/method.rb', line 138

def all_rooted?
  super && parameters.all?(&:all_rooted?) && (!block || block&.all_rooted?) && signatures.all?(&:all_rooted?)
end

#anon_splat? ⇒ Boolean

Returns:



430
431
432
 
# File 'lib/solargraph/pin/method.rb', line 430

def anon_splat?
  @anon_splat
end

#attribute? ⇒ Boolean

Returns:



380
381
382
 
# File 'lib/solargraph/pin/method.rb', line 380

def attribute?
  @attribute
end

#block? ⇒ Boolean

Returns:



159
160
161
 
# File 'lib/solargraph/pin/method.rb', line 159

def block?
  !block.nil?
end

#combine_all_signature_pins(*signature_pins) ⇒ Array<Pin::Signature>

Parameters:

Returns:



39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/solargraph/pin/method.rb', line 39

def combine_all_signature_pins(*signature_pins)
  # @type [Hash{Array => Array<Pin::Signature>}]

  by_arity = {}
  signature_pins.each do |signature_pin|
    by_arity[signature_pin.arity] ||= []
    by_arity[signature_pin.arity] << signature_pin
  end
  by_arity.transform_values! do |same_arity_pins|
    # @param memo [Pin::Signature, nil]

    # @param signature [Pin::Signature]

    same_arity_pins.reduce(nil) do |memo, signature|
      next signature if memo.nil?
      memo.combine_with(signature)
    end
  end
  by_arity.values.flatten
end

#combine_signatures(other) ⇒ Array<Pin::Signature>

Parameters:

Returns:



71
72
73
74
75
76
77
78
79
80
81
 
# File 'lib/solargraph/pin/method.rb', line 71

def combine_signatures(other)
  all_undefined = signatures.all? { |sig| sig.return_type.undefined? }
  other_all_undefined = other.signatures.all? { |sig| sig.return_type.undefined? }
  if all_undefined && !other_all_undefined
    other.signatures
  elsif other_all_undefined && !all_undefined
    signatures
  else
    combine_all_signature_pins(*signatures, *other.signatures)
  end
end

#combine_visibility(other) ⇒ ::Symbol

Parameters:

Returns:



59
60
61
62
63
64
65
66
67
 
# File 'lib/solargraph/pin/method.rb', line 59

def combine_visibility(other)
  if dodgy_visibility_source? && !other.dodgy_visibility_source?
    other.visibility
  elsif other.dodgy_visibility_source? && !dodgy_visibility_source?
    visibility
  else
    assert_same(other, :visibility)
  end
end

#combine_with(other, attrs = {}) ⇒ Object 



83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/solargraph/pin/method.rb', line 83

def combine_with(other, attrs = {})
  priority_choice = choose_priority(other)
  return priority_choice unless priority_choice.nil?

  sigs = combine_signatures(other)
  parameters = if sigs.length > 0
    [].freeze
  else
    choose(other, :parameters).clone.freeze
  end
  new_attrs = {
    visibility: combine_visibility(other),
    # @sg-ignore https://github.com/castwide/solargraph/pull/1050

    explicit: explicit? || other.explicit?,
    block: combine_blocks(other),
    node: choose_node(other, :node),
    attribute: prefer_rbs_location(other, :attribute?),
    parameters: parameters,
    signatures: sigs,
    anon_splat: assert_same(other, :anon_splat?),
    return_type: nil # pulled from signatures on first call

  }.merge(attrs)
  super(other, new_attrs)
end

#completion_item_kind ⇒ Object 



169
170
171
 
# File 'lib/solargraph/pin/method.rb', line 169

def completion_item_kind
  attribute? ? Solargraph::LanguageServer::CompletionItemKinds::PROPERTY : Solargraph::LanguageServer::CompletionItemKinds::METHOD
end

#detail ⇒ String?

Returns:



241
242
243
244
245
246
247
248
249
250
251
252
253
254
 
# File 'lib/solargraph/pin/method.rb', line 241

def detail
  # This property is not cached in an instance variable because it can

  # change when pins get proxied.

  detail = String.new
  detail += if signatures.length > 1
    "(*) "
  else
    "(#{signatures.first.parameters.map(&:full).join(', ')}) " unless signatures.first.parameters.empty?
  end.to_s
  detail += "=#{probed? ? '~' : (proxied? ? '^' : '>')} #{return_type.to_s}" unless return_type.undefined?
  detail.strip!
  return nil if detail.empty?
  detail
end

#explicit? ⇒ Boolean

Returns:



376
377
378
 
# File 'lib/solargraph/pin/method.rb', line 376

def explicit?
  @explicit
end

#generate_signature(parameters, return_type) ⇒ Signature

Parameters:

Returns:



184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
 
# File 'lib/solargraph/pin/method.rb', line 184

def generate_signature(parameters, return_type)
  block = nil
  yieldparam_tags = docstring.tags(:yieldparam)
  yieldreturn_tags = docstring.tags(:yieldreturn)
  generics = docstring.tags(:generic).map(&:name)
  needs_block_param_signature =
    parameters.last&.block? || !yieldreturn_tags.empty? || !yieldparam_tags.empty?
  if needs_block_param_signature
    yield_parameters = yieldparam_tags.map do |p|
      name = p.name
      decl = :arg
      if name
        decl = select_decl(name, false)
        name = clean_param(name)
      end
      Pin::Parameter.new(
        location: location,
        closure: self,
        comments: p.text,
        name: name,
        decl: decl,
        presence: location ? location.range : nil,
        return_type: ComplexType.try_parse(*p.types),
        source: source
      )
    end
    yield_return_type = ComplexType.try_parse(*yieldreturn_tags.flat_map(&:types))
    block = Signature.new(generics: generics, parameters: yield_parameters, return_type: yield_return_type, source: source,
                          closure: self, location: location, type_location: type_location)
  end
  signature = Signature.new(generics: generics, parameters: parameters, return_type: return_type, block: block, closure: self, source: source,
                            location: location, type_location: type_location)
  block.closure = signature if block
  signature
end

#inner_desc ⇒ Object 



266
267
268
269
270
271
272
273
 
# File 'lib/solargraph/pin/method.rb', line 266

def inner_desc
  # ensure the signatures line up when logged

  if signatures.length > 1
    path + " \n#{to_rbs}\n"
  else
    super
  end
end

#method_name ⇒ String

Returns:



292
293
294
 
# File 'lib/solargraph/pin/method.rb', line 292

def method_name
  name
end

#nearly?(other) ⇒ Boolean

Returns:



385
386
387
388
389
390
391
392
393
 
# File 'lib/solargraph/pin/method.rb', line 385

def nearly? other
  super &&
    # @sg-ignore https://github.com/castwide/solargraph/pull/1050

    parameters == other.parameters &&
    # @sg-ignore https://github.com/castwide/solargraph/pull/1050

    scope == other.scope &&
    # @sg-ignore https://github.com/castwide/solargraph/pull/1050

    visibility == other.visibility
end

#overloads ⇒ ::Array<Pin::Method>

Returns:



400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
 
# File 'lib/solargraph/pin/method.rb', line 400

def overloads
  # Ignore overload tags with nil parameters. If it's not an array, the

  # tag's source is likely malformed.


  # @param tag [YARD::Tags::OverloadTag]

  @overloads ||= docstring.tags(:overload).select(&:parameters).map do |tag|
    Pin::Signature.new(
      generics: generics,
      # @param src [Array(String, String)]

      parameters: tag.parameters.map do |src|
        name, decl = parse_overload_param(src.first)
        Pin::Parameter.new(
          location: location,
          closure: self,
          comments: tag.docstring.all.to_s,
          name: name,
          decl: decl,
          presence: location ? location.range : nil,
          return_type: param_type_from_name(tag, src.first),
          source: :overloads
        )
      end,
      closure: self,
      return_type: ComplexType.try_parse(*tag.docstring.tags(:return).flat_map(&:types)),
      source: :overloads,
    )
  end
  @overloads
end

#path ⇒ Object 



287
288
289
 
# File 'lib/solargraph/pin/method.rb', line 287

def path
  @path ||= "#{namespace}#{(scope == :instance ? '#' : '.')}#{name}"
end

#probe(api_map) ⇒ Object 



395
396
397
 
# File 'lib/solargraph/pin/method.rb', line 395

def probe api_map
  attribute? ? infer_from_iv(api_map) : infer_from_return_nodes(api_map)
end

#proxy_with_signatures(return_type) ⇒ self

Parameters:

Returns:



234
235
236
237
238
 
# File 'lib/solargraph/pin/method.rb', line 234

def proxy_with_signatures return_type
  out = proxy return_type
  out.signatures = out.signatures.map { |sig| sig.proxy return_type }
  out
end

#reset_generated! ⇒ void

This method returns an undefined value.



125
126
127
128
129
130
131
132
133
134
135
136
 
# File 'lib/solargraph/pin/method.rb', line 125

def reset_generated!
  super
  unless signatures.empty?
    return_type = nil
    @block = :undefined
    parameters = []
  end
  block&.reset_generated!
  @signatures&.each(&:reset_generated!)
  signature_help = nil
  documentation = nil
end

#resolve_ref_tag(api_map) ⇒ self

Parameters:

Returns:



436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
 
# File 'lib/solargraph/pin/method.rb', line 436

def resolve_ref_tag api_map
  return self if @resolved_ref_tag

  @resolved_ref_tag = true
  return self unless docstring.ref_tags.any?
  docstring.ref_tags.each do |tag|
    ref = if tag.owner.to_s.start_with?(/[#.]/)
      api_map.get_methods(namespace)
             .select { |pin| pin.path.end_with?(tag.owner.to_s) }
             .first
    else
      # @todo Resolve relative namespaces

      api_map.get_path_pins(tag.owner.to_s).first
    end
    next unless ref

    docstring.add_tag(*ref.docstring.tags(:param))
  end
  self
end

#rest_of_stack(api_map) ⇒ Array<Pin::Method>

Parameters:

Returns:



459
460
461
 
# File 'lib/solargraph/pin/method.rb', line 459

def rest_of_stack api_map
  api_map.get_method_stack(method_namespace, method_name, scope: scope).reject { |pin| pin.path == path }
end

#symbol_kind ⇒ Object 



173
174
175
 
# File 'lib/solargraph/pin/method.rb', line 173

def symbol_kind
  attribute? ? Solargraph::LanguageServer::SymbolKinds::PROPERTY : LanguageServer::SymbolKinds::METHOD
end

#to_rbs ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/solargraph/pin/method.rb', line 275

def to_rbs
  return nil if signatures.empty?

  rbs = "def #{name}: #{signatures.first.to_rbs}"
  signatures[1..].each do |sig|
    rbs += "\n"
    rbs += (' ' * (4 + name.length))
    rbs += "| #{name}: #{sig.to_rbs}"
  end
  rbs
end

#transform_types(&transform) ⇒ Object 



113
114
115
116
117
118
119
120
121
122
 
# File 'lib/solargraph/pin/method.rb', line 113

def transform_types(&transform)
  # @todo 'super' alone should work here I think, but doesn't typecheck at level typed

  m = super(&transform)
  m.signatures = m.signatures.map do |sig|
    sig.transform_types(&transform)
  end
  m.block = block&.transform_types(&transform)
  m.reset_generated!
  m
end

#typify(api_map) ⇒ Object 



296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
 
# File 'lib/solargraph/pin/method.rb', line 296

def typify api_map
  logger.debug { "Method#typify(self=#{self}, binder=#{binder}, closure=#{closure}, context=#{context.rooted_tags}, return_type=#{return_type.rooted_tags}) - starting" }
  decl = super
  unless decl.undefined?
    logger.debug { "Method#typify(self=#{self}, binder=#{binder}, closure=#{closure}, context=#{context}) => #{decl.rooted_tags.inspect} - decl found" }
    return decl
  end
  type = see_reference(api_map) || typify_from_super(api_map)
  logger.debug { "Method#typify(self=#{self}) - type=#{type&.rooted_tags.inspect}" }
  unless type.nil?
    qualified = type.qualify(api_map, *closure.gates)
    logger.debug { "Method#typify(self=#{self}) => #{qualified.rooted_tags.inspect}" }
    return qualified
  end
  super
end

#with_single_signature(signature) ⇒ Pin::Method

Parameters:

Returns:



144
145
146
147
148
149
150
151
152
153
154
155
156
157
 
# File 'lib/solargraph/pin/method.rb', line 144

def with_single_signature(signature)
  m = proxy signature.return_type
  m.reset_generated!
  # @todo populating the single parameters/return_type/block

  #   arguments here seems to be needed for some specs to pass,

  #   even though we have a signature with the same information.

  #   Is this a problem for RBS-populated methods, which don't

  #   populate these three?

  m.parameters = signature.parameters
  m.return_type = signature.return_type
  m.block = signature.block
  m.signatures = [signature]
  m
end