ruby-lsp 0.17.3 → 0.17.4

data/lib/ruby_indexer/test/index_test.rb

@@ -93,30 +93,30 @@ module RubyIndexer
 
     def test_fuzzy_search
       @index.index_single(IndexablePath.new(nil, "/fake/path/foo.rb"), <<~RUBY)
-        class Bar; end
+        class Zws; end
 
-        module Foo
-          class Bar
+        module Qtl
+          class Zws
           end
 
-          class Baz
+          class Zwo
             class Something
             end
           end
         end
       RUBY
 
-      result = @index.fuzzy_search("Bar")
-      assert_equal(3, result.length)
-      assert_equal(["Bar", "Backtrace", "Base"], result.map(&:name))
-
-      result = @index.fuzzy_search("foobarsomeking")
-      assert_equal(6, result.length)
-      assert_equal(["Foo::Baz::Something", "Foo::Bar", "Foo::Baz", "Foo", "Base", "Bar"], result.map(&:name))
+      result = @index.fuzzy_search("Zws")
+      assert_equal(2, result.length)
+      assert_equal(["Zws", "Qtl::Zwo::Something"], result.map(&:name))
 
-      result = @index.fuzzy_search("FooBaz")
+      result = @index.fuzzy_search("qtlzwssomeking")
       assert_equal(5, result.length)
-      assert_equal(["Foo::Baz", "Foo::Bar", "Foo", "Foo::Baz::Something", "Float"], result.map(&:name))
+      assert_equal(["Qtl::Zwo::Something", "Qtl::Zws", "Qtl::Zwo", "Qtl", "Zws"], result.map(&:name))
+
+      result = @index.fuzzy_search("QltZwo")
+      assert_equal(4, result.length)
+      assert_equal(["Qtl::Zwo", "Qtl::Zws", "Qtl::Zwo::Something", "Qtl"], result.map(&:name))
     end
 
     def test_index_single_ignores_directories
@@ -140,25 +140,23 @@ module RubyIndexer
     end
 
     def test_searching_for_entries_based_on_prefix
-      # For this test, it's easier if we don't include core classes and modules
-      @index = Index.new
       @index.index_single(IndexablePath.new("/fake", "/fake/path/foo.rb"), <<~RUBY)
-        class Foo::Bar
+        class Foo::Bizw
         end
       RUBY
       @index.index_single(IndexablePath.new("/fake", "/fake/path/other_foo.rb"), <<~RUBY)
-        class Foo::Bar
+        class Foo::Bizw
         end
 
-        class Foo::Baz
+        class Foo::Bizt
         end
       RUBY
 
       results = @index.prefix_search("Foo", []).map { |entries| entries.map(&:name) }
-      assert_equal([["Foo::Bar", "Foo::Bar"], ["Foo::Baz"]], results)
+      assert_equal([["Foo::Bizw", "Foo::Bizw"], ["Foo::Bizt"]], results)
 
-      results = @index.prefix_search("Ba", ["Foo"]).map { |entries| entries.map(&:name) }
-      assert_equal([["Foo::Bar", "Foo::Bar"], ["Foo::Baz"]], results)
+      results = @index.prefix_search("Biz", ["Foo"]).map { |entries| entries.map(&:name) }
+      assert_equal([["Foo::Bizw", "Foo::Bizw"], ["Foo::Bizt"]], results)
     end
 
     def test_resolve_normalizes_top_level_names
@@ -291,16 +289,16 @@ module RubyIndexer
       index(<<~RUBY)
         module Foo
           module Bar
-            def baz; end
+            def qzx; end
           end
         end
       RUBY
 
-      entries = @index.prefix_search("ba")
+      entries = @index.prefix_search("qz")
       refute_empty(entries)
 
-      entry = T.must(entries.first).first
-      assert_equal("baz", entry.name)
+      entry = T.must(T.must(entries.first).first)
+      assert_equal("qzx", entry.name)
     end
 
     def test_indexing_prism_fixtures_succeeds
@@ -1145,8 +1143,32 @@ module RubyIndexer
       assert_nil(@index.resolve("RSpec", []))
     end
 
+    def test_object_superclass_indexing_and_resolution_with_reopened_object_class
+      index(<<~RUBY)
+        class Object; end
+      RUBY
+
+      entries = @index["Object"]
+      assert_equal(2, entries.length)
+      reopened_entry = entries.last
+      assert_equal("::BasicObject", reopened_entry.parent_class)
+      assert_equal(["Object", "Kernel", "BasicObject"], @index.linearized_ancestors_of("Object"))
+    end
+
+    def test_object_superclass_indexing_and_resolution_with_reopened_basic_object_class
+      index(<<~RUBY)
+        class BasicObject; end
+      RUBY
+
+      entries = @index["BasicObject"]
+      assert_equal(2, entries.length)
+      reopened_entry = entries.last
+      assert_nil(reopened_entry.parent_class)
+      assert_equal(["BasicObject"], @index.linearized_ancestors_of("BasicObject"))
+    end
+
     def test_object_superclass_resolution
-      @index.index_single(IndexablePath.new(nil, "/fake/path/foo.rb"), <<~RUBY)
+      index(<<~RUBY)
         module Foo
           class Object; end
 
@@ -1162,8 +1184,25 @@ module RubyIndexer
       )
     end
 
+    def test_basic_object_superclass_resolution
+      index(<<~RUBY)
+        module Foo
+          class BasicObject; end
+
+          class Bar; end
+          class Baz < BasicObject; end
+        end
+      RUBY
+
+      assert_equal(["Foo::Bar", "Object", "Kernel", "BasicObject"], @index.linearized_ancestors_of("Foo::Bar"))
+      assert_equal(
+        ["Foo::Baz", "Foo::BasicObject", "Object", "Kernel", "BasicObject"],
+        @index.linearized_ancestors_of("Foo::Baz"),
+      )
+    end
+
     def test_top_level_object_superclass_resolution
-      @index.index_single(IndexablePath.new(nil, "/fake/path/foo.rb"), <<~RUBY)
+      index(<<~RUBY)
         module Foo
           class Object; end
 
@@ -1173,5 +1212,265 @@ module RubyIndexer
 
       assert_equal(["Foo::Bar", "Object", "Kernel", "BasicObject"], @index.linearized_ancestors_of("Foo::Bar"))
     end
+
+    def test_top_level_basic_object_superclass_resolution
+      index(<<~RUBY)
+        module Foo
+          class BasicObject; end
+
+          class Bar < ::BasicObject; end
+        end
+      RUBY
+
+      assert_equal(["Foo::Bar", "BasicObject"], @index.linearized_ancestors_of("Foo::Bar"))
+    end
+
+    def test_resolving_method_inside_singleton_context
+      @index.index_single(IndexablePath.new(nil, "/fake/path/foo.rb"), <<~RUBY)
+        module Foo
+          class Bar
+            class << self
+              class Baz
+                class << self
+                  def found_me!; end
+                end
+              end
+            end
+          end
+        end
+      RUBY
+
+      entry = @index.resolve_method("found_me!", "Foo::Bar::<Class:Bar>::Baz::<Class:Baz>")&.first
+      refute_nil(entry)
+
+      assert_equal("found_me!", T.must(entry).name)
+    end
+
+    def test_resolving_constants_in_singleton_contexts
+      @index.index_single(IndexablePath.new(nil, "/fake/path/foo.rb"), <<~RUBY)
+        module Foo
+          class Bar
+            CONST = 3
+
+            class << self
+              CONST = 2
+
+              class Baz
+                CONST = 1
+
+                class << self
+                end
+              end
+            end
+          end
+        end
+      RUBY
+
+      entry = @index.resolve("CONST", ["Foo", "Bar", "<Class:Bar>", "Baz", "<Class:Baz>"])&.first
+      refute_nil(entry)
+      assert_equal(9, T.must(entry).location.start_line)
+    end
+
+    def test_resolving_instance_variables_in_singleton_contexts
+      @index.index_single(IndexablePath.new(nil, "/fake/path/foo.rb"), <<~RUBY)
+        module Foo
+          class Bar
+            @a = 123
+
+            class << self
+              def hello
+                @b = 123
+              end
+
+              @c = 123
+            end
+          end
+        end
+      RUBY
+
+      entry = @index.resolve_instance_variable("@a", "Foo::Bar::<Class:Bar>")&.first
+      refute_nil(entry)
+      assert_equal("@a", T.must(entry).name)
+
+      entry = @index.resolve_instance_variable("@b", "Foo::Bar::<Class:Bar>")&.first
+      refute_nil(entry)
+      assert_equal("@b", T.must(entry).name)
+
+      entry = @index.resolve_instance_variable("@c", "Foo::Bar::<Class:Bar>::<Class:<Class:Bar>>")&.first
+      refute_nil(entry)
+      assert_equal("@c", T.must(entry).name)
+    end
+
+    def test_instance_variable_completion_in_singleton_contexts
+      @index.index_single(IndexablePath.new(nil, "/fake/path/foo.rb"), <<~RUBY)
+        module Foo
+          class Bar
+            @a = 123
+
+            class << self
+              def hello
+                @b = 123
+              end
+
+              @c = 123
+            end
+          end
+        end
+      RUBY
+
+      entries = @index.instance_variable_completion_candidates("@", "Foo::Bar::<Class:Bar>").map(&:name)
+      assert_includes(entries, "@a")
+      assert_includes(entries, "@b")
+
+      assert_includes(
+        @index.instance_variable_completion_candidates("@", "Foo::Bar::<Class:Bar>::<Class:<Class:Bar>>").map(&:name),
+        "@c",
+      )
+    end
+
+    def test_singletons_are_excluded_from_prefix_search
+      index(<<~RUBY)
+        class Zwq
+          class << self
+          end
+        end
+      RUBY
+
+      assert_empty(@index.prefix_search("Zwq::<C"))
+    end
+
+    def test_singletons_are_excluded_from_fuzzy_search
+      index(<<~RUBY)
+        class Zwq
+          class << self
+          end
+        end
+      RUBY
+
+      results = @index.fuzzy_search("Zwq")
+      assert_equal(1, results.length)
+      assert_equal("Zwq", results.first.name)
+    end
+
+    def test_resolving_method_aliases
+      index(<<~RUBY)
+        class Foo
+          def bar(a, b, c)
+          end
+
+          alias double_alias bar
+        end
+
+        class Bar < Foo
+          def hello(b); end
+
+          alias baz bar
+          alias_method :qux, :hello
+          alias double double_alias
+        end
+      RUBY
+
+      # baz
+      methods = @index.resolve_method("baz", "Bar")
+      refute_nil(methods)
+
+      entry = T.must(methods.first)
+      assert_kind_of(Entry::MethodAlias, entry)
+      assert_equal("bar", entry.target.name)
+      assert_equal("Foo", T.must(entry.target.owner).name)
+
+      # qux
+      methods = @index.resolve_method("qux", "Bar")
+      refute_nil(methods)
+
+      entry = T.must(methods.first)
+      assert_kind_of(Entry::MethodAlias, entry)
+      assert_equal("hello", entry.target.name)
+      assert_equal("Bar", T.must(entry.target.owner).name)
+
+      # double
+      methods = @index.resolve_method("double", "Bar")
+      refute_nil(methods)
+
+      entry = T.must(methods.first)
+      assert_kind_of(Entry::MethodAlias, entry)
+
+      target = entry.target
+      assert_equal("double_alias", target.name)
+      assert_kind_of(Entry::MethodAlias, target)
+      assert_equal("Foo", T.must(target.owner).name)
+
+      final_target = target.target
+      assert_equal("bar", final_target.name)
+      assert_kind_of(Entry::Method, final_target)
+      assert_equal("Foo", T.must(final_target.owner).name)
+    end
+
+    def test_resolving_circular_method_aliases
+      index(<<~RUBY)
+        class Foo
+          alias bar bar
+        end
+      RUBY
+
+      # It's not possible to resolve an alias that points to itself
+      methods = @index.resolve_method("bar", "Foo")
+      assert_nil(methods)
+
+      entry = T.must(@index["bar"].first)
+      assert_kind_of(Entry::UnresolvedMethodAlias, entry)
+    end
+
+    def test_unresolable_method_aliases
+      index(<<~RUBY)
+        class Foo
+          alias bar baz
+        end
+      RUBY
+
+      # `baz` does not exist, so resolving `bar` is not possible
+      methods = @index.resolve_method("bar", "Foo")
+      assert_nil(methods)
+
+      entry = T.must(@index["bar"].first)
+      assert_kind_of(Entry::UnresolvedMethodAlias, entry)
+    end
+
+    def test_only_aliases_for_the_right_owner_are_resolved
+      index(<<~RUBY)
+        class Foo
+          attr_reader :name
+          alias_method :decorated_name, :name
+        end
+
+        class Bar
+          alias_method :decorated_name, :to_s
+        end
+      RUBY
+
+      methods = @index.resolve_method("decorated_name", "Foo")
+      refute_nil(methods)
+
+      entry = T.must(methods.first)
+      assert_kind_of(Entry::MethodAlias, entry)
+
+      target = entry.target
+      assert_equal("name", target.name)
+      assert_kind_of(Entry::Accessor, target)
+      assert_equal("Foo", T.must(target.owner).name)
+
+      other_decorated_name = T.must(@index["decorated_name"].find { |e| e.is_a?(Entry::UnresolvedMethodAlias) })
+      assert_kind_of(Entry::UnresolvedMethodAlias, other_decorated_name)
+    end
+
+    def test_completion_does_not_include_unresolved_aliases
+      index(<<~RUBY)
+        class Foo
+          alias_method :bar, :missing
+        end
+      RUBY
+
+      assert_empty(@index.method_completion_candidates("bar", "Foo"))
+    end
   end
 end

data/lib/ruby_indexer/test/instance_variables_test.rb

@@ -20,7 +20,9 @@ module RubyIndexer
       assert_entry("@a", Entry::InstanceVariable, "/fake/path/foo.rb:4-6:4-8")
 
       entry = T.must(@index["@a"]&.first)
-      assert_equal("Foo::Bar", T.must(entry.owner).name)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::Class, owner)
+      assert_equal("Foo::Bar", owner.name)
     end
 
     def test_instance_variable_and_write
@@ -38,7 +40,9 @@ module RubyIndexer
       assert_entry("@a", Entry::InstanceVariable, "/fake/path/foo.rb:4-6:4-8")
 
       entry = T.must(@index["@a"]&.first)
-      assert_equal("Foo::Bar", T.must(entry.owner).name)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::Class, owner)
+      assert_equal("Foo::Bar", owner.name)
     end
 
     def test_instance_variable_operator_write
@@ -56,7 +60,9 @@ module RubyIndexer
       assert_entry("@a", Entry::InstanceVariable, "/fake/path/foo.rb:4-6:4-8")
 
       entry = T.must(@index["@a"]&.first)
-      assert_equal("Foo::Bar", T.must(entry.owner).name)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::Class, owner)
+      assert_equal("Foo::Bar", owner.name)
     end
 
     def test_instance_variable_or_write
@@ -74,7 +80,9 @@ module RubyIndexer
       assert_entry("@a", Entry::InstanceVariable, "/fake/path/foo.rb:4-6:4-8")
 
       entry = T.must(@index["@a"]&.first)
-      assert_equal("Foo::Bar", T.must(entry.owner).name)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::Class, owner)
+      assert_equal("Foo::Bar", owner.name)
     end
 
     def test_instance_variable_target
@@ -93,10 +101,14 @@ module RubyIndexer
       assert_entry("@b", Entry::InstanceVariable, "/fake/path/foo.rb:4-10:4-12")
 
       entry = T.must(@index["@a"]&.first)
-      assert_equal("Foo::Bar", T.must(entry.owner).name)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::Class, owner)
+      assert_equal("Foo::Bar", owner.name)
 
       entry = T.must(@index["@b"]&.first)
-      assert_equal("Foo::Bar", T.must(entry.owner).name)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::Class, owner)
+      assert_equal("Foo::Bar", owner.name)
     end
 
     def test_empty_name_instance_variables
@@ -118,6 +130,14 @@ module RubyIndexer
         module Foo
           class Bar
             @a = 123
+
+            class << self
+              def hello
+                @b = 123
+              end
+
+              @c = 123
+            end
           end
         end
       RUBY
@@ -125,7 +145,64 @@ module RubyIndexer
       assert_entry("@a", Entry::InstanceVariable, "/fake/path/foo.rb:2-4:2-6")
 
       entry = T.must(@index["@a"]&.first)
-      assert_equal("Foo::Bar", T.must(entry.owner).name)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::SingletonClass, owner)
+      assert_equal("Foo::Bar::<Class:Bar>", owner.name)
+
+      assert_entry("@b", Entry::InstanceVariable, "/fake/path/foo.rb:6-8:6-10")
+
+      entry = T.must(@index["@b"]&.first)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::SingletonClass, owner)
+      assert_equal("Foo::Bar::<Class:Bar>", owner.name)
+
+      assert_entry("@c", Entry::InstanceVariable, "/fake/path/foo.rb:9-6:9-8")
+
+      entry = T.must(@index["@c"]&.first)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::SingletonClass, owner)
+      assert_equal("Foo::Bar::<Class:Bar>::<Class:<Class:Bar>>", owner.name)
+    end
+
+    def test_top_level_instance_variables
+      index(<<~RUBY)
+        @a = 123
+      RUBY
+
+      entry = T.must(@index["@a"]&.first)
+      assert_nil(entry.owner)
+    end
+
+    def test_class_instance_variables_inside_self_method
+      index(<<~RUBY)
+        class Foo
+          def self.bar
+            @a = 123
+          end
+        end
+      RUBY
+
+      entry = T.must(@index["@a"]&.first)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::SingletonClass, owner)
+      assert_equal("Foo::<Class:Foo>", owner.name)
+    end
+
+    def test_instance_variable_inside_dynamic_method_declaration
+      index(<<~RUBY)
+        class Foo
+          def something.bar
+            @a = 123
+          end
+        end
+      RUBY
+
+      # If the surrounding method is beind defined on any dynamic value that isn't `self`, then we attribute the
+      # instance variable to the wrong owner since there's no way to understand that statically
+      entry = T.must(@index["@a"]&.first)
+      owner = T.must(entry.owner)
+      assert_instance_of(Entry::Class, owner)
+      assert_equal("Foo", owner.name)
     end
   end
 end