ruby-lsp 0.26.4 → 0.26.6

data/lib/ruby_lsp/listeners/hover.rb

@@ -283,10 +283,10 @@ module RubyLsp
         content = KEYWORD_DOCS[keyword]
         return unless content
 
-        doc_path = File.join(STATIC_DOCS_PATH, "#{keyword}.md")
+        doc_uri = URI::Generic.from_path(path: File.join(STATIC_DOCS_PATH, "#{keyword}.md"))
 
         @response_builder.push("```ruby\n#{keyword}\n```", category: :title)
-        @response_builder.push("[Read more](#{doc_path})", category: :links)
+        @response_builder.push("[Read more](#{doc_uri})", category: :links)
         @response_builder.push(content, category: :documentation)
       end
 

data/lib/ruby_lsp/requests/code_action_resolve.rb

@@ -51,20 +51,42 @@ module RubyLsp
       #: -> (Interface::CodeAction)
       def switch_block_style
         source_range = @code_action.dig(:data, :range)
-        raise EmptySelectionError, "Invalid selection for refactor" if source_range[:start] == source_range[:end]
+        if source_range[:start] == source_range[:end]
+          block_context = @document.locate_node(
+            source_range[:start],
+            node_types: [Prism::BlockNode],
+          )
+          node = block_context.node
+          unless node.is_a?(Prism::BlockNode)
+            raise InvalidTargetRangeError, "Cursor is not inside a block"
+          end
 
-        target = @document.locate_first_within_range(
-          @code_action.dig(:data, :range),
-          node_types: [Prism::CallNode],
-        )
+          # Find the call node at the block node's start position.
+          # This should be the call node whose block the cursor is inside of.
+          call_context = RubyDocument.locate(
+            @document.ast,
+            node.location.cached_start_code_units_offset(@document.code_units_cache),
+            node_types: [Prism::CallNode],
+            code_units_cache: @document.code_units_cache,
+          )
+          target = call_context.node
+          unless target.is_a?(Prism::CallNode) && target.block == node
+            raise InvalidTargetRangeError, "Couldn't find an appropriate location to place extracted refactor"
+          end
+        else
+          target = @document.locate_first_within_range(
+            @code_action.dig(:data, :range),
+            node_types: [Prism::CallNode],
+          )
 
-        unless target.is_a?(Prism::CallNode)
-          raise InvalidTargetRangeError, "Couldn't find an appropriate location to place extracted refactor"
-        end
+          unless target.is_a?(Prism::CallNode)
+            raise InvalidTargetRangeError, "Couldn't find an appropriate location to place extracted refactor"
+          end
 
-        node = target.block
-        unless node.is_a?(Prism::BlockNode)
-          raise InvalidTargetRangeError, "Couldn't find an appropriate location to place extracted refactor"
+          node = target.block
+          unless node.is_a?(Prism::BlockNode)
+            raise InvalidTargetRangeError, "Couldn't find an appropriate location to place extracted refactor"
+          end
         end
 
         indentation = " " * target.location.start_column unless node.opening_loc.slice == "do"

data/lib/ruby_lsp/requests/code_actions.rb

@@ -63,12 +63,8 @@ module RubyLsp
             kind: Constant::CodeActionKind::REFACTOR_EXTRACT,
             data: { range: @range, uri: @uri.to_s },
           )
-          code_actions << Interface::CodeAction.new(
-            title: TOGGLE_BLOCK_STYLE_TITLE,
-            kind: Constant::CodeActionKind::REFACTOR_REWRITE,
-            data: { range: @range, uri: @uri.to_s },
-          )
         end
+        code_actions.concat(toggle_block_style_action)
         code_actions.concat(attribute_actions)
 
         code_actions
@@ -113,6 +109,25 @@ module RubyLsp
           ),
         ]
       end
+
+      #: -> Array[Interface::CodeAction]
+      def toggle_block_style_action
+        if @range[:start] == @range[:end]
+          block_context = @document.locate_node(
+            @range[:start],
+            node_types: [Prism::BlockNode],
+          )
+          return [] unless block_context.node.is_a?(Prism::BlockNode)
+        end
+
+        [
+          Interface::CodeAction.new(
+            title: TOGGLE_BLOCK_STYLE_TITLE,
+            kind: Constant::CodeActionKind::REFACTOR_REWRITE,
+            data: { range: @range, uri: @uri.to_s },
+          ),
+        ]
+      end
     end
   end
 end

data/lib/ruby_lsp/requests/completion_resolve.rb

@@ -68,10 +68,12 @@ module RubyLsp
           "[Learn more about guessed types](#{GUESSED_TYPES_URL})"
         end
 
-        @item[:documentation] = Interface::MarkupContent.new(
-          kind: "markdown",
-          value: markdown_from_index_entries(label, entries, MAX_DOCUMENTATION_ENTRIES, extra_links: extra_links),
-        )
+        unless @item[:kind] == Constant::CompletionItemKind::FILE
+          @item[:documentation] = Interface::MarkupContent.new(
+            kind: "markdown",
+            value: markdown_from_index_entries(label, entries, MAX_DOCUMENTATION_ENTRIES, extra_links: extra_links),
+          )
+        end
 
         @item
       end
@@ -84,7 +86,7 @@ module RubyLsp
         content = KEYWORD_DOCS[keyword]
 
         if content
-          doc_path = File.join(STATIC_DOCS_PATH, "#{keyword}.md")
+          doc_uri = URI::Generic.from_path(path: File.join(STATIC_DOCS_PATH, "#{keyword}.md"))
 
           @item[:documentation] = Interface::MarkupContent.new(
             kind: "markdown",
@@ -93,7 +95,7 @@ module RubyLsp
               #{keyword}
               ```
 
-              [Read more](#{doc_path})
+              [Read more](#{doc_uri})
 
               #{content}
             MARKDOWN

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

@@ -5,6 +5,7 @@ require "uri/file"
 
 module URI
   # Must be kept in sync with the one in Tapioca
+  # https://github.com/Shopify/tapioca/blob/main/lib/tapioca/helpers/source_uri.rb
   class Source < URI::File
     COMPONENT = [
       :scheme,
@@ -21,16 +22,14 @@ module URI
     # have the uri gem in their own bundle and thus not use a compatible version.
     PARSER = const_defined?(:RFC2396_PARSER) ? RFC2396_PARSER : DEFAULT_PARSER #: RFC2396_Parser
 
-    self #: as untyped # rubocop:disable Style/RedundantSelf
-      .alias_method(:gem_name, :host)
-    self #: as untyped # rubocop:disable Style/RedundantSelf
-      .alias_method(:line_number, :fragment)
+    alias_method(:gem_name, :host)
+    alias_method(:line_number, :fragment)
 
     #: String?
     attr_reader :gem_version
 
     class << self
-      #: (gem_name: String, gem_version: String?, path: String, line_number: String?) -> URI::Source
+      #: (gem_name: String, gem_version: String?, path: String, line_number: String?) -> instance
       def build(gem_name:, gem_version:, path:, line_number:)
         super(
           {
@@ -67,12 +66,14 @@ module URI
 
     #: -> String
     def to_s
-      "source://#{gem_name}/#{gem_version}#{path}##{line_number}"
+      "source://#{gem_name}/#{gem_version}/#{path}##{line_number}"
     end
 
     if URI.respond_to?(:register_scheme)
+      # Handle URI 0.11.0 and newer https://github.com/ruby/uri/pull/26
       URI.register_scheme("SOURCE", self)
     else
+      # Fallback for URI <0.11.0
       @@schemes = @@schemes #: Hash[String, untyped] # rubocop:disable Style/ClassVars
       @@schemes["SOURCE"] = self
     end

data/lib/ruby_lsp/scripts/compose_bundle.rb

@@ -5,7 +5,7 @@ def compose(raw_initialize)
   require_relative "../setup_bundler"
   require "json"
   require "uri"
-  require "ruby_indexer/lib/ruby_indexer/uri"
+  require_relative "../../ruby_indexer/lib/ruby_indexer/uri"
 
   initialize_request = JSON.parse(raw_initialize, symbolize_names: true)
   workspace_uri = initialize_request.dig(:params, :workspaceFolders, 0, :uri)

data/lib/ruby_lsp/setup_bundler.rb

@@ -31,12 +31,16 @@ module RubyLsp
 
     FOUR_HOURS = 4 * 60 * 60 #: Integer
 
+    # Gems that should be kept up to date in the composed bundle. When updating, any of these gems that are not
+    # already in the user's Gemfile will be updated together.
+    GEMS_TO_UPDATE = ["ruby-lsp", "debug", "prism", "rbs"].freeze #: Array[String]
+
     #: (String project_path, **untyped options) -> void
     def initialize(project_path, **options)
       @project_path = project_path
       @branch = options[:branch] #: String?
       @launcher = options[:launcher] #: bool?
-      patch_thor_to_print_progress_to_stderr! if @launcher
+      force_output_to_stderr! if @launcher
 
       # Regular bundle paths
       @gemfile = begin
@@ -282,14 +286,25 @@ module RubyLsp
 
       return update(env) if @needs_update_path.exist?
 
-      # The ENV can only be merged after checking if an update is required because we depend on the original value of
-      # ENV["BUNDLE_GEMFILE"], which gets overridden after the merge
       FileUtils.touch(@needs_update_path) if needs_update
 
       $stderr.puts("Ruby LSP> Checking if the composed bundle is satisfied...")
-      missing_gems = bundle_check
 
-      unless missing_gems.empty?
+      begin
+        missing_gems = bundle_check
+      rescue Errno::EPIPE, Bundler::HTTPError
+        # These are errors cases where we cannot recover
+        raise
+      rescue => e
+        # If anything fails with bundle check, try to bundle install
+        $stderr.puts("Ruby LSP> Running bundle install because #{e.message}")
+        bundle_install
+        return env
+      end
+
+      if missing_gems.empty?
+        $stderr.puts("Ruby LSP> Bundle already satisfied")
+      else
         $stderr.puts(<<~MESSAGE)
           Ruby LSP> Running bundle install because the following gems are not installed:
           #{missing_gems.map { |g| "#{g.name}: #{g.version}" }.join("\n")}
@@ -298,11 +313,6 @@ module RubyLsp
         bundle_install
       end
 
-      $stderr.puts("Ruby LSP> Bundle already satisfied")
-      env
-    rescue => e
-      $stderr.puts("Ruby LSP> Running bundle install because #{e.message}")
-      bundle_install
       env
     end
 
@@ -325,7 +335,7 @@ module RubyLsp
     def update(env)
       # Try to auto upgrade the gems we depend on, unless they are in the Gemfile as that would result in undesired
       # source control changes
-      gems = ["ruby-lsp", "debug", "prism"].reject { |dep| @dependencies[dep] }
+      gems = GEMS_TO_UPDATE.reject { |dep| @dependencies[dep] }
       gems << "ruby-lsp-rails" if @rails_app && !@dependencies["ruby-lsp-rails"]
 
       Bundler::CLI::Update.new({ conservative: true }, gems).run
@@ -337,14 +347,14 @@ module RubyLsp
 
     #: (Hash[String, String] env) -> Hash[String, String]
     def run_bundle_install_through_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 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
+      # If the gems in GEMS_TO_UPDATE (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 composed bundle was just
+      # created and any of those gems 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
 
       # When not updating, we run `(bundle check || bundle install)`
-      # When updating, we run `((bundle check && bundle update ruby-lsp debug) || bundle install)`
+      # When updating, we run `((bundle check && bundle update <GEMS_TO_UPDATE>) || bundle install)`
       bundler_path = File.join(Gem.default_bindir, "bundle")
       base_command = (!Gem.win_platform? && File.exist?(bundler_path) ? "#{Gem.ruby} #{bundler_path}" : "bundle").dup
 
@@ -355,12 +365,11 @@ module RubyLsp
       command = +"(#{base_command} check"
 
       if should_bundle_update?
-        # If any of `ruby-lsp`, `ruby-lsp-rails` or `debug` are not in the Gemfile, try to update them to the latest
-        # version
+        # If any of the gems in GEMS_TO_UPDATE (or `ruby-lsp-rails` for Rails apps) are not in the Gemfile, try to
+        # update them to the latest version
         command.prepend("(")
         command << " && #{base_command} update "
-        command << "ruby-lsp " unless @dependencies["ruby-lsp"]
-        command << "debug " unless @dependencies["debug"]
+        GEMS_TO_UPDATE.each { |gem| command << "#{gem} " unless @dependencies[gem] }
         command << "ruby-lsp-rails " if @rails_app && !@dependencies["ruby-lsp-rails"]
         command.delete_suffix!(" ")
         command << ")"
@@ -489,11 +498,16 @@ module RubyLsp
     end
 
     #: -> void
-    def patch_thor_to_print_progress_to_stderr!
-      return unless defined?(Bundler::Thor::Shell::Basic)
+    def force_output_to_stderr!
+      # Bundler and RubyGems have different UI objects used for printing. We need to ensure that both are configured to
+      # print only to stderr or else they'll break the connection with the editor
+      Gem::DefaultUserInteraction.ui = Gem::StreamUI.new($stdin, $stderr, $stderr, false)
+
+      ui = Bundler.ui
+      ui.output_stream = :stderr if ui.respond_to?(:output_stream=)
+      ui.level = :info
 
-      Bundler::Thor::Shell::Basic.prepend(ThorPatch)
-      Bundler.ui.level = :info
+      Bundler::Thor::Shell::Basic.prepend(ThorPatch) if defined?(Bundler::Thor::Shell::Basic)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.26.4
+  version: 0.26.6
 platform: ruby
 authors:
 - Shopify
@@ -96,20 +96,6 @@ files:
 - lib/ruby_indexer/lib/ruby_indexer/uri.rb
 - lib/ruby_indexer/lib/ruby_indexer/visibility_scope.rb
 - lib/ruby_indexer/ruby_indexer.rb
-- lib/ruby_indexer/test/class_variables_test.rb
-- lib/ruby_indexer/test/classes_and_modules_test.rb
-- lib/ruby_indexer/test/configuration_test.rb
-- lib/ruby_indexer/test/constant_test.rb
-- lib/ruby_indexer/test/enhancements_test.rb
-- lib/ruby_indexer/test/global_variable_test.rb
-- lib/ruby_indexer/test/index_test.rb
-- lib/ruby_indexer/test/instance_variables_test.rb
-- lib/ruby_indexer/test/method_test.rb
-- lib/ruby_indexer/test/prefix_tree_test.rb
-- lib/ruby_indexer/test/rbs_indexer_test.rb
-- lib/ruby_indexer/test/reference_finder_test.rb
-- lib/ruby_indexer/test/test_case.rb
-- lib/ruby_indexer/test/uri_test.rb
 - lib/ruby_lsp/addon.rb
 - lib/ruby_lsp/base_server.rb
 - lib/ruby_lsp/client_capabilities.rb
@@ -217,7 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.7.2
+rubygems_version: 4.0.3
 specification_version: 4
 summary: An opinionated language server for Ruby
 test_files: []

data/lib/ruby_indexer/test/class_variables_test.rb

@@ -1,140 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require_relative "test_case"
-
-module RubyIndexer
-  class ClassVariableTest < TestCase
-    def test_class_variable_and_write
-      index(<<~RUBY)
-        class Foo
-          @@bar &&= 1
-        end
-      RUBY
-
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-
-    def test_class_variable_operator_write
-      index(<<~RUBY)
-        class Foo
-          @@bar += 1
-        end
-      RUBY
-
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-    end
-
-    def test_class_variable_or_write
-      index(<<~RUBY)
-        class Foo
-          @@bar ||= 1
-        end
-      RUBY
-
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-    end
-
-    def test_class_variable_target_node
-      index(<<~RUBY)
-        class Foo
-          @@foo, @@bar = 1
-        end
-      RUBY
-
-      assert_entry("@@foo", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-9:1-14")
-
-      entry = @index["@@foo"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-
-    def test_class_variable_write
-      index(<<~RUBY)
-        class Foo
-          @@bar = 1
-        end
-      RUBY
-
-      assert_entry("@@bar", Entry::ClassVariable, "/fake/path/foo.rb:1-2:1-7")
-    end
-
-    def test_empty_name_class_variable
-      index(<<~RUBY)
-        module Foo
-          @@ = 1
-        end
-      RUBY
-
-      refute_entry("@@")
-    end
-
-    def test_top_level_class_variable
-      index(<<~RUBY)
-        @@foo = 123
-      RUBY
-
-      entry = @index["@@foo"]&.first #: as Entry::ClassVariable
-      assert_nil(entry.owner)
-    end
-
-    def test_class_variable_inside_self_method
-      index(<<~RUBY)
-        class Foo
-          def self.bar
-            @@bar = 123
-          end
-        end
-      RUBY
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-
-    def test_class_variable_inside_singleton_class
-      index(<<~RUBY)
-        class Foo
-          class << self
-            @@bar = 123
-          end
-        end
-      RUBY
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-
-    def test_class_variable_in_singleton_class_method
-      index(<<~RUBY)
-        class Foo
-          class << self
-            def self.bar
-              @@bar = 123
-            end
-          end
-        end
-      RUBY
-
-      entry = @index["@@bar"]&.first #: as Entry::ClassVariable
-      owner = entry.owner #: as !nil
-      assert_instance_of(Entry::Class, owner)
-      assert_equal("Foo", owner.name)
-    end
-  end
-end