Class: RubyIndexer::MethodTest

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

Instance Method Summary collapse

Methods inherited from TestCase

#setup, #teardown

Instance Method Details

#test_changing_visibility_post_definition ⇒ Object 



927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
 
# File 'lib/ruby_indexer/test/method_test.rb', line 927

def test_changing_visibility_post_definition
  index("    class Foo\n      def bar; end\n      private :bar\n\n      def baz; end\n      protected :baz\n\n      private\n      def qux; end\n\n      public :qux\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  assert_predicate(entry, :private?)\n\n  entry = @index[\"baz\"]&.first #: as Entry::Method\n  assert_predicate(entry, :protected?)\n\n  entry = @index[\"qux\"]&.first #: as Entry::Method\n  assert_predicate(entry, :public?)\nend\n")

#test_comments_documentation ⇒ Object 



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
 
# File 'lib/ruby_indexer/test/method_test.rb', line 234

def test_comments_documentation
  index("    # Documentation for Foo\n\n    class Foo\n      # ####################\n      # Documentation for bar\n      # ####################\n      #\n      def bar\n      end\n\n      # test\n\n      # Documentation for baz\n      def baz; end\n      def ban; end\n    end\n  RUBY\n\n  foo = @index[\"Foo\"]&.first #: as !nil\n  assert_equal(\"Documentation for Foo\", foo.comments)\n\n  bar = @index[\"bar\"]&.first #: as !nil\n  assert_equal(\"####################\\nDocumentation for bar\\n####################\\n\", bar.comments)\n\n  baz = @index[\"baz\"]&.first #: as !nil\n  assert_equal(\"Documentation for baz\", baz.comments)\n\n  ban = @index[\"ban\"]&.first #: as !nil\n  assert_empty(ban.comments)\nend\n")

#test_conditional_method ⇒ Object 



19
20
21
22
23
24
25
26
27
28
 
# File 'lib/ruby_indexer/test/method_test.rb', line 19

def test_conditional_method
  index("    class Foo\n      def bar\n      end if condition\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\nend\n")

#test_handling_attr ⇒ Object 



953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
 
# File 'lib/ruby_indexer/test/method_test.rb', line 953

def test_handling_attr
  index("    class Foo\n      attr :bar\n      attr :baz, true\n      attr :qux, false\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Accessor, \"/fake/path/foo.rb:1-8:1-11\")\n  assert_no_entry(\"bar=\")\n  assert_entry(\"baz\", Entry::Accessor, \"/fake/path/foo.rb:2-8:2-11\")\n  assert_entry(\"baz=\", Entry::Accessor, \"/fake/path/foo.rb:2-8:2-11\")\n  assert_entry(\"qux\", Entry::Accessor, \"/fake/path/foo.rb:3-8:3-11\")\n  assert_no_entry(\"qux=\")\nend\n")

#test_ignores_attributes_invoked_on_constant ⇒ Object 



544
545
546
547
548
549
550
551
552
553
 
# File 'lib/ruby_indexer/test/method_test.rb', line 544

def test_ignores_attributes_invoked_on_constant
  index("    class Foo\n    end\n\n    Foo.attr_reader :bar\n  RUBY\n\n  assert_no_entry(\"bar\")\nend\n")

#test_keeps_track_of_aliases ⇒ Object 



578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
 
# File 'lib/ruby_indexer/test/method_test.rb', line 578

def test_keeps_track_of_aliases
  index("    class Foo\n      alias whatever to_s\n      alias_method :foo, :to_a\n      alias_method \"bar\", \"to_a\"\n\n      # These two are not indexed because they are dynamic or incomplete\n      alias_method baz, :to_a\n      alias_method :baz\n    end\n  RUBY\n\n  assert_entry(\"whatever\", Entry::UnresolvedMethodAlias, \"/fake/path/foo.rb:1-8:1-16\")\n  assert_entry(\"foo\", Entry::UnresolvedMethodAlias, \"/fake/path/foo.rb:2-15:2-19\")\n  assert_entry(\"bar\", Entry::UnresolvedMethodAlias, \"/fake/path/foo.rb:3-15:3-20\")\n  # Foo plus 3 valid aliases\n  assert_equal(4, @index.length - @default_indexed_entries.length)\nend\n")

#test_keeps_track_of_attributes ⇒ Object 



525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
 
# File 'lib/ruby_indexer/test/method_test.rb', line 525

def test_keeps_track_of_attributes
  index("    class Foo\n      # Hello there\n      attr_reader :bar, :other\n      attr_writer :baz\n      attr_accessor :qux\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Accessor, \"/fake/path/foo.rb:2-15:2-18\")\n  assert_equal(\"Hello there\", @index[\"bar\"]&.first&.comments)\n  assert_entry(\"other\", Entry::Accessor, \"/fake/path/foo.rb:2-21:2-26\")\n  assert_equal(\"Hello there\", @index[\"other\"]&.first&.comments)\n  assert_entry(\"baz=\", Entry::Accessor, \"/fake/path/foo.rb:3-15:3-18\")\n  assert_entry(\"qux\", Entry::Accessor, \"/fake/path/foo.rb:4-17:4-20\")\n  assert_entry(\"qux=\", Entry::Accessor, \"/fake/path/foo.rb:4-17:4-20\")\nend\n")

#test_keeps_track_of_method_owner ⇒ Object 



511
512
513
514
515
516
517
518
519
520
521
522
523
 
# File 'lib/ruby_indexer/test/method_test.rb', line 511

def test_keeps_track_of_method_owner
  index("    class Foo\n      def bar\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  owner_name = entry.owner&.name\n\n  assert_equal(\"Foo\", owner_name)\nend\n")

#test_making_several_class_methods_private ⇒ Object 



912
913
914
915
916
917
918
919
920
921
922
923
924
925
 
# File 'lib/ruby_indexer/test/method_test.rb', line 912

def test_making_several_class_methods_private
  index("    class Foo\n      def self.bar; end\n      def self.baz; end\n      def self.qux; end\n\n      private_class_method :bar, :baz, :qux\n\n      def initialize\n      end\n    end\n  RUBY\nend\n")

#test_method_under_dynamic_class_or_module ⇒ Object 



67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/ruby_indexer/test/method_test.rb', line 67

def test_method_under_dynamic_class_or_module
  index("    module Foo\n      class self::Bar\n        def bar\n        end\n      end\n    end\n\n    module Bar\n      def bar\n      end\n    end\n  RUBY\n\n  assert_equal(2, @index[\"bar\"]&.length)\n  first_entry = @index[\"bar\"]&.first #: as Entry::Method\n  assert_equal(\"Foo::self::Bar\", first_entry.owner&.name)\n  second_entry = @index[\"bar\"]&.last #: as Entry::Method\n  assert_equal(\"Bar\", second_entry.owner&.name)\nend\n")

#test_method_with_anonymous_rest_parameters ⇒ Object 



449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
 
# File 'lib/ruby_indexer/test/method_test.rb', line 449

def test_method_with_anonymous_rest_parameters
  index("    class Foo\n      def bar(*, **)\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(2, parameters.length)\n  first, second = parameters\n\n  assert_equal(Entry::RestParameter::DEFAULT_NAME, first&.name)\n  assert_instance_of(Entry::RestParameter, first)\n\n  assert_equal(Entry::KeywordRestParameter::DEFAULT_NAME, second&.name)\n  assert_instance_of(Entry::KeywordRestParameter, second)\nend\n")

#test_method_with_block_parameters ⇒ Object 



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
 
# File 'lib/ruby_indexer/test/method_test.rb', line 423

def test_method_with_block_parameters
  index("    class Foo\n      def bar(&block)\n      end\n\n      def baz(&)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  param = parameters.first #: as Entry::Parameter\n  assert_equal(:block, param.name)\n  assert_instance_of(Entry::BlockParameter, param)\n\n  entry = @index[\"baz\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(1, parameters.length)\n\n  param = parameters.first #: as Entry::Parameter\n  assert_equal(Entry::BlockParameter::DEFAULT_NAME, param.name)\n  assert_instance_of(Entry::BlockParameter, param)\nend\n")

#test_method_with_destructed_parameters ⇒ Object 



284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
 
# File 'lib/ruby_indexer/test/method_test.rb', line 284

def test_method_with_destructed_parameters
  index("    class Foo\n      def bar((a, (b, )))\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(1, parameters.length)\n  parameter = parameters.first\n  assert_equal(:\"(a, (b, ))\", parameter&.name)\n  assert_instance_of(Entry::RequiredParameter, parameter)\nend\n")

#test_method_with_destructured_rest_parameters ⇒ Object 



405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
 
# File 'lib/ruby_indexer/test/method_test.rb', line 405

def test_method_with_destructured_rest_parameters
  index("    class Foo\n      def bar((a, *b))\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(1, parameters.length)\n  param = parameters.first #: as Entry::Parameter\n\n  assert_equal(:\"(a, *b)\", param.name)\n  assert_instance_of(Entry::RequiredParameter, param)\nend\n")

#test_method_with_forbidden_keyword_splat_parameter ⇒ Object 



470
471
472
473
474
475
476
477
478
479
480
481
482
 
# File 'lib/ruby_indexer/test/method_test.rb', line 470

def test_method_with_forbidden_keyword_splat_parameter
  index("    class Foo\n      def bar(**nil)\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_empty(parameters)\nend\n")

#test_method_with_keyword_parameters ⇒ Object 



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

def test_method_with_keyword_parameters
  index("    class Foo\n      def bar(a:, b: 123)\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(2, parameters.length)\n  a, b = parameters\n\n  assert_equal(:a, a&.name)\n  assert_instance_of(Entry::KeywordParameter, a)\n\n  assert_equal(:b, b&.name)\n  assert_instance_of(Entry::OptionalKeywordParameter, b)\nend\n")

#test_method_with_multibyte_characters ⇒ Object 



30
31
32
33
34
35
36
37
38
 
# File 'lib/ruby_indexer/test/method_test.rb', line 30

def test_method_with_multibyte_characters
  index("    class Foo\n      def \u3053\u3093\u306B\u3061\u306F; end\n    end\n  RUBY\n\n  assert_entry(\"\u3053\u3093\u306B\u3061\u306F\", Entry::Method, \"/fake/path/foo.rb:1-2:1-16\")\nend\n")

#test_method_with_no_parameters ⇒ Object 



8
9
10
11
12
13
14
15
16
17
 
# File 'lib/ruby_indexer/test/method_test.rb', line 8

def test_method_with_no_parameters
  index("    class Foo\n      def bar\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\nend\n")

#test_method_with_optional_parameters ⇒ Object 



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

def test_method_with_optional_parameters
  index("    class Foo\n      def bar(a = 123)\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(1, parameters.length)\n  parameter = parameters.first\n  assert_equal(:a, parameter&.name)\n  assert_instance_of(Entry::OptionalParameter, parameter)\nend\n")

#test_method_with_parameters ⇒ Object 



267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
 
# File 'lib/ruby_indexer/test/method_test.rb', line 267

def test_method_with_parameters
  index("    class Foo\n      def bar(a)\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(1, parameters.length)\n  parameter = parameters.first\n  assert_equal(:a, parameter&.name)\n  assert_instance_of(Entry::RequiredParameter, parameter)\nend\n")

#test_method_with_post_parameters ⇒ Object 



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
 
# File 'lib/ruby_indexer/test/method_test.rb', line 360

def test_method_with_post_parameters
  index("    class Foo\n      def bar(*a, b)\n      end\n\n      def baz(**a, b)\n      end\n\n      def qux(*a, (b, c))\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(2, parameters.length)\n  a, b = parameters\n\n  assert_equal(:a, a&.name)\n  assert_instance_of(Entry::RestParameter, a)\n\n  assert_equal(:b, b&.name)\n  assert_instance_of(Entry::RequiredParameter, b)\n\n  entry = @index[\"baz\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(2, parameters.length)\n  a, b = parameters\n\n  assert_equal(:a, a&.name)\n  assert_instance_of(Entry::KeywordRestParameter, a)\n\n  assert_equal(:b, b&.name)\n  assert_instance_of(Entry::RequiredParameter, b)\n\n  entry = @index[\"qux\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(2, parameters.length)\n  _a, second = parameters\n\n  assert_equal(:\"(b, c)\", second&.name)\n  assert_instance_of(Entry::RequiredParameter, second)\nend\n")

#test_method_with_rest_and_keyword_rest_parameters ⇒ Object 



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

def test_method_with_rest_and_keyword_rest_parameters
  index("    class Foo\n      def bar(*a, **b)\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(2, parameters.length)\n  a, b = parameters\n\n  assert_equal(:a, a&.name)\n  assert_instance_of(Entry::RestParameter, a)\n\n  assert_equal(:b, b&.name)\n  assert_instance_of(Entry::KeywordRestParameter, b)\nend\n")

#test_methods_with_argument_forwarding ⇒ Object 



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
 
# File 'lib/ruby_indexer/test/method_test.rb', line 484

def test_methods_with_argument_forwarding
  index("    class Foo\n      def bar(...)\n      end\n\n      def baz(a, ...)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  assert_instance_of(Entry::Method, entry, \"Expected `bar` to be indexed\")\n\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(1, parameters.length)\n  assert_instance_of(Entry::ForwardingParameter, parameters.first)\n\n  entry = @index[\"baz\"]&.first #: as Entry::Method\n  assert_instance_of(Entry::Method, entry, \"Expected `baz` to be indexed\")\n\n  parameters = entry.signatures.first&.parameters #: as Array[Entry::Parameter]\n  assert_equal(2, parameters.length)\n  assert_instance_of(Entry::RequiredParameter, parameters[0])\n  assert_instance_of(Entry::ForwardingParameter, parameters[1])\nend\n")

#test_module_function_does_nothing_in_classes ⇒ Object 



891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
 
# File 'lib/ruby_indexer/test/method_test.rb', line 891

def test_module_function_does_nothing_in_classes
  # Invoking `module_function` in a class raises an error. We simply ignore it
  index("    class Foo\n      def bar; end\n\n      module_function\n\n      def baz; end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  assert_predicate(entry, :public?)\n  assert_equal(\"Foo\", entry.owner&.name)\n\n  entry = @index[\"baz\"]&.first #: as Entry::Method\n  assert_predicate(entry, :public?)\n  assert_equal(\"Foo\", entry.owner&.name)\nend\n")

#test_module_function_with_no_arguments ⇒ Object 



851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'lib/ruby_indexer/test/method_test.rb', line 851

def test_module_function_with_no_arguments
  index("    module Foo\n      def bar; end\n\n      module_function\n\n      def baz; end\n      attr_reader :attribute\n\n      public\n\n      def qux; end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  assert_predicate(entry, :public?)\n  assert_equal(\"Foo\", entry.owner&.name)\n\n  instance_baz, singleton_baz = @index[\"baz\"] #: as Array[Entry::Method]\n  assert_predicate(instance_baz, :private?)\n  assert_equal(\"Foo\", instance_baz&.owner&.name)\n\n  assert_predicate(singleton_baz, :public?)\n  assert_equal(\"Foo::<Class:Foo>\", singleton_baz&.owner&.name)\n\n  # After invoking `public`, the state of `module_function` is reset\n  instance_qux, singleton_qux = @index[\"qux\"] #: as Array[Entry::Method]\n  assert_nil(singleton_qux)\n  assert_predicate(instance_qux, :public?)\n  assert_equal(\"Foo\", instance_baz&.owner&.name)\n\n  # Attributes are not turned into class methods, they do become private\n  instance_attribute, singleton_attribute = @index[\"attribute\"] #: as Array[Entry::Method]\n  assert_nil(singleton_attribute)\n  assert_equal(\"Foo\", instance_attribute&.owner&.name)\n  assert_predicate(instance_attribute, :private?)\nend\n")

#test_name_location_points_to_method_identifier_location ⇒ Object 



623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
 
# File 'lib/ruby_indexer/test/method_test.rb', line 623

def test_name_location_points_to_method_identifier_location
  index("    class Foo\n      def bar\n        a = 123\n        a + 456\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  refute_equal(entry.location, entry.name_location)\n\n  name_location = entry.name_location\n  assert_equal(2, name_location.start_line)\n  assert_equal(2, name_location.end_line)\n  assert_equal(6, name_location.start_column)\n  assert_equal(9, name_location.end_column)\nend\n")

#test_partial_signature_matches ⇒ Object 



831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
 
# File 'lib/ruby_indexer/test/method_test.rb', line 831

def test_partial_signature_matches
  # It's important to match signatures partially, because we want to figure out which signature we should show while
  # the user is in the middle of typing
  index("    class Foo\n      def bar(a:, b:)\n      end\n\n      def baz(a, b)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  assert_signature_matches(entry, \"bar(a: 1)\")\n\n  entry = @index[\"baz\"]&.first #: as Entry::Method\n  assert_signature_matches(entry, \"baz(1)\")\nend\n")

#test_private_class_method_visibility_tracking_array_argument ⇒ Object 



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
 
# File 'lib/ruby_indexer/test/method_test.rb', line 183

def test_private_class_method_visibility_tracking_array_argument
  index("    class Test\n      def self.foo\n      end\n\n      def self.bar\n      end\n\n      private_class_method([\"foo\", :bar])\n\n      def self.baz\n      end\n    end\n  RUBY\n\n  [\"foo\", \"bar\"].each do |keyword|\n    entries = @index[keyword] #: as Array[Entry::Method]\n    assert_equal(1, entries.size)\n    entry = entries.first\n    assert_predicate(entry, :private?)\n  end\n\n  entries = @index[\"baz\"] #: as Array[Entry::Method]\n  assert_equal(1, entries.size)\n  entry = entries.first\n  assert_predicate(entry, :public?)\nend\n")

#test_private_class_method_visibility_tracking_method_argument ⇒ Object 



212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
 
# File 'lib/ruby_indexer/test/method_test.rb', line 212

def test_private_class_method_visibility_tracking_method_argument
  index("    class Test\n      private_class_method def self.foo\n      end\n\n      def self.bar\n      end\n    end\n  RUBY\n\n  entries = @index[\"foo\"] #: as Array[Entry::Method]\n  assert_equal(1, entries.size)\n  entry = entries.first\n  assert_predicate(entry, :private?)\n\n  entries = @index[\"bar\"] #: as Array[Entry::Method]\n  assert_equal(1, entries.size)\n  entry = entries.first\n  assert_predicate(entry, :public?)\nend\n")

#test_private_class_method_visibility_tracking_string_symbol_arguments ⇒ Object 



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
 
# File 'lib/ruby_indexer/test/method_test.rb', line 154

def test_private_class_method_visibility_tracking_string_symbol_arguments
  index("    class Test\n      def self.foo\n      end\n\n      def self.bar\n      end\n\n      private_class_method(\"foo\", :bar)\n\n      def self.baz\n      end\n    end\n  RUBY\n\n  [\"foo\", \"bar\"].each do |keyword|\n    entries = @index[keyword] #: as Array[Entry::Method]\n    assert_equal(1, entries.size)\n    entry = entries.first\n    assert_predicate(entry, :private?)\n  end\n\n  entries = @index[\"baz\"] #: as Array[Entry::Method]\n  assert_equal(1, entries.size)\n  entry = entries.first\n  assert_predicate(entry, :public?)\nend\n")

#test_properly_tracks_multiple_levels_of_nesting ⇒ Object 



555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
 
# File 'lib/ruby_indexer/test/method_test.rb', line 555

def test_properly_tracks_multiple_levels_of_nesting
  index("    module Foo\n      def first_method; end\n\n      module Bar\n        def second_method; end\n      end\n\n      def third_method; end\n    end\n  RUBY\n\n  entry = @index[\"first_method\"]&.first #: as Entry::Method\n  assert_equal(\"Foo\", entry.owner&.name)\n\n  entry = @index[\"second_method\"]&.first #: as Entry::Method\n  assert_equal(\"Foo::Bar\", entry.owner&.name)\n\n  entry = @index[\"third_method\"]&.first #: as Entry::Method\n  assert_equal(\"Foo\", entry.owner&.name)\nend\n")

#test_signature_matches_for_a_method_with_argument_forwarding ⇒ Object 



677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
 
# File 'lib/ruby_indexer/test/method_test.rb', line 677

def test_signature_matches_for_a_method_with_argument_forwarding
  index("    class Foo\n      def bar(...)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n\n  # All calls match a forwarding parameter\n  assert_signature_matches(entry, \"bar(1)\")\n  assert_signature_matches(entry, \"bar(1, 2)\")\n  assert_signature_matches(entry, \"bar(...)\")\n  assert_signature_matches(entry, \"bar(1, ...)\")\n  assert_signature_matches(entry, \"bar(*a)\")\n  assert_signature_matches(entry, \"bar(1, *a)\")\n  assert_signature_matches(entry, \"bar(1, *a, 2)\")\n  assert_signature_matches(entry, \"bar(*a, 2)\")\n  assert_signature_matches(entry, \"bar(1, **a)\")\n  assert_signature_matches(entry, \"bar(1) {}\")\n  assert_signature_matches(entry, \"bar()\")\n  assert_signature_matches(entry, \"bar(1, 2, 3)\")\n  assert_signature_matches(entry, \"bar(1, 2, a: 1, b: 5) {}\")\nend\n")

#test_signature_matches_for_a_method_with_positional_params ⇒ Object 



643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
 
# File 'lib/ruby_indexer/test/method_test.rb', line 643

def test_signature_matches_for_a_method_with_positional_params
  index("    class Foo\n      def bar(a, b = 123)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n\n  # Matching calls\n  assert_signature_matches(entry, \"bar()\")\n  assert_signature_matches(entry, \"bar(1)\")\n  assert_signature_matches(entry, \"bar(1, 2)\")\n  assert_signature_matches(entry, \"bar(...)\")\n  assert_signature_matches(entry, \"bar(1, ...)\")\n  assert_signature_matches(entry, \"bar(*a)\")\n  assert_signature_matches(entry, \"bar(1, *a)\")\n  assert_signature_matches(entry, \"bar(1, *a, 2)\")\n  assert_signature_matches(entry, \"bar(*a, 2)\")\n  assert_signature_matches(entry, \"bar(1, **a)\")\n  assert_signature_matches(entry, \"bar(1) {}\")\n  # This call is impossible to analyze statically because it depends on whether there are elements inside `a` or\n  # not. If there's nothing, the call will fail. But if there's anything inside, the hash will become the first\n  # positional argument\n  assert_signature_matches(entry, \"bar(**a)\")\n\n  # Non matching calls\n\n  refute_signature_matches(entry, \"bar(1, 2, 3)\")\n  refute_signature_matches(entry, \"bar(1, b: 2)\")\n  refute_signature_matches(entry, \"bar(1, 2, c: 3)\")\nend\n")

#test_signature_matches_for_destructured_parameters ⇒ Object 



729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
 
# File 'lib/ruby_indexer/test/method_test.rb', line 729

def test_signature_matches_for_destructured_parameters
  index("    class Foo\n      def bar(a, (b, c))\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n\n  # All calls with at least one positional argument match\n  assert_signature_matches(entry, \"bar()\")\n  assert_signature_matches(entry, \"bar(1)\")\n  assert_signature_matches(entry, \"bar(1, 2)\")\n  assert_signature_matches(entry, \"bar(...)\")\n  assert_signature_matches(entry, \"bar(1, ...)\")\n  assert_signature_matches(entry, \"bar(*a)\")\n  assert_signature_matches(entry, \"bar(1, *a)\")\n  assert_signature_matches(entry, \"bar(*a, 2)\")\n  # This matches because `bar(1, *[], 2)` would result in `bar(1, 2)`, which is a valid call\n  assert_signature_matches(entry, \"bar(1, *a, 2)\")\n  assert_signature_matches(entry, \"bar(1, **a)\")\n  assert_signature_matches(entry, \"bar(1) {}\")\n\n  refute_signature_matches(entry, \"bar(1, 2, 3)\")\n  refute_signature_matches(entry, \"bar(1, 2, a: 1, b: 5) {}\")\nend\n")

#test_signature_matches_for_keyword_parameters ⇒ Object 



784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
 
# File 'lib/ruby_indexer/test/method_test.rb', line 784

def test_signature_matches_for_keyword_parameters
  index("    class Foo\n      def bar(a:, b: 123)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n\n  assert_signature_matches(entry, \"bar(...)\")\n  assert_signature_matches(entry, \"bar()\")\n  assert_signature_matches(entry, \"bar(a: 1)\")\n  assert_signature_matches(entry, \"bar(a: 1, b: 32)\")\n\n  refute_signature_matches(entry, \"bar(a: 1, c: 2)\")\n  refute_signature_matches(entry, \"bar(1, ...)\")\n  refute_signature_matches(entry, \"bar(1) {}\")\n  refute_signature_matches(entry, \"bar(1, *a)\")\n  refute_signature_matches(entry, \"bar(*a, 2)\")\n  refute_signature_matches(entry, \"bar(1, *a, 2)\")\n  refute_signature_matches(entry, \"bar(1, **a)\")\n  refute_signature_matches(entry, \"bar(*a)\")\n  refute_signature_matches(entry, \"bar(1)\")\n  refute_signature_matches(entry, \"bar(1, 2)\")\n  refute_signature_matches(entry, \"bar(1, 2, a: 1, b: 5) {}\")\nend\n")

#test_signature_matches_for_keyword_splats ⇒ Object 



812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
 
# File 'lib/ruby_indexer/test/method_test.rb', line 812

def test_signature_matches_for_keyword_splats
  index("    class Foo\n      def bar(a, b:, **kwargs)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n\n  assert_signature_matches(entry, \"bar(...)\")\n  assert_signature_matches(entry, \"bar()\")\n  assert_signature_matches(entry, \"bar(1)\")\n  assert_signature_matches(entry, \"bar(1, b: 2)\")\n  assert_signature_matches(entry, \"bar(1, b: 2, c: 3, d: 4)\")\n\n  refute_signature_matches(entry, \"bar(1, 2, b: 2)\")\nend\n")

#test_signature_matches_for_post_forwarding_parameter ⇒ Object 



703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
 
# File 'lib/ruby_indexer/test/method_test.rb', line 703

def test_signature_matches_for_post_forwarding_parameter
  index("    class Foo\n      def bar(a, ...)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n\n  # All calls with at least one positional argument match\n  assert_signature_matches(entry, \"bar(1)\")\n  assert_signature_matches(entry, \"bar(1, 2)\")\n  assert_signature_matches(entry, \"bar(...)\")\n  assert_signature_matches(entry, \"bar(1, ...)\")\n  assert_signature_matches(entry, \"bar(*a)\")\n  assert_signature_matches(entry, \"bar(1, *a)\")\n  assert_signature_matches(entry, \"bar(1, *a, 2)\")\n  assert_signature_matches(entry, \"bar(*a, 2)\")\n  assert_signature_matches(entry, \"bar(1, **a)\")\n  assert_signature_matches(entry, \"bar(1) {}\")\n  assert_signature_matches(entry, \"bar(1, 2, 3)\")\n  assert_signature_matches(entry, \"bar(1, 2, a: 1, b: 5) {}\")\n  assert_signature_matches(entry, \"bar()\")\nend\n")

#test_signature_matches_for_post_parameters ⇒ Object 



757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
 
# File 'lib/ruby_indexer/test/method_test.rb', line 757

def test_signature_matches_for_post_parameters
  index("    class Foo\n      def bar(*splat, a)\n      end\n    end\n  RUBY\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n\n  # All calls with at least one positional argument match\n  assert_signature_matches(entry, \"bar(1)\")\n  assert_signature_matches(entry, \"bar(1, 2)\")\n  assert_signature_matches(entry, \"bar(...)\")\n  assert_signature_matches(entry, \"bar(1, ...)\")\n  assert_signature_matches(entry, \"bar(*a)\")\n  assert_signature_matches(entry, \"bar(1, *a)\")\n  assert_signature_matches(entry, \"bar(*a, 2)\")\n  assert_signature_matches(entry, \"bar(1, *a, 2)\")\n  assert_signature_matches(entry, \"bar(1, **a)\")\n  assert_signature_matches(entry, \"bar(1, 2, 3)\")\n  assert_signature_matches(entry, \"bar(1) {}\")\n  assert_signature_matches(entry, \"bar()\")\n\n  refute_signature_matches(entry, \"bar(1, 2, a: 1, b: 5) {}\")\nend\n")

#test_singleton_method_using_other_receiver_is_not_indexed ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'lib/ruby_indexer/test/method_test.rb', line 56

def test_singleton_method_using_other_receiver_is_not_indexed
  index("    class Foo\n      def String.bar\n      end\n    end\n  RUBY\n\n  assert_no_entry(\"bar\")\nend\n")

#test_singleton_method_using_self_receiver ⇒ Object 



40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
 
# File 'lib/ruby_indexer/test/method_test.rb', line 40

def test_singleton_method_using_self_receiver
  index("    class Foo\n      def self.bar\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:2-5\")\n\n  entry = @index[\"bar\"]&.first #: as Entry::Method\n  owner = entry.owner\n  assert_equal(\"Foo::<Class:Foo>\", owner&.name)\n  assert_instance_of(Entry::SingletonClass, owner)\nend\n")

#test_singleton_methods ⇒ Object 



598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
 
# File 'lib/ruby_indexer/test/method_test.rb', line 598

def test_singleton_methods
  index("    class Foo\n      def self.bar; end\n\n      class << self\n        def baz; end\n      end\n    end\n  RUBY\n\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:1-2:1-19\")\n  assert_entry(\"baz\", Entry::Method, \"/fake/path/foo.rb:4-4:4-16\")\n\n  bar = @index[\"bar\"]&.first #: as Entry::Method\n  baz = @index[\"baz\"]&.first #: as Entry::Method\n\n  assert_instance_of(Entry::SingletonClass, bar.owner)\n  assert_instance_of(Entry::SingletonClass, baz.owner)\n\n  # Regardless of whether the method was added through `self.something` or `class << self`, the owner object must be\n  # the exact same\n  assert_same(bar.owner, baz.owner)\nend\n")

#test_visibility_tracking ⇒ Object 



89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
 
# File 'lib/ruby_indexer/test/method_test.rb', line 89

def test_visibility_tracking
  index("    class Foo\n      private def foo\n      end\n\n      def bar; end\n\n      protected\n\n      def baz; end\n    end\n  RUBY\n\n  assert_entry(\"foo\", Entry::Method, \"/fake/path/foo.rb:1-10:2-5\", visibility: :private)\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:4-2:4-14\", visibility: :public)\n  assert_entry(\"baz\", Entry::Method, \"/fake/path/foo.rb:8-2:8-14\", visibility: :protected)\nend\n")

#test_visibility_tracking_with_module_function ⇒ Object 



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
 
# File 'lib/ruby_indexer/test/method_test.rb', line 128

def test_visibility_tracking_with_module_function
  index("    module Test\n      def foo; end\n      def bar; end\n      module_function :foo, \"bar\"\n    end\n  RUBY\n\n  [\"foo\", \"bar\"].each do |keyword|\n    entries = @index[keyword] #: as Array[Entry::Method]\n    # should receive two entries because module_function creates a singleton method\n    # for the Test module and a private method for classes include the Test module\n    assert_equal(entries.size, 2)\n    first_entry, second_entry = *entries\n    # The first entry points to the location of the module_function call\n    assert_equal(\"Test\", first_entry&.owner&.name)\n    assert_instance_of(Entry::Module, first_entry&.owner)\n    assert_predicate(first_entry, :private?)\n    # The second entry points to the public singleton method\n    assert_equal(\"Test::<Class:Test>\", second_entry&.owner&.name)\n    assert_instance_of(Entry::SingletonClass, second_entry&.owner)\n    assert_equal(:public, second_entry&.visibility)\n  end\nend\n")

#test_visibility_tracking_with_nested_class_or_modules ⇒ Object 



108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
 
# File 'lib/ruby_indexer/test/method_test.rb', line 108

def test_visibility_tracking_with_nested_class_or_modules
  index("    class Foo\n      private\n\n      def foo; end\n\n      class Bar\n        def bar; end\n      end\n\n      def baz; end\n    end\n  RUBY\n\n  assert_entry(\"foo\", Entry::Method, \"/fake/path/foo.rb:3-2:3-14\", visibility: :private)\n  assert_entry(\"bar\", Entry::Method, \"/fake/path/foo.rb:6-4:6-16\", visibility: :public)\n  assert_entry(\"baz\", Entry::Method, \"/fake/path/foo.rb:9-2:9-14\", visibility: :private)\nend\n")