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, #full_type_arity, #generics, #mandatory_positional_param_count, #parameter_names, #parameters_to_rbs, #resolve_generics_from_context, #resolve_generics_from_context_until_complete, #type_arity

Methods inherited from Closure

#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_closure, #combine_directives, #combine_name, #combine_return_type, #comments, #deprecated?, #desc, #dodgy_return_type_source?, #erase_generics, #filename, #gates, #identity, #infer, #inspect, #macro_names, #macro_names?, #macros, #macros_names?, #maybe_directives?, #maybe_macros?, #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

log_level, 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, #closure=, #comments, #each_closure, #name, #namespace, #source

Constructor Details

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

Returns a new instance of Method.

Parameters:

  • visibility (::Symbol) (defaults to: :public) —

    :public, :protected, or :private

  • explicit (Boolean) (defaults to: true)
  • block (Pin::Signature, nil, :undefined) (defaults to: :undefined)
  • node (Parser::AST::Node, nil) (defaults to: nil)
  • attribute (Boolean) (defaults to: false)
  • signatures (::Array<Signature>, nil) (defaults to: nil)
  • anon_splat (Boolean) (defaults to: false)
  • context (ComplexType, ComplexType::UniqueType, nil) (defaults to: nil)
  • splat (Hash{Symbol => Object}) 


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

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

Instance Attribute Details

#block ⇒ Pin::Signature?

@sg-ignore flow sensitive typing needs to remove literal with

this unless block

Returns:



132
133
134
135
 
# File 'lib/solargraph/pin/method.rb', line 132

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

#documentation ⇒ Object 



305
306
307
308
309
310
311
312
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
 
# File 'lib/solargraph/pin/method.rb', line 305

def documentation
  if @documentation.nil?
    method_docs ||= super || ''
    param_tags = docstring.tags(:param)
    unless param_tags.nil? || 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? || 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? || 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? || 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? || 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? || 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:

  • (Parser::AST::Node) 


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

def node
  @node
end

#return_type ⇒ Object 



145
146
147
 
# File 'lib/solargraph/pin/method.rb', line 145

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

#signature_help ⇒ ::Array<Hash>

Returns:

  • (::Array<Hash>) 


230
231
232
233
234
235
236
237
 
# File 'lib/solargraph/pin/method.rb', line 230

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

#signatures ⇒ ::Array<Signature>

Returns:



190
191
192
193
194
195
196
 
# File 'lib/solargraph/pin/method.rb', line 190

def signatures
  @signatures ||= if inline_rbs.empty?
                    signatures_from_yard
                  else
                    signatures_from_inline_rbs
                  end
end

#visibility ⇒ ::Symbol (readonly)

Returns :public, :private, or :protected.

Returns:

  • (::Symbol) —

    :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:



77
78
79
 
# File 'lib/solargraph/pin/method.rb', line 77

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

#all_rooted? ⇒ Boolean

Returns:

  • (Boolean) 


104
105
106
 
# File 'lib/solargraph/pin/method.rb', line 104

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

#anon_splat? ⇒ Boolean

Returns:

  • (Boolean) 


422
423
424
 
# File 'lib/solargraph/pin/method.rb', line 422

def anon_splat?
  @anon_splat
end

#attribute? ⇒ Boolean

Returns:

  • (Boolean) 


372
373
374
 
# File 'lib/solargraph/pin/method.rb', line 372

def attribute?
  @attribute
end

#block? ⇒ Boolean

Returns:

  • (Boolean) 


125
126
127
 
# File 'lib/solargraph/pin/method.rb', line 125

def block?
  !block.nil?
end

#combine_visibility(other) ⇒ ::Symbol

Parameters:

Returns:

  • (::Symbol) 


42
43
44
45
46
47
48
49
50
 
# File 'lib/solargraph/pin/method.rb', line 42

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 



52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
 
# File 'lib/solargraph/pin/method.rb', line 52

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.positive?
                 [].freeze
               else
                 choose(other, :parameters).clone.freeze
               end
  new_attrs = {
    visibility: combine_visibility(other),
    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 



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

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

#detail ⇒ String?

Returns:

  • (String, nil) 


207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
 
# File 'lib/solargraph/pin/method.rb', line 207

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
  # @sg-ignore Need to add nil check here
  unless return_type.undefined?
    detail += "=#{if probed?
                    '~'
                  else
                    (proxied? ? '^' : '>')
                  end} #{return_type}"
  end
  detail.strip!
  return nil if detail.empty?
  detail
end

#explicit? ⇒ Boolean

Returns:

  • (Boolean) 


368
369
370
 
# File 'lib/solargraph/pin/method.rb', line 368

def explicit?
  @explicit
end

#generate_signature(parameters, return_type) ⇒ Signature

Parameters:

Returns:



152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
 
# File 'lib/solargraph/pin/method.rb', line 152

def generate_signature parameters, return_type
  # @type [Pin::Signature, nil]
  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&.range,
        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 



239
240
241
242
243
244
245
246
 
# File 'lib/solargraph/pin/method.rb', line 239

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:

  • (String) 


266
267
268
 
# File 'lib/solargraph/pin/method.rb', line 266

def method_name
  name
end

#nearly?(other) ⇒ Boolean

Returns:

  • (Boolean) 


377
378
379
380
381
382
383
384
385
 
# File 'lib/solargraph/pin/method.rb', line 377

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::Signature>

Returns:



392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
 
# File 'lib/solargraph/pin/method.rb', line 392

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&.range,
          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 



261
262
263
 
# File 'lib/solargraph/pin/method.rb', line 261

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

#probe(api_map) ⇒ Object 



387
388
389
 
# File 'lib/solargraph/pin/method.rb', line 387

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:

  • (self) 


200
201
202
203
204
 
# File 'lib/solargraph/pin/method.rb', line 200

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.



93
94
95
96
97
98
99
100
101
102
 
# File 'lib/solargraph/pin/method.rb', line 93

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

#resolve_ref_tag(api_map) ⇒ self

Parameters:

Returns:

  • (self) 


428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
 
# File 'lib/solargraph/pin/method.rb', line 428

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:



451
452
453
 
# File 'lib/solargraph/pin/method.rb', line 451

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 



141
142
143
 
# File 'lib/solargraph/pin/method.rb', line 141

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

#to_rbs ⇒ Object 



248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/solargraph/pin/method.rb', line 248

def to_rbs
  return nil if signatures.empty?

  rbs = "def #{name}: #{signatures.first.to_rbs}"
  # @sg-ignore Need to add nil check here
  signatures[1..].each do |sig|
    rbs += "\n"
    rbs += (' ' * (4 + name.length))
    rbs += "| #{name}: #{sig.to_rbs}"
  end
  rbs
end

#transform_types(&transform) ⇒ Object 



81
82
83
84
85
86
87
88
89
90
 
# File 'lib/solargraph/pin/method.rb', line 81

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 



270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
 
# File 'lib/solargraph/pin/method.rb', line 270

def typify api_map
  logger.debug do
    # @sg-ignore Need to add nil check here
    "Method#typify(self=#{self}, binder=#{binder}, closure=#{closure}, context=#{context.rooted_tags}, return_type=#{return_type.rooted_tags}) - starting"
  end
  decl = if macro_names?
    types = macro_names.flat_map do |mac|
      directive = api_map.named_macro(mac)
      next unless directive
      macro = Solargraph::YardMap::Macro.from_directive(directive, self)
      expanded = macro.macro_object.expand([name, *parameter_names])
      docstring = Solargraph::Source.parse_docstring(expanded).to_docstring
      docstring.tags(:return).flat_map(&:types)
    end
    ComplexType.try_parse(*types)
  else
    super
  end
  unless decl.undefined?
    logger.debug do
      "Method#typify(self=#{self}, binder=#{binder}, closure=#{closure}, context=#{context}) => #{decl.rooted_tags.inspect} - decl found"
    end
    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?
    # @sg-ignore Need to add nil check here
    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:



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

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