solargraph 0.58.1 → 0.58.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (147) hide show
  1. checksums.yaml +4 -4
  2. data/.gitignore +1 -0
  3. data/CHANGELOG.md +7 -1
  4. data/lib/solargraph/api_map/cache.rb +110 -110
  5. data/lib/solargraph/api_map/constants.rb +279 -279
  6. data/lib/solargraph/api_map/index.rb +193 -193
  7. data/lib/solargraph/api_map/source_to_yard.rb +97 -97
  8. data/lib/solargraph/api_map/store.rb +384 -384
  9. data/lib/solargraph/api_map.rb +945 -945
  10. data/lib/solargraph/complex_type/type_methods.rb +228 -228
  11. data/lib/solargraph/complex_type/unique_type.rb +482 -482
  12. data/lib/solargraph/complex_type.rb +444 -444
  13. data/lib/solargraph/convention/data_definition/data_definition_node.rb +91 -91
  14. data/lib/solargraph/convention/data_definition.rb +105 -105
  15. data/lib/solargraph/convention/struct_definition/struct_assignment_node.rb +61 -61
  16. data/lib/solargraph/convention/struct_definition/struct_definition_node.rb +102 -102
  17. data/lib/solargraph/convention/struct_definition.rb +164 -164
  18. data/lib/solargraph/diagnostics/require_not_found.rb +53 -53
  19. data/lib/solargraph/diagnostics/rubocop.rb +118 -118
  20. data/lib/solargraph/diagnostics/rubocop_helpers.rb +68 -68
  21. data/lib/solargraph/diagnostics/type_check.rb +55 -55
  22. data/lib/solargraph/doc_map.rb +439 -439
  23. data/lib/solargraph/equality.rb +34 -34
  24. data/lib/solargraph/gem_pins.rb +98 -98
  25. data/lib/solargraph/language_server/host/diagnoser.rb +89 -89
  26. data/lib/solargraph/language_server/host/dispatch.rb +130 -130
  27. data/lib/solargraph/language_server/host/message_worker.rb +112 -112
  28. data/lib/solargraph/language_server/host/sources.rb +99 -99
  29. data/lib/solargraph/language_server/host.rb +878 -878
  30. data/lib/solargraph/language_server/message/extended/check_gem_version.rb +114 -114
  31. data/lib/solargraph/language_server/message/extended/document.rb +23 -23
  32. data/lib/solargraph/language_server/message/text_document/completion.rb +56 -56
  33. data/lib/solargraph/language_server/message/text_document/definition.rb +40 -40
  34. data/lib/solargraph/language_server/message/text_document/document_symbol.rb +26 -26
  35. data/lib/solargraph/language_server/message/text_document/formatting.rb +148 -148
  36. data/lib/solargraph/language_server/message/text_document/hover.rb +58 -58
  37. data/lib/solargraph/language_server/message/text_document/signature_help.rb +24 -24
  38. data/lib/solargraph/language_server/message/text_document/type_definition.rb +25 -25
  39. data/lib/solargraph/language_server/message/workspace/workspace_symbol.rb +23 -23
  40. data/lib/solargraph/library.rb +683 -683
  41. data/lib/solargraph/location.rb +82 -82
  42. data/lib/solargraph/logging.rb +37 -37
  43. data/lib/solargraph/parser/comment_ripper.rb +69 -69
  44. data/lib/solargraph/parser/flow_sensitive_typing.rb +255 -255
  45. data/lib/solargraph/parser/node_processor/base.rb +92 -92
  46. data/lib/solargraph/parser/node_processor.rb +62 -62
  47. data/lib/solargraph/parser/parser_gem/class_methods.rb +149 -149
  48. data/lib/solargraph/parser/parser_gem/node_chainer.rb +166 -166
  49. data/lib/solargraph/parser/parser_gem/node_methods.rb +486 -486
  50. data/lib/solargraph/parser/parser_gem/node_processors/and_node.rb +22 -22
  51. data/lib/solargraph/parser/parser_gem/node_processors/args_node.rb +59 -59
  52. data/lib/solargraph/parser/parser_gem/node_processors/begin_node.rb +15 -15
  53. data/lib/solargraph/parser/parser_gem/node_processors/block_node.rb +46 -46
  54. data/lib/solargraph/parser/parser_gem/node_processors/def_node.rb +53 -53
  55. data/lib/solargraph/parser/parser_gem/node_processors/if_node.rb +23 -23
  56. data/lib/solargraph/parser/parser_gem/node_processors/ivasgn_node.rb +40 -40
  57. data/lib/solargraph/parser/parser_gem/node_processors/lvasgn_node.rb +29 -29
  58. data/lib/solargraph/parser/parser_gem/node_processors/masgn_node.rb +59 -59
  59. data/lib/solargraph/parser/parser_gem/node_processors/opasgn_node.rb +98 -98
  60. data/lib/solargraph/parser/parser_gem/node_processors/orasgn_node.rb +17 -17
  61. data/lib/solargraph/parser/parser_gem/node_processors/resbody_node.rb +38 -38
  62. data/lib/solargraph/parser/parser_gem/node_processors/sclass_node.rb +52 -52
  63. data/lib/solargraph/parser/parser_gem/node_processors/send_node.rb +291 -291
  64. data/lib/solargraph/parser/parser_gem/node_processors/while_node.rb +29 -29
  65. data/lib/solargraph/parser/parser_gem/node_processors.rb +70 -70
  66. data/lib/solargraph/parser/region.rb +69 -69
  67. data/lib/solargraph/parser/snippet.rb +17 -17
  68. data/lib/solargraph/pin/base.rb +729 -729
  69. data/lib/solargraph/pin/base_variable.rb +126 -126
  70. data/lib/solargraph/pin/block.rb +104 -104
  71. data/lib/solargraph/pin/breakable.rb +9 -9
  72. data/lib/solargraph/pin/callable.rb +231 -231
  73. data/lib/solargraph/pin/closure.rb +72 -72
  74. data/lib/solargraph/pin/common.rb +79 -79
  75. data/lib/solargraph/pin/conversions.rb +123 -123
  76. data/lib/solargraph/pin/delegated_method.rb +120 -120
  77. data/lib/solargraph/pin/documenting.rb +114 -114
  78. data/lib/solargraph/pin/instance_variable.rb +34 -34
  79. data/lib/solargraph/pin/keyword.rb +20 -20
  80. data/lib/solargraph/pin/local_variable.rb +75 -75
  81. data/lib/solargraph/pin/method.rb +672 -672
  82. data/lib/solargraph/pin/method_alias.rb +34 -34
  83. data/lib/solargraph/pin/namespace.rb +115 -115
  84. data/lib/solargraph/pin/parameter.rb +275 -275
  85. data/lib/solargraph/pin/proxy_type.rb +39 -39
  86. data/lib/solargraph/pin/reference/override.rb +47 -47
  87. data/lib/solargraph/pin/reference/superclass.rb +15 -15
  88. data/lib/solargraph/pin/reference.rb +39 -39
  89. data/lib/solargraph/pin/search.rb +61 -61
  90. data/lib/solargraph/pin/signature.rb +61 -61
  91. data/lib/solargraph/pin/symbol.rb +53 -53
  92. data/lib/solargraph/pin/until.rb +18 -18
  93. data/lib/solargraph/pin/while.rb +18 -18
  94. data/lib/solargraph/pin.rb +44 -44
  95. data/lib/solargraph/pin_cache.rb +245 -245
  96. data/lib/solargraph/position.rb +132 -119
  97. data/lib/solargraph/range.rb +112 -112
  98. data/lib/solargraph/rbs_map/conversions.rb +823 -823
  99. data/lib/solargraph/rbs_map/core_map.rb +58 -58
  100. data/lib/solargraph/rbs_map/stdlib_map.rb +43 -43
  101. data/lib/solargraph/rbs_map.rb +163 -163
  102. data/lib/solargraph/shell.rb +352 -352
  103. data/lib/solargraph/source/chain/call.rb +337 -337
  104. data/lib/solargraph/source/chain/constant.rb +26 -26
  105. data/lib/solargraph/source/chain/hash.rb +34 -34
  106. data/lib/solargraph/source/chain/if.rb +28 -28
  107. data/lib/solargraph/source/chain/instance_variable.rb +13 -13
  108. data/lib/solargraph/source/chain/literal.rb +48 -48
  109. data/lib/solargraph/source/chain/or.rb +23 -23
  110. data/lib/solargraph/source/chain.rb +291 -291
  111. data/lib/solargraph/source/change.rb +82 -82
  112. data/lib/solargraph/source/cursor.rb +166 -166
  113. data/lib/solargraph/source/source_chainer.rb +194 -194
  114. data/lib/solargraph/source/updater.rb +55 -55
  115. data/lib/solargraph/source.rb +498 -498
  116. data/lib/solargraph/source_map/clip.rb +226 -226
  117. data/lib/solargraph/source_map/data.rb +34 -34
  118. data/lib/solargraph/source_map/mapper.rb +259 -259
  119. data/lib/solargraph/source_map.rb +212 -212
  120. data/lib/solargraph/type_checker/checks.rb +124 -124
  121. data/lib/solargraph/type_checker/param_def.rb +37 -37
  122. data/lib/solargraph/type_checker/problem.rb +32 -32
  123. data/lib/solargraph/type_checker/rules.rb +84 -84
  124. data/lib/solargraph/type_checker.rb +814 -814
  125. data/lib/solargraph/version.rb +1 -1
  126. data/lib/solargraph/workspace/config.rb +255 -255
  127. data/lib/solargraph/workspace/require_paths.rb +97 -97
  128. data/lib/solargraph/workspace.rb +220 -220
  129. data/lib/solargraph/yard_map/helpers.rb +44 -44
  130. data/lib/solargraph/yard_map/mapper/to_method.rb +130 -130
  131. data/lib/solargraph/yard_map/mapper/to_namespace.rb +31 -31
  132. data/lib/solargraph/yard_map/mapper.rb +79 -79
  133. data/lib/solargraph/yard_map/to_method.rb +89 -89
  134. data/lib/solargraph/yardoc.rb +87 -87
  135. data/lib/solargraph.rb +105 -105
  136. data/rbs_collection.yaml +1 -1
  137. metadata +12 -12
  138. /data/{sig → rbs}/shims/ast/0/node.rbs +0 -0
  139. /data/{sig → rbs}/shims/ast/2.4/.rbs_meta.yaml +0 -0
  140. /data/{sig → rbs}/shims/ast/2.4/ast.rbs +0 -0
  141. /data/{sig → rbs}/shims/parser/3.2.0.1/builders/default.rbs +0 -0
  142. /data/{sig → rbs}/shims/parser/3.2.0.1/manifest.yaml +0 -0
  143. /data/{sig → rbs}/shims/parser/3.2.0.1/parser.rbs +0 -0
  144. /data/{sig → rbs}/shims/parser/3.2.0.1/polyfill.rbs +0 -0
  145. /data/{sig → rbs}/shims/thor/1.2.0.1/.rbs_meta.yaml +0 -0
  146. /data/{sig → rbs}/shims/thor/1.2.0.1/manifest.yaml +0 -0
  147. /data/{sig → rbs}/shims/thor/1.2.0.1/thor.rbs +0 -0
@@ -1,444 +1,444 @@
1
- # frozen_string_literal: true
2
-
3
- module Solargraph
4
- # A container for type data based on YARD type tags.
5
- #
6
- class ComplexType
7
- GENERIC_TAG_NAME = 'generic'.freeze
8
- # @!parse
9
- # include TypeMethods
10
- include Equality
11
-
12
- autoload :TypeMethods, 'solargraph/complex_type/type_methods'
13
- autoload :UniqueType, 'solargraph/complex_type/unique_type'
14
-
15
- # @param types [Array<UniqueType, ComplexType>]
16
- def initialize types = [UniqueType::UNDEFINED]
17
- # @todo @items here should not need an annotation
18
- # @type [Array<UniqueType>]
19
- items = types.flat_map(&:items).uniq(&:to_s)
20
- if items.any? { |i| i.name == 'false' } && items.any? { |i| i.name == 'true' }
21
- items.delete_if { |i| i.name == 'false' || i.name == 'true' }
22
- items.unshift(ComplexType::BOOLEAN)
23
- end
24
- items = [UniqueType::UNDEFINED] if items.any?(&:undefined?)
25
- @items = items
26
- end
27
-
28
- # @sg-ignore Fix "Not enough arguments to Module#protected"
29
- protected def equality_fields
30
- [self.class, items]
31
- end
32
-
33
- # @param api_map [ApiMap]
34
- # @param context [String]
35
- # @return [ComplexType]
36
- def qualify api_map, *gates
37
- red = reduce_object
38
- types = red.items.map do |t|
39
- next t if ['nil', 'void', 'undefined'].include?(t.name)
40
- next t if ['::Boolean'].include?(t.rooted_name)
41
- t.qualify api_map, *gates
42
- end
43
- ComplexType.new(types).reduce_object
44
- end
45
-
46
- # @param generics_to_resolve [Enumerable<String>]]
47
- # @param context_type [UniqueType, nil]
48
- # @param resolved_generic_values [Hash{String => ComplexType}] Added to as types are encountered or resolved
49
- # @return [self]
50
- def resolve_generics_from_context generics_to_resolve, context_type, resolved_generic_values: {}
51
- return self unless generic?
52
-
53
- ComplexType.new(@items.map { |i| i.resolve_generics_from_context(generics_to_resolve, context_type, resolved_generic_values: resolved_generic_values) })
54
- end
55
-
56
- # @return [UniqueType]
57
- def first
58
- @items.first
59
- end
60
-
61
- # @return [String]
62
- def to_rbs
63
- ((@items.length > 1 ? '(' : '') +
64
- @items.map(&:to_rbs).join(' | ') +
65
- (@items.length > 1 ? ')' : ''))
66
- end
67
-
68
- # @param dst [ComplexType]
69
- # @return [ComplexType]
70
- def self_to_type dst
71
- object_type_dst = dst.reduce_class_type
72
- transform do |t|
73
- next t if t.name != 'self'
74
- object_type_dst
75
- end
76
- end
77
-
78
- # @yieldparam [UniqueType]
79
- # @return [Array<UniqueType>]
80
- def map &block
81
- @items.map &block
82
- end
83
-
84
- # @yieldparam [UniqueType]
85
- # @return [Enumerable<UniqueType>]
86
- def each &block
87
- @items.each &block
88
- end
89
-
90
- # @yieldparam [UniqueType]
91
- # @return [void]
92
- # @overload each_unique_type()
93
- # @return [Enumerator<UniqueType>]
94
- def each_unique_type &block
95
- return enum_for(__method__) unless block_given?
96
-
97
- @items.each do |item|
98
- item.each_unique_type &block
99
- end
100
- end
101
-
102
- # @param atype [ComplexType] type which may be assigned to this type
103
- # @param api_map [ApiMap] The ApiMap that performs qualification
104
- def can_assign?(api_map, atype)
105
- any? { |ut| ut.can_assign?(api_map, atype) }
106
- end
107
-
108
- # @param new_name [String, nil]
109
- # @param make_rooted [Boolean, nil]
110
- # @param new_key_types [Array<ComplexType>, nil]
111
- # @param rooted [Boolean, nil]
112
- # @param new_subtypes [Array<ComplexType>, nil]
113
- # @return [self]
114
- def recreate(new_name: nil, make_rooted: nil, new_key_types: nil, new_subtypes: nil)
115
- ComplexType.new(map do |ut|
116
- ut.recreate(new_name: new_name,
117
- make_rooted: make_rooted,
118
- new_key_types: new_key_types,
119
- new_subtypes: new_subtypes)
120
- end)
121
- end
122
-
123
- # @return [Integer]
124
- def length
125
- @items.length
126
- end
127
-
128
- # @return [Array<UniqueType>]
129
- def to_a
130
- @items
131
- end
132
-
133
- # @param index [Integer]
134
- # @return [UniqueType]
135
- def [](index)
136
- @items[index]
137
- end
138
-
139
- # @return [Array<UniqueType>]
140
- def select &block
141
- @items.select &block
142
- end
143
-
144
- # @return [String]
145
- def namespace
146
- # cache this attr for high frequency call
147
- @namespace ||= method_missing(:namespace).to_s
148
- end
149
-
150
- # @return [Array<String>]
151
- def namespaces
152
- @items.map(&:namespace)
153
- end
154
-
155
- # @param name [Symbol]
156
- # @return [Object, nil]
157
- def method_missing name, *args, &block
158
- return if @items.first.nil?
159
- return @items.first.send(name, *args, &block) if respond_to_missing?(name)
160
- super
161
- end
162
-
163
- # @param name [Symbol]
164
- # @param include_private [Boolean]
165
- def respond_to_missing?(name, include_private = false)
166
- TypeMethods.public_instance_methods.include?(name) || super
167
- end
168
-
169
- def to_s
170
- map(&:tag).join(', ')
171
- end
172
-
173
- # @return [String]
174
- def tags
175
- map(&:tag).join(', ')
176
- end
177
-
178
- # @return [String]
179
- def simple_tags
180
- simplify_literals.tags
181
- end
182
-
183
- def literal?
184
- @items.any?(&:literal?)
185
- end
186
-
187
- # @return [ComplexType]
188
- def downcast_to_literal_if_possible
189
- ComplexType.new(items.map(&:downcast_to_literal_if_possible))
190
- end
191
-
192
- # @return [String]
193
- def desc
194
- rooted_tags
195
- end
196
-
197
- # @return [String]
198
- def rooted_tags
199
- map(&:rooted_tag).join(', ')
200
- end
201
-
202
- # @yieldparam [UniqueType]
203
- def all? &block
204
- @items.all? &block
205
- end
206
-
207
- # @yieldparam [UniqueType]
208
- # @yieldreturn [Boolean]
209
- # @return [Boolean]
210
- def any? &block
211
- @items.compact.any? &block
212
- end
213
-
214
- def selfy?
215
- @items.any?(&:selfy?)
216
- end
217
-
218
- def generic?
219
- any?(&:generic?)
220
- end
221
-
222
- # @return [self]
223
- def simplify_literals
224
- ComplexType.new(map(&:simplify_literals))
225
- end
226
-
227
- # @param new_name [String, nil]
228
- # @yieldparam t [UniqueType]
229
- # @yieldreturn [UniqueType]
230
- # @return [ComplexType]
231
- def transform(new_name = nil, &transform_type)
232
- raise "Please remove leading :: and set rooted with recreate() instead - #{new_name}" if new_name&.start_with?('::')
233
- ComplexType.new(map { |ut| ut.transform(new_name, &transform_type) })
234
- end
235
-
236
- # @return [self]
237
- def force_rooted
238
- transform do |t|
239
- t.recreate(make_rooted: true)
240
- end
241
- end
242
-
243
- # @param definitions [Pin::Namespace, Pin::Method]
244
- # @param context_type [ComplexType]
245
- # @return [ComplexType]
246
- def resolve_generics definitions, context_type
247
- result = @items.map { |i| i.resolve_generics(definitions, context_type) }
248
- ComplexType.new(result)
249
- end
250
-
251
- def nullable?
252
- @items.any?(&:nil_type?)
253
- end
254
-
255
- # @return [Array<ComplexType>]
256
- def all_params
257
- @items.first.all_params || []
258
- end
259
-
260
- # @return [ComplexType]
261
- def reduce_class_type
262
- new_items = items.flat_map do |type|
263
- next type unless ['Module', 'Class'].include?(type.name)
264
- next type if type.all_params.empty?
265
-
266
- type.all_params
267
- end
268
- ComplexType.new(new_items)
269
- end
270
-
271
- # every type and subtype in this union have been resolved to be
272
- # fully qualified
273
- def all_rooted?
274
- all?(&:all_rooted?)
275
- end
276
-
277
- # every top-level type has resolved to be fully qualified; see
278
- # #all_rooted? to check their subtypes as well
279
- def rooted?
280
- all?(&:rooted?)
281
- end
282
-
283
- attr_reader :items
284
-
285
- def rooted?
286
- @items.all?(&:rooted?)
287
- end
288
-
289
- protected
290
-
291
- # @return [ComplexType]
292
- def reduce_object
293
- new_items = items.flat_map do |ut|
294
- next [ut] if ut.name != 'Object' || ut.subtypes.empty?
295
- ut.subtypes
296
- end
297
- ComplexType.new(new_items)
298
- end
299
-
300
- def bottom?
301
- @items.all?(&:bot?)
302
- end
303
-
304
- class << self
305
- # Parse type strings into a ComplexType.
306
- #
307
- # @example
308
- # ComplexType.parse 'String', 'Foo', 'nil' #=> [String, Foo, nil]
309
- #
310
- # @note
311
- # The `partial` parameter is used to indicate that the method is
312
- # receiving a string that will be used inside another ComplexType.
313
- # It returns arrays of ComplexTypes instead of a single cohesive one.
314
- # Consumers should not need to use this parameter; it should only be
315
- # used internally.
316
- #
317
- # @param strings [Array<String>] The type definitions to parse
318
- # @return [ComplexType]
319
- # # @overload parse(*strings, partial: false)
320
- # # @todo Need ability to use a literal true as a type below
321
- # # @param partial [Boolean] True if the string is part of a another type
322
- # # @return [Array<UniqueType>]
323
- # @todo To be able to select the right signature above,
324
- # Chain::Call needs to know the decl type (:arg, :optarg,
325
- # :kwarg, etc) of the arguments given, instead of just having
326
- # an array of Chains as the arguments.
327
- def parse *strings, partial: false
328
- # @type [Hash{Array<String> => ComplexType}]
329
- @cache ||= {}
330
- unless partial
331
- cached = @cache[strings]
332
- return cached unless cached.nil?
333
- end
334
- types = []
335
- key_types = nil
336
- strings.each do |type_string|
337
- point_stack = 0
338
- curly_stack = 0
339
- paren_stack = 0
340
- base = String.new
341
- subtype_string = String.new
342
- # @param char [String]
343
- type_string&.each_char do |char|
344
- if char == '='
345
- #raise ComplexTypeError, "Invalid = in type #{type_string}" unless curly_stack > 0
346
- elsif char == '<'
347
- point_stack += 1
348
- elsif char == '>'
349
- if subtype_string.end_with?('=') && curly_stack > 0
350
- subtype_string += char
351
- elsif base.end_with?('=')
352
- raise ComplexTypeError, "Invalid hash thing" unless key_types.nil?
353
- # types.push ComplexType.new([UniqueType.new(base[0..-2].strip)])
354
- types.push UniqueType.parse(base[0..-2].strip, subtype_string)
355
- # @todo this should either expand key_type's type
356
- # automatically or complain about not being
357
- # compatible with key_type's type in type checking
358
- key_types = types
359
- types = []
360
- base.clear
361
- subtype_string.clear
362
- next
363
- else
364
- raise ComplexTypeError, "Invalid close in type #{type_string}" if point_stack == 0
365
- point_stack -= 1
366
- subtype_string += char
367
- end
368
- next
369
- elsif char == '{'
370
- curly_stack += 1
371
- elsif char == '}'
372
- curly_stack -= 1
373
- subtype_string += char
374
- raise ComplexTypeError, "Invalid close in type #{type_string}" if curly_stack < 0
375
- next
376
- elsif char == '('
377
- paren_stack += 1
378
- elsif char == ')'
379
- paren_stack -= 1
380
- subtype_string += char
381
- raise ComplexTypeError, "Invalid close in type #{type_string}" if paren_stack < 0
382
- next
383
- elsif char == ',' && point_stack == 0 && curly_stack == 0 && paren_stack == 0
384
- # types.push ComplexType.new([UniqueType.new(base.strip, subtype_string.strip)])
385
- types.push UniqueType.parse(base.strip, subtype_string.strip)
386
- base.clear
387
- subtype_string.clear
388
- next
389
- end
390
- if point_stack == 0 && curly_stack == 0 && paren_stack == 0
391
- base.concat char
392
- else
393
- subtype_string.concat char
394
- end
395
- end
396
- raise ComplexTypeError, "Unclosed subtype in #{type_string}" if point_stack != 0 || curly_stack != 0 || paren_stack != 0
397
- # types.push ComplexType.new([UniqueType.new(base, subtype_string)])
398
- types.push UniqueType.parse(base.strip, subtype_string.strip)
399
- end
400
- unless key_types.nil?
401
- raise ComplexTypeError, "Invalid use of key/value parameters" unless partial
402
- return key_types if types.empty?
403
- return [key_types, types]
404
- end
405
- result = partial ? types : ComplexType.new(types)
406
- @cache[strings] = result unless partial
407
- result
408
- end
409
-
410
- # @param strings [Array<String>]
411
- # @return [ComplexType]
412
- def try_parse *strings
413
- parse *strings
414
- rescue ComplexTypeError => e
415
- Solargraph.logger.info "Error parsing complex type `#{strings.join(', ')}`: #{e.message}"
416
- ComplexType::UNDEFINED
417
- end
418
- end
419
-
420
- VOID = ComplexType.parse('void')
421
- UNDEFINED = ComplexType.parse('undefined')
422
- SYMBOL = ComplexType.parse('::Symbol')
423
- ROOT = ComplexType.parse('::Class<>')
424
- NIL = ComplexType.parse('nil')
425
- SELF = ComplexType.parse('self')
426
- BOOLEAN = ComplexType.parse('::Boolean')
427
- BOT = ComplexType.parse('bot')
428
-
429
- private
430
-
431
- # @todo This is a quick and dirty hack that forces `self` keywords
432
- # to reference an instance of their class and never the class itself.
433
- # This behavior may change depending on which result is expected
434
- # from YARD conventions. See https://github.com/lsegal/yard/issues/1257
435
- # @param dst [String]
436
- # @return [String]
437
- def reduce_class dst
438
- while dst =~ /^(Class|Module)\<(.*?)\>$/
439
- dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')
440
- end
441
- dst
442
- end
443
- end
444
- end
1
+ # frozen_string_literal: true
2
+
3
+ module Solargraph
4
+ # A container for type data based on YARD type tags.
5
+ #
6
+ class ComplexType
7
+ GENERIC_TAG_NAME = 'generic'.freeze
8
+ # @!parse
9
+ # include TypeMethods
10
+ include Equality
11
+
12
+ autoload :TypeMethods, 'solargraph/complex_type/type_methods'
13
+ autoload :UniqueType, 'solargraph/complex_type/unique_type'
14
+
15
+ # @param types [Array<UniqueType, ComplexType>]
16
+ def initialize types = [UniqueType::UNDEFINED]
17
+ # @todo @items here should not need an annotation
18
+ # @type [Array<UniqueType>]
19
+ items = types.flat_map(&:items).uniq(&:to_s)
20
+ if items.any? { |i| i.name == 'false' } && items.any? { |i| i.name == 'true' }
21
+ items.delete_if { |i| i.name == 'false' || i.name == 'true' }
22
+ items.unshift(ComplexType::BOOLEAN)
23
+ end
24
+ items = [UniqueType::UNDEFINED] if items.any?(&:undefined?)
25
+ @items = items
26
+ end
27
+
28
+ # @sg-ignore Fix "Not enough arguments to Module#protected"
29
+ protected def equality_fields
30
+ [self.class, items]
31
+ end
32
+
33
+ # @param api_map [ApiMap]
34
+ # @param context [String]
35
+ # @return [ComplexType]
36
+ def qualify api_map, *gates
37
+ red = reduce_object
38
+ types = red.items.map do |t|
39
+ next t if ['nil', 'void', 'undefined'].include?(t.name)
40
+ next t if ['::Boolean'].include?(t.rooted_name)
41
+ t.qualify api_map, *gates
42
+ end
43
+ ComplexType.new(types).reduce_object
44
+ end
45
+
46
+ # @param generics_to_resolve [Enumerable<String>]]
47
+ # @param context_type [UniqueType, nil]
48
+ # @param resolved_generic_values [Hash{String => ComplexType}] Added to as types are encountered or resolved
49
+ # @return [self]
50
+ def resolve_generics_from_context generics_to_resolve, context_type, resolved_generic_values: {}
51
+ return self unless generic?
52
+
53
+ ComplexType.new(@items.map { |i| i.resolve_generics_from_context(generics_to_resolve, context_type, resolved_generic_values: resolved_generic_values) })
54
+ end
55
+
56
+ # @return [UniqueType]
57
+ def first
58
+ @items.first
59
+ end
60
+
61
+ # @return [String]
62
+ def to_rbs
63
+ ((@items.length > 1 ? '(' : '') +
64
+ @items.map(&:to_rbs).join(' | ') +
65
+ (@items.length > 1 ? ')' : ''))
66
+ end
67
+
68
+ # @param dst [ComplexType]
69
+ # @return [ComplexType]
70
+ def self_to_type dst
71
+ object_type_dst = dst.reduce_class_type
72
+ transform do |t|
73
+ next t if t.name != 'self'
74
+ object_type_dst
75
+ end
76
+ end
77
+
78
+ # @yieldparam [UniqueType]
79
+ # @return [Array<UniqueType>]
80
+ def map &block
81
+ @items.map &block
82
+ end
83
+
84
+ # @yieldparam [UniqueType]
85
+ # @return [Enumerable<UniqueType>]
86
+ def each &block
87
+ @items.each &block
88
+ end
89
+
90
+ # @yieldparam [UniqueType]
91
+ # @return [void]
92
+ # @overload each_unique_type()
93
+ # @return [Enumerator<UniqueType>]
94
+ def each_unique_type &block
95
+ return enum_for(__method__) unless block_given?
96
+
97
+ @items.each do |item|
98
+ item.each_unique_type &block
99
+ end
100
+ end
101
+
102
+ # @param atype [ComplexType] type which may be assigned to this type
103
+ # @param api_map [ApiMap] The ApiMap that performs qualification
104
+ def can_assign?(api_map, atype)
105
+ any? { |ut| ut.can_assign?(api_map, atype) }
106
+ end
107
+
108
+ # @param new_name [String, nil]
109
+ # @param make_rooted [Boolean, nil]
110
+ # @param new_key_types [Array<ComplexType>, nil]
111
+ # @param rooted [Boolean, nil]
112
+ # @param new_subtypes [Array<ComplexType>, nil]
113
+ # @return [self]
114
+ def recreate(new_name: nil, make_rooted: nil, new_key_types: nil, new_subtypes: nil)
115
+ ComplexType.new(map do |ut|
116
+ ut.recreate(new_name: new_name,
117
+ make_rooted: make_rooted,
118
+ new_key_types: new_key_types,
119
+ new_subtypes: new_subtypes)
120
+ end)
121
+ end
122
+
123
+ # @return [Integer]
124
+ def length
125
+ @items.length
126
+ end
127
+
128
+ # @return [Array<UniqueType>]
129
+ def to_a
130
+ @items
131
+ end
132
+
133
+ # @param index [Integer]
134
+ # @return [UniqueType]
135
+ def [](index)
136
+ @items[index]
137
+ end
138
+
139
+ # @return [Array<UniqueType>]
140
+ def select &block
141
+ @items.select &block
142
+ end
143
+
144
+ # @return [String]
145
+ def namespace
146
+ # cache this attr for high frequency call
147
+ @namespace ||= method_missing(:namespace).to_s
148
+ end
149
+
150
+ # @return [Array<String>]
151
+ def namespaces
152
+ @items.map(&:namespace)
153
+ end
154
+
155
+ # @param name [Symbol]
156
+ # @return [Object, nil]
157
+ def method_missing name, *args, &block
158
+ return if @items.first.nil?
159
+ return @items.first.send(name, *args, &block) if respond_to_missing?(name)
160
+ super
161
+ end
162
+
163
+ # @param name [Symbol]
164
+ # @param include_private [Boolean]
165
+ def respond_to_missing?(name, include_private = false)
166
+ TypeMethods.public_instance_methods.include?(name) || super
167
+ end
168
+
169
+ def to_s
170
+ map(&:tag).join(', ')
171
+ end
172
+
173
+ # @return [String]
174
+ def tags
175
+ map(&:tag).join(', ')
176
+ end
177
+
178
+ # @return [String]
179
+ def simple_tags
180
+ simplify_literals.tags
181
+ end
182
+
183
+ def literal?
184
+ @items.any?(&:literal?)
185
+ end
186
+
187
+ # @return [ComplexType]
188
+ def downcast_to_literal_if_possible
189
+ ComplexType.new(items.map(&:downcast_to_literal_if_possible))
190
+ end
191
+
192
+ # @return [String]
193
+ def desc
194
+ rooted_tags
195
+ end
196
+
197
+ # @return [String]
198
+ def rooted_tags
199
+ map(&:rooted_tag).join(', ')
200
+ end
201
+
202
+ # @yieldparam [UniqueType]
203
+ def all? &block
204
+ @items.all? &block
205
+ end
206
+
207
+ # @yieldparam [UniqueType]
208
+ # @yieldreturn [Boolean]
209
+ # @return [Boolean]
210
+ def any? &block
211
+ @items.compact.any? &block
212
+ end
213
+
214
+ def selfy?
215
+ @items.any?(&:selfy?)
216
+ end
217
+
218
+ def generic?
219
+ any?(&:generic?)
220
+ end
221
+
222
+ # @return [self]
223
+ def simplify_literals
224
+ ComplexType.new(map(&:simplify_literals))
225
+ end
226
+
227
+ # @param new_name [String, nil]
228
+ # @yieldparam t [UniqueType]
229
+ # @yieldreturn [UniqueType]
230
+ # @return [ComplexType]
231
+ def transform(new_name = nil, &transform_type)
232
+ raise "Please remove leading :: and set rooted with recreate() instead - #{new_name}" if new_name&.start_with?('::')
233
+ ComplexType.new(map { |ut| ut.transform(new_name, &transform_type) })
234
+ end
235
+
236
+ # @return [self]
237
+ def force_rooted
238
+ transform do |t|
239
+ t.recreate(make_rooted: true)
240
+ end
241
+ end
242
+
243
+ # @param definitions [Pin::Namespace, Pin::Method]
244
+ # @param context_type [ComplexType]
245
+ # @return [ComplexType]
246
+ def resolve_generics definitions, context_type
247
+ result = @items.map { |i| i.resolve_generics(definitions, context_type) }
248
+ ComplexType.new(result)
249
+ end
250
+
251
+ def nullable?
252
+ @items.any?(&:nil_type?)
253
+ end
254
+
255
+ # @return [Array<ComplexType>]
256
+ def all_params
257
+ @items.first.all_params || []
258
+ end
259
+
260
+ # @return [ComplexType]
261
+ def reduce_class_type
262
+ new_items = items.flat_map do |type|
263
+ next type unless ['Module', 'Class'].include?(type.name)
264
+ next type if type.all_params.empty?
265
+
266
+ type.all_params
267
+ end
268
+ ComplexType.new(new_items)
269
+ end
270
+
271
+ # every type and subtype in this union have been resolved to be
272
+ # fully qualified
273
+ def all_rooted?
274
+ all?(&:all_rooted?)
275
+ end
276
+
277
+ # every top-level type has resolved to be fully qualified; see
278
+ # #all_rooted? to check their subtypes as well
279
+ def rooted?
280
+ all?(&:rooted?)
281
+ end
282
+
283
+ attr_reader :items
284
+
285
+ def rooted?
286
+ @items.all?(&:rooted?)
287
+ end
288
+
289
+ protected
290
+
291
+ # @return [ComplexType]
292
+ def reduce_object
293
+ new_items = items.flat_map do |ut|
294
+ next [ut] if ut.name != 'Object' || ut.subtypes.empty?
295
+ ut.subtypes
296
+ end
297
+ ComplexType.new(new_items)
298
+ end
299
+
300
+ def bottom?
301
+ @items.all?(&:bot?)
302
+ end
303
+
304
+ class << self
305
+ # Parse type strings into a ComplexType.
306
+ #
307
+ # @example
308
+ # ComplexType.parse 'String', 'Foo', 'nil' #=> [String, Foo, nil]
309
+ #
310
+ # @note
311
+ # The `partial` parameter is used to indicate that the method is
312
+ # receiving a string that will be used inside another ComplexType.
313
+ # It returns arrays of ComplexTypes instead of a single cohesive one.
314
+ # Consumers should not need to use this parameter; it should only be
315
+ # used internally.
316
+ #
317
+ # @param strings [Array<String>] The type definitions to parse
318
+ # @return [ComplexType]
319
+ # # @overload parse(*strings, partial: false)
320
+ # # @todo Need ability to use a literal true as a type below
321
+ # # @param partial [Boolean] True if the string is part of a another type
322
+ # # @return [Array<UniqueType>]
323
+ # @todo To be able to select the right signature above,
324
+ # Chain::Call needs to know the decl type (:arg, :optarg,
325
+ # :kwarg, etc) of the arguments given, instead of just having
326
+ # an array of Chains as the arguments.
327
+ def parse *strings, partial: false
328
+ # @type [Hash{Array<String> => ComplexType}]
329
+ @cache ||= {}
330
+ unless partial
331
+ cached = @cache[strings]
332
+ return cached unless cached.nil?
333
+ end
334
+ types = []
335
+ key_types = nil
336
+ strings.each do |type_string|
337
+ point_stack = 0
338
+ curly_stack = 0
339
+ paren_stack = 0
340
+ base = String.new
341
+ subtype_string = String.new
342
+ # @param char [String]
343
+ type_string&.each_char do |char|
344
+ if char == '='
345
+ #raise ComplexTypeError, "Invalid = in type #{type_string}" unless curly_stack > 0
346
+ elsif char == '<'
347
+ point_stack += 1
348
+ elsif char == '>'
349
+ if subtype_string.end_with?('=') && curly_stack > 0
350
+ subtype_string += char
351
+ elsif base.end_with?('=')
352
+ raise ComplexTypeError, "Invalid hash thing" unless key_types.nil?
353
+ # types.push ComplexType.new([UniqueType.new(base[0..-2].strip)])
354
+ types.push UniqueType.parse(base[0..-2].strip, subtype_string)
355
+ # @todo this should either expand key_type's type
356
+ # automatically or complain about not being
357
+ # compatible with key_type's type in type checking
358
+ key_types = types
359
+ types = []
360
+ base.clear
361
+ subtype_string.clear
362
+ next
363
+ else
364
+ raise ComplexTypeError, "Invalid close in type #{type_string}" if point_stack == 0
365
+ point_stack -= 1
366
+ subtype_string += char
367
+ end
368
+ next
369
+ elsif char == '{'
370
+ curly_stack += 1
371
+ elsif char == '}'
372
+ curly_stack -= 1
373
+ subtype_string += char
374
+ raise ComplexTypeError, "Invalid close in type #{type_string}" if curly_stack < 0
375
+ next
376
+ elsif char == '('
377
+ paren_stack += 1
378
+ elsif char == ')'
379
+ paren_stack -= 1
380
+ subtype_string += char
381
+ raise ComplexTypeError, "Invalid close in type #{type_string}" if paren_stack < 0
382
+ next
383
+ elsif char == ',' && point_stack == 0 && curly_stack == 0 && paren_stack == 0
384
+ # types.push ComplexType.new([UniqueType.new(base.strip, subtype_string.strip)])
385
+ types.push UniqueType.parse(base.strip, subtype_string.strip)
386
+ base.clear
387
+ subtype_string.clear
388
+ next
389
+ end
390
+ if point_stack == 0 && curly_stack == 0 && paren_stack == 0
391
+ base.concat char
392
+ else
393
+ subtype_string.concat char
394
+ end
395
+ end
396
+ raise ComplexTypeError, "Unclosed subtype in #{type_string}" if point_stack != 0 || curly_stack != 0 || paren_stack != 0
397
+ # types.push ComplexType.new([UniqueType.new(base, subtype_string)])
398
+ types.push UniqueType.parse(base.strip, subtype_string.strip)
399
+ end
400
+ unless key_types.nil?
401
+ raise ComplexTypeError, "Invalid use of key/value parameters" unless partial
402
+ return key_types if types.empty?
403
+ return [key_types, types]
404
+ end
405
+ result = partial ? types : ComplexType.new(types)
406
+ @cache[strings] = result unless partial
407
+ result
408
+ end
409
+
410
+ # @param strings [Array<String>]
411
+ # @return [ComplexType]
412
+ def try_parse *strings
413
+ parse *strings
414
+ rescue ComplexTypeError => e
415
+ Solargraph.logger.info "Error parsing complex type `#{strings.join(', ')}`: #{e.message}"
416
+ ComplexType::UNDEFINED
417
+ end
418
+ end
419
+
420
+ VOID = ComplexType.parse('void')
421
+ UNDEFINED = ComplexType.parse('undefined')
422
+ SYMBOL = ComplexType.parse('::Symbol')
423
+ ROOT = ComplexType.parse('::Class<>')
424
+ NIL = ComplexType.parse('nil')
425
+ SELF = ComplexType.parse('self')
426
+ BOOLEAN = ComplexType.parse('::Boolean')
427
+ BOT = ComplexType.parse('bot')
428
+
429
+ private
430
+
431
+ # @todo This is a quick and dirty hack that forces `self` keywords
432
+ # to reference an instance of their class and never the class itself.
433
+ # This behavior may change depending on which result is expected
434
+ # from YARD conventions. See https://github.com/lsegal/yard/issues/1257
435
+ # @param dst [String]
436
+ # @return [String]
437
+ def reduce_class dst
438
+ while dst =~ /^(Class|Module)\<(.*?)\>$/
439
+ dst = dst.sub(/^(Class|Module)\</, '').sub(/\>$/, '')
440
+ end
441
+ dst
442
+ end
443
+ end
444
+ end