File: type_inferrer_test.rb

package info (click to toggle)
ruby-ruby-lsp 0.26.7-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 27,676 kB
  • sloc: ruby: 35,294; javascript: 29; sh: 7; makefile: 4
file content (512 lines) | stat: -rw-r--r-- 14,106 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
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
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
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
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
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
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
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
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
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
# typed: true
# frozen_string_literal: true

require "test_helper"

module RubyLsp
  class TypeInferrerTest < Minitest::Test
    def setup
      @index = RubyIndexer::Index.new
      @type_inferrer = TypeInferrer.new(@index)
    end

    def test_infer_receiver_type_self_inside_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          def bar
            baz
          end
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_self_inside_class_body
      node_context = index_and_locate(<<~RUBY, { line: 1, character: 2 })
        class Foo
          baz
        end
      RUBY

      assert_equal("Foo::<Class:Foo>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_self_inside_singleton_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          def self.bar
            baz
          end
        end
      RUBY

      assert_equal("Foo::<Class:Foo>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_self_inside_singleton_block_body
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          class << self
            baz
          end
        end
      RUBY

      assert_equal("Foo::<Class:Foo>::<Class:<Class:Foo>>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_self_inside_singleton_block_method
      node_context = index_and_locate(<<~RUBY, { line: 3, character: 6 })
        class Foo
          class << self
            def bar
              baz
            end
          end
        end
      RUBY

      assert_equal("Foo::<Class:Foo>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_constant
      node_context = index_and_locate(<<~RUBY, { line: 4, character: 4 })
        class Foo
          def bar; end
        end

        Foo.bar
      RUBY

      assert_equal("Foo::<Class:Foo>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_constant_path
      node_context = index_and_locate(<<~RUBY, { line: 6, character: 9 })
        module Foo
          class Bar
            def baz; end
          end
        end

        Foo::Bar.baz
      RUBY

      assert_equal("Foo::Bar::<Class:Bar>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_top_level_receiver
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 0 })
        foo
      RUBY

      assert_equal("Object", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_instance_variables_in_class_body
      node_context = index_and_locate(<<~RUBY, { line: 1, character: 2 })
        class Foo
          @hello1
        end
      RUBY

      assert_equal("Foo::<Class:Foo>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_instance_variables_in_singleton_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          def self.bar
            @hello1
          end
        end
      RUBY

      assert_equal("Foo::<Class:Foo>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_instance_variables_in_singleton_block_body
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          class << self
            @hello1
          end
        end
      RUBY

      assert_equal("Foo::<Class:Foo>::<Class:<Class:Foo>>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_in_namespaced_singleton_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo::Bar
          def self.foo
            bar
          end
        end
      RUBY

      result = @type_inferrer.infer_receiver_type(node_context).name
      assert_equal("Foo::Bar::<Class:Bar>", result)
    end

    def test_infer_receiver_type_instance_variables_in_singleton_block_method
      node_context = index_and_locate(<<~RUBY, { line: 3, character: 6 })
        class Foo
          class << self
            def bar
              @hello1
            end
          end
        end
      RUBY

      assert_equal("Foo::<Class:Foo>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_instance_variables_in_instance_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          def bar
            @hello1
          end
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_top_level_instance_variables
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 0 })
        @foo
      RUBY

      assert_equal("Object", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_guessed_types_for_local_variable_receiver
      node_context = index_and_locate(<<~RUBY, { line: 4, character: 5 })
        class User
        end

        user = something
        user.name
      RUBY

      assert_equal("User", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_guessed_types_for_chained_method_calls
      node_context = index_and_locate(<<~RUBY, { line: 3, character: 15 })
        class User
        end

        something.user.name
      RUBY

      assert_equal("User", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_guessed_types_for_instance_variable_receiver
      node_context = index_and_locate(<<~RUBY, { line: 4, character: 6 })
        class User
        end

        @user = something
        @user.name
      RUBY

      assert_equal("User", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_guessed_types_for_method_call_receiver
      node_context = index_and_locate(<<~RUBY, { line: 3, character: 5 })
        class User
        end

        user.name
      RUBY

      assert_equal("User", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_guessed_types_inside_nesting
      node_context = index_and_locate(<<~RUBY, { line: 9, character: 9 })
        module Blog
          class User
          end
        end

        module Admin
          class User
          end

          user.name
        end
      RUBY

      assert_equal("Admin::User", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_forwarding_super_receiver
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo < Bar
          def initialize
            super
          end
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_super_receiver
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo < Bar
          def initialize(a, b, c)
            super()
          end
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_string_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 3 })
        "".upcase
      RUBY

      assert_equal("String", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_symbol_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 5 })
        :foo.to_s
      RUBY

      assert_equal("Symbol", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_array_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 3 })
        [].first
      RUBY

      assert_equal("Array", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_hash_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 3 })
        {}.keys
      RUBY

      assert_equal("Hash", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_integer_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 3 })
        10.to_s
      RUBY

      assert_equal("Integer", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_float_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 4 })
        1.5.to_s
      RUBY

      assert_equal("Float", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_regexp_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 5 })
        /abc/.match("abc")
      RUBY

      assert_equal("Regexp", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_nil_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 4 })
        nil.to_s
      RUBY

      assert_equal("NilClass", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_true_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 5 })
        true.to_s
      RUBY

      assert_equal("TrueClass", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_false_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 6 })
        false.to_s
      RUBY

      assert_equal("FalseClass", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_range_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 8 })
        (5..10).to_a
      RUBY

      assert_equal("Range", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_lambda_literal
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 5 })
        ->{}.call
      RUBY

      assert_equal("Proc", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_self_type_for_compact_namespace
      node_context = index_and_locate(<<~RUBY, { line: 1, character: 3 })
        class Admin::User
          validates
        end
      RUBY

      assert_equal("Admin::User::<Class:User>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_self_type_for_compact_namespace_inside_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Admin::User
          def foo
            hello
          end
        end
      RUBY

      assert_equal("Admin::User", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_self_type_for_compact_namespace_inside_singleton_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Admin::User
          def self.foo
            hello
          end
        end
      RUBY

      assert_equal("Admin::User::<Class:User>", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_class_variables_in_class_body
      node_context = index_and_locate(<<~RUBY, { line: 1, character: 2 })
        class Foo
          @@hello1
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_class_variables_in_singleton_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          def self.bar
            @@hello1
          end
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_class_variables_in_singleton_block_body
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          class << self
            @@hello1
          end
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_class_variables_in_singleton_block_method
      node_context = index_and_locate(<<~RUBY, { line: 3, character: 6 })
        class Foo
          class << self
            def bar
              @@hello1
            end
          end
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_receiver_type_class_variables_in_instance_method
      node_context = index_and_locate(<<~RUBY, { line: 2, character: 4 })
        class Foo
          def bar
            @@hello1
          end
        end
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_top_level_class_variables
      node_context = index_and_locate(<<~RUBY, { line: 0, character: 0 })
        @@foo
      RUBY

      assert_equal("Object", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_object_instantiation_receiver
      node_context = index_and_locate(<<~RUBY, { line: 1, character: 8 })
        class Foo; end
        Foo.new.bar
      RUBY

      assert_equal("Foo", @type_inferrer.infer_receiver_type(node_context).name)
    end

    def test_infer_object_instantiation_receiver_is_ignored_if_new_is_overridden
      node_context = index_and_locate(<<~RUBY, { line: 8, character: 8 })
        module Bar
          def new; end
        end

        class Foo
          extend Bar
        end

        Foo.new.bar
      RUBY

      assert_nil(@type_inferrer.infer_receiver_type(node_context))
    end

    private

    def index_and_locate(source, position)
      @index.index_single(URI::Generic.from_path(path: "/fake/path/foo.rb"), source)
      document = RubyLsp::RubyDocument.new(
        source: source,
        version: 1,
        uri: URI::Generic.build(scheme: "file", path: "/fake/path/foo.rb"),
        global_state: RubyLsp::GlobalState.new,
      )
      document.locate_node(position)
    end
  end
end