ruby-lsp 0.22.1 → 0.23.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: efd5671eae595026a17c3114a00de1053865ac828726dd7ac5a66548f6b1ad56
-  data.tar.gz: ccf5b7af12a6e1e327cc2d458be11f39a9ac7319ab9049863ed5a74e333e8a6f
+  metadata.gz: 3792653083ea45143ce56ff51f68ced5217a52e9172c2cb33e03d012eda30ee8
+  data.tar.gz: 7d798218889b1add42189e08013a3503d9140a6504144fd0edfd8de00827c7f0
 SHA512:
-  metadata.gz: 8fbcdfaac508788a17fb3b7e939ce290e33049a0080ff6260abfaeb609ee76a033234ccc2efa5724587e9c4cbf4552e2cd5d2cb0af1186971b8ed06fec290cb3
-  data.tar.gz: 3e37acf250618e60df2addbce7f9acf86df4bf3e771b7b49c4cd8f4ad326ea82e3d41ad80c5ce71e3b0429dab98385df51f4645824cd419e32dac5ea13778760
+  metadata.gz: ec313c0971ed544bfb14904105345d8a4843e8aa4eeefaccbcbdb69e40ff2da2f618b4d95f89cf86ed51a90a9e3f2cb7aca93d56dca352de6f1ac2b4aff29dfe
+  data.tar.gz: 1fb2034291a4ca052d91c03095dcea32165dd2deaeafdbda59dfd67142d6380fcf9f1306879b9b516c8ba14605223042625fca5ecc1b7b9eb2137c0777ebc32f

data/VERSION

@@ -1 +1 @@
-0.22.1
+0.23.0

data/exe/ruby-lsp

@@ -64,7 +64,7 @@ if ENV["BUNDLE_GEMFILE"].nil?
   # which gives us the opportunity to control which specs are activated and enter degraded mode if any gems failed to
   # install rather than failing to boot the server completely
   if options[:launcher]
-    command = +File.expand_path("ruby-lsp-launcher", __dir__)
+    command = +"#{Gem.ruby} #{File.expand_path("ruby-lsp-launcher", __dir__)}"
     command << " --debug" if options[:debug]
     exit exec(command)
   end
@@ -78,13 +78,14 @@ if ENV["BUNDLE_GEMFILE"].nil?
     exit(78)
   end
 
-  base_bundle = if env["BUNDLER_VERSION"]
-    "bundle _#{env["BUNDLER_VERSION"]}_"
-  else
-    "bundle"
+  bundler_path = File.join(Gem.default_bindir, "bundle")
+  base_command = (File.exist?(bundler_path) ? "#{Gem.ruby} #{bundler_path}" : "bundle").dup
+
+  if env["BUNDLER_VERSION"]
+    base_command << " _#{env["BUNDLER_VERSION"]}_"
   end
 
-  exit exec(env, "#{base_bundle} exec ruby-lsp #{original_args.join(" ")}".strip)
+  exit exec(env, "#{base_command} exec ruby-lsp #{original_args.join(" ")}".strip)
 end
 
 $LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
@@ -139,9 +140,9 @@ if options[:doctor]
 
   puts "Globbing for indexable files"
 
-  index.configuration.indexables.each do |indexable|
-    puts "indexing: #{indexable.full_path}"
-    index.index_single(indexable)
+  index.configuration.indexable_uris.each do |uri|
+    puts "indexing: #{uri}"
+    index.index_file(uri)
   end
   return
 end

data/exe/ruby-lsp-check

@@ -44,14 +44,14 @@ puts "\n"
 puts "Verifying that indexing executes successfully. This may take a while..."
 
 index = RubyIndexer::Index.new
-indexables = index.configuration.indexables
+uris = index.configuration.indexable_uris
 
-indexables.each_with_index do |indexable, i|
-  index.index_single(indexable)
+uris.each_with_index do |uri, i|
+  index.index_file(uri)
 rescue => e
-  errors[indexable.full_path] = e
+  errors[uri.full_path] = e
 ensure
-  print("\033[M\033[0KIndexed #{i + 1}/#{indexables.length}") unless ENV["CI"]
+  print("\033[M\033[0KIndexed #{i + 1}/#{uris.length}") unless ENV["CI"]
 end
 puts "\n"
 

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

@@ -81,8 +81,8 @@ module RubyIndexer
         .then { |dirs| File.join(@workspace_path, "{#{dirs.join(",")}}/**/*") }
     end
 
-    sig { returns(T::Array[IndexablePath]) }
-    def indexables
+    sig { returns(T::Array[URI::Generic]) }
+    def indexable_uris
       excluded_gems = @excluded_gems - @included_gems
       locked_gems = Bundler.locked_gems&.specs
 
@@ -107,12 +107,12 @@ module RubyIndexer
           [included_path, relative_path]
         end
 
-      indexables = T.let([], T::Array[IndexablePath])
+      uris = T.let([], T::Array[URI::Generic])
 
       # Handle top level files separately. The path below is an optimization to prevent descending down directories that
       # are going to be excluded anyway, so we need to handle top level scripts separately
       Dir.glob(File.join(@workspace_path, "*.rb"), flags).each do |path|
-        indexables << IndexablePath.new(nil, path)
+        uris << URI::Generic.from_path(path: path)
       end
 
       # Add user specified patterns
@@ -134,7 +134,7 @@ module RubyIndexer
               load_path_entry = $LOAD_PATH.find { |load_path| path.start_with?(load_path) }
             end
 
-            indexables << IndexablePath.new(load_path_entry, path)
+            uris << URI::Generic.from_path(path: path, load_path_entry: load_path_entry)
           end
         end
       end
@@ -150,9 +150,9 @@ module RubyIndexer
       end
 
       # Remove user specified patterns
-      indexables.reject! do |indexable|
+      uris.reject! do |indexable|
         excluded_patterns.any? do |pattern|
-          File.fnmatch?(pattern, indexable.full_path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+          File.fnmatch?(pattern, T.must(indexable.full_path), File::FNM_PATHNAME | File::FNM_EXTGLOB)
         end
       end
 
@@ -182,14 +182,14 @@ module RubyIndexer
 
         if pathname.directory?
           # If the default_path is a directory, we index all the Ruby files in it
-          indexables.concat(
+          uris.concat(
             Dir.glob(File.join(default_path, "**", "*.rb"), File::FNM_PATHNAME | File::FNM_EXTGLOB).map! do |path|
-              IndexablePath.new(RbConfig::CONFIG["rubylibdir"], path)
+              URI::Generic.from_path(path: path, load_path_entry: RbConfig::CONFIG["rubylibdir"])
             end,
           )
         elsif pathname.extname == ".rb"
           # If the default_path is a Ruby file, we index it
-          indexables << IndexablePath.new(RbConfig::CONFIG["rubylibdir"], default_path)
+          uris << URI::Generic.from_path(path: default_path, load_path_entry: RbConfig::CONFIG["rubylibdir"])
         end
       end
 
@@ -204,10 +204,12 @@ module RubyIndexer
         # duplicates or accidentally ignoring exclude patterns
         next if spec.full_gem_path == @workspace_path
 
-        indexables.concat(
+        uris.concat(
           spec.require_paths.flat_map do |require_path|
             load_path_entry = File.join(spec.full_gem_path, require_path)
-            Dir.glob(File.join(load_path_entry, "**", "*.rb")).map! { |path| IndexablePath.new(load_path_entry, path) }
+            Dir.glob(File.join(load_path_entry, "**", "*.rb")).map! do |path|
+              URI::Generic.from_path(path: path, load_path_entry: load_path_entry)
+            end
           end,
         )
       rescue Gem::MissingSpecError
@@ -216,8 +218,8 @@ module RubyIndexer
         # just ignore if they're missing
       end
 
-      indexables.uniq!(&:full_path)
-      indexables
+      uris.uniq!(&:to_s)
+      uris
     end
 
     sig { returns(Regexp) }
@@ -271,6 +273,15 @@ module RubyIndexer
       end
 
       others.concat(this_gem.to_spec.dependencies) if this_gem
+      others.concat(
+        others.filter_map do |d|
+          d.to_spec&.dependencies
+        rescue Gem::MissingSpecError
+          nil
+        end.flatten,
+      )
+      others.uniq!
+      others.map!(&:name)
 
       excluded.each do |dependency|
         next unless dependency.runtime?
@@ -279,12 +290,7 @@ module RubyIndexer
         next unless spec
 
         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) }
+          next if others.include?(transitive_dependency.name)
 
           excluded << transitive_dependency
         end

data/lib/ruby_indexer/lib/ruby_indexer/declaration_listener.rb

@@ -16,13 +16,13 @@ module RubyIndexer
         index: Index,
         dispatcher: Prism::Dispatcher,
         parse_result: Prism::ParseResult,
-        file_path: String,
+        uri: URI::Generic,
         collect_comments: T::Boolean,
       ).void
     end
-    def initialize(index, dispatcher, parse_result, file_path, collect_comments: false)
+    def initialize(index, dispatcher, parse_result, uri, collect_comments: false)
       @index = index
-      @file_path = file_path
+      @uri = uri
       @enhancements = T.let(Enhancement.all(self), T::Array[Enhancement])
       @visibility_stack = T.let([Entry::Visibility::PUBLIC], T::Array[Entry::Visibility])
       @comments_by_line = T.let(
@@ -80,6 +80,11 @@ module RubyIndexer
         :on_instance_variable_or_write_node_enter,
         :on_instance_variable_target_node_enter,
         :on_alias_method_node_enter,
+        :on_class_variable_and_write_node_enter,
+        :on_class_variable_operator_write_node_enter,
+        :on_class_variable_or_write_node_enter,
+        :on_class_variable_target_node_enter,
+        :on_class_variable_write_node_enter,
       )
     end
 
@@ -154,7 +159,7 @@ module RubyIndexer
         else
           entry = Entry::SingletonClass.new(
             real_nesting,
-            @file_path,
+            @uri,
             Location.from_prism_location(node.location, @code_units_cache),
             Location.from_prism_location(expression.location, @code_units_cache),
             collect_comments(node),
@@ -291,7 +296,7 @@ module RubyIndexer
         enhancement.on_call_node_enter(node)
       rescue StandardError => e
         @indexing_errors << <<~MSG
-          Indexing error in #{@file_path} with '#{enhancement.class.name}' on call node enter enhancement: #{e.message}
+          Indexing error in #{@uri} with '#{enhancement.class.name}' on call node enter enhancement: #{e.message}
         MSG
       end
     end
@@ -312,7 +317,7 @@ module RubyIndexer
         enhancement.on_call_node_leave(node)
       rescue StandardError => e
         @indexing_errors << <<~MSG
-          Indexing error in #{@file_path} with '#{enhancement.class.name}' on call node leave enhancement: #{e.message}
+          Indexing error in #{@uri} with '#{enhancement.class.name}' on call node leave enhancement: #{e.message}
         MSG
       end
     end
@@ -327,7 +332,7 @@ module RubyIndexer
       when nil
         @index.add(Entry::Method.new(
           method_name,
-          @file_path,
+          @uri,
           Location.from_prism_location(node.location, @code_units_cache),
           Location.from_prism_location(node.name_loc, @code_units_cache),
           comments,
@@ -343,7 +348,7 @@ module RubyIndexer
 
           @index.add(Entry::Method.new(
             method_name,
-            @file_path,
+            @uri,
             Location.from_prism_location(node.location, @code_units_cache),
             Location.from_prism_location(node.name_loc, @code_units_cache),
             comments,
@@ -427,13 +432,38 @@ module RubyIndexer
           method_name,
           node.old_name.slice,
           @owner_stack.last,
-          @file_path,
+          @uri,
           Location.from_prism_location(node.new_name.location, @code_units_cache),
           comments,
         ),
       )
     end
 
+    sig { params(node: Prism::ClassVariableAndWriteNode).void }
+    def on_class_variable_and_write_node_enter(node)
+      handle_class_variable(node, node.name_loc)
+    end
+
+    sig { params(node: Prism::ClassVariableOperatorWriteNode).void }
+    def on_class_variable_operator_write_node_enter(node)
+      handle_class_variable(node, node.name_loc)
+    end
+
+    sig { params(node: Prism::ClassVariableOrWriteNode).void }
+    def on_class_variable_or_write_node_enter(node)
+      handle_class_variable(node, node.name_loc)
+    end
+
+    sig { params(node: Prism::ClassVariableTargetNode).void }
+    def on_class_variable_target_node_enter(node)
+      handle_class_variable(node, node.location)
+    end
+
+    sig { params(node: Prism::ClassVariableWriteNode).void }
+    def on_class_variable_write_node_enter(node)
+      handle_class_variable(node, node.name_loc)
+    end
+
     sig do
       params(
         name: String,
@@ -448,7 +478,7 @@ module RubyIndexer
 
       @index.add(Entry::Method.new(
         name,
-        @file_path,
+        @uri,
         location,
         location,
         comments,
@@ -472,7 +502,7 @@ module RubyIndexer
 
       entry = Entry::Module.new(
         actual_nesting(name),
-        @file_path,
+        @uri,
         location,
         name_loc,
         comments,
@@ -494,7 +524,7 @@ module RubyIndexer
       nesting = name_or_nesting.is_a?(Array) ? name_or_nesting : actual_nesting(name_or_nesting)
       entry = Entry::Class.new(
         nesting,
-        @file_path,
+        @uri,
         Location.from_prism_location(full_location, @code_units_cache),
         Location.from_prism_location(name_location, @code_units_cache),
         comments,
@@ -546,9 +576,45 @@ module RubyIndexer
 
       @index.add(Entry::GlobalVariable.new(
         name,
-        @file_path,
+        @uri,
+        Location.from_prism_location(loc, @code_units_cache),
+        comments,
+      ))
+    end
+
+    sig do
+      params(
+        node: T.any(
+          Prism::ClassVariableAndWriteNode,
+          Prism::ClassVariableOperatorWriteNode,
+          Prism::ClassVariableOrWriteNode,
+          Prism::ClassVariableTargetNode,
+          Prism::ClassVariableWriteNode,
+        ),
+        loc: Prism::Location,
+      ).void
+    end
+    def handle_class_variable(node, loc)
+      name = node.name.to_s
+      # Ignore incomplete class variable names, which aren't valid Ruby syntax.
+      # This could occur if the code is in an incomplete or temporary state.
+      return if name == "@@"
+
+      comments = collect_comments(node)
+
+      owner = @owner_stack.last
+
+      # set the class variable's owner to the attached context when defined within a singleton scope.
+      if owner.is_a?(Entry::SingletonClass)
+        owner = @owner_stack.reverse.find { |entry| !entry.name.include?("<Class:") }
+      end
+
+      @index.add(Entry::ClassVariable.new(
+        name,
+        @uri,
         Location.from_prism_location(loc, @code_units_cache),
         comments,
+        owner,
       ))
     end
 
@@ -578,7 +644,7 @@ module RubyIndexer
 
       @index.add(Entry::InstanceVariable.new(
         name,
-        @file_path,
+        @uri,
         Location.from_prism_location(loc, @code_units_cache),
         collect_comments(node),
         owner,
@@ -642,7 +708,7 @@ module RubyIndexer
           new_name_value,
           old_name_value,
           @owner_stack.last,
-          @file_path,
+          @uri,
           Location.from_prism_location(new_name.location, @code_units_cache),
           comments,
         ),
@@ -678,7 +744,7 @@ module RubyIndexer
             value.slice,
             @stack.dup,
             name,
-            @file_path,
+            @uri,
             Location.from_prism_location(node.location, @code_units_cache),
             comments,
           )
@@ -691,7 +757,7 @@ module RubyIndexer
             value.name.to_s,
             @stack.dup,
             name,
-            @file_path,
+            @uri,
             Location.from_prism_location(node.location, @code_units_cache),
             comments,
           )
@@ -702,14 +768,14 @@ module RubyIndexer
             value.target.slice,
             @stack.dup,
             name,
-            @file_path,
+            @uri,
             Location.from_prism_location(node.location, @code_units_cache),
             comments,
           )
         else
           Entry::Constant.new(
             name,
-            @file_path,
+            @uri,
             Location.from_prism_location(node.location, @code_units_cache),
             comments,
           )
@@ -781,7 +847,7 @@ module RubyIndexer
         if reader
           @index.add(Entry::Accessor.new(
             name,
-            @file_path,
+            @uri,
             Location.from_prism_location(loc, @code_units_cache),
             comments,
             current_visibility,
@@ -793,7 +859,7 @@ module RubyIndexer
 
         @index.add(Entry::Accessor.new(
           "#{name}=",
-          @file_path,
+          @uri,
           Location.from_prism_location(loc, @code_units_cache),
           comments,
           current_visibility,
@@ -866,7 +932,7 @@ module RubyIndexer
           location = Location.from_prism_location(argument.location, @code_units_cache)
           @index.add(Entry::Method.new(
             method_name,
-            @file_path,
+            @uri,
             location,
             location,
             collect_comments(node)&.concat(entry.comments),

data/lib/ruby_indexer/lib/ruby_indexer/entry.rb

@@ -16,8 +16,8 @@ module RubyIndexer
     sig { returns(String) }
     attr_reader :name
 
-    sig { returns(String) }
-    attr_reader :file_path
+    sig { returns(URI::Generic) }
+    attr_reader :uri
 
     sig { returns(RubyIndexer::Location) }
     attr_reader :location
@@ -30,14 +30,14 @@ module RubyIndexer
     sig do
       params(
         name: String,
-        file_path: String,
+        uri: URI::Generic,
         location: Location,
         comments: T.nilable(String),
       ).void
     end
-    def initialize(name, file_path, location, comments)
+    def initialize(name, uri, location, comments)
       @name = name
-      @file_path = file_path
+      @uri = uri
       @comments = comments
       @visibility = T.let(Visibility::PUBLIC, Visibility)
       @location = location
@@ -60,14 +60,24 @@ module RubyIndexer
 
     sig { returns(String) }
     def file_name
-      File.basename(@file_path)
+      if @uri.scheme == "untitled"
+        T.must(@uri.opaque)
+      else
+        File.basename(T.must(file_path))
+      end
+    end
+
+    sig { returns(T.nilable(String)) }
+    def file_path
+      @uri.full_path
     end
 
     sig { returns(String) }
     def comments
       @comments ||= begin
         # Parse only the comments based on the file path, which is much faster than parsing the entire file
-        parsed_comments = Prism.parse_file_comments(@file_path)
+        path = file_path
+        parsed_comments = path ? Prism.parse_file_comments(path) : []
 
         # Group comments based on whether they belong to a single block of comments
         grouped = parsed_comments.slice_when do |left, right|
@@ -137,18 +147,18 @@ module RubyIndexer
       sig do
         params(
           nesting: T::Array[String],
-          file_path: String,
+          uri: URI::Generic,
           location: Location,
           name_location: Location,
           comments: T.nilable(String),
         ).void
       end
-      def initialize(nesting, file_path, location, name_location, comments)
+      def initialize(nesting, uri, location, name_location, comments)
         @name = T.let(nesting.join("::"), String)
         # The original nesting where this namespace was discovered
         @nesting = nesting
 
-        super(@name, file_path, location, comments)
+        super(@name, uri, location, comments)
 
         @name_location = name_location
       end
@@ -186,15 +196,15 @@ module RubyIndexer
       sig do
         params(
           nesting: T::Array[String],
-          file_path: String,
+          uri: URI::Generic,
           location: Location,
           name_location:  Location,
           comments: T.nilable(String),
           parent_class: T.nilable(String),
         ).void
       end
-      def initialize(nesting, file_path, location, name_location, comments, parent_class) # rubocop:disable Metrics/ParameterLists
-        super(nesting, file_path, location, name_location, comments)
+      def initialize(nesting, uri, location, name_location, comments, parent_class) # rubocop:disable Metrics/ParameterLists
+        super(nesting, uri, location, name_location, comments)
         @parent_class = parent_class
       end
 
@@ -332,15 +342,15 @@ module RubyIndexer
       sig do
         params(
           name: String,
-          file_path: String,
+          uri: URI::Generic,
           location: Location,
           comments: T.nilable(String),
           visibility: Visibility,
           owner: T.nilable(Entry::Namespace),
         ).void
       end
-      def initialize(name, file_path, location, comments, visibility, owner) # rubocop:disable Metrics/ParameterLists
-        super(name, file_path, location, comments)
+      def initialize(name, uri, location, comments, visibility, owner) # rubocop:disable Metrics/ParameterLists
+        super(name, uri, location, comments)
         @visibility = visibility
         @owner = owner
       end
@@ -399,7 +409,7 @@ module RubyIndexer
       sig do
         params(
           name: String,
-          file_path: String,
+          uri: URI::Generic,
           location: Location,
           name_location: Location,
           comments: T.nilable(String),
@@ -408,8 +418,8 @@ module RubyIndexer
           owner: T.nilable(Entry::Namespace),
         ).void
       end
-      def initialize(name, file_path, location, name_location, comments, signatures, visibility, owner) # rubocop:disable Metrics/ParameterLists
-        super(name, file_path, location, comments, visibility, owner)
+      def initialize(name, uri, location, name_location, comments, signatures, visibility, owner) # rubocop:disable Metrics/ParameterLists
+        super(name, uri, location, comments, visibility, owner)
         @signatures = signatures
         @name_location = name_location
       end
@@ -439,13 +449,13 @@ module RubyIndexer
           target: String,
           nesting: T::Array[String],
           name: String,
-          file_path: String,
+          uri: URI::Generic,
           location: Location,
           comments: T.nilable(String),
         ).void
       end
-      def initialize(target, nesting, name, file_path, location, comments) # rubocop:disable Metrics/ParameterLists
-        super(name, file_path, location, comments)
+      def initialize(target, nesting, name, uri, location, comments) # rubocop:disable Metrics/ParameterLists
+        super(name, uri, location, comments)
 
         @target = target
         @nesting = nesting
@@ -463,7 +473,7 @@ module RubyIndexer
       def initialize(target, unresolved_alias)
         super(
           unresolved_alias.name,
-          unresolved_alias.file_path,
+          unresolved_alias.uri,
           unresolved_alias.location,
           unresolved_alias.comments,
         )
@@ -476,6 +486,26 @@ module RubyIndexer
     # Represents a global variable e.g.: $DEBUG
     class GlobalVariable < Entry; end
 
+    # Represents a class variable e.g.: @@a = 1
+    class ClassVariable < Entry
+      sig { returns(T.nilable(Entry::Namespace)) }
+      attr_reader :owner
+
+      sig do
+        params(
+          name: String,
+          uri: URI::Generic,
+          location: Location,
+          comments: T.nilable(String),
+          owner: T.nilable(Entry::Namespace),
+        ).void
+      end
+      def initialize(name, uri, location, comments, owner)
+        super(name, uri, location, comments)
+        @owner = owner
+      end
+    end
+
     # Represents an instance variable e.g.: @a = 1
     class InstanceVariable < Entry
       sig { returns(T.nilable(Entry::Namespace)) }
@@ -484,14 +514,14 @@ module RubyIndexer
       sig do
         params(
           name: String,
-          file_path: String,
+          uri: URI::Generic,
           location: Location,
           comments: T.nilable(String),
           owner: T.nilable(Entry::Namespace),
         ).void
       end
-      def initialize(name, file_path, location, comments, owner)
-        super(name, file_path, location, comments)
+      def initialize(name, uri, location, comments, owner)
+        super(name, uri, location, comments)
         @owner = owner
       end
     end
@@ -513,13 +543,13 @@ module RubyIndexer
           new_name: String,
           old_name: String,
           owner: T.nilable(Entry::Namespace),
-          file_path: String,
+          uri: URI::Generic,
           location: Location,
           comments: T.nilable(String),
         ).void
       end
-      def initialize(new_name, old_name, owner, file_path, location, comments) # rubocop:disable Metrics/ParameterLists
-        super(new_name, file_path, location, comments)
+      def initialize(new_name, old_name, owner, uri, location, comments) # rubocop:disable Metrics/ParameterLists
+        super(new_name, uri, location, comments)
 
         @new_name = new_name
         @old_name = old_name
@@ -547,7 +577,7 @@ module RubyIndexer
 
         super(
           unresolved_alias.new_name,
-          unresolved_alias.file_path,
+          unresolved_alias.uri,
           unresolved_alias.location,
           full_comments,
         )