ruby-lsp 0.13.1 → 0.13.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78df9c8d35fc18cea6fc06a0f679b48b69e3daaaf504d762d2f5ae4df9d99ad0
-  data.tar.gz: 3c251eed7939e81c5aa115d303b2876d3769c509ef0487b0faa26d1a2de79c50
+  metadata.gz: 2329129b74c75a0bb4113d1f1489463f666b74ef495d0ac65bad675fbd83d1d3
+  data.tar.gz: 2f31f495b9ca0b1a9f909758dabce816411d0b64a006577c93c7a80a253791e5
 SHA512:
-  metadata.gz: af33b81309429318e7fe61dc4a2bd989328b8e9127097ab621eab162e61e1b2d93f1be1b192307d3b48f47659489343e093d92125e9c68895c40517803dba5ed
-  data.tar.gz: 6373eb77209eb865e29026fba603f4db8d3249949bcff7c0aee3f550569a7225c84b76d5872fd61a8798c0ef04da2d538b50b4d3045697ef40cc85336a2c715b
+  metadata.gz: 9c3ab34cb3e7877105ca21df3f521589d9838bd15e77a3d17cc4df91ca1f93221ef845e514a902a03a63a1f82ad6b5cf90fa4f9a93037fbfb57af5f7a48b0ebe
+  data.tar.gz: d4867c86eb238abf039f40592d7ff48acd85749fcf9349ab72fdea218ff5201156fc0d511987ed768b1fb2dcc9fd55a76bfac611f3fc565b7b2ba8c8d1054a72

data/VERSION

@@ -1 +1 @@
-0.13.1
+0.13.2

data/lib/ruby_indexer/lib/ruby_indexer/configuration.rb

@@ -193,7 +193,7 @@ module RubyIndexer
       # When working on a gem, we need to make sure that its gemspec dependencies can't be excluded. This is necessary
       # because Bundler doesn't assign groups to gemspec dependencies
       this_gem = Bundler.definition.dependencies.find do |d|
-        d.to_spec.full_gem_path == Dir.pwd
+        d.to_spec&.full_gem_path == Dir.pwd
       rescue Gem::MissingSpecError
         false
       end

data/lib/ruby_indexer/lib/ruby_indexer/entry.rb

@@ -81,9 +81,13 @@ module RubyIndexer
 
       abstract!
 
+      # Name includes just the name of the parameter, excluding symbols like splats
       sig { returns(Symbol) }
       attr_reader :name
 
+      # Decorated name is the parameter name including the splat or block prefix, e.g.: `*foo`, `**foo` or `&block`
+      alias_method :decorated_name, :name
+
       sig { params(name: Symbol).void }
       def initialize(name:)
         @name = name
@@ -100,25 +104,48 @@ module RubyIndexer
 
     # An required keyword method parameter, e.g. `def foo(a:)`
     class KeywordParameter < Parameter
+      sig { override.returns(Symbol) }
+      def decorated_name
+        :"#{@name}:"
+      end
     end
 
     # An optional keyword method parameter, e.g. `def foo(a: 123)`
     class OptionalKeywordParameter < Parameter
+      sig { override.returns(Symbol) }
+      def decorated_name
+        :"#{@name}:"
+      end
     end
 
     # A rest method parameter, e.g. `def foo(*a)`
     class RestParameter < Parameter
       DEFAULT_NAME = T.let(:"<anonymous splat>", Symbol)
+
+      sig { override.returns(Symbol) }
+      def decorated_name
+        :"*#{@name}"
+      end
     end
 
     # A keyword rest method parameter, e.g. `def foo(**a)`
     class KeywordRestParameter < Parameter
       DEFAULT_NAME = T.let(:"<anonymous keyword splat>", Symbol)
+
+      sig { override.returns(Symbol) }
+      def decorated_name
+        :"**#{@name}"
+      end
     end
 
     # A block method parameter, e.g. `def foo(&block)`
     class BlockParameter < Parameter
       DEFAULT_NAME = T.let(:"<anonymous block>", Symbol)
+
+      sig { override.returns(Symbol) }
+      def decorated_name
+        :"&#{@name}"
+      end
     end
 
     class Member < Entry
@@ -220,7 +247,7 @@ module RubyIndexer
 
         rest = parameters_node.rest
 
-        if rest
+        if rest.is_a?(Prism::RestParameterNode)
           rest_name = rest.name || RestParameter::DEFAULT_NAME
           parameters << RestParameter.new(name: rest_name)
         end
@@ -261,6 +288,8 @@ module RubyIndexer
             names << (rest.operator == "*" ? "*#{name}".to_sym : name&.to_sym)
           end
 
+          names << nil if rest.is_a?(Prism::ImplicitRestNode)
+
           names.concat(node.rights.map { |parameter_node| parameter_name(parameter_node) })
 
           names_with_commas = names.join(", ")

data/lib/ruby_lsp/document.rb

@@ -8,10 +8,6 @@ module RubyLsp
 
     abstract!
 
-    PositionShape = T.type_alias { { line: Integer, character: Integer } }
-    RangeShape = T.type_alias { { start: PositionShape, end: PositionShape } }
-    EditShape = T.type_alias { { range: RangeShape, text: String } }
-
     sig { returns(Prism::ParseResult) }
     attr_reader :parse_result
 
@@ -80,7 +76,7 @@ module RubyLsp
       @cache[request_name]
     end
 
-    sig { params(edits: T::Array[EditShape], version: Integer).void }
+    sig { params(edits: T::Array[T::Hash[Symbol, T.untyped]], version: Integer).void }
     def push_edits(edits, version:)
       edits.each do |edit|
         range = edit[:range]
@@ -112,7 +108,7 @@ module RubyLsp
 
     sig do
       params(
-        position: PositionShape,
+        position: T::Hash[Symbol, T.untyped],
         node_types: T::Array[T.class_of(Prism::Node)],
       ).returns([T.nilable(Prism::Node), T.nilable(Prism::Node), T::Array[String]])
     end
@@ -193,7 +189,7 @@ module RubyLsp
       end
 
       # Finds the character index inside the source string for a given line and column
-      sig { params(position: PositionShape).returns(Integer) }
+      sig { params(position: T::Hash[Symbol, T.untyped]).returns(Integer) }
       def find_char_position(position)
         # Find the character index for the beginning of the requested line
         until @current_line == position[:line]

data/lib/ruby_lsp/executor.rb

@@ -25,6 +25,7 @@ module RubyLsp
       begin
         response = run(request)
       rescue StandardError, LoadError => e
+        warn(e.message)
         error = e
       end
 
@@ -171,6 +172,8 @@ module RubyLsp
         completion(uri, request.dig(:params, :position))
       when "textDocument/definition"
         definition(uri, request.dig(:params, :position))
+      when "textDocument/signatureHelp"
+        signature_help(uri, request.dig(:params, :position), request.dig(:params, :context))
       when "workspace/didChangeWatchedFiles"
         did_change_watched_files(request.dig(:params, :changes))
       when "workspace/symbol"
@@ -240,12 +243,44 @@ module RubyLsp
       end
     end
 
+    sig do
+      params(
+        uri: URI::Generic,
+        position: T::Hash[Symbol, T.untyped],
+        context: T::Hash[Symbol, T.untyped],
+      ).returns(T.any(T.nilable(Interface::SignatureHelp), T::Hash[Symbol, T.untyped]))
+    end
+    def signature_help(uri, position, context)
+      current_signature = context[:activeSignatureHelp]
+      document = @store.get(uri)
+      target, parent, nesting = document.locate_node(
+        { line: position[:line], character: position[:character] - 2 },
+        node_types: [Prism::CallNode],
+      )
+
+      # If we're typing a nested method call (e.g.: `foo(bar)`), then we may end up locating `bar` as the target method
+      # call incorrectly. To correct that, we check if there's an active signature with the same name as the parent node
+      # and then replace the target
+      if current_signature && parent.is_a?(Prism::CallNode)
+        active_signature = current_signature[:activeSignature] || 0
+
+        if current_signature.dig(:signatures, active_signature, :label)&.start_with?(parent.message)
+          target = parent
+        end
+      end
+
+      dispatcher = Prism::Dispatcher.new
+      listener = Requests::SignatureHelp.new(context, nesting, @index, dispatcher)
+      dispatcher.dispatch_once(target)
+      listener.response
+    end
+
     sig { params(query: T.nilable(String)).returns(T::Array[Interface::WorkspaceSymbol]) }
     def workspace_symbol(query)
       Requests::WorkspaceSymbol.new(query, @index).run
     end
 
-    sig { params(uri: URI::Generic, range: T.nilable(Document::RangeShape)).returns({ ast: String }) }
+    sig { params(uri: URI::Generic, range: T.nilable(T::Hash[Symbol, T.untyped])).returns({ ast: String }) }
     def show_syntax_tree(uri, range)
       { ast: Requests::ShowSyntaxTree.new(@store.get(uri), range).run }
     end
@@ -253,7 +288,7 @@ module RubyLsp
     sig do
       params(
         uri: URI::Generic,
-        position: Document::PositionShape,
+        position: T::Hash[Symbol, T.untyped],
       ).returns(T.nilable(T.any(T::Array[Interface::Location], Interface::Location)))
     end
     def definition(uri, position)
@@ -274,7 +309,7 @@ module RubyLsp
     sig do
       params(
         uri: URI::Generic,
-        position: Document::PositionShape,
+        position: T::Hash[Symbol, T.untyped],
       ).returns(T.nilable(Interface::Hover))
     end
     def hover(uri, position)
@@ -301,7 +336,7 @@ module RubyLsp
     end
 
     sig do
-      params(uri: URI::Generic, content_changes: T::Array[Document::EditShape], version: Integer).returns(Object)
+      params(uri: URI::Generic, content_changes: T::Array[T::Hash[Symbol, T.untyped]], version: Integer).returns(Object)
     end
     def text_document_did_change(uri, content_changes, version)
       @store.push_edits(uri: uri, edits: content_changes, version: version)
@@ -323,7 +358,7 @@ module RubyLsp
     sig do
       params(
         uri: URI::Generic,
-        positions: T::Array[Document::PositionShape],
+        positions: T::Array[T::Hash[Symbol, T.untyped]],
       ).returns(T.nilable(T::Array[T.nilable(Requests::Support::SelectionRange)]))
     end
     def selection_range(uri, positions)
@@ -361,7 +396,7 @@ module RubyLsp
     sig do
       params(
         uri: URI::Generic,
-        position: Document::PositionShape,
+        position: T::Hash[Symbol, T.untyped],
         character: String,
       ).returns(T::Array[Interface::TextEdit])
     end
@@ -372,7 +407,7 @@ module RubyLsp
     sig do
       params(
         uri: URI::Generic,
-        position: Document::PositionShape,
+        position: T::Hash[Symbol, T.untyped],
       ).returns(T.nilable(T::Array[Interface::DocumentHighlight]))
     end
     def document_highlight(uri, position)
@@ -385,7 +420,12 @@ module RubyLsp
       listener.response
     end
 
-    sig { params(uri: URI::Generic, range: Document::RangeShape).returns(T.nilable(T::Array[Interface::InlayHint])) }
+    sig do
+      params(
+        uri: URI::Generic,
+        range: T::Hash[Symbol, T.untyped],
+      ).returns(T.nilable(T::Array[Interface::InlayHint]))
+    end
     def inlay_hint(uri, range)
       document = @store.get(uri)
 
@@ -402,7 +442,7 @@ module RubyLsp
     sig do
       params(
         uri: URI::Generic,
-        range: Document::RangeShape,
+        range: T::Hash[Symbol, T.untyped],
         context: T::Hash[Symbol, T.untyped],
       ).returns(T.nilable(T::Array[Interface::CodeAction]))
     end
@@ -456,7 +496,7 @@ module RubyLsp
       Interface::FullDocumentDiagnosticReport.new(kind: "full", items: response) if response
     end
 
-    sig { params(uri: URI::Generic, range: Document::RangeShape).returns(Interface::SemanticTokens) }
+    sig { params(uri: URI::Generic, range: T::Hash[Symbol, T.untyped]).returns(Interface::SemanticTokens) }
     def semantic_tokens_range(uri, range)
       document = @store.get(uri)
       start_line = range.dig(:start, :line)
@@ -472,7 +512,7 @@ module RubyLsp
     sig do
       params(
         uri: URI::Generic,
-        position: Document::PositionShape,
+        position: T::Hash[Symbol, T.untyped],
       ).returns(T.nilable(T::Array[Interface::CompletionItem]))
     end
     def completion(uri, position)
@@ -692,6 +732,13 @@ module RubyLsp
         )
       end
 
+      signature_help_provider = if enabled_features["signatureHelp"]
+        # Identifier characters are automatically included, such as A-Z, a-z, 0-9, _, * or :
+        Interface::SignatureHelpOptions.new(
+          trigger_characters: ["(", " ", ","],
+        )
+      end
+
       # Dynamically registered capabilities
       file_watching_caps = options.dig(:capabilities, :workspace, :didChangeWatchedFiles)
 
@@ -744,6 +791,7 @@ module RubyLsp
           code_lens_provider: code_lens_provider,
           definition_provider: enabled_features["definition"],
           workspace_symbol_provider: enabled_features["workspaceSymbol"],
+          signature_help_provider: signature_help_provider,
         ),
         serverInfo: {
           name: "Ruby LSP",

data/lib/ruby_lsp/requests/code_action_resolve.rb

@@ -137,7 +137,7 @@ module RubyLsp
 
       private
 
-      sig { params(range: Document::RangeShape, new_text: String).returns(Interface::TextEdit) }
+      sig { params(range: T::Hash[Symbol, T.untyped], new_text: String).returns(Interface::TextEdit) }
       def create_text_edit(range, new_text)
         Interface::TextEdit.new(
           range: Interface::Range.new(

data/lib/ruby_lsp/requests/code_actions.rb

@@ -22,7 +22,7 @@ module RubyLsp
       sig do
         params(
           document: Document,
-          range: Document::RangeShape,
+          range: T::Hash[Symbol, T.untyped],
           context: T::Hash[Symbol, T.untyped],
         ).void
       end
@@ -49,7 +49,7 @@ module RubyLsp
 
       private
 
-      sig { params(range: Document::RangeShape, uri: URI::Generic).returns(Interface::CodeAction) }
+      sig { params(range: T::Hash[Symbol, T.untyped], uri: URI::Generic).returns(Interface::CodeAction) }
       def refactor_code_action(range, uri)
         Interface::CodeAction.new(
           title: "Refactor: Extract Variable",

data/lib/ruby_lsp/requests/completion.rb

@@ -154,13 +154,11 @@ module RubyLsp
       end
       def build_method_completion(entry, node)
         name = entry.name
-        parameters = entry.parameters
-        new_text = parameters.empty? ? name : "#{name}(#{parameters.map(&:name).join(", ")})"
 
         Interface::CompletionItem.new(
           label: name,
           filter_text: name,
-          text_edit: Interface::TextEdit.new(range: range_from_node(node), new_text: new_text),
+          text_edit: Interface::TextEdit.new(range: range_from_node(node), new_text: name),
           kind: Constant::CompletionItemKind::METHOD,
           label_details: Interface::CompletionItemLabelDetails.new(
             description: entry.file_name,

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -26,7 +26,7 @@ module RubyLsp
         T::Array[Regexp],
       )
 
-      sig { params(document: Document, position: Document::PositionShape, trigger_character: String).void }
+      sig { params(document: Document, position: T::Hash[Symbol, T.untyped], trigger_character: String).void }
       def initialize(document, position, trigger_character)
         super(document)
 
@@ -143,7 +143,7 @@ module RubyLsp
         add_edit_with_text("##{spaces}")
       end
 
-      sig { params(text: String, position: Document::PositionShape).void }
+      sig { params(text: String, position: T::Hash[Symbol, T.untyped]).void }
       def add_edit_with_text(text, position = @position)
         pos = Interface::Position.new(
           line: position[:line],

data/lib/ruby_lsp/requests/show_syntax_tree.rb

@@ -20,7 +20,7 @@ module RubyLsp
     class ShowSyntaxTree < BaseRequest
       extend T::Sig
 
-      sig { params(document: Document, range: T.nilable(Document::RangeShape)).void }
+      sig { params(document: Document, range: T.nilable(T::Hash[Symbol, T.untyped])).void }
       def initialize(document, range)
         super(document)
 

data/lib/ruby_lsp/requests/signature_help.rb

@@ -0,0 +1,95 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  module Requests
+    # ![Signature help demo](../../signature_help.gif)
+    #
+    # The [signature help
+    # request](https://microsoft.github.io/language-server-protocol/specification#textDocument_signatureHelp) displays
+    # information about the parameters of a method as you type an invocation.
+    #
+    # Currently only supports methods invoked directly on `self` without taking inheritance into account.
+    #
+    # # Example
+    #
+    # ```ruby
+    # class Foo
+    #  def bar(a, b, c)
+    #  end
+    #
+    #  def baz
+    #    bar( # -> Signature help will show the parameters of `bar`
+    #  end
+    # ```
+    class SignatureHelp < Listener
+      extend T::Sig
+      extend T::Generic
+
+      ResponseType = type_member { { fixed: T.nilable(T.any(Interface::SignatureHelp, T::Hash[Symbol, T.untyped])) } }
+
+      sig { override.returns(ResponseType) }
+      attr_reader :_response
+
+      sig do
+        params(
+          context: T::Hash[Symbol, T.untyped],
+          nesting: T::Array[String],
+          index: RubyIndexer::Index,
+          dispatcher: Prism::Dispatcher,
+        ).void
+      end
+      def initialize(context, nesting, index, dispatcher)
+        @context = context
+        @nesting = nesting
+        @index = index
+        @_response = T.let(nil, ResponseType)
+
+        super(dispatcher)
+        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 unless self_receiver?(node)
+
+        message = node.message
+        return unless message
+
+        target_method = @index.resolve_method(message, @nesting.join("::"))
+        return unless target_method
+
+        parameters = target_method.parameters
+        name = target_method.name
+
+        # If the method doesn't have any parameters, there's no need to show signature help
+        return if parameters.empty?
+
+        label = "#{name}(#{parameters.map(&:decorated_name).join(", ")})"
+
+        arguments_node = node.arguments
+        arguments = arguments_node&.arguments || []
+        active_parameter = (arguments.length - 1).clamp(0, parameters.length - 1)
+
+        # 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
+        if arguments_node &&
+            node.slice.byteslice(arguments_node.location.end_offset - node.location.start_offset) == ","
+          active_parameter += 1
+        end
+
+        @_response = Interface::SignatureHelp.new(
+          signatures: [
+            Interface::SignatureInformation.new(
+              label: label,
+              parameters: parameters.map { |param| Interface::ParameterInformation.new(label: param.name) },
+              documentation: markdown_from_index_entries("", target_method),
+            ),
+          ],
+          active_parameter: active_parameter,
+        )
+      end
+    end
+  end
+end

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

@@ -7,7 +7,7 @@ module RubyLsp
       class SelectionRange < Interface::SelectionRange
         extend T::Sig
 
-        sig { params(position: Document::PositionShape).returns(T::Boolean) }
+        sig { params(position: T::Hash[Symbol, T.untyped]).returns(T::Boolean) }
         def cover?(position)
           start_covered = range.start.line < position[:line] ||
             (range.start.line == position[:line] && range.start.character <= position[:character])

data/lib/ruby_lsp/requests.rb

@@ -22,6 +22,7 @@ module RubyLsp
   # - [Definition](rdoc-ref:RubyLsp::Requests::Definition)
   # - [ShowSyntaxTree](rdoc-ref:RubyLsp::Requests::ShowSyntaxTree)
   # - [WorkspaceSymbol](rdoc-ref:RubyLsp::Requests::WorkspaceSymbol)
+  # - [SignatureHelp](rdoc-ref:RubyLsp::Requests::SignatureHelp)
 
   module Requests
     autoload :BaseRequest, "ruby_lsp/requests/base_request"
@@ -43,6 +44,7 @@ module RubyLsp
     autoload :Definition, "ruby_lsp/requests/definition"
     autoload :ShowSyntaxTree, "ruby_lsp/requests/show_syntax_tree"
     autoload :WorkspaceSymbol, "ruby_lsp/requests/workspace_symbol"
+    autoload :SignatureHelp, "ruby_lsp/requests/signature_help"
 
     # :nodoc:
     module Support

data/lib/ruby_lsp/store.rb

@@ -63,7 +63,7 @@ module RubyLsp
       @state[uri.to_s] = document
     end
 
-    sig { params(uri: URI::Generic, edits: T::Array[Document::EditShape], version: Integer).void }
+    sig { params(uri: URI::Generic, edits: T::Array[T::Hash[Symbol, T.untyped]], version: Integer).void }
     def push_edits(uri:, edits:, version:)
       T.must(@state[uri.to_s]).push_edits(edits, version: version)
     end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.13.1
+  version: 0.13.2
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-12-06 00:00:00.000000000 Z
+date: 2023-12-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -30,20 +30,20 @@ dependencies:
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.20'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.18.0
+        version: 0.19.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.19'
+        version: '0.20'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -118,6 +118,7 @@ files:
 - lib/ruby_lsp/requests/selection_ranges.rb
 - lib/ruby_lsp/requests/semantic_highlighting.rb
 - lib/ruby_lsp/requests/show_syntax_tree.rb
+- lib/ruby_lsp/requests/signature_help.rb
 - lib/ruby_lsp/requests/support/annotation.rb
 - lib/ruby_lsp/requests/support/common.rb
 - lib/ruby_lsp/requests/support/dependency_detector.rb