ruby-lsp 0.16.2 → 0.16.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a3b197d35d03d1b5b78894bce8b03c6aa76be7586fc7034422415d0656ddea7a
-  data.tar.gz: 2fd148c0ab5d8b3ac55784722ab49a3be6b1b4885c8b284e8a6cf40c503b4066
+  metadata.gz: 94d4dfcda701bdf2ea1dd04e2a271572a139fe3d716e1bd535e2c05bcc9b3d23
+  data.tar.gz: b79dfc816bf027e733fa5f44db3e2d1039ae860f9dee88fe996ab1a27089d467
 SHA512:
-  metadata.gz: 1994f1d014bc3f70ff96e90d5b3961c279166e5f58be6b38415ec1e2515b7557c6a00f4cde45ba3a66e0d9dd6c1402f7e4754c6f8addb6efb848ec7a65fbadc7
-  data.tar.gz: ffec2a6c5321eb159ea4d505f9b6c6dd56b64cb16d2f052666b9c15f406d59fa478d9e7f7c9734219874c3ca3bb8dcae9b2cbdd683576a3d74b523cf769298e4
+  metadata.gz: 9de1f73feba2284c75294542a0e9ae1196f092004fe83ef815b2e08a1b404daceebc0b3f6f8f59149f936c8f7414821942556bee522776a909c071765dcc3443
+  data.tar.gz: b7617a6d508a94e5a06b8d39acb4d2bcc28d02832b19ab8567ed58b6b297aa3fc450dd0a116257fe91fc9545683550456c0d712fc32dc3f3ff716e2cdca2985e

data/VERSION

@@ -1 +1 @@
-0.16.2
+0.16.4

data/lib/ruby_lsp/base_server.rb

@@ -59,9 +59,11 @@ module RubyLsp
           end
         end
 
-        # We need to process shutdown and exit from the main thread in order to close queues and wait for other threads
-        # to finish. Everything else is pushed into the incoming queue
+        # The following requests need to be executed in the main thread directly to avoid concurrency issues. Everything
+        # else is pushed into the incoming queue
         case method
+        when "initialize", "textDocument/didOpen", "textDocument/didClose", "textDocument/didChange"
+          process_message(message)
         when "shutdown"
           $stderr.puts("Shutting down Ruby LSP...")
 

data/lib/ruby_lsp/document.rb

@@ -20,13 +20,13 @@ module RubyLsp
     sig { returns(URI::Generic) }
     attr_reader :uri
 
-    sig { returns(String) }
+    sig { returns(Encoding) }
     attr_reader :encoding
 
-    sig { params(source: String, version: Integer, uri: URI::Generic, encoding: String).void }
-    def initialize(source:, version:, uri:, encoding: Constant::PositionEncodingKind::UTF8)
+    sig { params(source: String, version: Integer, uri: URI::Generic, encoding: Encoding).void }
+    def initialize(source:, version:, uri:, encoding: Encoding::UTF_8)
       @cache = T.let({}, T::Hash[String, T.untyped])
-      @encoding = T.let(encoding, String)
+      @encoding = T.let(encoding, Encoding)
       @source = T.let(source, String)
       @version = T.let(version, Integer)
       @uri = T.let(uri, URI::Generic)
@@ -187,7 +187,7 @@ module RubyLsp
       # After character 0xFFFF, UTF-16 considers characters to have length 2 and we have to account for that
       SURROGATE_PAIR_START = T.let(0xFFFF, Integer)
 
-      sig { params(source: String, encoding: String).void }
+      sig { params(source: String, encoding: Encoding).void }
       def initialize(source, encoding)
         @current_line = T.let(0, Integer)
         @pos = T.let(0, Integer)
@@ -209,7 +209,7 @@ module RubyLsp
         # need to adjust for surrogate pairs
         requested_position = @pos + position[:character]
 
-        if @encoding == Constant::PositionEncodingKind::UTF16
+        if @encoding == Encoding::UTF_16LE
           requested_position -= utf_16_character_position_correction(@pos, requested_position)
         end
 

data/lib/ruby_lsp/global_state.rb

@@ -17,15 +17,23 @@ module RubyLsp
     sig { returns(RubyIndexer::Index) }
     attr_reader :index
 
+    sig { returns(Encoding) }
+    attr_reader :encoding
+
+    sig { returns(T::Boolean) }
+    attr_reader :supports_watching_files
+
     sig { void }
     def initialize
       @workspace_uri = T.let(URI::Generic.from_path(path: Dir.pwd), URI::Generic)
+      @encoding = T.let(Encoding::UTF_8, Encoding)
 
       @formatter = T.let("auto", String)
       @test_library = T.let(detect_test_library, String)
       @typechecker = T.let(detect_typechecker, T::Boolean)
       @index = T.let(RubyIndexer::Index.new, RubyIndexer::Index)
       @supported_formatters = T.let({}, T::Hash[String, Requests::Support::Formatter])
+      @supports_watching_files = T.let(false, T::Boolean)
     end
 
     sig { params(identifier: String, instance: Requests::Support::Formatter).void }
@@ -46,6 +54,22 @@ module RubyLsp
       specified_formatter = options.dig(:initializationOptions, :formatter)
       @formatter = specified_formatter if specified_formatter
       @formatter = detect_formatter if @formatter == "auto"
+
+      encodings = options.dig(:capabilities, :general, :positionEncodings)
+      @encoding = if !encodings || encodings.empty?
+        Encoding::UTF_16LE
+      elsif encodings.include?(Constant::PositionEncodingKind::UTF8)
+        Encoding::UTF_8
+      elsif encodings.include?(Constant::PositionEncodingKind::UTF16)
+        Encoding::UTF_16LE
+      else
+        Encoding::UTF_32
+      end
+
+      file_watching_caps = options.dig(:capabilities, :workspace, :didChangeWatchedFiles)
+      if file_watching_caps&.dig(:dynamicRegistration) && file_watching_caps&.dig(:relativePatternSupport)
+        @supports_watching_files = true
+      end
     end
 
     sig { returns(String) }
@@ -53,6 +77,25 @@ module RubyLsp
       T.must(@workspace_uri.to_standardized_path)
     end
 
+    sig { returns(String) }
+    def encoding_name
+      case @encoding
+      when Encoding::UTF_8
+        Constant::PositionEncodingKind::UTF8
+      when Encoding::UTF_16LE
+        Constant::PositionEncodingKind::UTF16
+      else
+        Constant::PositionEncodingKind::UTF32
+      end
+    end
+
+    sig { params(gem_pattern: Regexp).returns(T::Boolean) }
+    def direct_dependency?(gem_pattern)
+      dependencies.any?(gem_pattern)
+    end
+
+    private
+
     sig { returns(String) }
     def detect_formatter
       # NOTE: Intentionally no $ at end, since we want to match rubocop-shopify, etc.
@@ -70,8 +113,10 @@ module RubyLsp
       if direct_dependency?(/^rspec/)
         "rspec"
       # A Rails app may have a dependency on minitest, but we would instead want to use the Rails test runner provided
-      # by ruby-lsp-rails.
-      elsif direct_dependency?(/^rails$/)
+      # by ruby-lsp-rails. A Rails app doesn't need to depend on the rails gem itself, individual components like
+      # activestorage may be added to the gemfile so that other components aren't downloaded. Check for the presence
+      #  of bin/rails to support these cases.
+      elsif File.exist?(File.join(workspace_path, "bin/rails"))
         "rails"
       # NOTE: Intentionally ends with $ to avoid mis-matching minitest-reporters, etc. in a Rails app.
       elsif direct_dependency?(/^minitest$/)
@@ -83,11 +128,6 @@ module RubyLsp
       end
     end
 
-    sig { params(gem_pattern: Regexp).returns(T::Boolean) }
-    def direct_dependency?(gem_pattern)
-      dependencies.any?(gem_pattern)
-    end
-
     sig { returns(T::Boolean) }
     def detect_typechecker
       return false if ENV["RUBY_LSP_BYPASS_TYPECHECKER"]

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

@@ -163,7 +163,7 @@ module RubyLsp
 
         sig { params(line: String).returns(Integer) }
         def length_of_line(line)
-          if @document.encoding == Constant::PositionEncodingKind::UTF16
+          if @document.encoding == Encoding::UTF_16LE
             line_length = 0
             line.codepoints.each do |codepoint|
               line_length += 1

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

@@ -3,15 +3,12 @@
 
 return unless defined?(RubyLsp::Requests::Support::RuboCopRunner)
 
-require "singleton"
-
 module RubyLsp
   module Requests
     module Support
       class RuboCopFormatter
         extend T::Sig
         include Formatter
-        include Singleton
 
         sig { void }
         def initialize

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

@@ -8,15 +8,12 @@ rescue LoadError
   return
 end
 
-require "singleton"
-
 module RubyLsp
   module Requests
     module Support
       # :nodoc:
       class SyntaxTreeFormatter
         extend T::Sig
-        include Singleton
         include Support::Formatter
 
         sig { void }

data/lib/ruby_lsp/server.rb

@@ -118,15 +118,6 @@ module RubyLsp
       client_name = options.dig(:clientInfo, :name)
       @store.client_name = client_name if client_name
 
-      encodings = options.dig(:capabilities, :general, :positionEncodings)
-      @store.encoding = if encodings.nil? || encodings.empty?
-        Constant::PositionEncodingKind::UTF16
-      elsif encodings.include?(Constant::PositionEncodingKind::UTF8)
-        Constant::PositionEncodingKind::UTF8
-      else
-        encodings.first
-      end
-
       progress = options.dig(:capabilities, :window, :workDoneProgress)
       @store.supports_progress = progress.nil? ? true : progress
       configured_features = options.dig(:initializationOptions, :enabledFeatures)
@@ -168,7 +159,7 @@ module RubyLsp
             change: Constant::TextDocumentSyncKind::INCREMENTAL,
             open_close: true,
           ),
-          position_encoding: @store.encoding,
+          position_encoding: @global_state.encoding_name,
           selection_range_provider: enabled_features["selectionRanges"],
           hover_provider: hover_provider,
           document_symbol_provider: document_symbol_provider,
@@ -196,11 +187,8 @@ module RubyLsp
 
       send_message(Result.new(id: message[:id], response: response))
 
-      # Dynamically registered capabilities
-      file_watching_caps = options.dig(:capabilities, :workspace, :didChangeWatchedFiles)
-
       # Not every client supports dynamic registration or file watching
-      if file_watching_caps&.dig(:dynamicRegistration) && file_watching_caps&.dig(:relativePatternSupport)
+      if global_state.supports_watching_files
         send_message(
           Request.new(
             id: @current_request_id,
@@ -257,10 +245,10 @@ module RubyLsp
       end
 
       if defined?(Requests::Support::RuboCopFormatter)
-        @global_state.register_formatter("rubocop", Requests::Support::RuboCopFormatter.instance)
+        @global_state.register_formatter("rubocop", Requests::Support::RuboCopFormatter.new)
       end
       if defined?(Requests::Support::SyntaxTreeFormatter)
-        @global_state.register_formatter("syntax_tree", Requests::Support::SyntaxTreeFormatter.instance)
+        @global_state.register_formatter("syntax_tree", Requests::Support::SyntaxTreeFormatter.new)
       end
 
       perform_initial_indexing(indexing_config)
@@ -269,25 +257,31 @@ module RubyLsp
 
     sig { params(message: T::Hash[Symbol, T.untyped]).void }
     def text_document_did_open(message)
-      text_document = message.dig(:params, :textDocument)
-      @store.set(uri: text_document[:uri], source: text_document[:text], version: text_document[:version])
-    rescue Errno::ENOENT
-      # If someone re-opens the editor with a file that was deleted or doesn't exist in the current branch, we don't
-      # want to crash
+      @mutex.synchronize do
+        text_document = message.dig(:params, :textDocument)
+        @store.set(
+          uri: text_document[:uri],
+          source: text_document[:text],
+          version: text_document[:version],
+          encoding: @global_state.encoding,
+        )
+      end
     end
 
     sig { params(message: T::Hash[Symbol, T.untyped]).void }
     def text_document_did_close(message)
-      uri = message.dig(:params, :textDocument, :uri)
-      @store.delete(uri)
+      @mutex.synchronize do
+        uri = message.dig(:params, :textDocument, :uri)
+        @store.delete(uri)
 
-      # Clear diagnostics for the closed file, so that they no longer appear in the problems tab
-      send_message(
-        Notification.new(
-          method: "textDocument/publishDiagnostics",
-          params: Interface::PublishDiagnosticsParams.new(uri: uri.to_s, diagnostics: []),
-        ),
-      )
+        # Clear diagnostics for the closed file, so that they no longer appear in the problems tab
+        send_message(
+          Notification.new(
+            method: "textDocument/publishDiagnostics",
+            params: Interface::PublishDiagnosticsParams.new(uri: uri.to_s, diagnostics: []),
+          ),
+        )
+      end
     end
 
     sig { params(message: T::Hash[Symbol, T.untyped]).void }
@@ -616,6 +610,7 @@ module RubyLsp
         uri = URI(change[:uri])
         file_path = uri.to_standardized_path
         next if file_path.nil? || File.directory?(file_path)
+        next unless file_path.end_with?(".rb")
 
         load_path_entry = $LOAD_PATH.find { |load_path| file_path.start_with?(load_path) }
         indexable = RubyIndexer::IndexablePath.new(load_path_entry, file_path)

data/lib/ruby_lsp/setup_bundler.rb

@@ -19,6 +19,7 @@ module RubyLsp
     extend T::Sig
 
     class BundleNotLocked < StandardError; end
+    class BundleInstallFailure < StandardError; end
 
     FOUR_HOURS = T.let(4 * 60 * 60, Integer)
 
@@ -49,6 +50,7 @@ module RubyLsp
       @last_updated_path = T.let(@custom_dir + "last_updated", Pathname)
 
       @dependencies = T.let(load_dependencies, T::Hash[String, T.untyped])
+      @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
@@ -224,7 +226,17 @@ module RubyLsp
       # Add bundle update
       $stderr.puts("Ruby LSP> Running bundle install for the custom bundle. This may take a while...")
       $stderr.puts("Ruby LSP> Command: #{command}")
-      system(env, 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
+      # another time and give up if it fails again
+      if !system(env, command) && !@retry && @custom_dir.exist?
+        @retry = true
+        @custom_dir.rmtree
+        $stderr.puts("Ruby LSP> Running bundle install failed. Trying to re-generate the custom bundle from scratch")
+        return setup!
+      end
+
       [bundle_gemfile.to_s, expanded_path, env["BUNDLE_APP_CONFIG"]]
     end
 

data/lib/ruby_lsp/store.rb

@@ -5,9 +5,6 @@ module RubyLsp
   class Store
     extend T::Sig
 
-    sig { returns(String) }
-    attr_accessor :encoding
-
     sig { returns(T::Boolean) }
     attr_accessor :supports_progress
 
@@ -23,7 +20,6 @@ module RubyLsp
     sig { void }
     def initialize
       @state = T.let({}, T::Hash[String, Document])
-      @encoding = T.let(Constant::PositionEncodingKind::UTF8, String)
       @supports_progress = T.let(true, T::Boolean)
       @experimental_features = T.let(false, T::Boolean)
       @features_configuration = T.let(
@@ -49,9 +45,9 @@ module RubyLsp
       T.must(@state[uri.to_s])
     end
 
-    sig { params(uri: URI::Generic, source: String, version: Integer).void }
-    def set(uri:, source:, version:)
-      document = RubyDocument.new(source: source, version: version, uri: uri, encoding: @encoding)
+    sig { params(uri: URI::Generic, source: String, version: Integer, encoding: Encoding).void }
+    def set(uri:, source:, version:, encoding: Encoding::UTF_8)
+      document = RubyDocument.new(source: source, version: version, uri: uri, encoding: encoding)
       @state[uri.to_s] = document
     end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.16.2
+  version: 0.16.4
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-04-05 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol