ruby-lsp 0.17.17 → 0.18.1

data/lib/ruby_lsp/listeners/signature_help.rb

@@ -42,17 +42,46 @@ module RubyLsp
         target_method = methods.first
         return unless target_method
 
-        parameters = target_method.parameters
-        name = target_method.name
+        signatures = target_method.signatures
 
         # If the method doesn't have any parameters, there's no need to show signature help
-        return if parameters.empty?
+        return if signatures.empty?
+
+        name = target_method.name
+        title = +""
+
+        extra_links = if type.is_a?(TypeInferrer::GuessedType)
+          title << "\n\nGuessed receiver: #{type.name}"
+          "[Learn more about guessed types](#{GUESSED_TYPES_URL})"
+        end
 
-        label = "#{name}(#{parameters.map(&:decorated_name).join(", ")})"
+        active_signature, active_parameter = determine_active_signature_and_parameter(node, signatures)
 
+        signature_help = Interface::SignatureHelp.new(
+          signatures: generate_signatures(signatures, name, methods, title, extra_links),
+          active_signature: active_signature,
+          active_parameter: active_parameter,
+        )
+        @response_builder.replace(signature_help)
+      end
+
+      private
+
+      sig do
+        params(node: Prism::CallNode, signatures: T::Array[RubyIndexer::Entry::Signature]).returns([Integer, Integer])
+      end
+      def determine_active_signature_and_parameter(node, signatures)
         arguments_node = node.arguments
         arguments = arguments_node&.arguments || []
-        active_parameter = (arguments.length - 1).clamp(0, parameters.length - 1)
+
+        # Find the first signature that matches the current arguments. If the user is invoking a method incorrectly and
+        # none of the signatures match, we show the first one
+        active_sig_index = signatures.find_index do |signature|
+          signature.matches?(arguments)
+        end || 0
+
+        parameter_length = [T.must(signatures[active_sig_index]).parameters.length - 1, 0].max
+        active_parameter = (arguments.length - 1).clamp(0, parameter_length)
 
         # If there are arguments, then we need to check if there's a trailing comma after the end of the last argument
         # to advance the active parameter to the next one
@@ -61,27 +90,29 @@ module RubyLsp
           active_parameter += 1
         end
 
-        title = +""
-
-        extra_links = if type.is_a?(TypeInferrer::GuessedType)
-          title << "\n\nGuessed receiver: #{type.name}"
-          "[Learn more about guessed types](#{GUESSED_TYPES_URL})"
-        end
+        [active_sig_index, active_parameter]
+      end
 
-        signature_help = Interface::SignatureHelp.new(
-          signatures: [
-            Interface::SignatureInformation.new(
-              label: label,
-              parameters: parameters.map { |param| Interface::ParameterInformation.new(label: param.name) },
-              documentation: Interface::MarkupContent.new(
-                kind: "markdown",
-                value: markdown_from_index_entries(title, methods, extra_links: extra_links),
-              ),
+      sig do
+        params(
+          signatures: T::Array[RubyIndexer::Entry::Signature],
+          method_name: String,
+          methods: T::Array[RubyIndexer::Entry],
+          title: String,
+          extra_links: T.nilable(String),
+        ).returns(T::Array[Interface::SignatureInformation])
+      end
+      def generate_signatures(signatures, method_name, methods, title, extra_links)
+        signatures.map do |signature|
+          Interface::SignatureInformation.new(
+            label:  "#{method_name}(#{signature.format})",
+            parameters: signature.parameters.map { |param| Interface::ParameterInformation.new(label: param.name) },
+            documentation: Interface::MarkupContent.new(
+              kind: "markdown",
+              value: markdown_from_index_entries(title, methods, extra_links: extra_links),
             ),
-          ],
-          active_parameter: active_parameter,
-        )
-        @response_builder.replace(signature_help)
+          )
+        end
       end
     end
   end

data/lib/ruby_lsp/rbs_document.rb

@@ -14,18 +14,19 @@ module RubyLsp
       super
     end
 
-    sig { override.returns(ParseResultType) }
-    def parse
-      return @parse_result unless @needs_parsing
+    sig { override.returns(T::Boolean) }
+    def parse!
+      return false unless @needs_parsing
 
       @needs_parsing = false
 
       _, _, declarations = RBS::Parser.parse_signature(@source)
       @syntax_error = false
       @parse_result = declarations
+      true
     rescue RBS::ParsingError
       @syntax_error = true
-      @parse_result
+      true
     end
 
     sig { override.returns(T::Boolean) }

data/lib/ruby_lsp/requests/code_action_resolve.rb

@@ -3,24 +3,9 @@
 
 module RubyLsp
   module Requests
-    # ![Code action resolve demo](../../code_action_resolve.gif)
-    #
     # The [code action resolve](https://microsoft.github.io/language-server-protocol/specification#codeAction_resolve)
     # request is used to to resolve the edit field for a given code action, if it is not already provided in the
     # textDocument/codeAction response. We can use it for scenarios that require more computation such as refactoring.
-    #
-    # # Example: Extract to variable
-    #
-    # ```ruby
-    # # Before:
-    # 1 + 1 # Select the text and use Refactor: Extract Variable
-    #
-    # # After:
-    # new_variable = 1 + 1
-    # new_variable
-    #
-    # ```
-    #
     class CodeActionResolve < Request
       extend T::Sig
       include Support::Common

data/lib/ruby_lsp/requests/code_actions.rb

@@ -3,19 +3,9 @@
 
 module RubyLsp
   module Requests
-    # ![Code actions demo](../../code_actions.gif)
-    #
     # The [code actions](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeAction)
     # request informs the editor of RuboCop quick fixes that can be applied. These are accessible by hovering over a
     # specific diagnostic.
-    #
-    # # Example
-    #
-    # ```ruby
-    # def say_hello
-    # puts "Hello" # --> code action: quick fix indentation
-    # end
-    # ```
     class CodeActions < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/code_lens.rb

@@ -7,19 +7,9 @@ require "ruby_lsp/listeners/code_lens"
 
 module RubyLsp
   module Requests
-    # ![Code lens demo](../../code_lens.gif)
-    #
     # The
     # [code lens](https://microsoft.github.io/language-server-protocol/specification#textDocument_codeLens)
-    # request informs the editor of runnable commands such as testing and debugging
-    #
-    # # Example
-    #
-    # ```ruby
-    # # Run | Run in Terminal | Debug
-    # class Test < Minitest::Test
-    # end
-    # ```
+    # request informs the editor of runnable commands such as testing and debugging.
     class CodeLens < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/completion.rb

@@ -5,27 +5,8 @@ require "ruby_lsp/listeners/completion"
 
 module RubyLsp
   module Requests
-    # ![Completion demo](../../completion.gif)
-    #
     # The [completion](https://microsoft.github.io/language-server-protocol/specification#textDocument_completion)
     # suggests possible completions according to what the developer is typing.
-    #
-    # Currently supported targets:
-    #
-    # - Classes
-    # - Modules
-    # - Constants
-    # - Require paths
-    # - Methods invoked on self only
-    # - Instance variables
-    #
-    # # Example
-    #
-    # ```ruby
-    # require "ruby_lsp/requests" # --> completion: suggests `base_request`, `code_actions`, ...
-    #
-    # RubyLsp::Requests:: # --> completion: suggests `Completion`, `Hover`, ...
-    # ```
     class Completion < Request
       extend T::Sig
 
@@ -36,7 +17,7 @@ module RubyLsp
         def provider
           Interface::CompletionOptions.new(
             resolve_provider: true,
-            trigger_characters: ["/", "\"", "'", ":", "@", "."],
+            trigger_characters: ["/", "\"", "'", ":", "@", ".", "=", "<"],
             completion_item: {
               labelDetailsSupport: true,
             },
@@ -60,6 +41,8 @@ module RubyLsp
         # Completion always receives the position immediately after the character that was just typed. Here we adjust it
         # back by 1, so that we find the right node
         char_position = document.create_scanner.find_char_position(params[:position]) - 1
+        delegate_request_if_needed!(global_state, document, char_position)
+
         node_context = RubyDocument.locate(
           document.parse_result.value,
           char_position,

data/lib/ruby_lsp/requests/completion_resolve.rb

@@ -3,8 +3,6 @@
 
 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
@@ -15,12 +13,6 @@ module RubyLsp
     #
     # 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

data/lib/ruby_lsp/requests/definition.rb

@@ -5,27 +5,9 @@ require "ruby_lsp/listeners/definition"
 
 module RubyLsp
   module Requests
-    # ![Definition demo](../../definition.gif)
-    #
     # The [definition
     # request](https://microsoft.github.io/language-server-protocol/specification#textDocument_definition) jumps to the
     # definition of the symbol under the cursor.
-    #
-    # Currently supported targets:
-    #
-    # - Classes
-    # - Modules
-    # - Constants
-    # - Require paths
-    # - Methods invoked on self only and on receivers where the type is unknown
-    # - Instance variables
-    #
-    # # Example
-    #
-    # ```ruby
-    # require "some_gem/file" # <- Request go to definition on this string will take you to the file
-    # Product.new # <- Request go to definition on this class name will take you to its declaration.
-    # ```
     class Definition < Request
       extend T::Sig
       extend T::Generic
@@ -53,8 +35,12 @@ module RubyLsp
         )
         @dispatcher = dispatcher
 
-        node_context = document.locate_node(
-          position,
+        char_position = document.create_scanner.find_char_position(position)
+        delegate_request_if_needed!(global_state, document, char_position)
+
+        node_context = RubyDocument.locate(
+          document.parse_result.value,
+          char_position,
           node_types: [
             Prism::CallNode,
             Prism::ConstantReadNode,

data/lib/ruby_lsp/requests/diagnostics.rb

@@ -3,19 +3,9 @@
 
 module RubyLsp
   module Requests
-    # ![Diagnostics demo](../../diagnostics.gif)
-    #
     # The
     # [diagnostics](https://microsoft.github.io/language-server-protocol/specification#textDocument_publishDiagnostics)
     # request informs the editor of RuboCop offenses for a given file.
-    #
-    # # Example
-    #
-    # ```ruby
-    # def say_hello
-    # puts "Hello" # --> diagnostics: incorrect indentation
-    # end
-    # ```
     class Diagnostics < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/document_highlight.rb

@@ -5,8 +5,6 @@ require "ruby_lsp/listeners/document_highlight"
 
 module RubyLsp
   module Requests
-    # ![Document highlight demo](../../document_highlight.gif)
-    #
     # The [document highlight](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentHighlight)
     # informs the editor all relevant elements of the currently pointed item for highlighting. For example, when
     # the cursor is on the `F` of the constant `FOO`, the editor should identify other occurrences of `FOO`
@@ -14,29 +12,24 @@ module RubyLsp
     #
     # For writable elements like constants or variables, their read/write occurrences should be highlighted differently.
     # This is achieved by sending different "kind" attributes to the editor (2 for read and 3 for write).
-    #
-    # # Example
-    #
-    # ```ruby
-    # FOO = 1 # should be highlighted as "write"
-    #
-    # def foo
-    #   FOO # should be highlighted as "read"
-    # end
-    # ```
     class DocumentHighlight < Request
       extend T::Sig
 
       sig do
         params(
+          global_state: GlobalState,
           document: T.any(RubyDocument, ERBDocument),
           position: T::Hash[Symbol, T.untyped],
           dispatcher: Prism::Dispatcher,
         ).void
       end
-      def initialize(document, position, dispatcher)
+      def initialize(global_state, document, position, dispatcher)
         super()
-        node_context = document.locate_node(position)
+        char_position = document.create_scanner.find_char_position(position)
+        delegate_request_if_needed!(global_state, document, char_position)
+
+        node_context = RubyDocument.locate(document.parse_result.value, char_position)
+
         @response_builder = T.let(
           ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight].new,
           ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight],

data/lib/ruby_lsp/requests/document_link.rb

@@ -5,19 +5,9 @@ require "ruby_lsp/listeners/document_link"
 
 module RubyLsp
   module Requests
-    # ![Document link demo](../../document_link.gif)
-    #
     # The [document link](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentLink)
     # makes `# source://PATH_TO_FILE#line` comments in a Ruby/RBI file clickable if the file exists.
     # When the user clicks the link, it'll open that location.
-    #
-    # # Example
-    #
-    # ```ruby
-    # # source://syntax_tree/3.2.1/lib/syntax_tree.rb#51 <- it will be clickable and will take the user to that location
-    # def format(source, maxwidth = T.unsafe(nil))
-    # end
-    # ```
     class DocumentLink < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/document_symbol.rb

@@ -5,29 +5,12 @@ require "ruby_lsp/listeners/document_symbol"
 
 module RubyLsp
   module Requests
-    # ![Document symbol demo](../../document_symbol.gif)
-    #
     # The [document
     # symbol](https://microsoft.github.io/language-server-protocol/specification#textDocument_documentSymbol) request
     # informs the editor of all the important symbols, such as classes, variables, and methods, defined in a file. With
     # this information, the editor can populate breadcrumbs, file outline and allow for fuzzy symbol searches.
     #
     # In VS Code, fuzzy symbol search can be accessed by opening the command palette and inserting an `@` symbol.
-    #
-    # # Example
-    #
-    # ```ruby
-    # class Person # --> document symbol: class
-    #   attr_reader :age # --> document symbol: field
-    #
-    #   def initialize
-    #     @age = 0 # --> document symbol: variable
-    #   end
-    #
-    #   def age # --> document symbol: method
-    #   end
-    # end
-    # ```
     class DocumentSymbol < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/folding_ranges.rb

@@ -5,18 +5,8 @@ require "ruby_lsp/listeners/folding_ranges"
 
 module RubyLsp
   module Requests
-    # ![Folding ranges demo](../../folding_ranges.gif)
-    #
     # The [folding ranges](https://microsoft.github.io/language-server-protocol/specification#textDocument_foldingRange)
     # request informs the editor of the ranges where and how code can be folded.
-    #
-    # # Example
-    #
-    # ```ruby
-    # def say_hello # <-- folding range start
-    #   puts "Hello"
-    # end # <-- folding range end
-    # ```
     class FoldingRanges < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/formatting.rb

@@ -3,25 +3,9 @@
 
 module RubyLsp
   module Requests
-    # ![Formatting symbol demo](../../formatting.gif)
-    #
     # The [formatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_formatting)
     # request uses RuboCop to fix auto-correctable offenses in the document. This requires enabling format on save and
     # registering the ruby-lsp as the Ruby formatter.
-    #
-    # The `rubyLsp.formatter` setting specifies which formatter to use.
-    # If set to `auto` then it behaves as follows:
-    # * It will use RuboCop if it is part of the bundle.
-    # * If RuboCop is not available, and `syntax_tree` is a direct dependency, it will use that.
-    # * Otherwise, no formatting will be applied.
-    #
-    # # Example
-    #
-    # ```ruby
-    # def say_hello
-    # puts "Hello" # --> formatting: fixes the indentation on save
-    # end
-    # ```
     class Formatting < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/hover.rb

@@ -5,16 +5,8 @@ require "ruby_lsp/listeners/hover"
 
 module RubyLsp
   module Requests
-    # ![Hover demo](../../hover.gif)
-    #
     # The [hover request](https://microsoft.github.io/language-server-protocol/specification#textDocument_hover)
     # displays the documentation for the symbol currently under the cursor.
-    #
-    # # Example
-    #
-    # ```ruby
-    # String # -> Hovering over the class reference will show all declaration locations and the documentation
-    # ```
     class Hover < Request
       extend T::Sig
       extend T::Generic
@@ -41,7 +33,15 @@ module RubyLsp
       end
       def initialize(document, global_state, position, dispatcher, sorbet_level)
         super()
-        node_context = document.locate_node(position, node_types: Listeners::Hover::ALLOWED_TARGETS)
+
+        char_position = document.create_scanner.find_char_position(position)
+        delegate_request_if_needed!(global_state, document, char_position)
+
+        node_context = RubyDocument.locate(
+          document.parse_result.value,
+          char_position,
+          node_types: Listeners::Hover::ALLOWED_TARGETS,
+        )
         target = node_context.node
         parent = node_context.parent
 

data/lib/ruby_lsp/requests/inlay_hints.rb

@@ -5,39 +5,9 @@ require "ruby_lsp/listeners/inlay_hints"
 
 module RubyLsp
   module Requests
-    # ![Inlay hint demo](../../inlay_hints.gif)
-    #
     # [Inlay hints](https://microsoft.github.io/language-server-protocol/specification#textDocument_inlayHint)
     # are labels added directly in the code that explicitly show the user something that might
     # otherwise just be implied.
-    #
-    # # Configuration
-    #
-    # To enable rescue hints, set `rubyLsp.featuresConfiguration.inlayHint.implicitRescue` to `true`.
-    #
-    # To enable hash value hints, set `rubyLsp.featuresConfiguration.inlayHint.implicitHashValue` to `true`.
-    #
-    # To enable all hints, set `rubyLsp.featuresConfiguration.inlayHint.enableAll` to `true`.
-    #
-    # # Example
-    #
-    # ```ruby
-    # begin
-    #   puts "do something that might raise"
-    # rescue # Label "StandardError" goes here as a bare rescue implies rescuing StandardError
-    #   puts "handle some rescue"
-    # end
-    # ```
-    #
-    # # Example
-    #
-    # ```ruby
-    # var = "foo"
-    # {
-    #   var: var, # Label "var" goes here in cases where the value is omitted
-    #   a: "hello",
-    # }
-    # ```
     class InlayHints < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -3,18 +3,8 @@
 
 module RubyLsp
   module Requests
-    # ![On type formatting demo](../../on_type_formatting.gif)
-    #
     # The [on type formatting](https://microsoft.github.io/language-server-protocol/specification#textDocument_onTypeFormatting)
     # request formats code as the user is typing. For example, automatically adding `end` to class definitions.
-    #
-    # # Example
-    #
-    # ```ruby
-    # class Foo # <-- upon adding a line break, on type formatting is triggered
-    #   # <-- cursor ends up here
-    # end # <-- end is automatically added
-    # ```
     class OnTypeFormatting < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/prepare_type_hierarchy.rb

@@ -3,22 +3,11 @@
 
 module RubyLsp
   module Requests
-    # ![Prepare type hierarchy demo](../../prepare_type_hierarchy.gif)
-    #
     # The [prepare type hierarchy
     # request](https://microsoft.github.io/language-server-protocol/specification#textDocument_prepareTypeHierarchy)
     # displays the list of ancestors (supertypes) and descendants (subtypes) for the selected type.
     #
     # Currently only supports supertypes due to a limitation of the index.
-    #
-    # # Example
-    #
-    # ```ruby
-    # class Foo; end
-    # class Bar < Foo; end
-    #
-    # puts Bar # <-- right click on `Bar` and select "Show Type Hierarchy"
-    # ```
     class PrepareTypeHierarchy < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/request.rb

@@ -3,7 +3,6 @@
 
 module RubyLsp
   module Requests
-    # :nodoc:
     class Request
       extend T::Sig
       extend T::Generic
@@ -17,6 +16,23 @@ module RubyLsp
 
       private
 
+      # Signals to the client that the request should be delegated to the language server server for the host language
+      # in ERB files
+      sig do
+        params(
+          global_state: GlobalState,
+          document: Document[T.untyped],
+          char_position: Integer,
+        ).void
+      end
+      def delegate_request_if_needed!(global_state, document, char_position)
+        if global_state.supports_request_delegation &&
+            document.is_a?(ERBDocument) &&
+            document.inside_host_language?(char_position)
+          raise DelegateRequestError
+        end
+      end
+
       # Checks if a location covers a position
       sig { params(location: Prism::Location, position: T.untyped).returns(T::Boolean) }
       def cover?(location, position)

data/lib/ruby_lsp/requests/selection_ranges.rb

@@ -3,8 +3,6 @@
 
 module RubyLsp
   module Requests
-    # ![Selection ranges demo](../../selection_ranges.gif)
-    #
     # The [selection ranges](https://microsoft.github.io/language-server-protocol/specification#textDocument_selectionRange)
     # request informs the editor of ranges that the user may want to select based on the location(s)
     # of their cursor(s).
@@ -12,14 +10,6 @@ module RubyLsp
     # Trigger this request with: Ctrl + Shift + -> or Ctrl + Shift + <-
     #
     # Note that if using VSCode Neovim, you will need to be in Insert mode for this to work correctly.
-    #
-    # # Example
-    #
-    # ```ruby
-    # def foo # --> The next selection range encompasses the entire method definition.
-    #   puts "Hello, world!" # --> Cursor is on this line
-    # end
-    # ```
     class SelectionRanges < Request
       extend T::Sig
       include Support::Common