ruby-lsp 0.21.0 → 0.22.1

data/lib/ruby_lsp/listeners/document_symbol.rb

@@ -41,6 +41,9 @@ module RubyLsp
           :on_module_node_enter,
           :on_module_node_leave,
           :on_instance_variable_write_node_enter,
+          :on_instance_variable_operator_write_node_enter,
+          :on_instance_variable_or_write_node_enter,
+          :on_instance_variable_and_write_node_enter,
           :on_class_variable_write_node_enter,
           :on_singleton_class_node_enter,
           :on_singleton_class_node_leave,
@@ -249,21 +252,51 @@ module RubyLsp
         @response_builder.pop
       end
 
+      sig { params(node: Prism::ClassVariableWriteNode).void }
+      def on_class_variable_write_node_enter(node)
+        create_document_symbol(
+          name: node.name.to_s,
+          kind: Constant::SymbolKind::VARIABLE,
+          range_location: node.name_loc,
+          selection_range_location: node.name_loc,
+        )
+      end
+
       sig { params(node: Prism::InstanceVariableWriteNode).void }
       def on_instance_variable_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
-          kind: Constant::SymbolKind::VARIABLE,
+          kind: Constant::SymbolKind::FIELD,
           range_location: node.name_loc,
           selection_range_location: node.name_loc,
         )
       end
 
-      sig { params(node: Prism::ClassVariableWriteNode).void }
-      def on_class_variable_write_node_enter(node)
+      sig { params(node: Prism::InstanceVariableOperatorWriteNode).void }
+      def on_instance_variable_operator_write_node_enter(node)
         create_document_symbol(
           name: node.name.to_s,
-          kind: Constant::SymbolKind::VARIABLE,
+          kind: Constant::SymbolKind::FIELD,
+          range_location: node.name_loc,
+          selection_range_location: node.name_loc,
+        )
+      end
+
+      sig { params(node: Prism::InstanceVariableOrWriteNode).void }
+      def on_instance_variable_or_write_node_enter(node)
+        create_document_symbol(
+          name: node.name.to_s,
+          kind: Constant::SymbolKind::FIELD,
+          range_location: node.name_loc,
+          selection_range_location: node.name_loc,
+        )
+      end
+
+      sig { params(node: Prism::InstanceVariableAndWriteNode).void }
+      def on_instance_variable_and_write_node_enter(node)
+        create_document_symbol(
+          name: node.name.to_s,
+          kind: Constant::SymbolKind::FIELD,
           range_location: node.name_loc,
           selection_range_location: node.name_loc,
         )

data/lib/ruby_lsp/requests/definition.rb

@@ -118,6 +118,8 @@ module RubyLsp
           Prism::InstanceVariableWriteNode
 
           !covers_position?(target.name_loc, position)
+        when Prism::CallNode
+          !covers_position?(target.message_loc, position)
         else
           false
         end

data/lib/ruby_lsp/requests/document_highlight.rb

@@ -38,7 +38,13 @@ module RubyLsp
           ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight].new,
           ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight],
         )
-        Listeners::DocumentHighlight.new(@response_builder, node_context.node, node_context.parent, dispatcher)
+        Listeners::DocumentHighlight.new(
+          @response_builder,
+          node_context.node,
+          node_context.parent,
+          dispatcher,
+          position,
+        )
       end
 
       sig { override.returns(T::Array[Interface::DocumentHighlight]) }

data/lib/ruby_lsp/requests/hover.rb

@@ -103,6 +103,8 @@ module RubyLsp
           Prism::GlobalVariableOrWriteNode,
           Prism::GlobalVariableWriteNode
           !covers_position?(target.name_loc, position)
+        when Prism::CallNode
+          !covers_position?(target.message_loc, position)
         else
           false
         end

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

@@ -15,6 +15,7 @@ rescue LoadError
   return
 end
 
+# Remember to update the version in the documentation (usage/dependency-compatibility section) if you change this
 # Ensure that RuboCop is at least version 1.4.0
 begin
   gem("rubocop", ">= 1.4.0")

data/lib/ruby_lsp/server.rb

@@ -81,8 +81,6 @@ module RubyLsp
         workspace_did_change_watched_files(message)
       when "workspace/symbol"
         workspace_symbol(message)
-      when "window/showMessageRequest"
-        window_show_message_request(message)
       when "rubyLsp/textDocument/showSyntaxTree"
         text_document_show_syntax_tree(message)
       when "rubyLsp/workspace/dependencies"
@@ -108,6 +106,8 @@ module RubyLsp
         )
       when "$/cancelRequest"
         @mutex.synchronize { @cancelled_requests << message[:params][:id] }
+      when nil
+        process_response(message) if message[:result]
       end
     rescue DelegateRequestError
       send_message(Error.new(id: message[:id], code: DelegateRequestError::CODE, message: "DELEGATE_REQUEST"))
@@ -140,6 +140,15 @@ module RubyLsp
       send_log_message("Error processing #{message[:method]}: #{e.full_message}", type: Constant::MessageType::ERROR)
     end
 
+    # Process responses to requests that were sent to the client
+    sig { params(message: T::Hash[Symbol, T.untyped]).void }
+    def process_response(message)
+      case message.dig(:result, :method)
+      when "window/showMessageRequest"
+        window_show_message_request(message)
+      end
+    end
+
     sig { params(include_project_addons: T::Boolean).void }
     def load_addons(include_project_addons: true)
       # If invoking Bundler.setup failed, then the load path will not be configured properly and trying to load add-ons
@@ -188,8 +197,6 @@ module RubyLsp
       client_name = options.dig(:clientInfo, :name)
       @store.client_name = client_name if client_name
 
-      progress = options.dig(:capabilities, :window, :workDoneProgress)
-      @store.supports_progress = progress.nil? ? true : progress
       configured_features = options.dig(:initializationOptions, :enabledFeatures)
 
       configured_hints = options.dig(:initializationOptions, :featuresConfiguration, :inlayHint)
@@ -209,6 +216,13 @@ module RubyLsp
         Hash.new(true)
       end
 
+      bundle_env_path = File.join(".ruby-lsp", "bundle_env")
+      bundle_env = if File.exist?(bundle_env_path)
+        env = File.readlines(bundle_env_path).to_h { |line| T.cast(line.chomp.split("=", 2), [String, String]) }
+        FileUtils.rm(bundle_env_path)
+        env
+      end
+
       document_symbol_provider = Requests::DocumentSymbol.provider if enabled_features["documentSymbols"]
       document_link_provider = Requests::DocumentLink.provider if enabled_features["documentLink"]
       code_lens_provider = Requests::CodeLens.provider if enabled_features["codeLens"]
@@ -262,6 +276,7 @@ module RubyLsp
         },
         formatter: @global_state.formatter,
         degraded_mode: !!(@install_error || @setup_error),
+        bundle_env: bundle_env,
       }
 
       send_message(Result.new(id: message[:id], response: response))
@@ -597,6 +612,11 @@ module RubyLsp
       # don't want to format it
       path = uri.to_standardized_path
       unless path.nil? || path.start_with?(@global_state.workspace_path)
+        send_log_message(<<~MESSAGE)
+          Ignoring formatting request for file outside of the workspace.
+          Workspace path was set by editor as #{@global_state.workspace_path}.
+          File path requested for formatting was #{path}
+        MESSAGE
         send_empty_response(message[:id])
         return
       end
@@ -1105,7 +1125,7 @@ module RubyLsp
 
     sig { params(id: String, title: String, percentage: Integer).void }
     def begin_progress(id, title, percentage: 0)
-      return unless @store.supports_progress
+      return unless @global_state.client_capabilities.supports_progress
 
       send_message(Request.new(
         id: @current_request_id,
@@ -1113,52 +1133,21 @@ module RubyLsp
         params: Interface::WorkDoneProgressCreateParams.new(token: id),
       ))
 
-      send_message(Notification.new(
-        method: "$/progress",
-        params: Interface::ProgressParams.new(
-          token: id,
-          value: Interface::WorkDoneProgressBegin.new(
-            kind: "begin",
-            title: title,
-            percentage: percentage,
-            message: "#{percentage}% completed",
-          ),
-        ),
-      ))
+      send_message(Notification.progress_begin(id, title, percentage: percentage, message: "#{percentage}% completed"))
     end
 
     sig { params(id: String, percentage: Integer).void }
     def progress(id, percentage)
-      return unless @store.supports_progress
+      return unless @global_state.client_capabilities.supports_progress
 
-      send_message(
-        Notification.new(
-          method: "$/progress",
-          params: Interface::ProgressParams.new(
-            token: id,
-            value: Interface::WorkDoneProgressReport.new(
-              kind: "report",
-              percentage: percentage,
-              message: "#{percentage}% completed",
-            ),
-          ),
-        ),
-      )
+      send_message(Notification.progress_report(id, percentage: percentage, message: "#{percentage}% completed"))
     end
 
     sig { params(id: String).void }
     def end_progress(id)
-      return unless @store.supports_progress
+      return unless @global_state.client_capabilities.supports_progress
 
-      send_message(
-        Notification.new(
-          method: "$/progress",
-          params: Interface::ProgressParams.new(
-            token: id,
-            value: Interface::WorkDoneProgressEnd.new(kind: "end"),
-          ),
-        ),
-      )
+      send_message(Notification.progress_end(id))
     rescue ClosedQueueError
       # If the server was killed and the message queue is already closed, there's no way to end the progress
       # notification
@@ -1226,11 +1215,14 @@ module RubyLsp
 
     sig { params(message: T::Hash[Symbol, T.untyped]).void }
     def window_show_message_request(message)
-      addon_name = message[:addon_name]
+      result = message[:result]
+      return unless result
+
+      addon_name = result[:addon_name]
       addon = Addon.addons.find { |addon| addon.name == addon_name }
       return unless addon
 
-      addon.handle_window_show_message_response(message[:title])
+      addon.handle_window_show_message_response(result[:title])
     end
   end
 end

data/lib/ruby_lsp/setup_bundler.rb

@@ -12,7 +12,7 @@ require "digest"
 require "time"
 require "uri"
 
-# This file is a script that will configure a custom bundle for the Ruby LSP. The custom bundle allows developers to use
+# This file is a script that will configure a composed bundle for the Ruby LSP. The composed bundle allows developers to use
 # 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.
 
@@ -45,6 +45,9 @@ module RubyLsp
       )
       @lockfile = T.let(@gemfile ? Bundler.default_lockfile : nil, T.nilable(Pathname))
 
+      @gemfile_hash = T.let(@gemfile ? Digest::SHA256.hexdigest(@gemfile.read) : nil, T.nilable(String))
+      @lockfile_hash = T.let(@lockfile&.exist? ? Digest::SHA256.hexdigest(@lockfile.read) : nil, T.nilable(String))
+
       @gemfile_name = T.let(@gemfile&.basename&.to_s || "Gemfile", String)
 
       # Custom bundle paths
@@ -62,7 +65,7 @@ module RubyLsp
       @retry = T.let(false, T::Boolean)
     end
 
-    # Sets up the custom bundle and returns the `BUNDLE_GEMFILE`, `BUNDLE_PATH` and `BUNDLE_APP_CONFIG` that should be
+    # Sets up the composed bundle and returns the `BUNDLE_GEMFILE`, `BUNDLE_PATH` and `BUNDLE_APP_CONFIG` that should be
     # used for running the server
     sig { returns(T::Hash[String, String]) }
     def setup!
@@ -73,12 +76,12 @@ module RubyLsp
       ignore_file = @custom_dir + ".gitignore"
       ignore_file.write("*") unless ignore_file.exist?
 
-      # Do not set up a custom bundle if LSP dependencies are already in the Gemfile
+      # Do not set up a composed bundle if LSP dependencies are already in the Gemfile
       if @dependencies["ruby-lsp"] &&
           @dependencies["debug"] &&
           (@rails_app ? @dependencies["ruby-lsp-rails"] : true)
         $stderr.puts(
-          "Ruby LSP> Skipping custom bundle setup since LSP dependencies are already in #{@gemfile}",
+          "Ruby LSP> Skipping composed bundle setup since LSP dependencies are already in #{@gemfile}",
         )
 
         return run_bundle_install
@@ -91,27 +94,25 @@ module RubyLsp
         return run_bundle_install(@custom_gemfile)
       end
 
-      lockfile_contents = @lockfile.read
-      current_lockfile_hash = Digest::SHA256.hexdigest(lockfile_contents)
-
-      if @custom_lockfile.exist? && @lockfile_hash_path.exist? && @lockfile_hash_path.read == current_lockfile_hash
+      if @lockfile_hash && @custom_lockfile.exist? && @lockfile_hash_path.exist? &&
+          @lockfile_hash_path.read == @lockfile_hash
         $stderr.puts(
-          "Ruby LSP> Skipping custom bundle setup since #{@custom_lockfile} already exists and is up to date",
+          "Ruby LSP> Skipping composed bundle setup since #{@custom_lockfile} already exists and is up to date",
         )
         return run_bundle_install(@custom_gemfile)
       end
 
       FileUtils.cp(@lockfile.to_s, @custom_lockfile.to_s)
       correct_relative_remote_paths
-      @lockfile_hash_path.write(current_lockfile_hash)
+      @lockfile_hash_path.write(@lockfile_hash)
       run_bundle_install(@custom_gemfile)
     end
 
     private
 
     sig { returns(T::Hash[String, T.untyped]) }
-    def custom_bundle_dependencies
-      @custom_bundle_dependencies ||= T.let(
+    def composed_bundle_dependencies
+      @composed_bundle_dependencies ||= T.let(
         begin
           original_bundle_gemfile = ENV["BUNDLE_GEMFILE"]
 
@@ -136,8 +137,8 @@ module RubyLsp
         "",
       ]
 
-      # If there's a top level Gemfile, we want to evaluate from the custom bundle. We get the source from the top level
-      # Gemfile, so if there isn't one we need to add a default source
+      # If there's a top level Gemfile, we want to evaluate from the composed bundle. We get the source from the top
+      # level Gemfile, so if there isn't one we need to add a default source
       if @gemfile&.exist? && @lockfile&.exist?
         parts << "eval_gemfile(File.expand_path(\"../#{@gemfile_name}\", __dir__))"
       else
@@ -187,7 +188,7 @@ module RubyLsp
       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
+      # If the user has a composed 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`
@@ -214,6 +215,23 @@ module RubyLsp
         @error_path.write(Marshal.dump(e))
       end
 
+      # If either the Gemfile or the lockfile have been modified during the process of setting up the bundle, retry
+      # composing the bundle from scratch
+
+      if @gemfile && @lockfile
+        current_gemfile_hash = Digest::SHA256.hexdigest(@gemfile.read)
+        current_lockfile_hash = Digest::SHA256.hexdigest(@lockfile.read)
+
+        if !@retry && (current_gemfile_hash != @gemfile_hash || current_lockfile_hash != @lockfile_hash)
+          @gemfile_hash = current_gemfile_hash
+          @lockfile_hash = current_lockfile_hash
+          @retry = true
+          @custom_dir.rmtree
+          $stderr.puts("Ruby LSP> Bundle was modified during setup. Retrying from scratch...")
+          return setup!
+        end
+      end
+
       env
     end
 
@@ -244,7 +262,7 @@ module RubyLsp
       base_bundle = base_bundle_command(env)
 
       # 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
+      # to upgrade them or else we'll produce undesired source control changes. If the composed bundle was just created
       # and any of `ruby-lsp`, `ruby-lsp-rails` or `debug` weren't a part of the Gemfile, then we need to run `bundle
       # install` for the first time to generate the Gemfile.lock with them included or else Bundler will complain that
       # they're missing. We can only update if the custom `.ruby-lsp/Gemfile.lock` already exists and includes all gems
@@ -274,16 +292,16 @@ module RubyLsp
       command << "1>&2"
 
       # Add bundle update
-      $stderr.puts("Ruby LSP> Running bundle install for the custom bundle. This may take a while...")
+      $stderr.puts("Ruby LSP> Running bundle install for the composed bundle. This may take a while...")
       $stderr.puts("Ruby LSP> Command: #{command}")
 
-      # Try to run the bundle install or update command. If that fails, it normally means that the custom lockfile is in
-      # a bad state that no longer reflects the top level one. In that case, we can remove the whole directory, try
+      # Try to run the bundle install or update command. If that fails, it normally means that the composed lockfile is
+      # in a bad state that no longer reflects the top level one. In that case, we can remove the whole directory, try
       # another time and give up if it fails again
       if !system(env, command) && !@retry && @custom_gemfile.exist?
         @retry = true
         @custom_dir.rmtree
-        $stderr.puts("Ruby LSP> Running bundle install failed. Trying to re-generate the custom bundle from scratch")
+        $stderr.puts("Ruby LSP> Running bundle install failed. Trying to re-generate the composed bundle from scratch")
         return setup!
       end
 
@@ -330,14 +348,14 @@ module RubyLsp
       if @rails_app
         return false if @dependencies.values_at("ruby-lsp", "ruby-lsp-rails", "debug").all?
 
-        # If the custom lockfile doesn't include `ruby-lsp`, `ruby-lsp-rails` or `debug`, we need to run bundle install
-        # before updating
-        return false if custom_bundle_dependencies.values_at("ruby-lsp", "debug", "ruby-lsp-rails").any?(&:nil?)
+        # If the composed lockfile doesn't include `ruby-lsp`, `ruby-lsp-rails` or `debug`, we need to run bundle
+        # install before updating
+        return false if composed_bundle_dependencies.values_at("ruby-lsp", "debug", "ruby-lsp-rails").any?(&:nil?)
       else
         return false if @dependencies.values_at("ruby-lsp", "debug").all?
 
-        # If the custom lockfile doesn't include `ruby-lsp` or `debug`, we need to run bundle install before updating
-        return false if custom_bundle_dependencies.values_at("ruby-lsp", "debug").any?(&:nil?)
+        # If the composed lockfile doesn't include `ruby-lsp` or `debug`, we need to run bundle install before updating
+        return false if composed_bundle_dependencies.values_at("ruby-lsp", "debug").any?(&:nil?)
       end
 
       # If the last updated file doesn't exist or was updated more than 4 hours ago, we should update
@@ -359,6 +377,9 @@ module RubyLsp
         else
           match
         end
+      rescue URI::InvalidURIError, URI::InvalidComponentError
+        # If the path raises an invalid error, it might be a git ssh path, which indeed isn't a URI
+        match
       end
 
       @custom_lockfile.write(content)

data/lib/ruby_lsp/store.rb

@@ -7,9 +7,6 @@ module RubyLsp
 
     class NonExistingDocumentError < StandardError; end
 
-    sig { returns(T::Boolean) }
-    attr_accessor :supports_progress
-
     sig { returns(T::Hash[Symbol, RequestConfig]) }
     attr_accessor :features_configuration
 
@@ -19,7 +16,6 @@ module RubyLsp
     sig { void }
     def initialize
       @state = T.let({}, T::Hash[String, Document[T.untyped]])
-      @supports_progress = T.let(true, T::Boolean)
       @features_configuration = T.let(
         {
           inlayHint: RequestConfig.new({

data/lib/ruby_lsp/utils.rb

@@ -87,6 +87,61 @@ module RubyLsp
           params: data,
         )
       end
+
+      sig do
+        params(
+          id: String,
+          title: String,
+          percentage: T.nilable(Integer),
+          message: T.nilable(String),
+        ).returns(Notification)
+      end
+      def progress_begin(id, title, percentage: nil, message: nil)
+        new(
+          method: "$/progress",
+          params: Interface::ProgressParams.new(
+            token: id,
+            value: Interface::WorkDoneProgressBegin.new(
+              kind: "begin",
+              title: title,
+              percentage: percentage,
+              message: message,
+            ),
+          ),
+        )
+      end
+
+      sig do
+        params(
+          id: String,
+          percentage: T.nilable(Integer),
+          message: T.nilable(String),
+        ).returns(Notification)
+      end
+      def progress_report(id, percentage: nil, message: nil)
+        new(
+          method: "$/progress",
+          params: Interface::ProgressParams.new(
+            token: id,
+            value: Interface::WorkDoneProgressReport.new(
+              kind: "report",
+              percentage: percentage,
+              message: message,
+            ),
+          ),
+        )
+      end
+
+      sig { params(id: String).returns(Notification) }
+      def progress_end(id)
+        Notification.new(
+          method: "$/progress",
+          params: Interface::ProgressParams.new(
+            token: id,
+            value: Interface::WorkDoneProgressEnd.new(kind: "end"),
+          ),
+        )
+      end
     end
 
     extend T::Sig

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.21.0
+  version: 0.22.1
 platform: ruby
 authors:
 - Shopify
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2024-10-31 00:00:00.000000000 Z
+date: 2024-11-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -217,7 +217,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.22
+rubygems_version: 3.5.23
 signing_key:
 specification_version: 4
 summary: An opinionated language server for Ruby