ruby-lsp 0.26.5 → 0.26.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1c0285974bdf15d052431c1401f320645f57d8bd186ce9899dafc53f11da269a
-  data.tar.gz: d17e63e0b0db476033d2dfcaec8e40b4131f97cde55c7ade2cd2977ead23dc15
+  metadata.gz: a2fb06df12b49f414c218bd2cb6a1ef5b817dff076894fa6e2ae6585a370f172
+  data.tar.gz: b9fef2a34f9361b8f4b3f74ecb3c64d53226964293bb01f4b7400ce1688746e9
 SHA512:
-  metadata.gz: 26f63dc15bacf617c683dbb7b55fbf1eee1d2f8051b207a27cead0479b475c16d9cb31fbee3fc180f3c054cfd6754c2e5427ec1fa7d4330a17ff3a0ccd9c5f92
-  data.tar.gz: 1717199121bee0e9e72dc7bac4ba1779cbed7d4480f7f58bf046b9a3ac8c752c34fe4584eadcf45f98437bbdfb5a3ebcad36cf6951318cf4c63ae6fb84e5b41e
+  metadata.gz: 5e2c4674e72af204f3b4c78b6053e205c9a4c7ffd5b99642cf78db3c469c0334f3952e3326c7b091b54974e2cd523716dcb8c0b1c17d861b9f80f87bbedd4056
+  data.tar.gz: d3aaba57e7f33f5a46bdd12a69f7c965e50bcb95049032e1ee12c21d538f4d3ffc6220e798abd0fa6488085f9cb45fea468e7a9318097b16ba9d73923e2ea9a5

data/VERSION

@@ -1 +1 @@
-0.26.5
+0.26.7

data/exe/ruby-lsp-launcher

@@ -101,7 +101,7 @@ begin
     Bundler.setup
     $stderr.puts("Composed Bundle set up successfully")
   end
-rescue Bundler::GemNotFound, Bundler::GitError
+rescue Bundler::GemNotFound, Bundler::GitError => e
   # Sometimes, we successfully set up the bundle, but users either change their Gemfile or uninstall gems from an
   # external process. If there's no install error, but the gem is still not found, then we need to attempt to start from
   # scratch
@@ -113,6 +113,10 @@ rescue Bundler::GemNotFound, Bundler::GitError
       exec(Gem.ruby, __FILE__, *ARGV, "--retry")
     end
   end
+
+  setup_error = e
+  $stderr.puts("Failed to set up composed Bundle\n#{e.full_message}")
+  $LOAD_PATH.unshift(File.expand_path("../lib", __dir__))
 rescue StandardError => e
   setup_error = e
   $stderr.puts("Failed to set up composed Bundle\n#{e.full_message}")

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

@@ -227,7 +227,7 @@ module RubyIndexer
       others.uniq!
       others.map!(&:name)
 
-      excluded.each do |dependency|
+      transitive_excluded = excluded.each_with_object([]) do |dependency, acc|
         next unless dependency.runtime?
 
         spec = dependency.to_spec
@@ -236,7 +236,7 @@ module RubyIndexer
         spec.dependencies.each do |transitive_dependency|
           next if others.include?(transitive_dependency.name)
 
-          excluded << transitive_dependency
+          acc << transitive_dependency
         end
       rescue Gem::MissingSpecError
         # If a gem is scoped only to some specific platform, then its dependencies may not be installed either, but they
@@ -244,6 +244,7 @@ module RubyIndexer
         # just ignore if they're missing
       end
 
+      excluded.concat(transitive_excluded)
       excluded.uniq!
       excluded.map(&:name)
     rescue Bundler::GemfileNotFound

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

@@ -14,6 +14,12 @@ module RubyLsp
           fatal: Constant::DiagnosticSeverity::ERROR,
         }.freeze #: Hash[Symbol, Integer]
 
+        # Cops where adding a `rubocop:disable` inline comment would itself resolve the offense,
+        # causing Lint/RedundantCopDisableDirective to flag the disable as unnecessary.
+        SELF_RESOLVING_DISABLE_COPS = Set.new([
+          "Layout/EmptyComment",
+        ]).freeze #: Set[String]
+
         ENHANCED_DOC_URL = begin
           gem("rubocop", ">= 1.64.0")
           true
@@ -35,7 +41,7 @@ module RubyLsp
           code_actions = []
 
           code_actions << autocorrect_action if correctable?
-          code_actions << disable_line_action
+          code_actions << disable_line_action unless SELF_RESOLVING_DISABLE_COPS.include?(@offense.cop_name)
 
           code_actions
         end

data/lib/ruby_lsp/setup_bundler.rb

@@ -31,6 +31,10 @@ 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
@@ -122,6 +126,7 @@ module RubyLsp
         return run_bundle_install(@custom_gemfile)
       end
 
+      @needs_update_path.delete if @needs_update_path.exist?
       FileUtils.cp(@lockfile.to_s, @custom_lockfile.to_s)
       correct_relative_remote_paths
       @lockfile_hash_path.write(@lockfile_hash)
@@ -331,26 +336,26 @@ 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
       correct_relative_remote_paths if @custom_lockfile.exist?
-      @needs_update_path.delete
+      @needs_update_path.delete if @needs_update_path.exist?
       @last_updated_path.write(Time.now.iso8601)
       env
     end
 
     #: (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
 
@@ -361,12 +366,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 << ")"

data/lib/ruby_lsp/test_reporters/lsp_reporter.rb

@@ -4,13 +4,40 @@
 require "English"
 require "json"
 require "socket"
-require "singleton"
 require "tmpdir"
 require_relative "../../ruby_indexer/lib/ruby_indexer/uri"
 
 module RubyLsp
   class LspReporter
-    include Singleton
+    @instance = nil #: LspReporter?
+
+    class << self
+      #: -> LspReporter
+      def instance
+        @instance ||= new
+      end
+
+      #: -> bool
+      def start_coverage?
+        ENV["RUBY_LSP_TEST_RUNNER"] == "coverage"
+      end
+
+      #: -> bool
+      def executed_under_test_runner?
+        !!(ENV["RUBY_LSP_TEST_RUNNER"] && ENV["RUBY_LSP_ENV"] != "test")
+      end
+
+      #: (Method | UnboundMethod) -> [URI::Generic, Integer?]?
+      def uri_and_line_for(method_object)
+        file_path, line = method_object.source_location
+        return unless file_path
+        return if file_path.start_with?("(eval at ")
+
+        uri = URI::Generic.from_path(path: File.expand_path(file_path))
+        zero_based_line = line ? line - 1 : nil
+        [uri, zero_based_line]
+      end
+    end
 
     # https://code.visualstudio.com/api/references/vscode-api#Position
     #: type position = { line: Integer, character: Integer }
@@ -50,6 +77,8 @@ module RubyLsp
       end #: IO | StringIO
 
       @invoked_shutdown = false #: bool
+      @message_queue = Thread::Queue.new #: Thread::Queue
+      @writer = Thread.new { write_loop } #: Thread
     end
 
     #: -> void
@@ -68,6 +97,8 @@ module RubyLsp
       @invoked_shutdown = true
 
       send_message("finish")
+      @message_queue.close
+      @writer.join
       @io.close
     end
 
@@ -96,17 +127,6 @@ module RubyLsp
       send_message("error", id: id, message: message, uri: uri.to_s)
     end
 
-    #: (Method | UnboundMethod) -> [URI::Generic, Integer?]?
-    def uri_and_line_for(method_object)
-      file_path, line = method_object.source_location
-      return unless file_path
-      return if file_path.start_with?("(eval at ")
-
-      uri = URI::Generic.from_path(path: File.expand_path(file_path))
-      zero_based_line = line ? line - 1 : nil
-      [uri, zero_based_line]
-    end
-
     # Gather the results returned by Coverage.result and format like the VS Code test explorer expects
     #
     # Coverage result format:
@@ -195,23 +215,11 @@ module RubyLsp
       internal_shutdown unless @invoked_shutdown
     end
 
-    class << self
-      #: -> bool
-      def start_coverage?
-        ENV["RUBY_LSP_TEST_RUNNER"] == "coverage"
-      end
-
-      #: -> bool
-      def executed_under_test_runner?
-        !!(ENV["RUBY_LSP_TEST_RUNNER"] && ENV["RUBY_LSP_ENV"] != "test")
-      end
-    end
-
     private
 
-    #: (String) -> TCPSocket
+    #: (String) -> Socket
     def socket(port)
-      socket = TCPSocket.new("localhost", port)
+      socket = Socket.tcp("localhost", port)
       socket.binmode
       socket.sync = true
       socket
@@ -220,7 +228,14 @@ module RubyLsp
     #: (String?, **untyped) -> void
     def send_message(method_name, **params)
       json_message = { method: method_name, params: params }.to_json
-      @io.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+      @message_queue << "Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}"
+    end
+
+    #: -> void
+    def write_loop
+      while (message = @message_queue.pop)
+        @io.write(message)
+      end
     end
   end
 end

data/lib/ruby_lsp/test_reporters/minitest_reporter.rb

@@ -89,7 +89,7 @@ module RubyLsp
         test_class_or_wrapper
       end
 
-      uri, line = LspReporter.instance.uri_and_line_for(klass.instance_method(method_name))
+      uri, line = LspReporter.uri_and_line_for(klass.instance_method(method_name))
       return unless uri
 
       id = "#{name}##{handle_spec_test_id(method_name, line)}"

data/lib/ruby_lsp/test_reporters/test_unit_reporter.rb

@@ -25,7 +25,7 @@ module RubyLsp
     def test_started(test)
       super
 
-      uri, line = LspReporter.instance.uri_and_line_for(test.method(test.method_name))
+      uri, line = LspReporter.uri_and_line_for(test.method(test.method_name))
       return unless uri
 
       @current_uri = uri

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.26.5
+  version: 0.26.7
 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

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