ruby-lsp 0.19.0 → 0.20.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f1d89f4c5d5724a4b8c17002986c64d9f3ea2951282e4a35d96d50b0dd699ba9
-  data.tar.gz: f3513888e58fbde4a85d93a2ef58ae124e02c354729693ae5e928a66548cd058
+  metadata.gz: d43d431cf15d817d80ebb8564f90a748b871ad3c2c278482d4b1b5c831b7bcd2
+  data.tar.gz: 28ab582396723d582f7909ad277300430b6e14e6a281408be21a71f4d768930f
 SHA512:
-  metadata.gz: 57b44fec7c55b57408e042a9c40fe900c2445aa9fefa811223aa3154f5a4e1e8b1d0f11cf306548b13653f3a61877bcb8d01df7beeadb4766f2094b27786653b
-  data.tar.gz: cf769828221a3a1cb65e906b2b9c5c0c8fac8feee265e5f31b90fb96813f10a225798da1b3746165e11fd4591f7bd0620ab177233c2214d939986e22a1e3709b
+  metadata.gz: 73a87212da50592a6b201a5f21ea559de74fb12ed795428e06392a4375aa73015a103aedd56734b9b05a2f0a27fcb7366b16107ea9f1a080b3459e2eff1dcd88
+  data.tar.gz: 7ad77f3dccbabba9cb306c73ccefca4e84e9ff480bc0594d20a1c6e03727948119f7accefc522e5ed25d6de1d21fff03b18c704c7c8908b33eb92cfc5b2c665d

data/VERSION

@@ -1 +1 @@
-0.19.0
+0.20.0

data/exe/ruby-lsp-check

@@ -32,7 +32,7 @@ files.each_with_index do |file, index|
   })
 
   result = server.pop_response
-  errors[file] = result.message if result.is_a?(RubyLsp::Error)
+  errors[file] = result if result.is_a?(RubyLsp::Error)
 ensure
   server.process_message({ method: "textDocument/didClose", params: { textDocument: { uri: uri } } })
   server.pop_response

data/lib/core_ext/uri.rb

@@ -3,6 +3,8 @@
 
 module URI
   class Generic
+    extend T::Sig
+
     # Avoid a deprecation warning with Ruby 3.4 where the default parser was changed to RFC3986.
     # This condition must remain even after support for 3.4 has been dropped for users that have
     # `uri` in their lockfile, decoupling it from the ruby version.
@@ -27,8 +29,6 @@ module URI
       end
     end
 
-    extend T::Sig
-
     sig { returns(T.nilable(String)) }
     def to_standardized_path
       parsed_path = path

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

@@ -33,6 +33,10 @@ module RubyIndexer
         T::Hash[Integer, Prism::Comment],
       )
       @inside_def = T.let(false, T::Boolean)
+      @code_units_cache = T.let(
+        parse_result.code_units_cache(@index.configuration.encoding),
+        T.any(T.proc.params(arg0: Integer).returns(Integer), Prism::CodeUnitsCache),
+      )
 
       # The nesting stack we're currently inside. Used to determine the fully qualified name of constants, but only
       # stored by unresolved aliases which need the original nesting to be lazily resolved
@@ -65,6 +69,11 @@ module RubyIndexer
         :on_constant_or_write_node_enter,
         :on_constant_and_write_node_enter,
         :on_constant_operator_write_node_enter,
+        :on_global_variable_and_write_node_enter,
+        :on_global_variable_operator_write_node_enter,
+        :on_global_variable_or_write_node_enter,
+        :on_global_variable_target_node_enter,
+        :on_global_variable_write_node_enter,
         :on_instance_variable_write_node_enter,
         :on_instance_variable_and_write_node_enter,
         :on_instance_variable_operator_write_node_enter,
@@ -106,10 +115,9 @@ module RubyIndexer
       entry = Entry::Class.new(
         nesting,
         @file_path,
-        node.location,
-        constant_path.location,
+        Location.from_prism_location(node.location, @code_units_cache),
+        Location.from_prism_location(constant_path.location, @code_units_cache),
         comments,
-        @index.configuration.encoding,
         parent_class,
       )
 
@@ -136,10 +144,9 @@ module RubyIndexer
       entry = Entry::Module.new(
         actual_nesting(name),
         @file_path,
-        node.location,
-        constant_path.location,
+        Location.from_prism_location(node.location, @code_units_cache),
+        Location.from_prism_location(constant_path.location, @code_units_cache),
         comments,
-        @index.configuration.encoding,
       )
 
       @owner_stack << entry
@@ -170,19 +177,17 @@ module RubyIndexer
         if existing_entries
           entry = T.must(existing_entries.first)
           entry.update_singleton_information(
-            node.location,
-            expression.location,
+            Location.from_prism_location(node.location, @code_units_cache),
+            Location.from_prism_location(expression.location, @code_units_cache),
             collect_comments(node),
-            @index.configuration.encoding,
           )
         else
           entry = Entry::SingletonClass.new(
             real_nesting,
             @file_path,
-            node.location,
-            expression.location,
+            Location.from_prism_location(node.location, @code_units_cache),
+            Location.from_prism_location(expression.location, @code_units_cache),
             collect_comments(node),
-            @index.configuration.encoding,
             nil,
           )
           @index.add(entry, skip_prefix_tree: true)
@@ -310,7 +315,7 @@ module RubyIndexer
       end
 
       @enhancements.each do |enhancement|
-        enhancement.on_call_node(@index, @owner_stack.last, node, @file_path)
+        enhancement.on_call_node(@index, @owner_stack.last, node, @file_path, @code_units_cache)
       rescue StandardError => e
         @indexing_errors << "Indexing error in #{@file_path} with '#{enhancement.class.name}' enhancement: #{e.message}"
       end
@@ -340,10 +345,9 @@ module RubyIndexer
         @index.add(Entry::Method.new(
           method_name,
           @file_path,
-          node.location,
-          node.name_loc,
+          Location.from_prism_location(node.location, @code_units_cache),
+          Location.from_prism_location(node.name_loc, @code_units_cache),
           comments,
-          @index.configuration.encoding,
           [Entry::Signature.new(list_params(node.parameters))],
           current_visibility,
           @owner_stack.last,
@@ -357,10 +361,9 @@ module RubyIndexer
           @index.add(Entry::Method.new(
             method_name,
             @file_path,
-            node.location,
-            node.name_loc,
+            Location.from_prism_location(node.location, @code_units_cache),
+            Location.from_prism_location(node.name_loc, @code_units_cache),
             comments,
-            @index.configuration.encoding,
             [Entry::Signature.new(list_params(node.parameters))],
             current_visibility,
             singleton,
@@ -382,6 +385,31 @@ module RubyIndexer
       end
     end
 
+    sig { params(node: Prism::GlobalVariableAndWriteNode).void }
+    def on_global_variable_and_write_node_enter(node)
+      handle_global_variable(node, node.name_loc)
+    end
+
+    sig { params(node: Prism::GlobalVariableOperatorWriteNode).void }
+    def on_global_variable_operator_write_node_enter(node)
+      handle_global_variable(node, node.name_loc)
+    end
+
+    sig { params(node: Prism::GlobalVariableOrWriteNode).void }
+    def on_global_variable_or_write_node_enter(node)
+      handle_global_variable(node, node.name_loc)
+    end
+
+    sig { params(node: Prism::GlobalVariableTargetNode).void }
+    def on_global_variable_target_node_enter(node)
+      handle_global_variable(node, node.location)
+    end
+
+    sig { params(node: Prism::GlobalVariableWriteNode).void }
+    def on_global_variable_write_node_enter(node)
+      handle_global_variable(node, node.name_loc)
+    end
+
     sig { params(node: Prism::InstanceVariableWriteNode).void }
     def on_instance_variable_write_node_enter(node)
       handle_instance_variable(node, node.name_loc)
@@ -417,15 +445,38 @@ module RubyIndexer
           node.old_name.slice,
           @owner_stack.last,
           @file_path,
-          node.new_name.location,
+          Location.from_prism_location(node.new_name.location, @code_units_cache),
           comments,
-          @index.configuration.encoding,
         ),
       )
     end
 
     private
 
+    sig do
+      params(
+        node: T.any(
+          Prism::GlobalVariableAndWriteNode,
+          Prism::GlobalVariableOperatorWriteNode,
+          Prism::GlobalVariableOrWriteNode,
+          Prism::GlobalVariableTargetNode,
+          Prism::GlobalVariableWriteNode,
+        ),
+        loc: Prism::Location,
+      ).void
+    end
+    def handle_global_variable(node, loc)
+      name = node.name.to_s
+      comments = collect_comments(node)
+
+      @index.add(Entry::GlobalVariable.new(
+        name,
+        @file_path,
+        Location.from_prism_location(loc, @code_units_cache),
+        comments,
+      ))
+    end
+
     sig do
       params(
         node: T.any(
@@ -453,9 +504,8 @@ module RubyIndexer
       @index.add(Entry::InstanceVariable.new(
         name,
         @file_path,
-        loc,
+        Location.from_prism_location(loc, @code_units_cache),
         collect_comments(node),
-        @index.configuration.encoding,
         owner,
       ))
     end
@@ -518,9 +568,8 @@ module RubyIndexer
           old_name_value,
           @owner_stack.last,
           @file_path,
-          new_name.location,
+          Location.from_prism_location(new_name.location, @code_units_cache),
           comments,
-          @index.configuration.encoding,
         ),
       )
     end
@@ -555,9 +604,8 @@ module RubyIndexer
             @stack.dup,
             name,
             @file_path,
-            node.location,
+            Location.from_prism_location(node.location, @code_units_cache),
             comments,
-            @index.configuration.encoding,
           )
         when Prism::ConstantWriteNode, Prism::ConstantAndWriteNode, Prism::ConstantOrWriteNode,
         Prism::ConstantOperatorWriteNode
@@ -569,9 +617,8 @@ module RubyIndexer
             @stack.dup,
             name,
             @file_path,
-            node.location,
+            Location.from_prism_location(node.location, @code_units_cache),
             comments,
-            @index.configuration.encoding,
           )
         when Prism::ConstantPathWriteNode, Prism::ConstantPathOrWriteNode, Prism::ConstantPathOperatorWriteNode,
         Prism::ConstantPathAndWriteNode
@@ -581,12 +628,16 @@ module RubyIndexer
             @stack.dup,
             name,
             @file_path,
-            node.location,
+            Location.from_prism_location(node.location, @code_units_cache),
             comments,
-            @index.configuration.encoding,
           )
         else
-          Entry::Constant.new(name, @file_path, node.location, comments, @index.configuration.encoding)
+          Entry::Constant.new(
+            name,
+            @file_path,
+            Location.from_prism_location(node.location, @code_units_cache),
+            comments,
+          )
         end,
       )
     end
@@ -652,9 +703,8 @@ module RubyIndexer
           @index.add(Entry::Accessor.new(
             name,
             @file_path,
-            loc,
+            Location.from_prism_location(loc, @code_units_cache),
             comments,
-            @index.configuration.encoding,
             current_visibility,
             @owner_stack.last,
           ))
@@ -665,9 +715,8 @@ module RubyIndexer
         @index.add(Entry::Accessor.new(
           "#{name}=",
           @file_path,
-          loc,
+          Location.from_prism_location(loc, @code_units_cache),
           comments,
-          @index.configuration.encoding,
           current_visibility,
           @owner_stack.last,
         ))

data/lib/ruby_indexer/lib/ruby_indexer/enhancement.rb

@@ -19,8 +19,12 @@ module RubyIndexer
         owner: T.nilable(Entry::Namespace),
         node: Prism::CallNode,
         file_path: String,
+        code_units_cache: T.any(
+          T.proc.params(arg0: Integer).returns(Integer),
+          Prism::CodeUnitsCache,
+        ),
       ).void
     end
-    def on_call_node(index, owner, node, file_path); end
+    def on_call_node(index, owner, node, file_path, code_units_cache); end
   end
 end

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

@@ -31,30 +31,16 @@ module RubyIndexer
       params(
         name: String,
         file_path: String,
-        location: T.any(Prism::Location, RubyIndexer::Location),
+        location: Location,
         comments: T.nilable(String),
-        encoding: Encoding,
       ).void
     end
-    def initialize(name, file_path, location, comments, encoding)
+    def initialize(name, file_path, location, comments)
       @name = name
       @file_path = file_path
       @comments = comments
       @visibility = T.let(Visibility::PUBLIC, Visibility)
-
-      @location = T.let(
-        if location.is_a?(Prism::Location)
-          Location.new(
-            location.start_line,
-            location.end_line,
-            location.start_code_units_column(encoding),
-            location.end_code_units_column(encoding),
-          )
-        else
-          location
-        end,
-        RubyIndexer::Location,
-      )
+      @location = location
     end
 
     sig { returns(T::Boolean) }
@@ -110,6 +96,10 @@ module RubyIndexer
         else
           ""
         end
+      rescue Errno::ENOENT
+        # If the file was deleted, but the entry hasn't been removed yet (could happen due to concurrency), then we do
+        # not want to fail. Just set the comments to an empty string
+        ""
       end
     end
 
@@ -148,32 +138,19 @@ module RubyIndexer
         params(
           nesting: T::Array[String],
           file_path: String,
-          location: T.any(Prism::Location, RubyIndexer::Location),
-          name_location: T.any(Prism::Location, Location),
+          location: Location,
+          name_location: Location,
           comments: T.nilable(String),
-          encoding: Encoding,
         ).void
       end
-      def initialize(nesting, file_path, location, name_location, comments, encoding) # rubocop:disable Metrics/ParameterLists
+      def initialize(nesting, file_path, 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, encoding)
-
-        @name_location = T.let(
-          if name_location.is_a?(Prism::Location)
-            Location.new(
-              name_location.start_line,
-              name_location.end_line,
-              name_location.start_code_units_column(encoding),
-              name_location.end_code_units_column(encoding),
-            )
-          else
-            name_location
-          end,
-          RubyIndexer::Location,
-        )
+        super(@name, file_path, location, comments)
+
+        @name_location = name_location
       end
 
       sig { returns(T::Array[String]) }
@@ -210,15 +187,14 @@ module RubyIndexer
         params(
           nesting: T::Array[String],
           file_path: String,
-          location: T.any(Prism::Location, RubyIndexer::Location),
-          name_location: T.any(Prism::Location, Location),
+          location: Location,
+          name_location:  Location,
           comments: T.nilable(String),
-          encoding: Encoding,
           parent_class: T.nilable(String),
         ).void
       end
-      def initialize(nesting, file_path, location, name_location, comments, encoding, parent_class) # rubocop:disable Metrics/ParameterLists
-        super(nesting, file_path, location, name_location, comments, encoding)
+      def initialize(nesting, file_path, location, name_location, comments, parent_class) # rubocop:disable Metrics/ParameterLists
+        super(nesting, file_path, location, name_location, comments)
         @parent_class = parent_class
       end
 
@@ -233,26 +209,14 @@ module RubyIndexer
 
       sig do
         params(
-          location: Prism::Location,
-          name_location: Prism::Location,
+          location: Location,
+          name_location: Location,
           comments: T.nilable(String),
-          encoding: Encoding,
         ).void
       end
-      def update_singleton_information(location, name_location, comments, encoding)
-        # Create a new RubyIndexer::Location object from the Prism location
-        @location = Location.new(
-          location.start_line,
-          location.end_line,
-          location.start_code_units_column(encoding),
-          location.end_code_units_column(encoding),
-        )
-        @name_location = Location.new(
-          name_location.start_line,
-          name_location.end_line,
-          name_location.start_code_units_column(encoding),
-          name_location.end_code_units_column(encoding),
-        )
+      def update_singleton_information(location, name_location, comments)
+        @location = location
+        @name_location = name_location
         (@comments ||= +"") << comments if comments
       end
     end
@@ -369,15 +333,14 @@ module RubyIndexer
         params(
           name: String,
           file_path: String,
-          location: T.any(Prism::Location, RubyIndexer::Location),
+          location: Location,
           comments: T.nilable(String),
-          encoding: Encoding,
           visibility: Visibility,
           owner: T.nilable(Entry::Namespace),
         ).void
       end
-      def initialize(name, file_path, location, comments, encoding, visibility, owner) # rubocop:disable Metrics/ParameterLists
-        super(name, file_path, location, comments, encoding)
+      def initialize(name, file_path, location, comments, visibility, owner) # rubocop:disable Metrics/ParameterLists
+        super(name, file_path, location, comments)
         @visibility = visibility
         @owner = owner
       end
@@ -437,31 +400,18 @@ module RubyIndexer
         params(
           name: String,
           file_path: String,
-          location: T.any(Prism::Location, RubyIndexer::Location),
-          name_location: T.any(Prism::Location, Location),
+          location: Location,
+          name_location: Location,
           comments: T.nilable(String),
-          encoding: Encoding,
           signatures: T::Array[Signature],
           visibility: Visibility,
           owner: T.nilable(Entry::Namespace),
         ).void
       end
-      def initialize(name, file_path, location, name_location, comments, encoding, signatures, visibility, owner) # rubocop:disable Metrics/ParameterLists
-        super(name, file_path, location, comments, encoding, visibility, owner)
+      def initialize(name, file_path, location, name_location, comments, signatures, visibility, owner) # rubocop:disable Metrics/ParameterLists
+        super(name, file_path, location, comments, visibility, owner)
         @signatures = signatures
-        @name_location = T.let(
-          if name_location.is_a?(Prism::Location)
-            Location.new(
-              name_location.start_line,
-              name_location.end_line,
-              name_location.start_code_units_column(encoding),
-              name_location.end_code_units_column(encoding),
-            )
-          else
-            name_location
-          end,
-          RubyIndexer::Location,
-        )
+        @name_location = name_location
       end
     end
 
@@ -490,13 +440,12 @@ module RubyIndexer
           nesting: T::Array[String],
           name: String,
           file_path: String,
-          location: T.any(Prism::Location, RubyIndexer::Location),
+          location: Location,
           comments: T.nilable(String),
-          encoding: Encoding,
         ).void
       end
-      def initialize(target, nesting, name, file_path, location, comments, encoding) # rubocop:disable Metrics/ParameterLists
-        super(name, file_path, location, comments, encoding)
+      def initialize(target, nesting, name, file_path, location, comments) # rubocop:disable Metrics/ParameterLists
+        super(name, file_path, location, comments)
 
         @target = target
         @nesting = nesting
@@ -510,14 +459,13 @@ module RubyIndexer
       sig { returns(String) }
       attr_reader :target
 
-      sig { params(target: String, unresolved_alias: UnresolvedConstantAlias, encoding: Encoding).void }
-      def initialize(target, unresolved_alias, encoding)
+      sig { params(target: String, unresolved_alias: UnresolvedConstantAlias).void }
+      def initialize(target, unresolved_alias)
         super(
           unresolved_alias.name,
           unresolved_alias.file_path,
           unresolved_alias.location,
           unresolved_alias.comments,
-          encoding
         )
 
         @visibility = unresolved_alias.visibility
@@ -525,6 +473,9 @@ module RubyIndexer
       end
     end
 
+    # Represents a global variable e.g.: $DEBUG
+    class GlobalVariable < Entry; end
+
     # Represents an instance variable e.g.: @a = 1
     class InstanceVariable < Entry
       sig { returns(T.nilable(Entry::Namespace)) }
@@ -534,14 +485,13 @@ module RubyIndexer
         params(
           name: String,
           file_path: String,
-          location: T.any(Prism::Location, RubyIndexer::Location),
+          location: Location,
           comments: T.nilable(String),
-          encoding: Encoding,
           owner: T.nilable(Entry::Namespace),
         ).void
       end
-      def initialize(name, file_path, location, comments, encoding, owner) # rubocop:disable Metrics/ParameterLists
-        super(name, file_path, location, comments, encoding)
+      def initialize(name, file_path, location, comments, owner)
+        super(name, file_path, location, comments)
         @owner = owner
       end
     end
@@ -564,13 +514,12 @@ module RubyIndexer
           old_name: String,
           owner: T.nilable(Entry::Namespace),
           file_path: String,
-          location: T.any(Prism::Location, RubyIndexer::Location),
+          location: Location,
           comments: T.nilable(String),
-          encoding: Encoding,
         ).void
       end
-      def initialize(new_name, old_name, owner, file_path, location, comments, encoding) # rubocop:disable Metrics/ParameterLists
-        super(new_name, file_path, location, comments, encoding)
+      def initialize(new_name, old_name, owner, file_path, location, comments) # rubocop:disable Metrics/ParameterLists
+        super(new_name, file_path, location, comments)
 
         @new_name = new_name
         @old_name = old_name
@@ -589,9 +538,9 @@ module RubyIndexer
       attr_reader :owner
 
       sig do
-        params(target: T.any(Member, MethodAlias), unresolved_alias: UnresolvedMethodAlias, encoding: Encoding).void
+        params(target: T.any(Member, MethodAlias), unresolved_alias: UnresolvedMethodAlias).void
       end
-      def initialize(target, unresolved_alias, encoding)
+      def initialize(target, unresolved_alias)
         full_comments = +"Alias for #{target.name}\n"
         full_comments << "#{unresolved_alias.comments}\n"
         full_comments << target.comments
@@ -601,7 +550,6 @@ module RubyIndexer
           unresolved_alias.file_path,
           unresolved_alias.location,
           full_comments,
-          encoding
         )
 
         @target = target

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

@@ -665,7 +665,6 @@ module RubyIndexer
           attached_ancestor.location,
           attached_ancestor.name_location,
           nil,
-          @configuration.encoding,
           nil,
         )
         add(singleton, skip_prefix_tree: true)
@@ -677,11 +676,13 @@ module RubyIndexer
     sig do
       type_parameters(:T).params(
         path: String,
-        type: T::Class[T.all(T.type_parameter(:T), Entry)],
-      ).returns(T.nilable(T::Array[T.type_parameter(:T)]))
+        type: T.nilable(T::Class[T.all(T.type_parameter(:T), Entry)]),
+      ).returns(T.nilable(T.any(T::Array[Entry], T::Array[T.type_parameter(:T)])))
     end
-    def entries_for(path, type)
+    def entries_for(path, type = nil)
       entries = @files_to_entries[path]
+      return entries unless type
+
       entries&.grep(type)
     end
 
@@ -857,7 +858,7 @@ module RubyIndexer
       return entry unless target
 
       target_name = T.must(target.first).name
-      resolved_alias = Entry::ConstantAlias.new(target_name, entry, @configuration.encoding)
+      resolved_alias = Entry::ConstantAlias.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[alias_name])
@@ -1048,7 +1049,7 @@ module RubyIndexer
       target_method_entries = resolve_method(entry.old_name, receiver_name, seen_names)
       return entry unless target_method_entries
 
-      resolved_alias = Entry::MethodAlias.new(T.must(target_method_entries.first), entry, @configuration.encoding)
+      resolved_alias = Entry::MethodAlias.new(T.must(target_method_entries.first), entry)
       original_entries = T.must(@entries[new_name])
       original_entries.delete(entry)
       original_entries << resolved_alias

data/lib/ruby_indexer/lib/ruby_indexer/location.rb

@@ -5,6 +5,28 @@ module RubyIndexer
   class Location
     extend T::Sig
 
+    class << self
+      extend T::Sig
+
+      sig do
+        params(
+          prism_location: Prism::Location,
+          code_units_cache: T.any(
+            T.proc.params(arg0: Integer).returns(Integer),
+            Prism::CodeUnitsCache,
+          ),
+        ).returns(T.attached_class)
+      end
+      def from_prism_location(prism_location, code_units_cache)
+        new(
+          prism_location.start_line,
+          prism_location.end_line,
+          prism_location.cached_start_code_units_column(code_units_cache),
+          prism_location.cached_end_code_units_column(code_units_cache),
+        )
+      end
+    end
+
     sig { returns(Integer) }
     attr_reader :start_line, :end_line, :start_column, :end_column