ruby-lsp 0.26.1 → 0.26.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c80f549675508ffbb28d649de04506adabec01eac9aa4c6eee057ec848adf858
-  data.tar.gz: 71ea1a4d628444b98bc1173748f5aecf0d71bdc8d3dc80f33b2779c9c78d9de0
+  metadata.gz: a3c596f1104438061fe9ee2b890b980a7048e2137c10d34783d55defa0f17354
+  data.tar.gz: b9f328146d02d36436a48385f1156a3a94ce9f321123220a2316a794ab253695
 SHA512:
-  metadata.gz: 7261bf15c095154ff36152492aa252cbd84b84f6e83eb458623c7bb9790a57957885a855c2ee10683b7035267177e323c013988befc02e96f3fdf0274d2312ca
-  data.tar.gz: 74bcea4844e876230713400776bf7def1db44492bcf913526195b5d01919efd24ac69b517594ce2499e332184bf7ef4881e17e7694574bf4d35afabeda25b8c4
+  metadata.gz: 21c6b94baa433cf5c944a96f2ef8829f36ec81b0a093fb1e6fb5c53537698df6adc936f71ff2856bc68411d9ccefbd143cb75ee703d8d2b5a171e940faada191
+  data.tar.gz: 7e84f101f485088c24e2afccaaa779f8cfdae3bb91798ec24f30199402bc3bbd5e142ece40a86de7845cb342b31d68be5c953383b0a0b081bf388b0574b25ab9

data/VERSION

@@ -1 +1 @@
-0.26.1
+0.26.2

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

@@ -424,7 +424,10 @@ module RubyIndexer
       (parts.length - 1).downto(0) do |i|
         current_name = parts[0..i] #: as !nil
           .join("::")
-        entry = @entries[current_name]&.first
+
+        entry = unless seen_names.include?(current_name)
+          @entries[current_name]&.first
+        end
 
         case entry
         when Entry::ConstantAlias
@@ -904,6 +907,9 @@ module RubyIndexer
       target = resolve(entry.target, entry.nesting, seen_names)
       return entry unless target
 
+      # Self referential alias can be unresolved we should bail out from resolving
+      return entry if target.first == entry
+
       target_name = target.first #: as !nil
         .name
       resolved_alias = Entry::ConstantAlias.new(target_name, entry)
@@ -1023,11 +1029,19 @@ module RubyIndexer
       name_parts.join("::")
     end
 
+    # Tries to return direct entry from index then non seen canonicalized alias or nil
     #: (String full_name, Array[String] seen_names) -> Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias]?
     def direct_or_aliased_constant(full_name, seen_names)
-      entries = @entries[full_name] || @entries[follow_aliased_namespace(full_name)]
+      if (entries = @entries[full_name])
+        return entries.map do |e|
+          e.is_a?(Entry::UnresolvedConstantAlias) ? resolve_alias(e, seen_names) : e
+        end #: as Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias])?
+      end
+
+      aliased = follow_aliased_namespace(full_name, seen_names)
+      return if full_name == aliased || seen_names.include?(aliased)
 
-      entries&.map do |e|
+      @entries[aliased]&.map do |e|
         e.is_a?(Entry::UnresolvedConstantAlias) ? resolve_alias(e, seen_names) : e
       end #: as Array[Entry::Constant | Entry::ConstantAlias | Entry::Namespace | Entry::UnresolvedConstantAlias])?
     end

data/lib/ruby_indexer/test/index_test.rb

@@ -1152,6 +1152,46 @@ module RubyIndexer
       assert_equal(2, foo_entry.location.start_line)
     end
 
+    def test_resolving_self_referential_constant_alias
+      index(<<~RUBY)
+        module A
+          module B
+            class C
+            end
+          end
+        end
+
+        module A
+          module D
+            B = B::C
+          end
+        end
+      RUBY
+
+      entry = @index.resolve("A::D::B", [])&.first #: as Entry::ConstantAlias
+
+      assert_kind_of(RubyIndexer::Entry::ConstantAlias, entry)
+      assert_equal(10, entry.location.start_line)
+      assert_equal("A::B::C", entry.target)
+    end
+
+    def test_resolving_non_existing_self_referential_constant_alias
+      index(<<~RUBY)
+        module Foo
+          SomeClass = ::SomeClass
+          UNRESOLVED = SomeClass::CONSTANT
+        end
+      RUBY
+
+      entry = @index.resolve("Foo::UNRESOLVED", [])&.first #: as Entry::UnresolvedConstantAlias
+      assert_kind_of(Entry::UnresolvedConstantAlias, entry)
+      assert_equal(3, entry.location.start_line)
+      assert_equal("SomeClass::CONSTANT", entry.target)
+
+      entry = @index.resolve("SomeClass::CONSTANT", ["Foo"])
+      refute(entry)
+    end
+
     def test_resolving_qualified_references
       index(<<~RUBY)
         module Namespace

data/lib/ruby_lsp/base_server.rb

@@ -103,7 +103,7 @@ module RubyLsp
     # This method is only intended to be used in tests! Pops the latest response that would be sent to the client
     #: -> untyped
     def pop_response
-      @outgoing_queue.pop
+      @outgoing_queue.pop(timeout: 20) || raise("No message received from server")
     end
 
     # This method is only intended to be used in tests! Pushes a message to the incoming queue directly

data/lib/ruby_lsp/listeners/document_highlight.rb

@@ -92,7 +92,8 @@ module RubyLsp
             Prism::RequiredParameterNode, Prism::RestParameterNode
             [target, node_value(target)]
           when Prism::ModuleNode, Prism::ClassNode, Prism::SingletonClassNode, Prism::DefNode, Prism::CaseNode,
-            Prism::WhileNode, Prism::UntilNode, Prism::ForNode, Prism::IfNode, Prism::UnlessNode
+            Prism::WhileNode, Prism::UntilNode, Prism::ForNode, Prism::IfNode, Prism::UnlessNode, Prism::BlockNode,
+            Prism::LambdaNode, Prism::BeginNode
             [target, nil]
           end
 
@@ -157,6 +158,9 @@ module RubyLsp
             :on_for_node_enter,
             :on_if_node_enter,
             :on_unless_node_enter,
+            :on_block_node_enter,
+            :on_lambda_node_enter,
+            :on_begin_node_enter,
           )
         end
       end
@@ -551,6 +555,27 @@ module RubyLsp
         add_matching_end_highlights(node.keyword_loc, node.end_keyword_loc)
       end
 
+      #: (Prism::BlockNode node) -> void
+      def on_block_node_enter(node)
+        return unless @target.is_a?(Prism::BlockNode)
+
+        add_matching_end_highlights(node.opening_loc, node.closing_loc)
+      end
+
+      #: (Prism::LambdaNode node) -> void
+      def on_lambda_node_enter(node)
+        return unless @target.is_a?(Prism::LambdaNode)
+
+        add_matching_end_highlights(node.opening_loc, node.closing_loc)
+      end
+
+      #: (Prism::BeginNode node) -> void
+      def on_begin_node_enter(node)
+        return unless @target.is_a?(Prism::BeginNode)
+
+        add_matching_end_highlights(node.begin_keyword_loc, node.end_keyword_loc)
+      end
+
       private
 
       #: (Prism::Node node, Array[singleton(Prism::Node)] classes) -> bool?

data/lib/ruby_lsp/listeners/spec_style.rb

@@ -58,13 +58,11 @@ module RubyLsp
 
       #: (Prism::CallNode) -> void
       def on_call_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
-        return unless in_spec_context?
-
         case node.name
         when :describe
           handle_describe(node)
         when :it, :specify
-          handle_example(node)
+          handle_example(node) if in_spec_context?
         end
       end
 
@@ -117,10 +115,7 @@ module RubyLsp
 
       #: (Prism::CallNode) -> void
       def handle_example(node)
-        # Minitest formats the descriptions into test method names by using the count of examples with the description
-        # We are not guaranteed to discover examples in the exact order using static analysis, so we use the line number
-        # instead. Note that anonymous examples mixed with meta-programming will not be handled correctly
-        description = extract_description(node) || "anonymous"
+        description = extract_it_description(node)
         line = node.location.start_line - 1
         parent = latest_group
         return unless parent.is_a?(Requests::Support::TestItem)
@@ -141,16 +136,37 @@ module RubyLsp
 
       #: (Prism::CallNode) -> String?
       def extract_description(node)
+        arguments = node.arguments&.arguments
+        return unless arguments
+
+        parts = arguments.map { |arg| extract_argument_content(arg) }
+        return if parts.empty?
+
+        parts.join("::")
+      end
+
+      #: (Prism::CallNode) -> String
+      def extract_it_description(node)
+        # Minitest formats the descriptions into test method names by using the count of examples with the description
+        # We are not guaranteed to discover examples in the exact order using static analysis, so we use the line number
+        # instead. Note that anonymous examples mixed with meta-programming will not be handled correctly
         first_argument = node.arguments&.arguments&.first
-        return unless first_argument
+        return "anonymous" unless first_argument
+
+        extract_argument_content(first_argument) || "anonymous"
+      end
 
-        case first_argument
+      #: (Prism::Node) -> String?
+      def extract_argument_content(arg)
+        case arg
         when Prism::StringNode
-          first_argument.content
+          arg.content
+        when Prism::SymbolNode
+          arg.value
         when Prism::ConstantReadNode, Prism::ConstantPathNode
-          constant_name(first_argument)
+          constant_name(arg)
         else
-          first_argument.slice
+          arg.slice
         end
       end
 
@@ -190,12 +206,13 @@ module RubyLsp
         end
 
         # Specs only using describes
-        first_group = @spec_group_id_stack.find { |i| i.is_a?(DescribeGroup) }
-        return unless first_group
+        first_group_index = @spec_group_id_stack.index { |i| i.is_a?(DescribeGroup) }
+        return unless first_group_index
 
+        first_group = @spec_group_id_stack[first_group_index] #: as !nil
         item = @response_builder[first_group.id] #: as !nil
 
-        @spec_group_id_stack[1..] #: as !nil
+        @spec_group_id_stack[first_group_index + 1..] #: as !nil
           .each do |group|
           next unless group.is_a?(DescribeGroup)
 

data/lib/ruby_lsp/listeners/test_discovery.rb

@@ -61,11 +61,26 @@ module RubyLsp
 
       #: (Prism::ClassNode node, String fully_qualified_name) -> Array[String]
       def calc_attached_ancestors(node, fully_qualified_name)
-        @index.linearized_ancestors_of(fully_qualified_name)
-      rescue RubyIndexer::Index::NonExistingNamespaceError
-        # When there are dynamic parts in the constant path, we will not have indexed the namespace. We can still
-        # provide test functionality if the class inherits directly from Test::Unit::TestCase or Minitest::Test
-        [node.superclass&.slice].compact
+        superclass = node.superclass
+
+        begin
+          ancestors = @index.linearized_ancestors_of(fully_qualified_name)
+          # If the project has no bundle and a test class inherits from `Minitest::Test`, the linearized ancestors will
+          # not include the parent class because we never indexed it in the first place. Here we add the superclass
+          # directly, so that we can support running tests in projects without a bundle
+          return ancestors if ancestors.length > 1
+
+          # If all we found is the class itself, then manually include the parent class
+          if ancestors.first == fully_qualified_name && superclass
+            return [*ancestors, superclass.slice]
+          end
+
+          ancestors
+        rescue RubyIndexer::Index::NonExistingNamespaceError
+          # When there are dynamic parts in the constant path, we will not have indexed the namespace. We can still
+          # provide test functionality if the class inherits directly from Test::Unit::TestCase or Minitest::Test
+          [superclass&.slice].compact
+        end
       end
 
       #: (Prism::ConstantPathNode | Prism::ConstantReadNode | Prism::ConstantPathTargetNode | Prism::CallNode | Prism::MissingNode node) -> String

data/lib/ruby_lsp/listeners/test_style.rb

@@ -33,13 +33,15 @@ module RubyLsp
 
             if tags.include?("test_dir")
               if children.empty?
-                full_files.concat(Dir.glob(
-                  "#{path}/**/{*_test,test_*,*_spec}.rb",
-                  File::Constants::FNM_EXTGLOB | File::Constants::FNM_PATHNAME,
-                ))
+                full_files.concat(
+                  Dir.glob(
+                    "#{path}/**/{*_test,test_*,*_spec}.rb",
+                    File::Constants::FNM_EXTGLOB | File::Constants::FNM_PATHNAME,
+                  ).map! { |p| Shellwords.escape(p) },
+                )
               end
             elsif tags.include?("test_file")
-              full_files << path if children.empty?
+              full_files << Shellwords.escape(path) if children.empty?
             elsif tags.include?("test_group")
               # If all of the children of the current test group are other groups, then there's no need to add it to the
               # aggregated examples
@@ -114,7 +116,7 @@ module RubyLsp
           end
 
           load_path = spec?(file_path) ? "-Ispec" : "-Itest"
-          "#{COMMAND} #{load_path} #{file_path} --name \"/#{regex}/\""
+          "#{COMMAND} #{load_path} #{Shellwords.escape(file_path)} --name \"/#{regex}/\""
         end
 
         #: (String, Hash[String, Hash[Symbol, untyped]]) -> Array[String]
@@ -125,7 +127,7 @@ module RubyLsp
               Shellwords.escape(TestDiscovery::DYNAMIC_REFERENCE_MARKER),
               ".*",
             )
-            command = +"#{COMMAND} -Itest #{file_path} --testcase \"/^#{group_regex}\\$/\""
+            command = +"#{COMMAND} -Itest #{Shellwords.escape(file_path)} --testcase \"/^#{group_regex}\\$/\""
 
             unless examples.empty?
               command << if examples.length == 1
@@ -145,7 +147,7 @@ module RubyLsp
       MINITEST_REPORTER_PATH = File.expand_path("../test_reporters/minitest_reporter.rb", __dir__) #: String
       TEST_UNIT_REPORTER_PATH = File.expand_path("../test_reporters/test_unit_reporter.rb", __dir__) #: String
       BASE_COMMAND = begin
-        Bundler.with_original_env { Bundler.default_lockfile }
+        Bundler.with_unbundled_env { Bundler.default_lockfile }
         "bundle exec ruby"
       rescue Bundler::GemfileNotFound
         "ruby"

data/lib/ruby_lsp/requests/go_to_relevant_file.rb

@@ -35,24 +35,78 @@ module RubyLsp
 
       #: -> Array[String]
       def find_relevant_paths
-        candidate_paths = Dir.glob(File.join("**", relevant_filename_pattern))
+        patterns = relevant_filename_patterns
+
+        candidate_paths = patterns.flat_map do |pattern|
+          Dir.glob(File.join(search_root, "**", pattern))
+        end
+
         return [] if candidate_paths.empty?
 
-        find_most_similar_with_jaccard(candidate_paths).map { File.join(@workspace_path, _1) }
+        find_most_similar_with_jaccard(candidate_paths).map { |path| File.expand_path(path, @workspace_path) }
       end
 
+      # Determine the search roots based on the closest test directories.
+      # This scopes the search to reduce the number of files that need to be checked.
       #: -> String
-      def relevant_filename_pattern
-        input_basename = File.basename(@path, File.extname(@path))
+      def search_root
+        current_path = File.join(".", @path)
+        current_dir = File.dirname(current_path)
+        while current_dir != "."
+          dir_basename = File.basename(current_dir)
+
+          # If current directory is a test directory, return its parent as search root
+          if TEST_KEYWORDS.include?(dir_basename)
+            return File.dirname(current_dir)
+          end
 
-        relevant_basename_pattern =
-          if input_basename.match?(TEST_PATTERN)
-            input_basename.gsub(TEST_PATTERN, "")
-          else
-            "{{#{TEST_PREFIX_GLOB}}#{input_basename},#{input_basename}{#{TEST_SUFFIX_GLOB}}}"
+          # Search the test directories by walking up the directory tree
+          begin
+            contains_test_dir = Dir
+              .entries(current_dir)
+              .filter { |entry| TEST_KEYWORDS.include?(entry) }
+              .any? { |entry| File.directory?(File.join(current_dir, entry)) }
+
+            return current_dir if contains_test_dir
+          rescue Errno::EACCES, Errno::ENOENT
+            # Skip directories we can't read
           end
 
-        "#{relevant_basename_pattern}#{File.extname(@path)}"
+          # Move up one level
+          parent_dir = File.dirname(current_dir)
+          current_dir = parent_dir
+        end
+
+        "."
+      end
+
+      #: -> Array[String]
+      def relevant_filename_patterns
+        extension = File.extname(@path)
+        input_basename = File.basename(@path, extension)
+
+        if input_basename.match?(TEST_PATTERN)
+          # Test file -> find implementation
+          base = input_basename.gsub(TEST_PATTERN, "")
+          parent_dir = File.basename(File.dirname(@path))
+
+          # If test file is in a directory matching the implementation name
+          # (e.g., go_to_relevant_file/test_go_to_relevant_file_a.rb)
+          # return patterns for both the base file name and the parent directory name
+          if base.include?(parent_dir) && base != parent_dir
+            ["#{base}#{extension}", "#{parent_dir}#{extension}"]
+          else
+            ["#{base}#{extension}"]
+          end
+        else
+          # Implementation file -> find tests (including in matching directory)
+          [
+            "{#{TEST_PREFIX_GLOB}}#{input_basename}#{extension}",
+            "#{input_basename}{#{TEST_SUFFIX_GLOB}}#{extension}",
+            "#{input_basename}/{#{TEST_PREFIX_GLOB}}*#{extension}",
+            "#{input_basename}/*{#{TEST_SUFFIX_GLOB}}#{extension}",
+          ]
+        end
       end
 
       # Using the Jaccard algorithm to determine the similarity between the

data/lib/ruby_lsp/requests/support/common.rb

@@ -140,21 +140,25 @@ module RubyLsp
           end
         end
 
-        #: (RubyIndexer::Entry entry) -> Integer?
+        #: (RubyIndexer::Entry entry) -> Integer
         def kind_for_entry(entry)
           case entry
           when RubyIndexer::Entry::Class
             Constant::SymbolKind::CLASS
           when RubyIndexer::Entry::Module
             Constant::SymbolKind::NAMESPACE
-          when RubyIndexer::Entry::Constant
+          when RubyIndexer::Entry::Constant, RubyIndexer::Entry::UnresolvedConstantAlias, RubyIndexer::Entry::ConstantAlias
             Constant::SymbolKind::CONSTANT
-          when RubyIndexer::Entry::Method
+          when RubyIndexer::Entry::Method, RubyIndexer::Entry::UnresolvedMethodAlias, RubyIndexer::Entry::MethodAlias
             entry.name == "initialize" ? Constant::SymbolKind::CONSTRUCTOR : Constant::SymbolKind::METHOD
           when RubyIndexer::Entry::Accessor
             Constant::SymbolKind::PROPERTY
-          when RubyIndexer::Entry::InstanceVariable
+          when RubyIndexer::Entry::InstanceVariable, RubyIndexer::Entry::ClassVariable
             Constant::SymbolKind::FIELD
+          when RubyIndexer::Entry::GlobalVariable
+            Constant::SymbolKind::VARIABLE
+          else
+            Constant::SymbolKind::NULL
           end
         end
       end

data/lib/ruby_lsp/requests/support/rubocop_runner.rb

@@ -61,6 +61,14 @@ module RubyLsp
           "RuboCop::Formatter::BaseFormatter", # Suppress any output by using the base formatter
         ] #: Array[String]
 
+        # Functionality was introduced in 1.75.0 but had issues with autocorrect
+        REUSE_PRISM_RESULT = begin
+          gem("rubocop", ">= 1.80.1")
+          true
+        rescue LoadError
+          false
+        end #: bool
+
         #: Array[::RuboCop::Cop::Offense]
         attr_reader :offenses
 
@@ -81,7 +89,7 @@ module RubyLsp
           @offenses = [] #: Array[::RuboCop::Cop::Offense]
           @errors = [] #: Array[String]
           @warnings = [] #: Array[String]
-          # @prism_result = nil #: Prism::ParseLexResult?
+          @prism_result = nil #: Prism::ParseLexResult?
 
           args += DEFAULT_ARGS
           rubocop_options = ::RuboCop::Options.new.parse(args).first
@@ -101,11 +109,7 @@ module RubyLsp
           @warnings = []
           @offenses = []
           @options[:stdin] = contents
-
-          # Setting the Prism result before running the RuboCop runner makes it reuse the existing AST and avoids
-          # double-parsing. Unfortunately, this leads to a bunch of cops failing to execute properly under LSP mode.
-          # Uncomment this once reusing the Prism result is more stable
-          # @prism_result = prism_result
+          @prism_result = prism_result if REUSE_PRISM_RESULT
 
           super([path])
 

data/lib/ruby_lsp/server.rb

@@ -303,7 +303,7 @@ module RubyLsp
           @current_request_id,
           Interface::RelativePattern.new(
             base_uri: @global_state.workspace_uri.to_s,
-            pattern: "{.rubocop.yml,.rubocop}",
+            pattern: "{.rubocop.yml,.rubocop,.rubocop_todo.yml}",
           ),
           registration_id: "rubocop-watcher",
         ))
@@ -1045,7 +1045,7 @@ module RubyLsp
 
         file_name = File.basename(file_path)
 
-        if file_name == ".rubocop.yml" || file_name == ".rubocop"
+        if file_name == ".rubocop.yml" || file_name == ".rubocop" || file_name == ".rubocop_todo.yml"
           handle_rubocop_config_change(uri)
         end
       end

data/lib/ruby_lsp/setup_bundler.rb

@@ -234,13 +234,14 @@ module RubyLsp
         # If no error occurred, then clear previous errors
         @error_path.delete if @error_path.exist?
         $stderr.puts("Ruby LSP> Composed bundle installation complete")
-      rescue Errno::EPIPE
-        # If the $stderr pipe was closed by the client, for example when closing the editor during running bundle
-        # install, we don't want to write the error to a file or else we will report to telemetry on the next launch and
-        # it does not represent an actual error.
+      rescue Errno::EPIPE, Bundler::HTTPError
+        # There are cases where we expect certain errors to happen occasionally, and we don't want to write them to
+        # a file, which would report to telemetry on the next launch.
         #
-        # This situation may happen because while running bundle install, the server is not yet ready to receive
-        # shutdown requests and we may continue doing work until the process is killed.
+        # - The $stderr pipe might be closed by the client, for example when closing the editor during running bundle
+        # install. This situation may happen because, while running bundle install, the server is not yet ready to
+        # receive shutdown requests and we may continue doing work until the process is killed.
+        # - Bundler might also encounter a network error.
         @error_path.delete if @error_path.exist?
       rescue => e
         # Write the error object to a file so that we can read it from the parent process

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.26.1
+  version: 0.26.2
 platform: ruby
 authors:
 - Shopify
@@ -216,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.9
+rubygems_version: 3.7.2
 specification_version: 4
 summary: An opinionated language server for Ruby
 test_files: []