ruby-lsp 0.14.6 → 0.15.0

data/lib/ruby_lsp/listeners/document_symbol.rb

@@ -12,17 +12,20 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::DocumentSymbol,
+          uri: URI::Generic,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(response_builder, dispatcher)
+      def initialize(response_builder, uri, dispatcher)
         @response_builder = response_builder
+        @uri = uri
 
         dispatcher.register(
           self,
           :on_class_node_enter,
           :on_class_node_leave,
           :on_call_node_enter,
+          :on_call_node_leave,
           :on_constant_path_write_node_enter,
           :on_constant_write_node_enter,
           :on_constant_path_or_write_node_enter,
@@ -79,10 +82,24 @@ module RubyLsp
 
       sig { params(node: Prism::CallNode).void }
       def on_call_node_enter(node)
-        if ATTR_ACCESSORS.include?(node.name)
+        node_name = node.name
+        if ATTR_ACCESSORS.include?(node_name)
           handle_attr_accessor(node)
-        elsif node.name == :alias_method
+        elsif node_name == :alias_method
           handle_alias_method(node)
+        elsif node_name == :namespace
+          handle_rake_namespace(node)
+        elsif node_name == :task
+          handle_rake_task(node)
+        end
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def on_call_node_leave(node)
+        return unless rake?
+
+        if node.name == :namespace && !node.receiver
+          @response_builder.pop
         end
       end
 
@@ -279,6 +296,7 @@ module RubyLsp
         ).returns(Interface::DocumentSymbol)
       end
       def create_document_symbol(name:, kind:, range_location:, selection_range_location:)
+        name = "<blank>" if name.empty?
         symbol = Interface::DocumentSymbol.new(
           name: name,
           kind: kind,
@@ -357,6 +375,76 @@ module RubyLsp
           )
         end
       end
+
+      sig { params(node: Prism::CallNode).void }
+      def handle_rake_namespace(node)
+        return unless rake?
+        return if node.receiver
+
+        arguments = node.arguments
+        return unless arguments
+
+        name_argument = arguments.arguments.first
+        return unless name_argument
+
+        name = case name_argument
+        when Prism::StringNode then name_argument.content
+        when Prism::SymbolNode then name_argument.value
+        end
+
+        return if name.nil? || name.empty?
+
+        @response_builder << create_document_symbol(
+          name: name,
+          kind: Constant::SymbolKind::MODULE,
+          range_location: name_argument.location,
+          selection_range_location: name_argument.location,
+        )
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def handle_rake_task(node)
+        return unless rake?
+        return if node.receiver
+
+        arguments = node.arguments
+        return unless arguments
+
+        name_argument = arguments.arguments.first
+        return unless name_argument
+
+        name = case name_argument
+        when Prism::StringNode then name_argument.content
+        when Prism::SymbolNode then name_argument.value
+        when Prism::KeywordHashNode
+          first_element = name_argument.elements.first
+          if first_element.is_a?(Prism::AssocNode)
+            key = first_element.key
+            case key
+            when Prism::StringNode then key.content
+            when Prism::SymbolNode then key.value
+            end
+          end
+        end
+
+        return if name.nil? || name.empty?
+
+        create_document_symbol(
+          name: name,
+          kind: Constant::SymbolKind::METHOD,
+          range_location: name_argument.location,
+          selection_range_location: name_argument.location,
+        )
+      end
+
+      sig { returns(T::Boolean) }
+      def rake?
+        if (path = @uri.to_standardized_path)
+          path.match?(/(Rakefile|\.rake)$/)
+        else
+          false
+        end
+      end
     end
   end
 end

data/lib/ruby_lsp/listeners/hover.rb

@@ -28,18 +28,19 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::Hover,
+          global_state: GlobalState,
           uri: URI::Generic,
           nesting: T::Array[String],
-          index: RubyIndexer::Index,
           dispatcher: Prism::Dispatcher,
           typechecker_enabled: T::Boolean,
         ).void
       end
-      def initialize(response_builder, uri, nesting, index, dispatcher, typechecker_enabled) # rubocop:disable Metrics/ParameterLists
+      def initialize(response_builder, global_state, uri, nesting, dispatcher, typechecker_enabled) # rubocop:disable Metrics/ParameterLists
         @response_builder = response_builder
+        @global_state = global_state
+        @index = T.let(global_state.index, RubyIndexer::Index)
         @path = T.let(uri.to_standardized_path, T.nilable(String))
         @nesting = nesting
-        @index = index
         @typechecker_enabled = typechecker_enabled
 
         dispatcher.register(
@@ -63,14 +64,14 @@ module RubyLsp
 
       sig { params(node: Prism::ConstantWriteNode).void }
       def on_constant_write_node_enter(node)
-        return if DependencyDetector.instance.typechecker
+        return if @global_state.typechecker
 
         generate_hover(node.name.to_s, node.name_loc)
       end
 
       sig { params(node: Prism::ConstantPathNode).void }
       def on_constant_path_node_enter(node)
-        return if DependencyDetector.instance.typechecker
+        return if @global_state.typechecker
 
         name = constant_name(node)
         return if name.nil?

data/lib/ruby_lsp/listeners/signature_help.rb

@@ -10,21 +10,24 @@ module RubyLsp
       sig do
         params(
           response_builder: ResponseBuilders::SignatureHelp,
+          global_state: GlobalState,
           nesting: T::Array[String],
-          index: RubyIndexer::Index,
           dispatcher: Prism::Dispatcher,
+          typechecker_enabled: T::Boolean,
         ).void
       end
-      def initialize(response_builder, nesting, index, dispatcher)
+      def initialize(response_builder, global_state, nesting, dispatcher, typechecker_enabled)
+        @typechecker_enabled = typechecker_enabled
         @response_builder = response_builder
+        @global_state = global_state
+        @index = T.let(global_state.index, RubyIndexer::Index)
         @nesting = nesting
-        @index = index
         dispatcher.register(self, :on_call_node_enter)
       end
 
       sig { params(node: Prism::CallNode).void }
       def on_call_node_enter(node)
-        return if DependencyDetector.instance.typechecker
+        return if @typechecker_enabled
         return unless self_receiver?(node)
 
         message = node.message

data/lib/ruby_lsp/load_sorbet.rb

@@ -0,0 +1,62 @@
+# typed: true
+# frozen_string_literal: true
+
+require "sorbet-runtime"
+
+begin
+  T::Configuration.default_checked_level = :never
+  # Suppresses call validation errors
+  T::Configuration.call_validation_error_handler = ->(*) {}
+  # Suppresses errors caused by T.cast, T.let, T.must, etc.
+  T::Configuration.inline_type_error_handler = ->(*) {}
+  # Suppresses errors caused by incorrect parameter ordering
+  T::Configuration.sig_validation_error_handler = ->(*) {}
+rescue
+  # Need this rescue so that if another gem has
+  # already set the checked level by the time we
+  # get to it, we don't fail outright.
+  nil
+end
+
+module RubyLsp
+  # No-op all inline type assertions defined in T
+  module InlineTypeAssertions
+    def absurd(value)
+      value
+    end
+
+    def any(type_a, type_b, *types)
+      T::Types::Union.new([type_a, type_b, *types])
+    end
+
+    def assert_type!(value, type, checked: true)
+      value
+    end
+
+    def bind(value, type, checked: true)
+      value
+    end
+
+    def cast(value, type, checked: true)
+      value
+    end
+
+    def let(value, type, checked: true)
+      value
+    end
+
+    def must(arg)
+      arg
+    end
+
+    def nilable(type)
+      T::Types::Union.new([type, T::Utils::Nilable::NIL_TYPE])
+    end
+
+    def unsafe(value)
+      value
+    end
+
+    T.singleton_class.prepend(self)
+  end
+end

data/lib/ruby_lsp/requests/code_lens.rb

@@ -34,20 +34,21 @@ module RubyLsp
 
       sig do
         params(
+          global_state: GlobalState,
           uri: URI::Generic,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(uri, dispatcher)
+      def initialize(global_state, uri, dispatcher)
         @response_builder = T.let(
           ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens].new,
           ResponseBuilders::CollectionResponseBuilder[Interface::CodeLens],
         )
         super()
-        Listeners::CodeLens.new(@response_builder, uri, dispatcher)
+        Listeners::CodeLens.new(@response_builder, global_state, uri, dispatcher)
 
         Addon.addons.each do |addon|
-          addon.create_code_lens_listener(@response_builder, uri, dispatcher)
+          addon.create_code_lens_listener(@response_builder, global_state, uri, dispatcher)
         end
       end
 

data/lib/ruby_lsp/requests/completion.rb

@@ -33,7 +33,7 @@ module RubyLsp
         sig { returns(Interface::CompletionOptions) }
         def provider
           Interface::CompletionOptions.new(
-            resolve_provider: false,
+            resolve_provider: true,
             trigger_characters: ["/", "\"", "'"],
             completion_item: {
               labelDetailsSupport: true,
@@ -45,13 +45,13 @@ module RubyLsp
       sig do
         params(
           document: Document,
-          index: RubyIndexer::Index,
+          global_state: GlobalState,
           position: T::Hash[Symbol, T.untyped],
           typechecker_enabled: T::Boolean,
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(document, index, position, typechecker_enabled, dispatcher)
+      def initialize(document, global_state, position, typechecker_enabled, dispatcher)
         super()
         @target = T.let(nil, T.nilable(Prism::Node))
         @dispatcher = dispatcher
@@ -68,7 +68,18 @@ module RubyLsp
           ResponseBuilders::CollectionResponseBuilder[Interface::CompletionItem],
         )
 
-        Listeners::Completion.new(@response_builder, index, nesting, typechecker_enabled, dispatcher, document.uri)
+        Listeners::Completion.new(
+          @response_builder,
+          global_state,
+          nesting,
+          typechecker_enabled,
+          dispatcher,
+          document.uri,
+        )
+
+        Addon.addons.each do |addon|
+          addon.create_completion_listener(@response_builder, global_state, nesting, dispatcher, document.uri)
+        end
 
         return unless matched && parent
 

data/lib/ruby_lsp/requests/completion_resolve.rb

@@ -0,0 +1,56 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    # ![Completion resolve demo](../../completion_resolve.gif)
+    #
+    # The [completionItem/resolve](https://microsoft.github.io/language-server-protocol/specification#completionItem_resolve)
+    # request provides additional information about the currently selected completion. Specifically, the `labelDetails`
+    # and `documentation` fields are provided, which are omitted from the completion items returned by
+    # `textDocument/completion`.
+    #
+    # The `labelDetails` field lists the files where the completion item is defined, and the `documentation` field
+    # includes any available documentation for those definitions.
+    #
+    # At most 10 definitions are included, to ensure low latency during request processing and rendering the completion
+    # item.
+    #
+    # # Example
+    #
+    # ```ruby
+    # A # -> as the user cycles through completion items, the documentation will be resolved and displayed
+    # ```
+    class CompletionResolve < Request
+      extend T::Sig
+      include Requests::Support::Common
+
+      # set a limit on the number of documentation entries returned, to avoid rendering performance issues
+      # https://github.com/Shopify/ruby-lsp/pull/1798
+      MAX_DOCUMENTATION_ENTRIES = 10
+
+      sig { params(global_state: GlobalState, item: T::Hash[Symbol, T.untyped]).void }
+      def initialize(global_state, item)
+        super()
+        @index = T.let(global_state.index, RubyIndexer::Index)
+        @item = item
+      end
+
+      sig { override.returns(Interface::CompletionItem) }
+      def perform
+        label = @item[:label]
+        entries = @index[label] || []
+        Interface::CompletionItem.new(
+          label: label,
+          label_details: Interface::CompletionItemLabelDetails.new(
+            description: entries.take(MAX_DOCUMENTATION_ENTRIES).map(&:file_name).join(","),
+          ),
+          documentation: Interface::MarkupContent.new(
+            kind: "markdown",
+            value: markdown_from_index_entries(label, entries, MAX_DOCUMENTATION_ENTRIES),
+          ),
+        )
+      end
+    end
+  end
+end

data/lib/ruby_lsp/requests/definition.rb

@@ -31,13 +31,13 @@ module RubyLsp
       sig do
         params(
           document: Document,
-          index: RubyIndexer::Index,
+          global_state: GlobalState,
           position: T::Hash[Symbol, T.untyped],
           dispatcher: Prism::Dispatcher,
           typechecker_enabled: T::Boolean,
         ).void
       end
-      def initialize(document, index, position, dispatcher, typechecker_enabled)
+      def initialize(document, global_state, position, dispatcher, typechecker_enabled)
         super()
         @response_builder = T.let(
           ResponseBuilders::CollectionResponseBuilder[Interface::Location].new,
@@ -57,10 +57,17 @@ module RubyLsp
           )
         end
 
-        Listeners::Definition.new(@response_builder, document.uri, nesting, index, dispatcher, typechecker_enabled)
+        Listeners::Definition.new(
+          @response_builder,
+          global_state,
+          document.uri,
+          nesting,
+          dispatcher,
+          typechecker_enabled,
+        )
 
         Addon.addons.each do |addon|
-          addon.create_definition_listener(@response_builder, document.uri, nesting, index, dispatcher)
+          addon.create_definition_listener(@response_builder, global_state, document.uri, nesting, dispatcher)
         end
 
         @target = T.let(target, T.nilable(Prism::Node))

data/lib/ruby_lsp/requests/document_symbol.rb

@@ -45,11 +45,11 @@ module RubyLsp
         end
       end
 
-      sig { params(dispatcher: Prism::Dispatcher).void }
-      def initialize(dispatcher)
+      sig { params(uri: URI::Generic, dispatcher: Prism::Dispatcher).void }
+      def initialize(uri, dispatcher)
         super()
         @response_builder = T.let(ResponseBuilders::DocumentSymbol.new, ResponseBuilders::DocumentSymbol)
-        Listeners::DocumentSymbol.new(@response_builder, dispatcher)
+        Listeners::DocumentSymbol.new(@response_builder, uri, dispatcher)
 
         Addon.addons.each do |addon|
           addon.create_document_symbol_listener(@response_builder, dispatcher)

data/lib/ruby_lsp/requests/hover.rb

@@ -33,13 +33,13 @@ module RubyLsp
       sig do
         params(
           document: Document,
-          index: RubyIndexer::Index,
+          global_state: GlobalState,
           position: T::Hash[Symbol, T.untyped],
           dispatcher: Prism::Dispatcher,
           typechecker_enabled: T::Boolean,
         ).void
       end
-      def initialize(document, index, position, dispatcher, typechecker_enabled)
+      def initialize(document, global_state, position, dispatcher, typechecker_enabled)
         super()
         @target = T.let(nil, T.nilable(Prism::Node))
         @target, parent, nesting = document.locate_node(
@@ -62,9 +62,9 @@ module RubyLsp
 
         uri = document.uri
         @response_builder = T.let(ResponseBuilders::Hover.new, ResponseBuilders::Hover)
-        Listeners::Hover.new(@response_builder, uri, nesting, index, dispatcher, typechecker_enabled)
+        Listeners::Hover.new(@response_builder, global_state, uri, nesting, dispatcher, typechecker_enabled)
         Addon.addons.each do |addon|
-          addon.create_hover_listener(@response_builder, nesting, index, dispatcher)
+          addon.create_hover_listener(@response_builder, global_state, nesting, dispatcher)
         end
 
         @dispatcher = dispatcher

data/lib/ruby_lsp/requests/signature_help.rb

@@ -42,13 +42,14 @@ module RubyLsp
       sig do
         params(
           document: Document,
-          index: RubyIndexer::Index,
+          global_state: GlobalState,
           position: T::Hash[Symbol, T.untyped],
           context: T.nilable(T::Hash[Symbol, T.untyped]),
           dispatcher: Prism::Dispatcher,
+          typechecker_enabled: T::Boolean,
         ).void
       end
-      def initialize(document, index, position, context, dispatcher)
+      def initialize(document, global_state, position, context, dispatcher, typechecker_enabled) # rubocop:disable Metrics/ParameterLists
         super()
         target, parent, nesting = document.locate_node(
           { line: position[:line], character: position[:character] },
@@ -60,7 +61,7 @@ module RubyLsp
         @target = T.let(target, T.nilable(Prism::Node))
         @dispatcher = dispatcher
         @response_builder = T.let(ResponseBuilders::SignatureHelp.new, ResponseBuilders::SignatureHelp)
-        Listeners::SignatureHelp.new(@response_builder, nesting, index, dispatcher)
+        Listeners::SignatureHelp.new(@response_builder, global_state, nesting, dispatcher, typechecker_enabled)
       end
 
       sig { override.returns(T.nilable(Interface::SignatureHelp)) }

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

@@ -86,13 +86,16 @@ module RubyLsp
           params(
             title: String,
             entries: T.any(T::Array[RubyIndexer::Entry], RubyIndexer::Entry),
+            max_entries: T.nilable(Integer),
           ).returns(T::Hash[Symbol, String])
         end
-        def categorized_markdown_from_index_entries(title, entries)
+        def categorized_markdown_from_index_entries(title, entries, max_entries = nil)
           markdown_title = "```ruby\n#{title}\n```"
           definitions = []
           content = +""
-          Array(entries).each do |entry|
+          entries = Array(entries)
+          entries_to_format = max_entries ? entries.take(max_entries) : entries
+          entries_to_format.each do |entry|
             loc = entry.location
 
             # We always handle locations as zero based. However, for file links in Markdown we need them to be one
@@ -108,9 +111,16 @@ module RubyLsp
             content << "\n\n#{entry.comments.join("\n")}" unless entry.comments.empty?
           end
 
+          additional_entries_text = if max_entries && entries.length > max_entries
+            additional = entries.length - max_entries
+            " | #{additional} other#{additional > 1 ? "s" : ""}"
+          else
+            ""
+          end
+
           {
             title: markdown_title,
-            links: "**Definitions**: #{definitions.join(" | ")}",
+            links: "**Definitions**: #{definitions.join(" | ")}#{additional_entries_text}",
             documentation: content,
           }
         end
@@ -119,10 +129,11 @@ module RubyLsp
           params(
             title: String,
             entries: T.any(T::Array[RubyIndexer::Entry], RubyIndexer::Entry),
+            max_entries: T.nilable(Integer),
           ).returns(String)
         end
-        def markdown_from_index_entries(title, entries)
-          categorized_markdown = categorized_markdown_from_index_entries(title, entries)
+        def markdown_from_index_entries(title, entries, max_entries = nil)
+          categorized_markdown = categorized_markdown_from_index_entries(title, entries, max_entries)
 
           <<~MARKDOWN.chomp
             #{categorized_markdown[:title]}

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

@@ -92,6 +92,10 @@ module RubyLsp
           @options[:stdin] = contents
 
           super([path])
+
+          # RuboCop rescues interrupts and then sets the `@aborting` variable to true. We don't want them to be rescued,
+          # so here we re-raise in case RuboCop received an interrupt.
+          raise Interrupt if aborting?
         rescue RuboCop::Runner::InfiniteCorrectionLoop => error
           raise Formatting::Error, error.message
         rescue RuboCop::ValidationError => error

data/lib/ruby_lsp/requests/workspace_symbol.rb

@@ -22,11 +22,12 @@ module RubyLsp
       extend T::Sig
       include Support::Common
 
-      sig { params(query: T.nilable(String), index: RubyIndexer::Index).void }
-      def initialize(query, index)
+      sig { params(global_state: GlobalState, query: T.nilable(String)).void }
+      def initialize(global_state, query)
         super()
+        @global_state = global_state
         @query = query
-        @index = index
+        @index = T.let(global_state.index, RubyIndexer::Index)
       end
 
       sig { override.returns(T::Array[Interface::WorkspaceSymbol]) }
@@ -35,7 +36,7 @@ module RubyLsp
           # If the project is using Sorbet, we let Sorbet handle symbols defined inside the project itself and RBIs, but
           # we still return entries defined in gems to allow developers to jump directly to the source
           file_path = entry.file_path
-          next if DependencyDetector.instance.typechecker && not_in_dependencies?(file_path)
+          next if @global_state.typechecker && not_in_dependencies?(file_path)
 
           # We should never show private symbols when searching the entire workspace
           next if entry.visibility == :private

data/lib/ruby_lsp/requests.rb

@@ -18,6 +18,7 @@ module RubyLsp
   # - [DocumentHighlight](rdoc-ref:RubyLsp::Requests::DocumentHighlight)
   # - [InlayHint](rdoc-ref:RubyLsp::Requests::InlayHints)
   # - [Completion](rdoc-ref:RubyLsp::Requests::Completion)
+  # - [CompletionResolve](rdoc-ref:RubyLsp::Requests::CompletionResolve)
   # - [CodeLens](rdoc-ref:RubyLsp::Requests::CodeLens)
   # - [Definition](rdoc-ref:RubyLsp::Requests::Definition)
   # - [ShowSyntaxTree](rdoc-ref:RubyLsp::Requests::ShowSyntaxTree)
@@ -40,6 +41,7 @@ module RubyLsp
     autoload :DocumentHighlight, "ruby_lsp/requests/document_highlight"
     autoload :InlayHints, "ruby_lsp/requests/inlay_hints"
     autoload :Completion, "ruby_lsp/requests/completion"
+    autoload :CompletionResolve, "ruby_lsp/requests/completion_resolve"
     autoload :CodeLens, "ruby_lsp/requests/code_lens"
     autoload :Definition, "ruby_lsp/requests/definition"
     autoload :ShowSyntaxTree, "ruby_lsp/requests/show_syntax_tree"