ruby-lsp 0.17.16 → 0.18.0

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

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -5,31 +5,9 @@ require "ruby_lsp/listeners/semantic_highlighting"
 
 module RubyLsp
   module Requests
-    # ![Semantic highlighting demo](../../semantic_highlighting.gif)
-    #
     # The [semantic
     # highlighting](https://microsoft.github.io/language-server-protocol/specification#textDocument_semanticTokens)
     # request informs the editor of the correct token types to provide consistent and accurate highlighting for themes.
-    #
-    # # Example
-    #
-    # ```ruby
-    # def foo
-    #   var = 1 # --> semantic highlighting: local variable
-    #   some_invocation # --> semantic highlighting: method invocation
-    #   var # --> semantic highlighting: local variable
-    # end
-    #
-    # # Strategy
-    #
-    # To maximize editor performance, the Ruby LSP will return the minimum number of semantic tokens, since applying
-    # them is an expensive operation for the client. This means that the server only returns tokens for ambiguous pieces
-    # of syntax, such as method invocations with no receivers or parenthesis (which can be confused with local
-    # variables).
-    #
-    # Offloading as much handling as possible to Text Mate grammars or equivalent will guarantee responsiveness in the
-    # editor and allow for a much smoother experience.
-    # ```
     class SemanticHighlighting < Request
       extend T::Sig
 
@@ -39,7 +17,7 @@ module RubyLsp
         sig { returns(Interface::SemanticTokensRegistrationOptions) }
         def provider
           Interface::SemanticTokensRegistrationOptions.new(
-            document_selector: [{ language: "ruby" }],
+            document_selector: [{ language: "ruby" }, { language: "erb" }],
             legend: Interface::SemanticTokensLegend.new(
               token_types: ResponseBuilders::SemanticHighlighting::TOKEN_TYPES.keys,
               token_modifiers: ResponseBuilders::SemanticHighlighting::TOKEN_MODIFIERS.keys,

data/lib/ruby_lsp/requests/show_syntax_tree.rb

@@ -3,20 +3,9 @@
 
 module RubyLsp
   module Requests
-    # ![Show syntax tree demo](../../show_syntax_tree.gif)
-    #
     # Show syntax tree is a custom [LSP
     # request](https://microsoft.github.io/language-server-protocol/specification#requestMessage) that displays the AST
     # for the current document or for the current selection in a new tab.
-    #
-    # # Example
-    #
-    # ```ruby
-    # # Executing the Ruby LSP: Show syntax tree command will display the AST for the document
-    # 1 + 1
-    # # (program (statements ((binary (int "1") + (int "1")))))
-    # ```
-    #
     class ShowSyntaxTree < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/signature_help.rb

@@ -5,25 +5,9 @@ require "ruby_lsp/listeners/signature_help"
 
 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 < Request
       extend T::Sig
 
@@ -51,10 +35,11 @@ module RubyLsp
       end
       def initialize(document, global_state, position, context, dispatcher, sorbet_level) # rubocop:disable Metrics/ParameterLists
         super()
-        node_context = document.locate_node(
-          { line: position[:line], character: position[:character] },
-          node_types: [Prism::CallNode],
-        )
+
+        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])
 
         target = adjust_for_nested_target(node_context.node, node_context.parent, position)
 

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

@@ -99,7 +99,7 @@ module RubyLsp
             )
 
             definitions << "[#{entry.file_name}](#{uri})"
-            content << "\n\n#{entry.comments.join("\n")}" unless entry.comments.empty?
+            content << "\n\n#{entry.comments}" unless entry.comments.empty?
           end
 
           additional_entries_text = if max_entries && entries.length > max_entries

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

@@ -80,7 +80,9 @@ module RubyLsp
 
           args += DEFAULT_ARGS
           rubocop_options = ::RuboCop::Options.new.parse(args).first
+
           config_store = ::RuboCop::ConfigStore.new
+          config_store.options_config = rubocop_options[:config] if rubocop_options[:config]
           @config_for_working_directory = T.let(config_store.for_pwd, ::RuboCop::Config)
 
           super(rubocop_options, config_store)

data/lib/ruby_lsp/requests/type_hierarchy_supertypes.rb

@@ -3,20 +3,9 @@
 
 module RubyLsp
   module Requests
-    # ![Type hierarchy supertypes demo](../../type_hierarchy_supertypes.gif)
-    #
     # The [type hierarchy supertypes
     # request](https://microsoft.github.io/language-server-protocol/specification#typeHierarchy_supertypes)
     # displays the list of ancestors (supertypes) for the selected type.
-    #
-    # # Example
-    #
-    # ```ruby
-    # class Foo; end
-    # class Bar < Foo; end
-    #
-    # puts Bar # <-- right click on `Bar` and select "Show Type Hierarchy"
-    # ```
     class TypeHierarchySupertypes < Request
       extend T::Sig
 

data/lib/ruby_lsp/requests/workspace_symbol.rb

@@ -3,21 +3,9 @@
 
 module RubyLsp
   module Requests
-    # ![Workspace symbol demo](../../workspace_symbol.gif)
-    #
     # The [workspace symbol](https://microsoft.github.io/language-server-protocol/specification#workspace_symbol)
     # request allows fuzzy searching declarations in the entire project. On VS Code, use CTRL/CMD + T to search for
     # symbols.
-    #
-    # # Example
-    #
-    # ```ruby
-    # # Searching for `Floo` will fuzzy match and return all declarations according to the query, including this `Foo`
-    # class
-    # class Foo
-    # end
-    # ```
-    #
     class WorkspaceSymbol < Request
       extend T::Sig
       include Support::Common

data/lib/ruby_lsp/ruby_document.rb

@@ -121,12 +121,13 @@ module RubyLsp
       end
     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
       @parse_result = Prism.parse(@source)
+      true
     end
 
     sig { override.returns(T::Boolean) }

data/lib/ruby_lsp/server.rb

@@ -9,12 +9,6 @@ module RubyLsp
     sig { returns(GlobalState) }
     attr_reader :global_state
 
-    sig { params(test_mode: T::Boolean).void }
-    def initialize(test_mode: false)
-      super
-      @global_state = T.let(GlobalState.new, GlobalState)
-    end
-
     sig { override.params(message: T::Hash[Symbol, T.untyped]).void }
     def process_message(message)
       case message[:method]
@@ -98,6 +92,8 @@ module RubyLsp
       when "$/cancelRequest"
         @mutex.synchronize { @cancelled_requests << message[:params][:id] }
       end
+    rescue DelegateRequestError
+      send_message(Error.new(id: message[:id], code: DelegateRequestError::CODE, message: "DELEGATE_REQUEST"))
     rescue StandardError, LoadError => e
       # If an error occurred in a request, we have to return an error response or else the editor will hang
       if message[:id]
@@ -284,7 +280,15 @@ module RubyLsp
       RubyVM::YJIT.enable if defined?(RubyVM::YJIT.enable)
 
       if defined?(Requests::Support::RuboCopFormatter)
-        @global_state.register_formatter("rubocop", Requests::Support::RuboCopFormatter.new)
+        begin
+          @global_state.register_formatter("rubocop", Requests::Support::RuboCopFormatter.new)
+        rescue RuboCop::Error => e
+          # The user may have provided unknown config switches in .rubocop or
+          # is trying to load a non-existant config file.
+          send_message(Notification.window_show_error(
+            "RuboCop configuration error: #{e.message}. Formatting will not be available.",
+          ))
+        end
       end
       if defined?(Requests::Support::SyntaxTreeFormatter)
         @global_state.register_formatter("syntax_tree", Requests::Support::SyntaxTreeFormatter.new)
@@ -543,7 +547,7 @@ module RubyLsp
         return
       end
 
-      request = Requests::DocumentHighlight.new(document, params[:position], dispatcher)
+      request = Requests::DocumentHighlight.new(@global_state, document, params[:position], dispatcher)
       dispatcher.dispatch(document.parse_result.value)
       send_message(Result.new(id: message[:id], response: request.perform))
     end
@@ -740,6 +744,17 @@ module RubyLsp
 
     sig { params(message: T::Hash[Symbol, T.untyped]).void }
     def text_document_completion_item_resolve(message)
+      # When responding to a delegated completion request, it means we're handling a completion item that isn't related
+      # to Ruby (probably related to an ERB host language like HTML). We need to return the original completion item
+      # back to the editor so that it's displayed correctly
+      if message.dig(:params, :data, :delegateCompletion)
+        send_message(Result.new(
+          id: message[:id],
+          response: message[:params],
+        ))
+        return
+      end
+
       send_message(Result.new(
         id: message[:id],
         response: Requests::CompletionResolve.new(@global_state, message[:params]).perform,

data/lib/ruby_lsp/setup_bundler.rb

@@ -56,7 +56,7 @@ module RubyLsp
 
     # Sets up the custom bundle and returns the `BUNDLE_GEMFILE`, `BUNDLE_PATH` and `BUNDLE_APP_CONFIG` that should be
     # used for running the server
-    sig { returns([String, T.nilable(String), T.nilable(String)]) }
+    sig { returns(T::Hash[String, String]) }
     def setup!
       raise BundleNotLocked if @gemfile&.exist? && !@lockfile&.exist?
 
@@ -176,22 +176,18 @@ module RubyLsp
       dependencies
     end
 
-    sig { params(bundle_gemfile: T.nilable(Pathname)).returns([String, T.nilable(String), T.nilable(String)]) }
+    sig { params(bundle_gemfile: T.nilable(Pathname)).returns(T::Hash[String, String]) }
     def run_bundle_install(bundle_gemfile = @gemfile)
+      env = bundler_settings_as_env
+      env["BUNDLE_GEMFILE"] = bundle_gemfile.to_s
+
       # If the user has a custom bundle path configured, we need to ensure that we will use the absolute and not
       # relative version of it when running `bundle install`. This is necessary to avoid installing the gems under the
       # `.ruby-lsp` folder, which is not the user's intention. For example, if the path is configured as `vendor`, we
       # want to install it in the top level `vendor` and not `.ruby-lsp/vendor`
-      path = Bundler.settings["path"]
-      expanded_path = File.expand_path(path, @project_path) if path
-
-      # Use the absolute `BUNDLE_PATH` to prevent accidentally creating unwanted folders under `.ruby-lsp`
-      env = {}
-      env["BUNDLE_GEMFILE"] = bundle_gemfile.to_s
-      env["BUNDLE_PATH"] = expanded_path if expanded_path
-
-      local_config_path = File.join(@project_path, ".bundle")
-      env["BUNDLE_APP_CONFIG"] = local_config_path if Dir.exist?(local_config_path)
+      if env["BUNDLE_PATH"]
+        env["BUNDLE_PATH"] = File.expand_path(env["BUNDLE_PATH"], @project_path)
+      end
 
       # If `ruby-lsp` and `debug` (and potentially `ruby-lsp-rails`) are already in the Gemfile, then we shouldn't try
       # to upgrade them or else we'll produce undesired source control changes. If the custom bundle was just created
@@ -238,7 +234,29 @@ module RubyLsp
         return setup!
       end
 
-      [bundle_gemfile.to_s, expanded_path, env["BUNDLE_APP_CONFIG"]]
+      env
+    end
+
+    # Gather all Bundler settings (global and local) and return them as a hash that can be used as the environment
+    sig { returns(T::Hash[String, String]) }
+    def bundler_settings_as_env
+      local_config_path = File.join(@project_path, ".bundle")
+
+      # If there's no Gemfile or if the local config path does not exist, we return an empty setting set (which has the
+      # global settings included). Otherwise, we also load the local settings
+      settings = begin
+        Dir.exist?(local_config_path) ? Bundler::Settings.new(local_config_path) : Bundler::Settings.new
+      rescue Bundler::GemfileNotFound
+        Bundler::Settings.new
+      end
+
+      # Map all settings to their environment variable names with `key_for` and their values. For example, the if the
+      # setting name `e` is `path` with a value of `vendor/bundle`, then it will return `"BUNDLE_PATH" =>
+      # "vendor/bundle"`
+      settings.all.to_h do |e|
+        key = Bundler::Settings.key_for(e)
+        [key, settings[e].to_s]
+      end
     end
 
     sig { returns(T::Boolean) }

data/lib/ruby_lsp/type_inferrer.rb

@@ -121,8 +121,12 @@ module RubyLsp
       return Type.new(node_context.fully_qualified_name) if node_context.surrounding_method
 
       # If we're not inside a method, then we're inside the body of a class or module, which is a singleton
-      # context
-      Type.new("#{nesting.join("::")}::<Class:#{nesting.last}>")
+      # context.
+      #
+      # If the class/module definition is using compact style (e.g.: `class Foo::Bar`), then we need to split the name
+      # into its individual parts to build the correct singleton name
+      parts = nesting.flat_map { |part| part.split("::") }
+      Type.new("#{parts.join("::")}::<Class:#{parts.last}>")
     end
 
     sig do

data/lib/ruby_lsp/utils.rb

@@ -25,7 +25,17 @@ module RubyLsp
     end,
     String,
   )
-  GUESSED_TYPES_URL = "https://github.com/Shopify/ruby-lsp/blob/main/DESIGN_AND_ROADMAP.md#guessed-types"
+  GUESSED_TYPES_URL = "https://shopify.github.io/ruby-lsp/design-and-roadmap.html#guessed-types"
+
+  # Request delegation for embedded languages is not yet standardized into the language server specification. Here we
+  # use this custom error class as a way to return a signal to the client that the request should be delegated to the
+  # language server for the host language. The support for delegation is custom built on the client side, so each editor
+  # needs to implement their own until this becomes a part of the spec
+  class DelegateRequestError < StandardError
+    # A custom error code that clients can use to handle delegate requests. This is past the range of error codes listed
+    # by the specification to avoid conflicting with other error types
+    CODE = -32900
+  end
 
   # A notification to be sent to the client
   class Message

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.17.16
+  version: 0.18.0
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-08-26 00:00:00.000000000 Z
+date: 2024-09-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -28,22 +28,16 @@ dependencies:
   name: prism
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.29.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.31'
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.29.0
-    - - "<"
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.31'
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: rbs
   requirement: !ruby/object:Gem::Requirement
@@ -118,7 +112,6 @@ files:
 - lib/ruby_indexer/test/test_case.rb
 - lib/ruby_lsp/addon.rb
 - lib/ruby_lsp/base_server.rb
-- lib/ruby_lsp/check_docs.rb
 - lib/ruby_lsp/document.rb
 - lib/ruby_lsp/erb_document.rb
 - lib/ruby_lsp/global_state.rb
@@ -207,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.17
+rubygems_version: 3.5.18
 signing_key:
 specification_version: 4
 summary: An opinionated language server for Ruby