ruby-lsp 0.12.2 → 0.12.4

data/lib/ruby_lsp/requests/code_action_resolve.rb

@@ -87,15 +87,19 @@ module RubyLsp
             :start,
             :line,
           ) && closest_node_loc.end_line - 1 >= source_range.dig(:end, :line)
-            indentation_line = closest_node_loc.start_line - 1
-            target_line = indentation_line
+            indentation_line_number = closest_node_loc.start_line - 1
+            target_line = indentation_line_number
           else
             target_line = closest_node_loc.end_line
-            indentation_line = closest_node_loc.end_line - 1
+            indentation_line_number = closest_node_loc.end_line - 1
           end
 
           lines = @document.source.lines
-          indentation = T.must(T.must(lines[indentation_line])[/\A */]).size
+
+          indentation_line = lines[indentation_line_number]
+          return Error::InvalidTargetRange unless indentation_line
+
+          indentation = T.must(indentation_line[/\A */]).size
 
           target_range = {
             start: { line: target_line, character: indentation },

data/lib/ruby_lsp/requests/completion.rb

@@ -6,9 +6,14 @@ module RubyLsp
     # ![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, completion is support for
-    # - require paths
-    # - classes, modules and constant names
+    # suggests possible completions according to what the developer is typing.
+    #
+    # Currently supported targets:
+    # - Classes
+    # - Modules
+    # - Constants
+    # - Require paths
+    # - Methods invoked on self only
     #
     # # Example
     #
@@ -45,6 +50,7 @@ module RubyLsp
           :on_string_node_enter,
           :on_constant_path_node_enter,
           :on_constant_read_node_enter,
+          :on_call_node_enter,
         )
       end
 
@@ -118,8 +124,48 @@ module RubyLsp
         end
       end
 
+      sig { params(node: Prism::CallNode).void }
+      def on_call_node_enter(node)
+        return if DependencyDetector.instance.typechecker
+        return unless self_receiver?(node)
+
+        name = node.message
+        return unless name
+
+        receiver_entries = @index[@nesting.join("::")]
+        return unless receiver_entries
+
+        receiver = T.must(receiver_entries.first)
+
+        candidates = T.cast(@index.prefix_search(name), T::Array[T::Array[RubyIndexer::Entry::Method]])
+        candidates.each do |entries|
+          entry = entries.find { |e| e.owner&.name == receiver.name }
+          next unless entry
+
+          @_response << build_method_completion(entry, node)
+        end
+      end
+
       private
 
+      sig { params(entry: RubyIndexer::Entry::Method, node: Prism::CallNode).returns(Interface::CompletionItem) }
+      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),
+          kind: Constant::CompletionItemKind::METHOD,
+          label_details: Interface::CompletionItemLabelDetails.new(
+            description: entry.file_name,
+          ),
+          documentation: markdown_from_index_entries(name, entry),
+        )
+      end
+
       sig { params(label: String, node: Prism::StringNode).returns(Interface::CompletionItem) }
       def build_completion(label, node)
         Interface::CompletionItem.new(

data/lib/ruby_lsp/requests/definition.rb

@@ -9,7 +9,12 @@ module RubyLsp
     # request](https://microsoft.github.io/language-server-protocol/specification#textDocument_definition) jumps to the
     # definition of the symbol under the cursor.
     #
-    # Currently, only jumping to classes, modules and required files is supported.
+    # Currently supported targets:
+    # - Classes
+    # - Modules
+    # - Constants
+    # - Require paths
+    # - Methods invoked on self only
     #
     # # Example
     #
@@ -75,8 +80,52 @@ module RubyLsp
       sig { params(node: Prism::CallNode).void }
       def on_call_node_enter(node)
         message = node.name
-        return unless message == :require || message == :require_relative
 
+        if message == :require || message == :require_relative
+          handle_require_definition(node)
+        else
+          handle_method_definition(node)
+        end
+      end
+
+      sig { params(node: Prism::ConstantPathNode).void }
+      def on_constant_path_node_enter(node)
+        find_in_index(node.slice)
+      end
+
+      sig { params(node: Prism::ConstantReadNode).void }
+      def on_constant_read_node_enter(node)
+        find_in_index(node.slice)
+      end
+
+      private
+
+      sig { params(node: Prism::CallNode).void }
+      def handle_method_definition(node)
+        return unless self_receiver?(node)
+
+        message = node.message
+        return unless message
+
+        target_method = @index.resolve_method(message, @nesting.join("::"))
+        return unless target_method
+
+        location = target_method.location
+        file_path = target_method.file_path
+        return if defined_in_gem?(file_path)
+
+        @_response = Interface::Location.new(
+          uri: URI::Generic.from_path(path: file_path).to_s,
+          range: Interface::Range.new(
+            start: Interface::Position.new(line: location.start_line - 1, character: location.start_column),
+            end: Interface::Position.new(line: location.end_line - 1, character: location.end_column),
+          ),
+        )
+      end
+
+      sig { params(node: Prism::CallNode).void }
+      def handle_require_definition(node)
+        message = node.name
         arguments = node.arguments
         return unless arguments
 
@@ -116,18 +165,6 @@ module RubyLsp
         end
       end
 
-      sig { params(node: Prism::ConstantPathNode).void }
-      def on_constant_path_node_enter(node)
-        find_in_index(node.slice)
-      end
-
-      sig { params(node: Prism::ConstantReadNode).void }
-      def on_constant_read_node_enter(node)
-        find_in_index(node.slice)
-      end
-
-      private
-
       sig { params(value: String).void }
       def find_in_index(value)
         entries = @index.resolve(value, @nesting)
@@ -138,23 +175,13 @@ module RubyLsp
         first_entry = T.must(entries.first)
         return if first_entry.visibility == :private && first_entry.name != "#{@nesting.join("::")}::#{value}"
 
-        bundle_path = begin
-          Bundler.bundle_path.to_s
-        rescue Bundler::GemfileNotFound
-          nil
-        end
-
         @_response = entries.filter_map do |entry|
           location = entry.location
           # If the project has Sorbet, then we only want to handle go to definition for constants defined in gems, as an
           # additional behavior on top of jumping to RBIs. Sorbet can already handle go to definition for all constants
           # in the project, even if the files are typed false
           file_path = entry.file_path
-          if DependencyDetector.instance.typechecker && bundle_path && !file_path.start_with?(bundle_path) &&
-              !file_path.start_with?(RbConfig::CONFIG["rubylibdir"])
-
-            next
-          end
+          next if defined_in_gem?(file_path)
 
           Interface::Location.new(
             uri: URI::Generic.from_path(path: file_path).to_s,

data/lib/ruby_lsp/requests/document_highlight.rb

@@ -97,7 +97,8 @@ module RubyLsp
           Prism::LocalVariableWriteNode,
           Prism::BlockParameterNode,
           Prism::RequiredParameterNode,
-          Prism::KeywordParameterNode,
+          Prism::RequiredKeywordParameterNode,
+          Prism::OptionalKeywordParameterNode,
           Prism::RestParameterNode,
           Prism::OptionalParameterNode,
           Prism::KeywordRestParameterNode,
@@ -137,8 +138,9 @@ module RubyLsp
             Prism::ClassVariableReadNode, Prism::ClassVariableTargetNode, Prism::ClassVariableWriteNode,
             Prism::LocalVariableAndWriteNode, Prism::LocalVariableOperatorWriteNode, Prism::LocalVariableOrWriteNode,
             Prism::LocalVariableReadNode, Prism::LocalVariableTargetNode, Prism::LocalVariableWriteNode,
-            Prism::CallNode, Prism::BlockParameterNode, Prism::KeywordParameterNode, Prism::KeywordRestParameterNode,
-            Prism::OptionalParameterNode, Prism::RequiredParameterNode, Prism::RestParameterNode
+            Prism::CallNode, Prism::BlockParameterNode, Prism::RequiredKeywordParameterNode,
+            Prism::RequiredKeywordParameterNode, Prism::KeywordRestParameterNode, Prism::OptionalParameterNode,
+            Prism::RequiredParameterNode, Prism::RestParameterNode
             target
           end
 
@@ -171,7 +173,8 @@ module RubyLsp
             :on_constant_path_and_write_node_enter,
             :on_constant_path_operator_write_node_enter,
             :on_local_variable_write_node_enter,
-            :on_keyword_parameter_node_enter,
+            :on_required_keyword_parameter_node_enter,
+            :on_optional_keyword_parameter_node_enter,
             :on_rest_parameter_node_enter,
             :on_optional_parameter_node_enter,
             :on_keyword_rest_parameter_node_enter,
@@ -359,8 +362,15 @@ module RubyLsp
         add_highlight(Constant::DocumentHighlightKind::WRITE, node.name_loc)
       end
 
-      sig { params(node: Prism::KeywordParameterNode).void }
-      def on_keyword_parameter_node_enter(node)
+      sig { params(node: Prism::RequiredKeywordParameterNode).void }
+      def on_required_keyword_parameter_node_enter(node)
+        return unless matches?(node, LOCAL_NODES)
+
+        add_highlight(Constant::DocumentHighlightKind::WRITE, node.name_loc)
+      end
+
+      sig { params(node: Prism::OptionalKeywordParameterNode).void }
+      def on_optional_keyword_parameter_node_enter(node)
         return unless matches?(node, LOCAL_NODES)
 
         add_highlight(Constant::DocumentHighlightKind::WRITE, node.name_loc)
@@ -551,8 +561,8 @@ module RubyLsp
           Prism::ClassVariableTargetNode, Prism::ClassVariableWriteNode, Prism::LocalVariableAndWriteNode,
           Prism::LocalVariableOperatorWriteNode, Prism::LocalVariableOrWriteNode, Prism::LocalVariableReadNode,
           Prism::LocalVariableTargetNode, Prism::LocalVariableWriteNode, Prism::DefNode, Prism::BlockParameterNode,
-          Prism::KeywordParameterNode, Prism::KeywordRestParameterNode, Prism::OptionalParameterNode,
-          Prism::RequiredParameterNode, Prism::RestParameterNode
+          Prism::RequiredKeywordParameterNode, Prism::OptionalKeywordParameterNode, Prism::KeywordRestParameterNode,
+          Prism::OptionalParameterNode, Prism::RequiredParameterNode, Prism::RestParameterNode
 
           node.name.to_s
         when Prism::CallNode

data/lib/ruby_lsp/requests/folding_ranges.rb

@@ -94,7 +94,7 @@ module RubyLsp
         opening_loc = node.opening_loc
         closing_loc = node.closing_loc
 
-        add_lines_range(opening_loc.start_line, closing_loc.end_line - 1) if opening_loc && closing_loc
+        add_lines_range(opening_loc.start_line, closing_loc.start_line - 1) if opening_loc && closing_loc
       end
 
       sig { params(node: Prism::ArrayNode).void }

data/lib/ruby_lsp/requests/hover.rb

@@ -51,6 +51,7 @@ module RubyLsp
           :on_constant_read_node_enter,
           :on_constant_write_node_enter,
           :on_constant_path_node_enter,
+          :on_call_node_enter,
         )
       end
 
@@ -95,6 +96,25 @@ module RubyLsp
         generate_hover(node.slice, node.location)
       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
+
+        location = target_method.location
+
+        @_response = Interface::Hover.new(
+          range: range_from_location(location),
+          contents: markdown_from_index_entries(message, target_method),
+        )
+      end
+
       private
 
       sig { params(name: String, location: Prism::Location).void }

data/lib/ruby_lsp/requests/inlay_hints.rb

@@ -18,6 +18,16 @@ module RubyLsp
     #   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 < Listener
       extend T::Sig
       extend T::Generic
@@ -36,7 +46,7 @@ module RubyLsp
         @_response = T.let([], ResponseType)
         @range = range
 
-        dispatcher.register(self, :on_rescue_node_enter)
+        dispatcher.register(self, :on_rescue_node_enter, :on_implicit_node_enter)
       end
 
       sig { params(node: Prism::RescueNode).void }
@@ -53,6 +63,34 @@ module RubyLsp
           tooltip: "StandardError is implied in a bare rescue",
         )
       end
+
+      sig { params(node: Prism::ImplicitNode).void }
+      def on_implicit_node_enter(node)
+        return unless visible?(node, @range)
+
+        node_value = node.value
+        loc = node.location
+        tooltip = ""
+        node_name = ""
+        case node_value
+        when Prism::CallNode
+          node_name = node_value.name
+          tooltip = "This is a method call. Method name: #{node_name}"
+        when Prism::ConstantReadNode
+          node_name = node_value.name
+          tooltip = "This is a constant: #{node_name}"
+        when Prism::LocalVariableReadNode
+          node_name = node_value.name
+          tooltip = "This is a local variable: #{node_name}"
+        end
+
+        @_response << Interface::InlayHint.new(
+          position: { line: loc.start_line - 1, character: loc.start_column + node_name.length + 1 },
+          label: node_name,
+          padding_left: true,
+          tooltip: tooltip,
+        )
+      end
     end
   end
 end

data/lib/ruby_lsp/requests/on_type_formatting.rb

@@ -51,7 +51,14 @@ module RubyLsp
           if (comment_match = @previous_line.match(/^#(\s*)/))
             handle_comment_line(T.must(comment_match[1]))
           elsif @document.syntax_error?
-            handle_statement_end
+            match = /(?<=<<(-|~))(?<quote>['"`]?)(?<delimiter>\w+)\k<quote>/.match(@previous_line)
+            heredoc_delimiter = match && match.named_captures["delimiter"]
+
+            if heredoc_delimiter
+              handle_heredoc_end(heredoc_delimiter)
+            else
+              handle_statement_end
+            end
           end
         end
 
@@ -121,6 +128,14 @@ module RubyLsp
         end
       end
 
+      sig { params(delimiter: String).void }
+      def handle_heredoc_end(delimiter)
+        indents = " " * @indentation
+        add_edit_with_text("\n")
+        add_edit_with_text("#{indents}#{delimiter}")
+        move_cursor_to(@position[:line], @indentation + 2)
+      end
+
       sig { params(spaces: String).void }
       def handle_comment_line(spaces)
         add_edit_with_text("##{spaces}")

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -135,7 +135,8 @@ module RubyLsp
           :on_local_variable_write_node_enter,
           :on_local_variable_read_node_enter,
           :on_block_parameter_node_enter,
-          :on_keyword_parameter_node_enter,
+          :on_required_keyword_parameter_node_enter,
+          :on_optional_keyword_parameter_node_enter,
           :on_keyword_rest_parameter_node_enter,
           :on_optional_parameter_node_enter,
           :on_required_parameter_node_enter,
@@ -252,11 +253,18 @@ module RubyLsp
         @current_scope << name.to_sym if name
       end
 
-      sig { params(node: Prism::KeywordParameterNode).void }
-      def on_keyword_parameter_node_enter(node)
-        name = node.name
-        @current_scope << name.to_s.delete_suffix(":").to_sym if name
+      sig { params(node: Prism::RequiredKeywordParameterNode).void }
+      def on_required_keyword_parameter_node_enter(node)
+        @current_scope << node.name
+        return unless visible?(node, @range)
+
+        location = node.name_loc
+        add_token(location.copy(length: location.length - 1), :parameter)
+      end
 
+      sig { params(node: Prism::OptionalKeywordParameterNode).void }
+      def on_optional_keyword_parameter_node_enter(node)
+        @current_scope << node.name
         return unless visible?(node, @range)
 
         location = node.name_loc

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

@@ -9,6 +9,9 @@ module RubyLsp
         # https://github.com/Shopify/ruby-lsp-rails, or addons by created by developers outside of Shopify, so be
         # cautious of changing anything.
         extend T::Sig
+        extend T::Helpers
+
+        requires_ancestor { Kernel }
 
         sig { params(node: Prism::Node).returns(Interface::Range) }
         def range_from_node(node)
@@ -66,12 +69,29 @@ module RubyLsp
           )
         end
 
-        sig { params(title: String, entries: T::Array[RubyIndexer::Entry]).returns(Interface::MarkupContent) }
+        sig { params(file_path: String).returns(T.nilable(T::Boolean)) }
+        def defined_in_gem?(file_path)
+          DependencyDetector.instance.typechecker && BUNDLE_PATH && !file_path.start_with?(T.must(BUNDLE_PATH)) &&
+            !file_path.start_with?(RbConfig::CONFIG["rubylibdir"])
+        end
+
+        sig { params(node: Prism::CallNode).returns(T::Boolean) }
+        def self_receiver?(node)
+          receiver = node.receiver
+          receiver.nil? || receiver.is_a?(Prism::SelfNode)
+        end
+
+        sig do
+          params(
+            title: String,
+            entries: T.any(T::Array[RubyIndexer::Entry], RubyIndexer::Entry),
+          ).returns(Interface::MarkupContent)
+        end
         def markdown_from_index_entries(title, entries)
           markdown_title = "```ruby\n#{title}\n```"
           definitions = []
           content = +""
-          entries.each do |entry|
+          Array(entries).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

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

@@ -66,7 +66,6 @@ module RubyLsp
 
     sig { returns(T::Array[String]) }
     def dependencies
-      # NOTE: If changing this behaviour, it's likely that the VS Code extension will also need changed.
       @dependencies ||= T.let(
         begin
           Bundler.with_original_env { Bundler.default_gemfile }

data/lib/ruby_lsp/requests/workspace_symbol.rb

@@ -20,6 +20,7 @@ module RubyLsp
     #
     class WorkspaceSymbol
       extend T::Sig
+      include Support::Common
 
       sig { params(query: T.nilable(String), index: RubyIndexer::Index).void }
       def initialize(query, index)
@@ -29,21 +30,11 @@ module RubyLsp
 
       sig { returns(T::Array[Interface::WorkspaceSymbol]) }
       def run
-        bundle_path = begin
-          Bundler.bundle_path.to_s
-        rescue Bundler::GemfileNotFound
-          nil
-        end
-
         @index.fuzzy_search(@query).filter_map do |entry|
           # 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
-          if DependencyDetector.instance.typechecker && bundle_path && !file_path.start_with?(bundle_path) &&
-              !file_path.start_with?(RbConfig::CONFIG["rubylibdir"])
-
-            next
-          end
+          next if defined_in_gem?(file_path)
 
           # We should never show private symbols when searching the entire workspace
           next if entry.visibility == :private
@@ -82,6 +73,8 @@ module RubyLsp
           Constant::SymbolKind::NAMESPACE
         when RubyIndexer::Entry::Constant
           Constant::SymbolKind::CONSTANT
+        when RubyIndexer::Entry::Method
+          entry.name == "initialize" ? Constant::SymbolKind::CONSTRUCTOR : Constant::SymbolKind::METHOD
         end
       end
     end

data/lib/ruby_lsp/ruby_document.rb

@@ -0,0 +1,14 @@
+# typed: strict
+# frozen_string_literal: true
+
+module RubyLsp
+  class RubyDocument < Document
+    sig { override.returns(Prism::ParseResult) }
+    def parse
+      return @parse_result unless @needs_parsing
+
+      @needs_parsing = false
+      @parse_result = Prism.parse(@source)
+    end
+  end
+end

data/lib/ruby_lsp/setup_bundler.rb

@@ -12,6 +12,8 @@ require "time"
 # the Ruby LSP without including the gem in their application's Gemfile while at the same time giving us access to the
 # exact locked versions of dependencies.
 
+Bundler.ui.level = :silent
+
 module RubyLsp
   class SetupBundler
     extend T::Sig

data/lib/ruby_lsp/store.rb

@@ -1,8 +1,6 @@
 # typed: strict
 # frozen_string_literal: true
 
-require "ruby_lsp/document"
-
 module RubyLsp
   class Store
     extend T::Sig
@@ -40,7 +38,7 @@ module RubyLsp
 
     sig { params(uri: URI::Generic, source: String, version: Integer).void }
     def set(uri:, source:, version:)
-      document = Document.new(source: source, version: version, uri: uri, encoding: @encoding)
+      document = RubyDocument.new(source: source, version: version, uri: uri, encoding: @encoding)
       @state[uri.to_s] = document
     end
 

data/lib/ruby_lsp/utils.rb

@@ -8,6 +8,15 @@ module RubyLsp
   # This freeze is not redundant since the interpolated string is mutable
   WORKSPACE_URI = T.let(URI::Generic.from_path(path: Dir.pwd), URI::Generic)
 
+  BUNDLE_PATH = T.let(
+    begin
+      Bundler.bundle_path.to_s
+    rescue Bundler::GemfileNotFound
+      nil
+    end,
+    T.nilable(String),
+  )
+
   # A notification to be sent to the client
   class Message
     extend T::Sig

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.12.2
+  version: 0.12.4
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2023-10-31 00:00:00.000000000 Z
+date: 2023-11-22 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.15.1
+        version: 0.17.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.18'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.15.1
+        version: 0.17.1
     - - "<"
       - !ruby/object:Gem::Version
-        version: '0.16'
+        version: '0.18'
 - !ruby/object:Gem::Dependency
   name: sorbet-runtime
   requirement: !ruby/object:Gem::Requirement
@@ -78,12 +78,12 @@ files:
 - lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb
 - lib/rubocop/cop/ruby_lsp/use_register_with_handler_method.rb
 - lib/ruby-lsp.rb
+- lib/ruby_indexer/lib/ruby_indexer/collector.rb
 - lib/ruby_indexer/lib/ruby_indexer/configuration.rb
 - lib/ruby_indexer/lib/ruby_indexer/entry.rb
 - lib/ruby_indexer/lib/ruby_indexer/index.rb
 - lib/ruby_indexer/lib/ruby_indexer/indexable_path.rb
 - lib/ruby_indexer/lib/ruby_indexer/prefix_tree.rb
-- lib/ruby_indexer/lib/ruby_indexer/visitor.rb
 - lib/ruby_indexer/ruby_indexer.rb
 - lib/ruby_indexer/test/classes_and_modules_test.rb
 - lib/ruby_indexer/test/configuration_test.rb
@@ -132,6 +132,7 @@ files:
 - lib/ruby_lsp/requests/support/source_uri.rb
 - lib/ruby_lsp/requests/support/syntax_tree_formatting_runner.rb
 - lib/ruby_lsp/requests/workspace_symbol.rb
+- lib/ruby_lsp/ruby_document.rb
 - lib/ruby_lsp/server.rb
 - lib/ruby_lsp/setup_bundler.rb
 - lib/ruby_lsp/store.rb