ruby-lsp 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 98731986ff16a22d1854fe971bfa188d55212665128ad635aabbf519c1097d9f
-  data.tar.gz: fe416e79e672448b3d2477909fec47451c6f878020ec92e2178259d933c51cb4
+  metadata.gz: 7491255b178e72942f0b98ae97c83020c0a5726162d556fba7a2592a2c8b5132
+  data.tar.gz: d9c61449b9d3eb43a53a8c00b704ceab8691bb404dedd3324d3ad055d859974d
 SHA512:
-  metadata.gz: ad9a36886ffb6b1370b2530ffdb84a89244e22ec2329ee111d70bea8e90ad7ebe6c92b87dd437e283270cb09a7d564b3471d7ddcdc51df86df54d4bdfd09ada8
-  data.tar.gz: 9a89e7a763d1a74a320ca8dd544a52ead86a3bd573204ad86585dce7dc7797ac993f3716b98e9e6cdfd9d5b6b7a8f17e9743aa149866945d099e7d9210719a28
+  metadata.gz: 88b6b4d22784336e299caa42e09a701bd9c70ac3176c224c00700ad80605dd8ad17d4274eedc95dad4f6c6432fb192c2094ca8b5ca66ce3ab95bf7ba3eb68831
+  data.tar.gz: caabe89725f634f87ace44cc85c4d001a8f74dbbb0f2d59f1e2e7a763a3b7896e72a6432abbba7e85e07646ebfc7c812c1126ef8afda520a9f827b58a8cc881d

data/README.md

@@ -46,14 +46,14 @@ See the [documentation](https://shopify.github.io/ruby-lsp) for more in-depth de
 For creating rich themes for Ruby using the semantic highlighting information, see the [semantic highlighting
 documentation](SEMANTIC_HIGHLIGHTING.md).
 
-### Extensions
+### Addons
 
-The Ruby LSP provides a server extension system that allows other gems to enhance the base functionality with more
-editor features. This is the mechanism that powers extensions like
+The Ruby LSP provides an addon system that allows other gems to enhance the base functionality with more editor
+features. This is the mechanism that powers addons like
 
 - [Ruby LSP Rails](https://github.com/Shopify/ruby-lsp-rails)
 
-For instructions on how to create extensions, see the [server extensions documentation](SERVER_EXTENSIONS.md).
+For instructions on how to create addons, see the [addons documentation](ADDONS.md).
 
 ## Learn More
 

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.11.0

data/exe/ruby-lsp-check

@@ -16,7 +16,7 @@ end
 
 require_relative "../lib/ruby_lsp/internal"
 
-RubyLsp::Extension.load_extensions
+RubyLsp::Addon.load_addons
 
 T::Utils.run_all_sig_blocks
 

data/lib/ruby_indexer/lib/ruby_indexer/configuration.rb

@@ -18,11 +18,7 @@ module RubyIndexer
 
     sig { void }
     def initialize
-      excluded_gem_names = Bundler.definition.dependencies.filter_map do |dependency|
-        dependency.name if dependency.groups == [:development]
-      end
-
-      @excluded_gems = T.let(excluded_gem_names, T::Array[String])
+      @excluded_gems = T.let(initial_excluded_gems, T::Array[String])
       @included_gems = T.let([], T::Array[String])
       @excluded_patterns = T.let([File.join("**", "*_test.rb")], T::Array[String])
       path = Bundler.settings["path"]
@@ -174,5 +170,39 @@ module RubyIndexer
       @included_patterns.concat(config["included_patterns"]) if config["included_patterns"]
       @excluded_magic_comments.concat(config["excluded_magic_comments"]) if config["excluded_magic_comments"]
     end
+
+    sig { returns(T::Array[String]) }
+    def initial_excluded_gems
+      excluded, others = Bundler.definition.dependencies.partition do |dependency|
+        dependency.groups == [:development]
+      end
+
+      # When working on a gem, we need to make sure that its gemspec dependencies can't be excluded. This is necessary
+      # because Bundler doesn't assign groups to gemspec dependencies
+      this_gem = Bundler.definition.dependencies.find { |d| d.to_spec.full_gem_path == Dir.pwd }
+      others.concat(this_gem.to_spec.dependencies) if this_gem
+
+      excluded.each do |dependency|
+        next unless dependency.runtime?
+
+        dependency.to_spec.dependencies.each do |transitive_dependency|
+          # If the transitive dependency is included in other groups, skip it
+          next if others.any? { |d| d.name == transitive_dependency.name }
+
+          # If the transitive dependency is included as a transitive dependency of a gem outside of the development
+          # group, skip it
+          next if others.any? { |d| d.to_spec.dependencies.include?(transitive_dependency) }
+
+          excluded << transitive_dependency
+        end
+      rescue Gem::MissingSpecError
+        # If a gem is scoped only to some specific platform, then its dependencies may not be installed either, but they
+        # are still listed in dependencies. We can't index them because they are not installed for the platform, so we
+        # just ignore if they're missing
+      end
+
+      excluded.uniq!
+      excluded.map(&:name)
+    end
   end
 end

data/lib/ruby_indexer/lib/ruby_indexer/index.rb

@@ -5,6 +5,8 @@ module RubyIndexer
   class Index
     extend T::Sig
 
+    class UnresolvableAliasError < StandardError; end
+
     # The minimum Jaro-Winkler similarity score for an entry to be considered a match for a given fuzzy search query
     ENTRY_SIMILARITY_THRESHOLD = 0.7
 
@@ -125,13 +127,29 @@ module RubyIndexer
     # 3. Baz
     sig { params(name: String, nesting: T::Array[String]).returns(T.nilable(T::Array[Entry])) }
     def resolve(name, nesting)
-      (nesting.length + 1).downto(0).each do |i|
-        prefix = T.must(nesting[0...i]).join("::")
-        full_name = prefix.empty? ? name : "#{prefix}::#{name}"
-        entries = @entries[full_name]
-        return entries if entries
+      if name.start_with?("::")
+        name = name.delete_prefix("::")
+        results = @entries[name] || @entries[follow_aliased_namespace(name)]
+        return results.map { |e| e.is_a?(Entry::UnresolvedAlias) ? resolve_alias(e) : e } if results
       end
 
+      nesting.length.downto(0).each do |i|
+        namespace = T.must(nesting[0...i]).join("::")
+        full_name = namespace.empty? ? name : "#{namespace}::#{name}"
+
+        # If we find an entry with `full_name` directly, then we can already return it, even if it contains aliases -
+        # because the user might be trying to jump to the alias definition.
+        #
+        # However, if we don't find it, then we need to search for possible aliases in the namespace. For example, in
+        # the LSP itself we alias `RubyLsp::Interface` to `LanguageServer::Protocol::Interface`, which means doing
+        # `RubyLsp::Interface::Location` is allowed. For these cases, we need some way to realize that the
+        # `RubyLsp::Interface` part is an alias, that has to be resolved
+        entries = @entries[full_name] || @entries[follow_aliased_namespace(full_name)]
+        return entries.map { |e| e.is_a?(Entry::UnresolvedAlias) ? resolve_alias(e) : e } if entries
+      end
+
+      nil
+    rescue UnresolvableAliasError
       nil
     end
 
@@ -152,6 +170,68 @@ module RubyIndexer
       # If `path` is a directory, just ignore it and continue indexing
     end
 
+    # Follows aliases in a namespace. The algorithm keeps checking if the name is an alias and then recursively follows
+    # it. The idea is that we test the name in parts starting from the complete name to the first namespace. For
+    # `Foo::Bar::Baz`, we would test:
+    # 1. Is `Foo::Bar::Baz` an alias? Get the target and recursively follow its target
+    # 2. Is `Foo::Bar` an alias? Get the target and recursively follow its target
+    # 3. Is `Foo` an alias? Get the target and recursively follow its target
+    #
+    # If we find an alias, then we want to follow its target. In the same example, if `Foo::Bar` is an alias to
+    # `Something::Else`, then we first discover `Something::Else::Baz`. But `Something::Else::Baz` might contain other
+    # aliases, so we have to invoke `follow_aliased_namespace` again to check until we only return a real name
+    sig { params(name: String).returns(String) }
+    def follow_aliased_namespace(name)
+      parts = name.split("::")
+      real_parts = []
+
+      (parts.length - 1).downto(0).each do |i|
+        current_name = T.must(parts[0..i]).join("::")
+        entry = @entries[current_name]&.first
+
+        case entry
+        when Entry::Alias
+          target = entry.target
+          return follow_aliased_namespace("#{target}::#{real_parts.join("::")}")
+        when Entry::UnresolvedAlias
+          resolved = resolve_alias(entry)
+
+          if resolved.is_a?(Entry::UnresolvedAlias)
+            raise UnresolvableAliasError, "The constant #{resolved.name} is an alias to a non existing constant"
+          end
+
+          target = resolved.target
+          return follow_aliased_namespace("#{target}::#{real_parts.join("::")}")
+        else
+          real_parts.unshift(T.must(parts[i]))
+        end
+      end
+
+      real_parts.join("::")
+    end
+
+    private
+
+    # Attempts to resolve an UnresolvedAlias into a resolved Alias. If the unresolved alias is pointing to a constant
+    # that doesn't exist, then we return the same UnresolvedAlias
+    sig { params(entry: Entry::UnresolvedAlias).returns(T.any(Entry::Alias, Entry::UnresolvedAlias)) }
+    def resolve_alias(entry)
+      target = resolve(entry.target, entry.nesting)
+      return entry unless target
+
+      target_name = T.must(target.first).name
+      resolved_alias = Entry::Alias.new(target_name, entry)
+
+      # Replace the UnresolvedAlias by a resolved one so that we don't have to do this again later
+      original_entries = T.must(@entries[entry.name])
+      original_entries.delete(entry)
+      original_entries << resolved_alias
+
+      @entries_tree.insert(entry.name, original_entries)
+
+      resolved_alias
+    end
+
     class Entry
       extend T::Sig
 
@@ -167,12 +247,16 @@ module RubyIndexer
       sig { returns(T::Array[String]) }
       attr_reader :comments
 
+      sig { returns(Symbol) }
+      attr_accessor :visibility
+
       sig { params(name: String, file_path: String, location: YARP::Location, comments: T::Array[String]).void }
       def initialize(name, file_path, location, comments)
         @name = name
         @file_path = file_path
         @location = location
         @comments = comments
+        @visibility = T.let(:public, Symbol)
       end
 
       sig { returns(String) }
@@ -195,6 +279,58 @@ module RubyIndexer
 
       class Constant < Entry
       end
+
+      # An UnresolvedAlias points to a constant alias with a right hand side that has not yet been resolved. For
+      # example, if we find
+      #
+      # ```ruby
+      #   CONST = Foo
+      # ```
+      # Before we have discovered `Foo`, there's no way to eagerly resolve this alias to the correct target constant.
+      # All aliases are inserted as UnresolvedAlias in the index first and then we lazily resolve them to the correct
+      # target in [rdoc-ref:Index#resolve]. If the right hand side contains a constant that doesn't exist, then it's not
+      # possible to resolve the alias and it will remain an UnresolvedAlias until the right hand side constant exists
+      class UnresolvedAlias < Entry
+        extend T::Sig
+
+        sig { returns(String) }
+        attr_reader :target
+
+        sig { returns(T::Array[String]) }
+        attr_reader :nesting
+
+        sig do
+          params(
+            target: String,
+            nesting: T::Array[String],
+            name: String,
+            file_path: String,
+            location: YARP::Location,
+            comments: T::Array[String],
+          ).void
+        end
+        def initialize(target, nesting, name, file_path, location, comments) # rubocop:disable Metrics/ParameterLists
+          super(name, file_path, location, comments)
+
+          @target = target
+          @nesting = nesting
+        end
+      end
+
+      # Alias represents a resolved alias, which points to an existing constant target
+      class Alias < Entry
+        extend T::Sig
+
+        sig { returns(String) }
+        attr_reader :target
+
+        sig { params(target: String, unresolved_alias: UnresolvedAlias).void }
+        def initialize(target, unresolved_alias)
+          super(unresolved_alias.name, unresolved_alias.file_path, unresolved_alias.location, unresolved_alias.comments)
+
+          @target = target
+        end
+      end
     end
   end
 end

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

@@ -36,9 +36,19 @@ module RubyIndexer
       when YARP::ModuleNode
         add_index_entry(node, Index::Entry::Module)
       when YARP::ConstantWriteNode, YARP::ConstantOrWriteNode
-        add_constant(node)
-      when YARP::ConstantPathWriteNode, YARP::ConstantPathOrWriteNode
-        add_constant_with_path(node)
+        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"
       end
     end
 
@@ -50,28 +60,66 @@ module RubyIndexer
 
     private
 
-    sig do
-      params(
-        node: T.any(YARP::ConstantWriteNode, YARP::ConstantOrWriteNode),
-      ).void
-    end
-    def add_constant(node)
-      comments = collect_comments(node)
-      @index << Index::Entry::Constant.new(fully_qualify_name(node.name), @file_path, node.location, comments)
+    sig { params(node: YARP::CallNode).void }
+    def handle_private_constant(node)
+      arguments = node.arguments&.arguments
+      return unless arguments
+
+      first_argument = arguments.first
+
+      name = case first_argument
+      when YARP::StringNode
+        first_argument.content
+      when YARP::SymbolNode
+        first_argument.value
+      end
+
+      return unless name
+
+      receiver = node.receiver
+      name = "#{receiver.slice}::#{name}" if receiver
+
+      # The private_constant method does not resolve the constant name. It always points to a constant that needs to
+      # exist in the current namespace
+      entries = @index[fully_qualify_name(name)]
+      entries&.each { |entry| entry.visibility = :private }
     end
 
     sig do
       params(
-        node: T.any(YARP::ConstantPathWriteNode, YARP::ConstantPathOrWriteNode),
+        node: T.any(
+          YARP::ConstantWriteNode,
+          YARP::ConstantOrWriteNode,
+          YARP::ConstantPathWriteNode,
+          YARP::ConstantPathOrWriteNode,
+          YARP::ConstantPathOperatorWriteNode,
+          YARP::ConstantPathAndWriteNode,
+        ),
+        name: String,
       ).void
     end
-    def add_constant_with_path(node)
-      # ignore variable constants like `var::FOO` or `self.class::FOO`
-      return unless node.target.parent.nil? || node.target.parent.is_a?(YARP::ConstantReadNode)
-
-      name = node.target.location.slice
+    def add_constant(node, name)
+      value = node.value
       comments = collect_comments(node)
-      @index << Index::Entry::Constant.new(fully_qualify_name(name), @file_path, node.location, comments)
+
+      @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
+
+        # 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
+
+        visit(value)
+        Index::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)
+      end
     end
 
     sig { params(node: T.any(YARP::ClassNode, YARP::ModuleNode), klass: T.class_of(Index::Entry)).void }

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-2")
+      assert_entry("Foo", Index::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-2")
+      assert_entry("Foo", Index::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-2")
+      assert_entry("Foo", Index::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-2")
-      assert_entry("Foo", Index::Entry::Class, "/fake/path/foo.rb:1-2:2-4")
+      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")
     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-2")
+      assert_entry("Foo::Bar", Index::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-2")
+      assert_entry("Foo", Index::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-2")
+      assert_entry("Foo", Index::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-2")
+      assert_entry("Foo", Index::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-2")
+      assert_entry("Foo::Bar", Index::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-2")
-      assert_entry("Foo::Bar", Index::Entry::Class, "/fake/path/foo.rb:1-2:2-4")
-      assert_entry("Foo::Baz", Index::Entry::Module, "/fake/path/foo.rb:4-2:9-4")
-      assert_entry("Foo::Baz::Qux", Index::Entry::Class, "/fake/path/foo.rb:5-4:8-6")
-      assert_entry("Foo::Baz::Qux::Something", Index::Entry::Class, "/fake/path/foo.rb:6-6:7-8")
+      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")
     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-2")
+      assert_entry("Foo", Index::Entry::Class, "/fake/path/foo.rb:0-0:1-3")
 
       @index.delete(IndexablePath.new(nil, "/fake/path/foo.rb"))
       refute_entry("Foo")
@@ -216,5 +216,28 @@ module RubyIndexer
       second_foo_entry = @index["Bar"][0]
       assert_equal("This is a Bar comment", second_foo_entry.comments.join("\n"))
     end
+
+    def test_private_class_and_module_indexing
+      index(<<~RUBY)
+        class A
+          class B; end
+          private_constant(:B)
+
+          module C; end
+          private_constant("C")
+
+          class D; end
+        end
+      RUBY
+
+      b_const = @index["A::B"].first
+      assert_equal(:private, b_const.visibility)
+
+      c_const = @index["A::C"].first
+      assert_equal(:private, c_const.visibility)
+
+      d_const = @index["A::D"].first
+      assert_equal(:public, d_const.visibility)
+    end
   end
 end

data/lib/ruby_indexer/test/configuration_test.rb

@@ -15,6 +15,8 @@ module RubyIndexer
 
       assert(indexables.none? { |indexable| indexable.full_path.include?("test/fixtures") })
       assert(indexables.none? { |indexable| indexable.full_path.include?("minitest-reporters") })
+      assert(indexables.none? { |indexable| indexable.full_path.include?("ansi") })
+      assert(indexables.any? { |indexable| indexable.full_path.include?("sorbet-runtime") })
       assert(indexables.none? { |indexable| indexable.full_path == __FILE__ })
     end