Class: RubyIndexer::RBSIndexerTest

Inherits:
TestCase
  • Object
show all
Defined in:
lib/ruby_indexer/test/rbs_indexer_test.rb

Instance Method Summary collapse

Methods inherited from TestCase

#setup, #teardown

Instance Method Details

#test_attaches_correct_owner_to_singleton_methods ⇒ Object 



86
87
88
89
90
91
92
93
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 86

def test_attaches_correct_owner_to_singleton_methods
  entries = @index["basename"] #: as Array[Entry::Method]
  refute_nil(entries)

  owner = entries.first&.owner #: as Entry::SingletonClass
  assert_instance_of(Entry::SingletonClass, owner)
  assert_equal("File::<Class:File>", owner.name)
end

#test_index_core_classes ⇒ Object 



8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 8

def test_index_core_classes
  entries = @index["Array"] #: as !nil
  refute_nil(entries)
  # Array is a class but also an instance method on Kernel
  assert_equal(2, entries.length)
  entry = entries.find { |entry| entry.is_a?(Entry::Class) } #: as Entry::Class
  assert_match(%r{/gems/rbs-.*/core/array.rbs}, entry.file_path)
  assert_equal("array.rbs", entry.file_name)
  assert_equal("Object", entry.parent_class)
  assert_equal(1, entry.mixin_operations.length)
  enumerable_include = entry.mixin_operations.first #: as !nil
  assert_equal("Enumerable", enumerable_include.module_name)

  # Using fixed positions would be fragile, so let's just check some basics.
  assert_operator(entry.location.start_line, :>, 0)
  assert_operator(entry.location.end_line, :>, entry.location.start_line)
  assert_equal(0, entry.location.start_column)
  assert_operator(entry.location.end_column, :>, 0)
end

#test_index_core_constants ⇒ Object 



43
44
45
46
47
48
49
50
51
52
53
54
55
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 43

def test_index_core_constants
  entries = @index["RUBY_VERSION"] #: as !nil
  refute_nil(entries)
  assert_equal(1, entries.length)

  entries = @index["Complex::I"] #: as !nil
  refute_nil(entries)
  assert_equal(1, entries.length)

  entries = @index["Encoding::US_ASCII"] #: as !nil
  refute_nil(entries)
  assert_equal(1, entries.length)
end

#test_index_core_modules ⇒ Object 



28
29
30
31
32
33
34
35
36
37
38
39
40
41
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 28

def test_index_core_modules
  entries = @index["Kernel"] #: as !nil
  refute_nil(entries)
  assert_equal(1, entries.length)
  entry = entries.first #: as Entry::Module
  assert_match(%r{/gems/rbs-.*/core/kernel.rbs}, entry.file_path)
  assert_equal("kernel.rbs", entry.file_name)

  # Using fixed positions would be fragile, so let's just check some basics.
  assert_operator(entry.location.start_line, :>, 0)
  assert_operator(entry.location.end_line, :>, entry.location.start_line)
  assert_equal(0, entry.location.start_column)
  assert_operator(entry.location.end_column, :>, 0)
end

#test_index_global_declaration ⇒ Object 



72
73
74
75
76
77
78
79
80
81
82
83
84
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 72

def test_index_global_declaration
  entries = @index["$DEBUG"] #: as Array[Entry::GlobalVariable]
  refute_nil(entries)
  assert_equal(1, entries.length)

  entry = entries.first #: as Entry::GlobalVariable

  assert_instance_of(Entry::GlobalVariable, entry)
  assert_equal("$DEBUG", entry.name)
  assert_match(%r{/gems/rbs-.*/core/global_variables.rbs}, entry.file_path)
  assert_operator(entry.location.start_column, :<, entry.location.end_column)
  assert_equal(entry.location.start_line, entry.location.end_line)
end

#test_index_methods ⇒ Object 



57
58
59
60
61
62
63
64
65
66
67
68
69
70
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 57

def test_index_methods
  entries = @index["initialize"] #: as Array[Entry::Method]
  refute_nil(entries)
  entry = entries.find { |entry| entry.owner&.name == "Array" } #: as Entry::Method
  assert_match(%r{/gems/rbs-.*/core/array.rbs}, entry.file_path)
  assert_equal("array.rbs", entry.file_name)
  assert_equal(:public, entry.visibility)

  # Using fixed positions would be fragile, so let's just check some basics.
  assert_operator(entry.location.start_line, :>, 0)
  assert_operator(entry.location.end_line, :>, entry.location.start_line)
  assert_equal(2, entry.location.start_column)
  assert_operator(entry.location.end_column, :>, 0)
end

#test_indexing_untyped_functions ⇒ Object 



358
359
360
361
362
363
364
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 358

def test_indexing_untyped_functions
  entries = @index.resolve_method("call", "Method") #: as Array[Entry::Method]

  parameters = entries.first&.signatures&.first&.parameters #: as !nil
  assert_equal(1, parameters.length)
  assert_instance_of(Entry::ForwardingParameter, parameters.first)
end

#test_location_and_name_location_are_the_same ⇒ Object 



95
96
97
98
99
100
101
102
103
104
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 95

def test_location_and_name_location_are_the_same
  # NOTE: RBS does not store the name location for classes, modules or methods. This behavior is not exactly what
  # we would like, but for now we assign the same location to both

  entries = @index["Array"] #: as Array[Entry::Class]
  refute_nil(entries)
  entry = entries.find { |entry| entry.is_a?(Entry::Class) } #: as Entry::Class

  assert_same(entry.location, entry.name_location)
end

#test_parse_simple_rbs ⇒ Object 



318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 318

def test_parse_simple_rbs
  rbs = "    class File\n      def self?.open: (String name, ?String mode, ?Integer perm) -> IO?\n          | [T] (String name, ?String mode, ?Integer perm) { (IO) -> T } -> T\n    end\n  RBS\n  signatures = parse_rbs_methods(rbs, \"open\")\n  assert_equal(2, signatures.length)\n  parameters = signatures[0].parameters\n  assert_equal([:name, :mode, :perm], parameters.map(&:name))\n  assert_kind_of(Entry::RequiredParameter, parameters[0])\n  assert_kind_of(Entry::OptionalParameter, parameters[1])\n  assert_kind_of(Entry::OptionalParameter, parameters[2])\n\n  parameters = signatures[1].parameters\n  assert_equal([:name, :mode, :perm, :\"<anonymous block>\"], parameters.map(&:name))\n  assert_kind_of(Entry::RequiredParameter, parameters[0])\n  assert_kind_of(Entry::OptionalParameter, parameters[1])\n  assert_kind_of(Entry::OptionalParameter, parameters[2])\n  assert_kind_of(Entry::BlockParameter, parameters[3])\nend\n"

#test_rbs_anonymous_block_parameter ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 191

def test_rbs_anonymous_block_parameter
  entries = @index["open"] #: as Array[Entry::Method]
  entry = entries.find { |entry| entry.owner&.name == "File::<Class:File>" } #: as Entry::Method

  assert_equal(2, entry.signatures.length)

  # (::String name, ?::String mode, ?::Integer perm) -> ::IO?
  # | [T] (::String name, ?::String mode, ?::Integer perm) { (::IO) -> T } -> T

  parameters = entry.signatures[0]&.parameters #: as !nil
  assert_equal([:file_name, :mode, :perm], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
  assert_kind_of(Entry::OptionalParameter, parameters[1])
  assert_kind_of(Entry::OptionalParameter, parameters[2])

  parameters = entry.signatures[1]&.parameters #: as !nil
  assert_equal([:file_name, :mode, :perm, :"<anonymous block>"], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
  assert_kind_of(Entry::OptionalParameter, parameters[1])
  assert_kind_of(Entry::OptionalParameter, parameters[2])
  assert_kind_of(Entry::BlockParameter, parameters[3])
end

#test_rbs_method_with_optional_keywords ⇒ Object 



252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 252

def test_rbs_method_with_optional_keywords
  entries = @index["step"] #: as Array[Entry::Method]
  entry = entries.find { |entry| entry.owner&.name == "Numeric" } #: as !nil

  signatures = entry.signatures
  assert_equal(4, signatures.length)

  # (?::Numeric limit, ?::Numeric step) { (::Numeric) -> void } -> self
  # | (?::Numeric limit, ?::Numeric step) -> ::Enumerator[::Numeric, self]
  # | (?by: ::Numeric, ?to: ::Numeric) { (::Numeric) -> void } -> self
  # | (?by: ::Numeric, ?to: ::Numeric) -> ::Enumerator[::Numeric, self]

  parameters = signatures[0]&.parameters #: as !nil
  assert_equal([:limit, :step, :"<anonymous block>"], parameters.map(&:name))
  assert_kind_of(Entry::OptionalParameter, parameters[0])
  assert_kind_of(Entry::OptionalParameter, parameters[1])
  assert_kind_of(Entry::BlockParameter, parameters[2])

  parameters = signatures[1]&.parameters #: as !nil
  assert_equal([:limit, :step], parameters.map(&:name))
  assert_kind_of(Entry::OptionalParameter, parameters[0])
  assert_kind_of(Entry::OptionalParameter, parameters[1])

  parameters = signatures[2]&.parameters #: as !nil
  assert_equal([:by, :to, :"<anonymous block>"], parameters.map(&:name))
  assert_kind_of(Entry::OptionalKeywordParameter, parameters[0])
  assert_kind_of(Entry::OptionalKeywordParameter, parameters[1])
  assert_kind_of(Entry::BlockParameter, parameters[2])

  parameters = signatures[3]&.parameters #: as !nil
  assert_equal([:by, :to], parameters.map(&:name))
  assert_kind_of(Entry::OptionalKeywordParameter, parameters[0])
  assert_kind_of(Entry::OptionalKeywordParameter, parameters[1])
end

#test_rbs_method_with_optional_parameter ⇒ Object 



146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 146

def test_rbs_method_with_optional_parameter
  entries = @index["chomp"] #: as Array[Entry::Method]
  assert_equal(1, entries.length)

  entry = entries.first #: as Entry::Method
  signatures = entry.signatures
  assert_equal(1, signatures.length)

  first_signature = signatures.first #: as Entry::Signature

  # (?::string? separator) -> ::String

  assert_equal(1, first_signature.parameters.length)
  assert_kind_of(Entry::OptionalParameter, first_signature.parameters[0])
  assert_equal(:separator, first_signature.parameters[0]&.name)
end

#test_rbs_method_with_optional_positionals ⇒ Object 



133
134
135
136
137
138
139
140
141
142
143
144
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 133

def test_rbs_method_with_optional_positionals
  entries = @index["polar"] #: as Array[Entry::Method]
  entry = entries.find { |entry| entry.owner&.name == "Complex::<Class:Complex>" } #: as Entry::Method

  # def self.polar: (Numeric, ?Numeric) -> Complex

  parameters = entry.signatures[0]&.parameters #: as Array[Entry::Parameter]

  assert_equal([:arg0, :arg1], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
  assert_kind_of(Entry::OptionalParameter, parameters[1])
end

#test_rbs_method_with_required_and_optional_parameters ⇒ Object 



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
188
189
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 163

def test_rbs_method_with_required_and_optional_parameters
  entries = @index["gsub"] #: as Array[Entry::Method]
  assert_equal(1, entries.length)

  entry = entries.first #: as Entry::Method

  signatures = entry.signatures
  assert_equal(3, signatures.length)

  # (::Regexp | ::string pattern, ::string | ::hash[::String, ::_ToS] replacement) -> ::String
  # | (::Regexp | ::string pattern) -> ::Enumerator[::String, ::String]
  # | (::Regexp | ::string pattern) { (::String match) -> ::_ToS } -> ::String

  parameters = signatures[0]&.parameters #: as !nil
  assert_equal([:pattern, :replacement], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
  assert_kind_of(Entry::RequiredParameter, parameters[1])

  parameters = signatures[1]&.parameters #: as !nil
  assert_equal([:pattern], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])

  parameters = signatures[2]&.parameters #: as !nil
  assert_equal([:pattern, :"<anonymous block>"], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
  assert_kind_of(Entry::BlockParameter, parameters[1])
end

#test_rbs_method_with_required_keywords ⇒ Object 



287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 287

def test_rbs_method_with_required_keywords
  # There are no methods in Core that have required keyword arguments,
  # so we test against RBS directly

  rbs = "    class File\n      def foo: (a: ::Numeric sz, b: ::Numeric) -> void\n    end\n  RBS\n  signatures = parse_rbs_methods(rbs, \"foo\")\n  parameters = signatures[0].parameters\n  assert_equal([:a, :b], parameters.map(&:name))\n  assert_kind_of(Entry::KeywordParameter, parameters[0])\n  assert_kind_of(Entry::KeywordParameter, parameters[1])\nend\n"

#test_rbs_method_with_required_positionals ⇒ Object 



106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 106

def test_rbs_method_with_required_positionals
  entries = @index["crypt"] #: as Array[Entry::Method]
  assert_equal(1, entries.length)

  entry = entries.first #: as Entry::Method
  signatures = entry.signatures
  assert_equal(1, signatures.length)

  first_signature = signatures.first #: as Entry::Signature

  # (::string salt_str) -> ::String

  assert_equal(1, first_signature.parameters.length)
  assert_kind_of(Entry::RequiredParameter, first_signature.parameters[0])
  assert_equal(:salt_str, first_signature.parameters[0]&.name)
end

#test_rbs_method_with_rest_keywords ⇒ Object 



303
304
305
306
307
308
309
310
311
312
313
314
315
316
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 303

def test_rbs_method_with_rest_keywords
  entries = @index["method_missing"] #: as Array[Entry::Method]
  entry = entries.find { |entry| entry.owner&.name == "BasicObject" } #: as !nil
  signatures = entry.signatures
  assert_equal(1, signatures.length)

  # (Symbol, *untyped, **untyped) ?{ (*untyped, **untyped) -> untyped } -> untyped

  parameters = signatures[0]&.parameters #: as !nil
  assert_equal([:arg0, :"<anonymous splat>", :"<anonymous keyword splat>"], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
  assert_kind_of(Entry::RestParameter, parameters[1])
  assert_kind_of(Entry::KeywordRestParameter, parameters[2])
end

#test_rbs_method_with_rest_positionals ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 214

def test_rbs_method_with_rest_positionals
  entries = @index["count"] #: as Array[Entry::Method]
  entry = entries.find { |entry| entry.owner&.name == "String" } #: as Entry::Method

  parameters = entry.signatures.first&.parameters #: as !nil
  assert_equal(1, entry.signatures.length)

  # (::String::selector selector_0, *::String::selector more_selectors) -> ::Integer

  assert_equal([:selector_0, :more_selectors], parameters.map(&:name))
  assert_kind_of(RubyIndexer::Entry::RequiredParameter, parameters[0])
  assert_kind_of(RubyIndexer::Entry::RestParameter, parameters[1])
end

#test_rbs_method_with_trailing_positionals ⇒ Object 



228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 228

def test_rbs_method_with_trailing_positionals
  entries = @index["select"] #: as Array[Entry::Method]
  entry = entries.find { |entry| entry.owner&.name == "IO::<Class:IO>" } #: as !nil

  signatures = entry.signatures
  assert_equal(2, signatures.length)

  # def self.select: [X, Y, Z] (::Array[X & io]? read_array, ?::Array[Y & io]? write_array, ?::Array[Z & io]? error_array) -> [ Array[X], Array[Y], Array[Z] ]
  #   | [X, Y, Z] (::Array[X & io]? read_array, ?::Array[Y & io]? write_array, ?::Array[Z & io]? error_array, Time::_Timeout? timeout) -> [ Array[X], Array[Y], Array[Z] ]?

  parameters = signatures[0]&.parameters #: as !nil
  assert_equal([:read_array, :write_array, :error_array], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
  assert_kind_of(Entry::OptionalParameter, parameters[1])
  assert_kind_of(Entry::OptionalParameter, parameters[2])

  parameters = signatures[1]&.parameters #: as !nil
  assert_equal([:read_array, :write_array, :error_array, :timeout], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
  assert_kind_of(Entry::OptionalParameter, parameters[1])
  assert_kind_of(Entry::OptionalParameter, parameters[2])
  assert_kind_of(Entry::OptionalParameter, parameters[3])
end

#test_rbs_method_with_unnamed_required_positionals ⇒ Object 



123
124
125
126
127
128
129
130
131
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 123

def test_rbs_method_with_unnamed_required_positionals
  entries = @index["try_convert"] #: as Array[Entry::Method]
  entry = entries.find { |entry| entry.owner&.name == "Array::<Class:Array>" } #: as Entry::Method

  parameters = entry.signatures[0]&.parameters #: as Array[Entry::Parameter]

  assert_equal([:arg0], parameters.map(&:name))
  assert_kind_of(Entry::RequiredParameter, parameters[0])
end

#test_signature_alias ⇒ Object 



341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
 
# File 'lib/ruby_indexer/test/rbs_indexer_test.rb', line 341

def test_signature_alias
  # In RBS, an alias means that two methods have the same signature.
  # It does not mean the same thing as a Ruby alias.
  any_entries = @index["any?"] #: as Array[Entry::UnresolvedMethodAlias]

  assert_equal(["Array", "Enumerable", "Hash"], any_entries.map { _1.owner&.name })

  entry = any_entries.find { |entry| entry.owner&.name == "Array" } #: as !nil

  assert_kind_of(RubyIndexer::Entry::UnresolvedMethodAlias, entry)
  assert_equal("any?", entry.name)
  assert_equal("all?", entry.old_name)
  assert_equal("Array", entry.owner&.name)
  assert(entry.file_path&.end_with?("core/array.rbs"))
  refute_empty(entry.comments)
end