ruby-lsp 0.11.1 → 0.12.0

data/lib/ruby_indexer/lib/ruby_indexer/visitor.rb

@@ -2,65 +2,139 @@
 # frozen_string_literal: true
 
 module RubyIndexer
-  class IndexVisitor < YARP::Visitor
+  class IndexVisitor < Prism::Visitor
     extend T::Sig
 
-    sig { params(index: Index, parse_result: YARP::ParseResult, file_path: String).void }
+    sig { params(index: Index, parse_result: Prism::ParseResult, file_path: String).void }
     def initialize(index, parse_result, file_path)
       @index = index
-      @parse_result = parse_result
       @file_path = file_path
       @stack = T.let([], T::Array[String])
       @comments_by_line = T.let(
         parse_result.comments.to_h do |c|
           [c.location.start_line, c]
         end,
-        T::Hash[Integer, YARP::Comment],
+        T::Hash[Integer, Prism::Comment],
       )
 
       super()
     end
 
-    sig { void }
-    def run
-      visit(@parse_result.value)
-    end
-
-    sig { params(node: T.nilable(YARP::Node)).void }
-    def visit(node)
-      case node
-      when YARP::ProgramNode, YARP::StatementsNode
-        visit_child_nodes(node)
-      when YARP::ClassNode
-        add_index_entry(node, Index::Entry::Class)
-      when YARP::ModuleNode
-        add_index_entry(node, Index::Entry::Module)
-      when YARP::ConstantWriteNode, YARP::ConstantOrWriteNode
-        name = fully_qualify_name(node.name.to_s)
-        add_constant(node, name)
-      when YARP::ConstantPathWriteNode, YARP::ConstantPathOrWriteNode, YARP::ConstantPathOperatorWriteNode,
-        YARP::ConstantPathAndWriteNode
-
-        # ignore variable constants like `var::FOO` or `self.class::FOO`
-        return unless node.target.parent.nil? || node.target.parent.is_a?(YARP::ConstantReadNode)
-
-        name = fully_qualify_name(node.target.location.slice)
-        add_constant(node, name)
-      when YARP::CallNode
-        message = node.message
-        handle_private_constant(node) if message == "private_constant"
+    sig { override.params(node: Prism::ClassNode).void }
+    def visit_class_node(node)
+      add_class_entry(node)
+    end
+
+    sig { override.params(node: Prism::ModuleNode).void }
+    def visit_module_node(node)
+      add_module_entry(node)
+    end
+
+    sig { override.params(node: Prism::MultiWriteNode).void }
+    def visit_multi_write_node(node)
+      value = node.value
+      values = value.is_a?(Prism::ArrayNode) && value.opening_loc ? value.elements : []
+
+      node.targets.each_with_index do |target, i|
+        current_value = values[i]
+        # The moment we find a splat on the right hand side of the assignment, we can no longer figure out which value
+        # gets assigned to what
+        values.clear if current_value.is_a?(Prism::SplatNode)
+
+        case target
+        when Prism::ConstantTargetNode
+          add_constant(target, fully_qualify_name(target.name.to_s), current_value)
+        when Prism::ConstantPathTargetNode
+          add_constant(target, fully_qualify_name(target.slice), current_value)
+        end
       end
     end
 
-    # Override to avoid using `map` instead of `each`
-    sig { params(nodes: T::Array[T.nilable(YARP::Node)]).void }
-    def visit_all(nodes)
-      nodes.each { |node| visit(node) }
+    sig { override.params(node: Prism::ConstantPathWriteNode).void }
+    def visit_constant_path_write_node(node)
+      # ignore variable constants like `var::FOO` or `self.class::FOO`
+      target = node.target
+      return unless target.parent.nil? || target.parent.is_a?(Prism::ConstantReadNode)
+
+      name = fully_qualify_name(target.location.slice)
+      add_constant(node, name)
+    end
+
+    sig { override.params(node: Prism::ConstantPathOrWriteNode).void }
+    def visit_constant_path_or_write_node(node)
+      # ignore variable constants like `var::FOO` or `self.class::FOO`
+      target = node.target
+      return unless target.parent.nil? || target.parent.is_a?(Prism::ConstantReadNode)
+
+      name = fully_qualify_name(target.location.slice)
+      add_constant(node, name)
+    end
+
+    sig { override.params(node: Prism::ConstantPathOperatorWriteNode).void }
+    def visit_constant_path_operator_write_node(node)
+      # ignore variable constants like `var::FOO` or `self.class::FOO`
+      target = node.target
+      return unless target.parent.nil? || target.parent.is_a?(Prism::ConstantReadNode)
+
+      name = fully_qualify_name(target.location.slice)
+      add_constant(node, name)
+    end
+
+    sig { override.params(node: Prism::ConstantPathAndWriteNode).void }
+    def visit_constant_path_and_write_node(node)
+      # ignore variable constants like `var::FOO` or `self.class::FOO`
+      target = node.target
+      return unless target.parent.nil? || target.parent.is_a?(Prism::ConstantReadNode)
+
+      name = fully_qualify_name(target.location.slice)
+      add_constant(node, name)
+    end
+
+    sig { override.params(node: Prism::ConstantWriteNode).void }
+    def visit_constant_write_node(node)
+      name = fully_qualify_name(node.name.to_s)
+      add_constant(node, name)
+    end
+
+    sig { override.params(node: Prism::ConstantOrWriteNode).void }
+    def visit_constant_or_write_node(node)
+      name = fully_qualify_name(node.name.to_s)
+      add_constant(node, name)
+    end
+
+    sig { override.params(node: Prism::ConstantAndWriteNode).void }
+    def visit_constant_and_write_node(node)
+      name = fully_qualify_name(node.name.to_s)
+      add_constant(node, name)
+    end
+
+    sig { override.params(node: Prism::ConstantOperatorWriteNode).void }
+    def visit_constant_operator_write_node(node)
+      name = fully_qualify_name(node.name.to_s)
+      add_constant(node, name)
+    end
+
+    sig { override.params(node: Prism::CallNode).void }
+    def visit_call_node(node)
+      message = node.message
+      handle_private_constant(node) if message == "private_constant"
+    end
+
+    sig { override.params(node: Prism::DefNode).void }
+    def visit_def_node(node)
+      method_name = node.name.to_s
+      comments = collect_comments(node)
+      case node.receiver
+      when nil
+        @index << Entry::InstanceMethod.new(method_name, @file_path, node.location, comments, node.parameters)
+      when Prism::SelfNode
+        @index << Entry::SingletonMethod.new(method_name, @file_path, node.location, comments, node.parameters)
+      end
     end
 
     private
 
-    sig { params(node: YARP::CallNode).void }
+    sig { params(node: Prism::CallNode).void }
     def handle_private_constant(node)
       arguments = node.arguments&.arguments
       return unless arguments
@@ -68,9 +142,9 @@ module RubyIndexer
       first_argument = arguments.first
 
       name = case first_argument
-      when YARP::StringNode
+      when Prism::StringNode
         first_argument.content
-      when YARP::SymbolNode
+      when Prism::SymbolNode
         first_argument.value
       end
 
@@ -88,56 +162,78 @@ module RubyIndexer
     sig do
       params(
         node: T.any(
-          YARP::ConstantWriteNode,
-          YARP::ConstantOrWriteNode,
-          YARP::ConstantPathWriteNode,
-          YARP::ConstantPathOrWriteNode,
-          YARP::ConstantPathOperatorWriteNode,
-          YARP::ConstantPathAndWriteNode,
+          Prism::ConstantWriteNode,
+          Prism::ConstantOrWriteNode,
+          Prism::ConstantAndWriteNode,
+          Prism::ConstantOperatorWriteNode,
+          Prism::ConstantPathWriteNode,
+          Prism::ConstantPathOrWriteNode,
+          Prism::ConstantPathOperatorWriteNode,
+          Prism::ConstantPathAndWriteNode,
+          Prism::ConstantTargetNode,
+          Prism::ConstantPathTargetNode,
         ),
         name: String,
+        value: T.nilable(Prism::Node),
       ).void
     end
-    def add_constant(node, name)
-      value = node.value
+    def add_constant(node, name, value = nil)
+      value = node.value unless node.is_a?(Prism::ConstantTargetNode) || node.is_a?(Prism::ConstantPathTargetNode)
       comments = collect_comments(node)
 
       @index << case value
-      when YARP::ConstantReadNode, YARP::ConstantPathNode
-        Index::Entry::UnresolvedAlias.new(value.slice, @stack.dup, name, @file_path, node.location, comments)
-      when YARP::ConstantWriteNode, YARP::ConstantAndWriteNode, YARP::ConstantOrWriteNode,
-        YARP::ConstantOperatorWriteNode
+      when Prism::ConstantReadNode, Prism::ConstantPathNode
+        Entry::UnresolvedAlias.new(value.slice, @stack.dup, name, @file_path, node.location, comments)
+      when Prism::ConstantWriteNode, Prism::ConstantAndWriteNode, Prism::ConstantOrWriteNode,
+        Prism::ConstantOperatorWriteNode
 
         # If the right hand side is another constant assignment, we need to visit it because that constant has to be
         # indexed too
         visit(value)
-        Index::Entry::UnresolvedAlias.new(value.name.to_s, @stack.dup, name, @file_path, node.location, comments)
-      when YARP::ConstantPathWriteNode, YARP::ConstantPathOrWriteNode, YARP::ConstantPathOperatorWriteNode,
-        YARP::ConstantPathAndWriteNode
+        Entry::UnresolvedAlias.new(value.name.to_s, @stack.dup, name, @file_path, node.location, comments)
+      when Prism::ConstantPathWriteNode, Prism::ConstantPathOrWriteNode, Prism::ConstantPathOperatorWriteNode,
+        Prism::ConstantPathAndWriteNode
 
         visit(value)
-        Index::Entry::UnresolvedAlias.new(value.target.slice, @stack.dup, name, @file_path, node.location, comments)
+        Entry::UnresolvedAlias.new(value.target.slice, @stack.dup, name, @file_path, node.location, comments)
       else
-        Index::Entry::Constant.new(name, @file_path, node.location, comments)
+        Entry::Constant.new(name, @file_path, node.location, comments)
       end
     end
 
-    sig { params(node: T.any(YARP::ClassNode, YARP::ModuleNode), klass: T.class_of(Index::Entry)).void }
-    def add_index_entry(node, klass)
+    sig { params(node: Prism::ModuleNode).void }
+    def add_module_entry(node)
       name = node.constant_path.location.slice
-
-      unless /^[A-Z:]/.match?(name)
-        return visit_child_nodes(node)
-      end
+      return visit_child_nodes(node) unless /^[A-Z:]/.match?(name)
 
       comments = collect_comments(node)
-      @index << klass.new(fully_qualify_name(name), @file_path, node.location, comments)
+
+      @index << Entry::Module.new(fully_qualify_name(name), @file_path, node.location, comments)
       @stack << name
       visit_child_nodes(node)
       @stack.pop
     end
 
-    sig { params(node: YARP::Node).returns(T::Array[String]) }
+    sig { params(node: Prism::ClassNode).void }
+    def add_class_entry(node)
+      name = node.constant_path.location.slice
+      return visit_child_nodes(node) unless /^[A-Z:]/.match?(name)
+
+      comments = collect_comments(node)
+
+      superclass = node.superclass
+      parent_class = case superclass
+      when Prism::ConstantReadNode, Prism::ConstantPathNode
+        superclass.slice
+      end
+
+      @index << Entry::Class.new(fully_qualify_name(name), @file_path, node.location, comments, parent_class)
+      @stack << name
+      visit(node.body)
+      @stack.pop
+    end
+
+    sig { params(node: Prism::Node).returns(T::Array[String]) }
     def collect_comments(node)
       comments = []
 

data/lib/ruby_indexer/ruby_indexer.rb

@@ -7,6 +7,7 @@ require "did_you_mean"
 require "ruby_indexer/lib/ruby_indexer/indexable_path"
 require "ruby_indexer/lib/ruby_indexer/visitor"
 require "ruby_indexer/lib/ruby_indexer/index"
+require "ruby_indexer/lib/ruby_indexer/entry"
 require "ruby_indexer/lib/ruby_indexer/configuration"
 require "ruby_indexer/lib/ruby_indexer/prefix_tree"
 

data/lib/ruby_indexer/test/classes_and_modules_test.rb

@@ -11,7 +11,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo", Index::Entry::Class, "/fake/path/foo.rb:0-0:1-3")
+      assert_entry("Foo", Entry::Class, "/fake/path/foo.rb:0-0:1-3")
     end
 
     def test_class_with_statements
@@ -21,7 +21,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo", Index::Entry::Class, "/fake/path/foo.rb:0-0:2-3")
+      assert_entry("Foo", Entry::Class, "/fake/path/foo.rb:0-0:2-3")
     end
 
     def test_colon_colon_class
@@ -30,7 +30,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo", Index::Entry::Class, "/fake/path/foo.rb:0-0:1-3")
+      assert_entry("Foo", Entry::Class, "/fake/path/foo.rb:0-0:1-3")
     end
 
     def test_colon_colon_class_inside_class
@@ -41,8 +41,8 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Bar", Index::Entry::Class, "/fake/path/foo.rb:0-0:3-3")
-      assert_entry("Foo", Index::Entry::Class, "/fake/path/foo.rb:1-2:2-5")
+      assert_entry("Bar", Entry::Class, "/fake/path/foo.rb:0-0:3-3")
+      assert_entry("Foo", Entry::Class, "/fake/path/foo.rb:1-2:2-5")
     end
 
     def test_namespaced_class
@@ -51,7 +51,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo::Bar", Index::Entry::Class, "/fake/path/foo.rb:0-0:1-3")
+      assert_entry("Foo::Bar", Entry::Class, "/fake/path/foo.rb:0-0:1-3")
     end
 
     def test_dynamically_namespaced_class
@@ -69,7 +69,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo", Index::Entry::Module, "/fake/path/foo.rb:0-0:1-3")
+      assert_entry("Foo", Entry::Module, "/fake/path/foo.rb:0-0:1-3")
     end
 
     def test_module_with_statements
@@ -79,7 +79,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo", Index::Entry::Module, "/fake/path/foo.rb:0-0:2-3")
+      assert_entry("Foo", Entry::Module, "/fake/path/foo.rb:0-0:2-3")
     end
 
     def test_colon_colon_module
@@ -88,7 +88,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo", Index::Entry::Module, "/fake/path/foo.rb:0-0:1-3")
+      assert_entry("Foo", Entry::Module, "/fake/path/foo.rb:0-0:1-3")
     end
 
     def test_namespaced_module
@@ -97,7 +97,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo::Bar", Index::Entry::Module, "/fake/path/foo.rb:0-0:1-3")
+      assert_entry("Foo::Bar", Entry::Module, "/fake/path/foo.rb:0-0:1-3")
     end
 
     def test_dynamically_namespaced_module
@@ -124,11 +124,11 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo", Index::Entry::Module, "/fake/path/foo.rb:0-0:10-3")
-      assert_entry("Foo::Bar", Index::Entry::Class, "/fake/path/foo.rb:1-2:2-5")
-      assert_entry("Foo::Baz", Index::Entry::Module, "/fake/path/foo.rb:4-2:9-5")
-      assert_entry("Foo::Baz::Qux", Index::Entry::Class, "/fake/path/foo.rb:5-4:8-7")
-      assert_entry("Foo::Baz::Qux::Something", Index::Entry::Class, "/fake/path/foo.rb:6-6:7-9")
+      assert_entry("Foo", Entry::Module, "/fake/path/foo.rb:0-0:10-3")
+      assert_entry("Foo::Bar", Entry::Class, "/fake/path/foo.rb:1-2:2-5")
+      assert_entry("Foo::Baz", Entry::Module, "/fake/path/foo.rb:4-2:9-5")
+      assert_entry("Foo::Baz::Qux", Entry::Class, "/fake/path/foo.rb:5-4:8-7")
+      assert_entry("Foo::Baz::Qux::Something", Entry::Class, "/fake/path/foo.rb:6-6:7-9")
     end
 
     def test_deleting_from_index_based_on_file_path
@@ -137,7 +137,7 @@ module RubyIndexer
         end
       RUBY
 
-      assert_entry("Foo", Index::Entry::Class, "/fake/path/foo.rb:0-0:1-3")
+      assert_entry("Foo", Entry::Class, "/fake/path/foo.rb:0-0:1-3")
 
       @index.delete(IndexablePath.new(nil, "/fake/path/foo.rb"))
       refute_entry("Foo")
@@ -239,5 +239,38 @@ module RubyIndexer
       d_const = @index["A::D"].first
       assert_equal(:public, d_const.visibility)
     end
+
+    def test_keeping_track_of_super_classes
+      index(<<~RUBY)
+        class Foo < Bar
+        end
+
+        class Baz
+        end
+
+        module Something
+          class Baz
+          end
+
+          class Qux < ::Baz
+          end
+        end
+
+        class FinalThing < Something::Baz
+        end
+      RUBY
+
+      foo = T.must(@index["Foo"].first)
+      assert_equal("Bar", foo.parent_class)
+
+      baz = T.must(@index["Baz"].first)
+      assert_nil(baz.parent_class)
+
+      qux = T.must(@index["Something::Qux"].first)
+      assert_equal("::Baz", qux.parent_class)
+
+      final_thing = T.must(@index["FinalThing"].first)
+      assert_equal("Something::Baz", final_thing.parent_class)
+    end
   end
 end