ruby-lsp 0.23.20 → 0.23.22

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 63ffbd4bd2ac09693c25c61a71ec89528578c3eaeaf35bf547e5ee748085f3d6
-  data.tar.gz: f3390b3e9f7f86c3dcf98130c04d18a40720ab21a6b521035859bafdac67ae60
+  metadata.gz: 48c7e1cdc0e7f0a31cbc69002bf6a6c3dea0779272757ee40ae90e4199199446
+  data.tar.gz: 1cd0d4a426ed4b1c44540e9e3344f73623f0ea0193374cab8faa727528474bf2
 SHA512:
-  metadata.gz: 0232de2d936eaa8baa579293884fdb47c69d70be87b834b655292111b50ab9609f0d52d2a627a679483919116a6215df25c0966fc725b9c5a11a5b0160f12550
-  data.tar.gz: 3c744d0e29846cc5bf4406a06675fb789d1d6efe959cf982fba2505ca58b151ea45b4c800aceedfd2b242d75e792f557d99ffea5108afdc3894c76d0885ea5ae
+  metadata.gz: ac87c3a6dcc52b2696076d9793b42f03f56a4e0fbe258cc20f09502bbb289f91acccb3593ebfd36d61b5eeb0ec0bc3ab697acc332b61889fd256db2600029eca
+  data.tar.gz: be146b667f656ddb1103756a4cf79bd294981fa5f3d0cebc38e44498168799b14941c1768e9f030e80d4f4f7e8c4e4b0107e9cbaf694184ddc037824a05a2f1f

data/VERSION

@@ -1 +1 @@
-0.23.20
+0.23.22

data/exe/ruby-lsp-test-exec

@@ -0,0 +1,18 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+# Append to RUBYOPT the necessary requires to hook our custom test reporters so that results are automatically
+# reflected in the test explorer
+rubyopt = [
+  *ENV["RUBYOPT"],
+  "-rbundler/setup",
+  "-r#{File.expand_path("../lib/ruby_lsp/test_reporters/minitest_reporter", __dir__)}",
+  "-r#{File.expand_path("../lib/ruby_lsp/test_reporters/test_unit_reporter", __dir__)}",
+].join(" ")
+
+# Replace this process with whatever command was passed. We only want to set RUBYOPT.
+# The way you use this executable is by prefixing your test command with `ruby-lsp-test-exec`, like so:
+#  ruby-lsp-test-exec bundle exec ruby -Itest test/example_test.rb
+#  ruby-lsp-test-exec bundle exec ruby -Ispec spec/example_spec.rb
+#  ruby-lsp-test-exec bundle exec rspec spec/example_spec.rb
+exec({ "RUBYOPT" => rubyopt }, *ARGV)

data/lib/ruby_indexer/lib/ruby_indexer/rbs_indexer.rb

@@ -103,7 +103,7 @@ module RubyIndexer
     #: (RBS::AST::Members::MethodDefinition member, Entry::Namespace owner) -> void
     def handle_method(member, owner)
       name = member.name.name
-      uri = URI::Generic.from_path(path: member.location.buffer.name)
+      uri = URI::Generic.from_path(path: member.location.buffer.name.to_s)
       location = to_ruby_indexer_location(member.location)
       comments = comments_to_string(member)
 
@@ -267,7 +267,7 @@ module RubyIndexer
 
     #: (RBS::AST::Members::Alias member, Entry::Namespace owner_entry) -> void
     def handle_signature_alias(member, owner_entry)
-      uri = URI::Generic.from_path(path: member.location.buffer.name)
+      uri = URI::Generic.from_path(path: member.location.buffer.name.to_s)
       comments = comments_to_string(member)
 
       entry = Entry::UnresolvedMethodAlias.new(

data/lib/ruby_lsp/listeners/spec_style.rb

@@ -4,12 +4,24 @@
 module RubyLsp
   module Listeners
     class SpecStyle < TestDiscovery
+      class Group
+        #: String
+        attr_reader :id
+
+        #: (String) -> void
+        def initialize(id)
+          @id = id
+        end
+      end
+
+      class ClassGroup < Group; end
+      class DescribeGroup < Group; end
+
       #: (ResponseBuilders::TestCollection, GlobalState, Prism::Dispatcher, URI::Generic) -> void
       def initialize(response_builder, global_state, dispatcher, uri)
         super
 
-        @describe_block_nesting = [] #: Array[String]
-        @spec_class_stack = [] #: Array[bool]
+        @spec_group_id_stack = [] #: Array[Group?]
 
         dispatcher.register(
           self,
@@ -22,21 +34,21 @@ module RubyLsp
 
       #: (Prism::ClassNode) -> void
       def on_class_node_enter(node)
-        with_test_ancestor_tracking(node) do |_, ancestors|
-          is_spec = ancestors.include?("Minitest::Spec")
-          @spec_class_stack.push(is_spec)
+        with_test_ancestor_tracking(node) do |name, ancestors|
+          @spec_group_id_stack << (ancestors.include?("Minitest::Spec") ? ClassGroup.new(name) : nil)
         end
       end
 
       #: (Prism::ClassNode) -> void
       def on_class_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         super
-
-        @spec_class_stack.pop
+        @spec_group_id_stack.pop
       end
 
       #: (Prism::CallNode) -> void
       def on_call_node_enter(node)
+        return unless in_spec_context?
+
         case node.name
         when :describe
           handle_describe(node)
@@ -49,84 +61,63 @@ module RubyLsp
       def on_call_node_leave(node)
         return unless node.name == :describe && !node.receiver
 
-        @describe_block_nesting.pop
+        @spec_group_id_stack.pop
       end
 
       private
 
       #: (Prism::CallNode) -> void
       def handle_describe(node)
+        # Describes will include the nesting of all classes and all outer describes as part of its ID, unlike classes
+        # that ignore describes
         return if node.block.nil?
 
         description = extract_description(node)
         return unless description
 
-        return unless in_spec_context?
-
-        if @nesting.empty? && @describe_block_nesting.empty?
-          test_item = Requests::Support::TestItem.new(
-            description,
-            description,
-            @uri,
-            range_from_node(node),
-            framework: :minitest,
-          )
-          @response_builder.add(test_item)
-          @response_builder.add_code_lens(test_item)
+        parent = latest_group
+        id = case parent
+        when Requests::Support::TestItem
+          "#{parent.id}::#{description}"
         else
-          add_to_parent_test_group(description, node)
+          description
         end
 
-        @describe_block_nesting << description
+        test_item = Requests::Support::TestItem.new(
+          id,
+          description,
+          @uri,
+          range_from_node(node),
+          framework: :minitest,
+        )
+
+        parent.add(test_item)
+        @response_builder.add_code_lens(test_item)
+        @spec_group_id_stack << DescribeGroup.new(id)
       end
 
       #: (Prism::CallNode) -> void
       def handle_example(node)
-        return unless in_spec_context?
-
-        return if @describe_block_nesting.empty? && @nesting.empty?
-
-        description = extract_description(node)
-        return unless description
+        # 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"
+        line = node.location.start_line - 1
+        parent = latest_group
+        return unless parent.is_a?(Requests::Support::TestItem)
 
-        add_to_parent_test_group(description, node)
-      end
-
-      #: (String, Prism::CallNode) -> void
-      def add_to_parent_test_group(description, node)
-        parent_test_group = find_parent_test_group
-        return unless parent_test_group
+        id = "#{parent.id}##{format("test_%04d_%s", line, description)}"
 
         test_item = Requests::Support::TestItem.new(
-          description,
+          id,
           description,
           @uri,
           range_from_node(node),
           framework: :minitest,
         )
-        parent_test_group.add(test_item)
-        @response_builder.add_code_lens(test_item)
-      end
-
-      #: -> Requests::Support::TestItem?
-      def find_parent_test_group
-        root_group_name, nested_describe_groups = if @nesting.empty?
-          [@describe_block_nesting.first, @describe_block_nesting[1..]]
-        else
-          [RubyIndexer::Index.actual_nesting(@nesting, nil).join("::"), @describe_block_nesting]
-        end
-        return unless root_group_name
-
-        test_group = @response_builder[root_group_name] #: Requests::Support::TestItem?
-        return unless test_group
-
-        return test_group unless nested_describe_groups
 
-        nested_describe_groups.each do |description|
-          test_group = test_group[description]
-        end
-
-        test_group
+        parent.add(test_item)
+        @response_builder.add_code_lens(test_item)
       end
 
       #: (Prism::CallNode) -> String?
@@ -144,11 +135,36 @@ module RubyLsp
         end
       end
 
+      #: -> (Requests::Support::TestItem | ResponseBuilders::TestCollection)
+      def latest_group
+        return @response_builder if @spec_group_id_stack.compact.empty?
+
+        first_class_index = @spec_group_id_stack.rindex { |i| i.is_a?(ClassGroup) } || 0
+        first_class = @spec_group_id_stack[0] #: as !nil
+        item = @response_builder[first_class.id] #: as !nil
+
+        # Descend into child items from the beginning all the way to the latest class group, ignoring describes
+        @spec_group_id_stack[1..first_class_index] #: as !nil
+          .each do |group|
+          next unless group.is_a?(ClassGroup)
+
+          item = item[group.id] #: as !nil
+        end
+
+        # From the class forward, we must take describes into account
+        @spec_group_id_stack[first_class_index + 1..] #: as !nil
+          .each do |group|
+          next unless group
+
+          item = item[group.id] #: as !nil
+        end
+
+        item
+      end
+
       #: -> bool
       def in_spec_context?
-        return true if @nesting.empty?
-
-        @spec_class_stack.last #: as !nil
+        @nesting.empty? || @spec_group_id_stack.any? { |id| id }
       end
     end
   end

data/lib/ruby_lsp/listeners/test_style.rb

@@ -34,7 +34,7 @@ module RubyLsp
             if tags.include?("test_dir")
               if children.empty?
                 full_files.concat(Dir.glob(
-                  "#{path}/**/{*_test,test_*}.rb",
+                  "#{path}/**/{*_test,test_*,*_spec}.rb",
                   File::Constants::FNM_EXTGLOB | File::Constants::FNM_PATHNAME,
                 ))
               end
@@ -44,7 +44,7 @@ module RubyLsp
               # 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
               unless children.any? && children.all? { |child| child[:tags].include?("test_group") }
-                aggregated_tests[path][item[:label]] = { tags: tags, examples: [] }
+                aggregated_tests[path][item[:id]] = { tags: tags, examples: [] }
               end
             else
               class_name, method_name = item[:id].split("#")
@@ -74,7 +74,9 @@ module RubyLsp
           end
 
           unless full_files.empty?
-            commands << "#{BASE_COMMAND} -Itest -e \"ARGV.each { |f| require f }\" #{full_files.join(" ")}"
+            specs, tests = full_files.partition { |path| spec?(path) }
+            commands << "#{BASE_COMMAND} -Itest -e \"ARGV.each { |f| require f }\" #{tests.join(" ")}" if tests.any?
+            commands << "#{BASE_COMMAND} -Ispec -e \"ARGV.each { |f| require f }\" #{specs.join(" ")}" if specs.any?
           end
 
           commands
@@ -82,10 +84,15 @@ module RubyLsp
 
         private
 
+        #: (String) -> bool
+        def spec?(path)
+          File.fnmatch?("**/spec/**/*_spec.rb", path, File::FNM_PATHNAME | File::FNM_EXTGLOB)
+        end
+
         #: (String, Hash[String, Hash[Symbol, untyped]]) -> String
         def handle_minitest_groups(file_path, groups_and_examples)
           regexes = groups_and_examples.flat_map do |group, info|
-            examples = info[:examples]
+            examples = info[:examples].map { |e| e.gsub(/test_\d{4}/, "test_\\d{4}") }
             group_regex = Shellwords.escape(group).gsub(
               Shellwords.escape(TestDiscovery::DYNAMIC_REFERENCE_MARKER),
               ".*",
@@ -105,7 +112,8 @@ module RubyLsp
             "(#{regexes.join("|")})"
           end
 
-          "#{BASE_COMMAND} -Itest #{file_path} --name \"/#{regex}/\""
+          load_path = spec?(file_path) ? "-Ispec" : "-Itest"
+          "#{BASE_COMMAND} #{load_path} #{file_path} --name \"/#{regex}/\""
         end
 
         #: (String, Hash[String, Hash[Symbol, untyped]]) -> Array[String]
@@ -148,6 +156,7 @@ module RubyLsp
         super
 
         @framework = :minitest #: Symbol
+        @parent_stack = [@response_builder] #: Array[(Requests::Support::TestItem | ResponseBuilders::TestCollection)?]
 
         dispatcher.register(
           self,
@@ -173,12 +182,33 @@ module RubyLsp
               framework: @framework,
             )
 
-            @response_builder.add(test_item)
+            last_test_group.add(test_item)
             @response_builder.add_code_lens(test_item)
+            @parent_stack << test_item
+          else
+            @parent_stack << nil
           end
         end
       end
 
+      #: (Prism::ClassNode node) -> void
+      def on_class_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
+        @parent_stack.pop
+        super
+      end
+
+      #: (Prism::ModuleNode node) -> void
+      def on_module_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
+        @parent_stack << nil
+        super
+      end
+
+      #: (Prism::ModuleNode node) -> void
+      def on_module_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
+        @parent_stack.pop
+        super
+      end
+
       #: (Prism::DefNode node) -> void
       def on_def_node_enter(node)
         return if @visibility_stack.last != :public
@@ -187,12 +217,8 @@ module RubyLsp
         return unless name.start_with?("test_")
 
         current_group_name = RubyIndexer::Index.actual_nesting(@nesting, nil).join("::")
-
-        # If we're finding a test method, but for the wrong framework, then the group test item will not have been
-        # previously pushed and thus we return early and avoid adding items for a framework this listener is not
-        # interested in
-        test_item = @response_builder[current_group_name]
-        return unless test_item
+        parent = @parent_stack.last
+        return unless parent.is_a?(Requests::Support::TestItem)
 
         example_item = Requests::Support::TestItem.new(
           "#{current_group_name}##{name}",
@@ -201,7 +227,7 @@ module RubyLsp
           range_from_node(node),
           framework: @framework,
         )
-        test_item.add(example_item)
+        parent.add(example_item)
         @response_builder.add_code_lens(example_item)
       end
 
@@ -224,6 +250,12 @@ module RubyLsp
 
       private
 
+      #: -> (Requests::Support::TestItem | ResponseBuilders::TestCollection)
+      def last_test_group
+        index = @parent_stack.rindex { |i| i } #: as !nil
+        @parent_stack[index] #: as Requests::Support::TestItem | ResponseBuilders::TestCollection
+      end
+
       #: (Array[String] attached_ancestors, String fully_qualified_name) -> bool
       def non_declarative_minitest?(attached_ancestors, fully_qualified_name)
         return false unless attached_ancestors.include?("Minitest::Test")

data/lib/ruby_lsp/test_reporters/lsp_reporter.rb

@@ -6,6 +6,7 @@ require "json"
 require "socket"
 require "singleton"
 require "tmpdir"
+require_relative "../../ruby_indexer/lib/ruby_indexer/uri"
 
 module RubyLsp
   class LspReporter
@@ -19,15 +20,20 @@ module RubyLsp
       dir_path = File.join(Dir.tmpdir, "ruby-lsp")
       FileUtils.mkdir_p(dir_path)
 
-      port_path = File.join(dir_path, "test_reporter_port")
+      # Remove in 1 month once updates have rolled out
+      legacy_port_path = File.join(dir_path, "test_reporter_port")
+      port_db_path = File.join(dir_path, "test_reporter_port_db.json")
       port = ENV["RUBY_LSP_REPORTER_PORT"]
 
       @io = begin
         # The environment variable is only used for tests. The extension always writes to the temporary file
         if port
           TCPSocket.new("localhost", port)
-        elsif File.exist?(port_path)
-          TCPSocket.new("localhost", File.read(port_path))
+        elsif File.exist?(port_db_path)
+          db = JSON.load_file(port_db_path)
+          TCPSocket.new("localhost", db[Dir.pwd])
+        elsif File.exist?(legacy_port_path)
+          TCPSocket.new("localhost", File.read(legacy_port_path))
         else
           # For tests that don't spawn the TCP server
           require "stringio"

data/lib/ruby_lsp/test_reporters/minitest_reporter.rb

@@ -8,7 +8,6 @@ rescue LoadError
 end
 
 require_relative "lsp_reporter"
-require "ruby_indexer/lib/ruby_indexer/uri"
 
 module RubyLsp
   # An override of the default progress reporter in Minitest to add color to the output
@@ -31,6 +30,30 @@ module RubyLsp
     end
   end
 
+  # This patch is here to prevent other gems from overriding or adding more Minitest reporters. Otherwise, they may
+  # break the integration between the server and extension
+  module PreventReporterOverridePatch
+    @lsp_reporters = [] #: Array[Minitest::AbstractReporter]
+
+    class << self
+      #: Array[Minitest::AbstractReporter]
+      attr_accessor :lsp_reporters
+    end
+
+    # Patch the writer to prevent replacing the entire array
+    #: (untyped) -> void
+    def reporters=(reporters)
+      # Do nothing. We don't want other gems to override our reporter
+    end
+
+    # Patch the reader to prevent appending more reporters. This method always returns a temporary copy of the real
+    # reporters so that if any gem mutates it, it continues to return the original reporters
+    #: -> Array[untyped]
+    def reporters
+      PreventReporterOverridePatch.lsp_reporters.dup
+    end
+  end
+
   class MinitestReporter < Minitest::AbstractReporter
     class << self
       #: (Hash[untyped, untyped]) -> void
@@ -46,6 +69,8 @@ module RubyLsp
 
         # Add the JSON RPC reporter
         reporters << MinitestReporter.new
+        PreventReporterOverridePatch.lsp_reporters = reporters
+        Minitest.reporter.class.prepend(PreventReporterOverridePatch)
       end
     end
 
@@ -54,15 +79,19 @@ module RubyLsp
       uri, line = LspReporter.instance.uri_and_line_for(test_class.instance_method(method_name))
       return unless uri
 
-      LspReporter.instance.start_test(id: "#{test_class.name}##{method_name}", uri: uri, line: line)
+      id = "#{test_class.name}##{handle_spec_test_id(method_name, line)}"
+      LspReporter.instance.start_test(id: id, uri: uri, line: line)
     end
 
     #: (Minitest::Result result) -> void
     def record(result)
-      id = "#{result.klass}##{result.name}"
-      file_path, _line = result.source_location
+      file_path, line = result.source_location
       return unless file_path
 
+      zero_based_line = line ? line - 1 : nil
+      name = handle_spec_test_id(result.name, zero_based_line)
+      id = "#{result.klass}##{name}"
+
       uri = URI::Generic.from_path(path: File.expand_path(file_path))
 
       if result.error?
@@ -82,6 +111,11 @@ module RubyLsp
     def report
       LspReporter.instance.shutdown
     end
+
+    #: (String, Integer?) -> String
+    def handle_spec_test_id(method_name, line)
+      method_name.gsub(/(?<=test_)\d{4}(?=_)/, format("%04d", line.to_s))
+    end
   end
 end
 

data/lib/ruby_lsp/test_reporters/test_unit_reporter.rb

@@ -10,7 +10,6 @@ rescue LoadError
 end
 
 require_relative "lsp_reporter"
-require "ruby_indexer/lib/ruby_indexer/uri"
 
 module RubyLsp
   class TestUnitReporter < Test::Unit::UI::Console::TestRunner

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.23.20
+  version: 0.23.22
 platform: ruby
 authors:
 - Shopify
@@ -52,7 +52,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -62,7 +62,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -84,6 +84,7 @@ executables:
 - ruby-lsp
 - ruby-lsp-check
 - ruby-lsp-launcher
+- ruby-lsp-test-exec
 extensions: []
 extra_rdoc_files: []
 files:
@@ -93,6 +94,7 @@ files:
 - exe/ruby-lsp
 - exe/ruby-lsp-check
 - exe/ruby-lsp-launcher
+- exe/ruby-lsp-test-exec
 - lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb
 - lib/rubocop/cop/ruby_lsp/use_register_with_handler_method.rb
 - lib/ruby-lsp.rb
@@ -228,7 +230,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: An opinionated language server for Ruby
 test_files: []