ruby-lsp 0.23.20 → 0.26.1

data/lib/ruby_lsp/global_state.rb

@@ -56,6 +56,17 @@ module RubyLsp
       @enabled_feature_flags = {} #: Hash[Symbol, bool]
       @mutex = Mutex.new #: Mutex
       @telemetry_machine_id = nil #: String?
+      @feature_configuration = {
+        inlayHint: RequestConfig.new({
+          enableAll: false,
+          implicitRescue: false,
+          implicitHashValue: false,
+        }),
+        codeLens: RequestConfig.new({
+          enableAll: false,
+          enableTestCodeLens: true,
+        }),
+      } #: Hash[Symbol, RequestConfig]
     end
 
     #: [T] { -> T } -> T
@@ -175,9 +186,19 @@ module RubyLsp
       @enabled_feature_flags = enabled_flags if enabled_flags
 
       @telemetry_machine_id = options.dig(:initializationOptions, :telemetryMachineId)
+
+      options.dig(:initializationOptions, :featuresConfiguration)&.each do |feature_name, config|
+        @feature_configuration[feature_name]&.merge!(config)
+      end
+
       notifications
     end
 
+    #: (Symbol) -> RequestConfig?
+    def feature_configuration(feature_name)
+      @feature_configuration[feature_name]
+    end
+
     #: (Symbol flag) -> bool?
     def enabled_feature?(flag)
       @enabled_feature_flags[:all] || @enabled_feature_flags[flag]

data/lib/ruby_lsp/internal.rb

@@ -6,8 +6,6 @@
 yarp_require_paths = Gem.loaded_specs["yarp"]&.full_require_paths
 $LOAD_PATH.delete_if { |path| yarp_require_paths.include?(path) } if yarp_require_paths
 
-require "sorbet-runtime"
-
 # Set Bundler's UI level to silent as soon as possible to prevent any prints to STDOUT
 require "bundler"
 Bundler.ui.level = :silent

data/lib/ruby_lsp/listeners/completion.rb

@@ -445,11 +445,14 @@ module RubyLsp
         return unless arguments_node
 
         path_node_to_complete = arguments_node.arguments.first
-
         return unless path_node_to_complete.is_a?(Prism::StringNode)
 
-        origin_dir = Pathname.new(@uri.to_standardized_path).dirname
+        # If the file is unsaved (e.g.: untitled:Untitled-1), we can't provide relative completion as we don't know
+        # where the user intends to save it
+        full_path = @uri.to_standardized_path
+        return unless full_path
 
+        origin_dir = Pathname.new(full_path).dirname
         content = path_node_to_complete.content
         # if the path is not a directory, glob all possible next characters
         # for example ../somethi| (where | is the cursor position)
@@ -516,6 +519,14 @@ module RubyLsp
 
           entry_name = entry.name
           owner_name = entry.owner&.name
+          new_text = entry_name
+
+          if entry_name.end_with?("=")
+            method_name = entry_name.delete_suffix("=")
+
+            # For writer methods, format as assignment and prefix "self." when no receiver is specified
+            new_text = node.receiver.nil? ? "self.#{method_name} = " : "#{method_name} = "
+          end
 
           label_details = Interface::CompletionItemLabelDetails.new(
             description: entry.file_name,
@@ -525,7 +536,7 @@ module RubyLsp
             label: entry_name,
             filter_text: entry_name,
             label_details: label_details,
-            text_edit: Interface::TextEdit.new(range: range, new_text: entry_name),
+            text_edit: Interface::TextEdit.new(range: range, new_text: new_text),
             kind: Constant::CompletionItemKind::METHOD,
             data: {
               owner_name: owner_name,

data/lib/ruby_lsp/listeners/hover.rb

@@ -7,6 +7,7 @@ module RubyLsp
       include Requests::Support::Common
 
       ALLOWED_TARGETS = [
+        Prism::BreakNode,
         Prism::CallNode,
         Prism::ConstantReadNode,
         Prism::ConstantWriteNode,
@@ -54,6 +55,7 @@ module RubyLsp
 
         dispatcher.register(
           self,
+          :on_break_node_enter,
           :on_constant_read_node_enter,
           :on_constant_write_node_enter,
           :on_constant_path_node_enter,
@@ -84,6 +86,11 @@ module RubyLsp
         )
       end
 
+      #: (Prism::BreakNode node) -> void
+      def on_break_node_enter(node)
+        handle_keyword_documentation(node.keyword)
+      end
+
       #: (Prism::StringNode node) -> void
       def on_string_node_enter(node)
         if @path && File.basename(@path) == GEMFILE_NAME

data/lib/ruby_lsp/listeners/inlay_hints.rb

@@ -8,10 +8,12 @@ module RubyLsp
 
       RESCUE_STRING_LENGTH = "rescue".length #: Integer
 
-      #: (ResponseBuilders::CollectionResponseBuilder[Interface::InlayHint] response_builder, RequestConfig hints_configuration, Prism::Dispatcher dispatcher) -> void
-      def initialize(response_builder, hints_configuration, dispatcher)
+      #: (GlobalState, ResponseBuilders::CollectionResponseBuilder[Interface::InlayHint], Prism::Dispatcher) -> void
+      def initialize(global_state, response_builder, dispatcher)
         @response_builder = response_builder
-        @hints_configuration = hints_configuration
+        @hints_configuration = ( # rubocop:disable Style/RedundantParentheses
+          global_state.feature_configuration(:inlayHint) #: as !nil
+        ) #: RequestConfig
 
         dispatcher.register(self, :on_rescue_node_enter, :on_implicit_node_enter)
       end

data/lib/ruby_lsp/listeners/spec_style.rb

@@ -4,39 +4,62 @@
 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
+        super(response_builder, global_state, uri)
 
-        @describe_block_nesting = [] #: Array[String]
-        @spec_class_stack = [] #: Array[bool]
+        @spec_group_id_stack = [] #: Array[Group?]
 
-        dispatcher.register(
-          self,
-          # Common handlers registered in parent class
+        register_events(
+          dispatcher,
           :on_class_node_enter,
-          :on_call_node_enter, # e.g. `describe` or `it`
+          :on_call_node_enter,
           :on_call_node_leave,
         )
       end
 
       #: (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)
+      def on_class_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
+        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
+        @spec_group_id_stack.pop
         super
+      end
 
-        @spec_class_stack.pop
+      #: (Prism::ModuleNode) -> void
+      def on_module_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
+        @spec_group_id_stack << nil
+        super
+      end
+
+      #: (Prism::ModuleNode) -> void
+      def on_module_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
+        @spec_group_id_stack.pop
+        super
       end
 
       #: (Prism::CallNode) -> void
-      def on_call_node_enter(node)
+      def on_call_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
+        return unless in_spec_context?
+
         case node.name
         when :describe
           handle_describe(node)
@@ -46,87 +69,74 @@ module RubyLsp
       end
 
       #: (Prism::CallNode) -> void
-      def on_call_node_leave(node)
+      def on_call_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         return unless node.name == :describe && !node.receiver
 
-        @describe_block_nesting.pop
+        current_group = @spec_group_id_stack.last
+        return unless current_group.is_a?(DescribeGroup)
+
+        description = extract_description(node)
+        return unless description && current_group.id.end_with?(description)
+
+        @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?
+        parent = latest_group
+        return unless parent
 
-        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)
+        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 +154,60 @@ module RubyLsp
         end
       end
 
+      #: -> (Requests::Support::TestItem | ResponseBuilders::TestCollection)?
+      def latest_group
+        # If we haven't found anything yet, then return the response builder
+        return @response_builder if @spec_group_id_stack.compact.empty?
+        # If we found something that isn't a group last, then we're inside a random module or class, but not a spec
+        # group
+        return unless @spec_group_id_stack.last
+
+        # Specs using at least one class as a group require special handling
+        closest_class_index = @spec_group_id_stack.rindex { |i| i.is_a?(ClassGroup) }
+
+        if closest_class_index
+          first_class_index = @spec_group_id_stack.index { |i| i.is_a?(ClassGroup) } #: as !nil
+          first_class = @spec_group_id_stack[first_class_index] #: 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[first_class_index + 1..closest_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[closest_class_index + 1..] #: as !nil
+            .each do |group|
+            next unless group
+
+            item = item[group.id] #: as !nil
+          end
+
+          return item
+        end
+
+        # Specs only using describes
+        first_group = @spec_group_id_stack.find { |i| i.is_a?(DescribeGroup) }
+        return unless first_group
+
+        item = @response_builder[first_group.id] #: as !nil
+
+        @spec_group_id_stack[1..] #: as !nil
+          .each do |group|
+          next unless group.is_a?(DescribeGroup)
+
+          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_discovery.rb

@@ -3,32 +3,23 @@
 
 module RubyLsp
   module Listeners
+    # @abstract
     class TestDiscovery
-      extend T::Helpers
-      abstract!
-
       include Requests::Support::Common
 
       DYNAMIC_REFERENCE_MARKER = "<dynamic_reference>"
 
-      #: (ResponseBuilders::TestCollection response_builder, GlobalState global_state, Prism::Dispatcher dispatcher, URI::Generic uri) -> void
-      def initialize(response_builder, global_state, dispatcher, uri)
+      #: (ResponseBuilders::TestCollection response_builder, GlobalState global_state, URI::Generic uri) -> void
+      def initialize(response_builder, global_state, uri)
         @response_builder = response_builder
         @uri = uri
         @index = global_state.index #: RubyIndexer::Index
         @visibility_stack = [:public] #: Array[Symbol]
         @nesting = [] #: Array[String]
-
-        dispatcher.register(
-          self,
-          :on_class_node_leave,
-          :on_module_node_enter,
-          :on_module_node_leave,
-        )
       end
 
       #: (Prism::ModuleNode node) -> void
-      def on_module_node_enter(node)
+      def on_module_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         @visibility_stack << :public
 
         name = constant_name(node.constant_path)
@@ -38,19 +29,31 @@ module RubyLsp
       end
 
       #: (Prism::ModuleNode node) -> void
-      def on_module_node_leave(node)
+      def on_module_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         @visibility_stack.pop
         @nesting.pop
       end
 
       #: (Prism::ClassNode node) -> void
-      def on_class_node_leave(node)
+      def on_class_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         @visibility_stack.pop
         @nesting.pop
       end
 
       private
 
+      #: (Prism::Dispatcher, *Symbol) -> void
+      def register_events(dispatcher, *events)
+        unique_events = events.dup.push(
+          :on_class_node_leave,
+          :on_module_node_enter,
+          :on_module_node_leave,
+        )
+
+        unique_events.uniq!
+        dispatcher.register(self, *unique_events)
+      end
+
       #: (String? name) -> String
       def calc_fully_qualified_name(name)
         RubyIndexer::Index.actual_nesting(@nesting, name).join("::")

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,10 @@ 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 << "#{COMMAND} -Itest -e \"ARGV.each { |f| require f }\" #{tests.join(" ")}" if tests.any?
+            commands << "#{COMMAND} -Ispec -e \"ARGV.each { |f| require f }\" #{specs.join(" ")}" if specs.any?
           end
 
           commands
@@ -82,10 +85,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| Shellwords.escape(e).gsub(/test_\d{4}/, "test_\\d{4}") }
             group_regex = Shellwords.escape(group).gsub(
               Shellwords.escape(TestDiscovery::DYNAMIC_REFERENCE_MARKER),
               ".*",
@@ -105,7 +113,8 @@ module RubyLsp
             "(#{regexes.join("|")})"
           end
 
-          "#{BASE_COMMAND} -Itest #{file_path} --name \"/#{regex}/\""
+          load_path = spec?(file_path) ? "-Ispec" : "-Itest"
+          "#{COMMAND} #{load_path} #{file_path} --name \"/#{regex}/\""
         end
 
         #: (String, Hash[String, Hash[Symbol, untyped]]) -> Array[String]
@@ -116,7 +125,7 @@ module RubyLsp
               Shellwords.escape(TestDiscovery::DYNAMIC_REFERENCE_MARKER),
               ".*",
             )
-            command = +"#{BASE_COMMAND} -Itest #{file_path} --testcase \"/^#{group_regex}\\$/\""
+            command = +"#{COMMAND} -Itest #{file_path} --testcase \"/^#{group_regex}\\$/\""
 
             unless examples.empty?
               command << if examples.length == 1
@@ -135,23 +144,24 @@ 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
-      ACCESS_MODIFIERS = [:public, :private, :protected].freeze
       BASE_COMMAND = begin
         Bundler.with_original_env { Bundler.default_lockfile }
         "bundle exec ruby"
       rescue Bundler::GemfileNotFound
         "ruby"
       end #: String
+      COMMAND = "#{BASE_COMMAND} -r#{MINITEST_REPORTER_PATH} -r#{TEST_UNIT_REPORTER_PATH}" #: String
+      ACCESS_MODIFIERS = [:public, :private, :protected].freeze
 
       #: (ResponseBuilders::TestCollection, GlobalState, Prism::Dispatcher, URI::Generic) -> void
       def initialize(response_builder, global_state, dispatcher, uri)
-        super
+        super(response_builder, global_state, uri)
 
         @framework = :minitest #: Symbol
+        @parent_stack = [@response_builder] #: Array[(Requests::Support::TestItem | ResponseBuilders::TestCollection)?]
 
-        dispatcher.register(
-          self,
-          # Common handlers registered in parent class
+        register_events(
+          dispatcher,
           :on_class_node_enter,
           :on_def_node_enter,
           :on_call_node_enter,
@@ -160,7 +170,7 @@ module RubyLsp
       end
 
       #: (Prism::ClassNode node) -> void
-      def on_class_node_enter(node)
+      def on_class_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         with_test_ancestor_tracking(node) do |name, ancestors|
           @framework = :test_unit if ancestors.include?("Test::Unit::TestCase")
 
@@ -173,26 +183,43 @@ 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)
+      def on_def_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         return if @visibility_stack.last != :public
 
         name = node.name.to_s
         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,12 +228,12 @@ 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
 
       #: (Prism::CallNode node) -> void
-      def on_call_node_enter(node)
+      def on_call_node_enter(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         name = node.name
         return unless ACCESS_MODIFIERS.include?(name)
 
@@ -214,7 +241,7 @@ module RubyLsp
       end
 
       #: (Prism::CallNode node) -> void
-      def on_call_node_leave(node)
+      def on_call_node_leave(node) # rubocop:disable RubyLsp/UseRegisterWithHandlerMethod
         name = node.name
         return unless ACCESS_MODIFIERS.include?(name)
         return unless node.arguments&.arguments
@@ -224,6 +251,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")