ruby-lsp 0.14.6 → 0.16.4

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,21 +5,12 @@ module RubyLsp
   class Store
     extend T::Sig
 
-    sig { returns(String) }
-    attr_accessor :encoding
-
-    sig { returns(String) }
-    attr_accessor :formatter
-
     sig { returns(T::Boolean) }
     attr_accessor :supports_progress
 
     sig { returns(T::Boolean) }
     attr_accessor :experimental_features
 
-    sig { returns(URI::Generic) }
-    attr_accessor :workspace_uri
-
     sig { returns(T::Hash[Symbol, RequestConfig]) }
     attr_accessor :features_configuration
 
@@ -29,11 +20,8 @@ module RubyLsp
     sig { void }
     def initialize
       @state = T.let({}, T::Hash[String, Document])
-      @encoding = T.let(Constant::PositionEncodingKind::UTF8, String)
-      @formatter = T.let("auto", String)
       @supports_progress = T.let(true, T::Boolean)
       @experimental_features = T.let(false, T::Boolean)
-      @workspace_uri = T.let(URI::Generic.from_path(path: Dir.pwd), URI::Generic)
       @features_configuration = T.let(
         {
           inlayHint: RequestConfig.new({
@@ -57,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
 

data/lib/ruby_lsp/test_helper.rb

@@ -0,0 +1,52 @@
+# typed: strict
+# frozen_string_literal: true
+
+# NOTE: This module is intended to be used by addons for writing their own tests, so keep that in mind if changing.
+
+module RubyLsp
+  module TestHelper
+    extend T::Sig
+
+    sig do
+      type_parameters(:T)
+        .params(
+          source: T.nilable(String),
+          uri: URI::Generic,
+          stub_no_typechecker: T::Boolean,
+          load_addons: T::Boolean,
+          block: T.proc.params(server: RubyLsp::Server, uri: URI::Generic).returns(T.type_parameter(:T)),
+        ).returns(T.type_parameter(:T))
+    end
+    def with_server(source = nil, uri = Kernel.URI("file:///fake.rb"), stub_no_typechecker: false, load_addons: true,
+      &block)
+      server = RubyLsp::Server.new(test_mode: true)
+      server.global_state.stubs(:typechecker).returns(false) if stub_no_typechecker
+
+      if source
+        server.process_message({
+          method: "textDocument/didOpen",
+          params: {
+            textDocument: {
+              uri: uri,
+              text: source,
+              version: 1,
+            },
+          },
+        })
+      end
+
+      server.global_state.index.index_single(
+        RubyIndexer::IndexablePath.new(nil, T.must(uri.to_standardized_path)),
+        source,
+      )
+      server.load_addons if load_addons
+      block.call(server, uri)
+    ensure
+      if load_addons
+        RubyLsp::Addon.addons.each(&:deactivate)
+        RubyLsp::Addon.addons.clear
+      end
+      T.must(server).run_shutdown
+    end
+  end
+end

data/lib/ruby_lsp/utils.rb

@@ -2,8 +2,13 @@
 # frozen_string_literal: true
 
 module RubyLsp
+  # rubocop:disable RubyLsp/UseLanguageServerAliases
+  Interface = LanguageServer::Protocol::Interface
+  Constant = LanguageServer::Protocol::Constant
+  Transport = LanguageServer::Protocol::Transport
+  # rubocop:enable RubyLsp/UseLanguageServerAliases
+
   # Used to indicate that a request shouldn't return a response
-  VOID = T.let(Object.new.freeze, Object)
   BUNDLE_PATH = T.let(
     begin
       Bundler.bundle_path.to_s
@@ -26,19 +31,22 @@ module RubyLsp
     extend T::Sig
     extend T::Helpers
 
-    abstract!
-
     sig { returns(String) }
-    attr_reader :message
+    attr_reader :method
 
     sig { returns(Object) }
     attr_reader :params
 
-    sig { params(message: String, params: Object).void }
-    def initialize(message:, params:)
-      @message = message
+    abstract!
+
+    sig { params(method: String, params: Object).void }
+    def initialize(method:, params:)
+      @method = method
       @params = params
     end
+
+    sig { abstract.returns(T::Hash[Symbol, T.untyped]) }
+    def to_hash; end
   end
 
   class Notification < Message
@@ -47,7 +55,7 @@ module RubyLsp
       sig { params(message: String).returns(Notification) }
       def window_show_error(message)
         new(
-          message: "window/showMessage",
+          method: "window/showMessage",
           params: Interface::ShowMessageParams.new(
             type: Constant::MessageType::ERROR,
             message: message,
@@ -55,46 +63,73 @@ module RubyLsp
         )
       end
     end
-  end
 
-  class Request < Message; end
-
-  # The final result of running a request before its IO is finalized
-  class Result
     extend T::Sig
 
-    sig { returns(T.untyped) }
-    attr_reader :response
+    sig { override.returns(T::Hash[Symbol, T.untyped]) }
+    def to_hash
+      { method: @method, params: T.unsafe(@params).to_hash }
+    end
+  end
 
-    sig { returns(T.nilable(Exception)) }
-    attr_reader :error
+  class Request < Message
+    extend T::Sig
 
-    sig { params(response: T.untyped, error: T.nilable(Exception)).void }
-    def initialize(response:, error: nil)
-      @response = response
-      @error = error
+    sig { params(id: Integer, method: String, params: Object).void }
+    def initialize(id:, method:, params:)
+      @id = id
+      super(method: method, params: params)
+    end
+
+    sig { override.returns(T::Hash[Symbol, T.untyped]) }
+    def to_hash
+      { id: @id, method: @method, params: T.unsafe(@params).to_hash }
     end
   end
 
-  # A request that will sit in the queue until it's executed
-  class Job
+  class Error
     extend T::Sig
 
+    sig { returns(String) }
+    attr_reader :message
+
+    sig { params(id: Integer, code: Integer, message: String, data: T.nilable(T::Hash[Symbol, T.untyped])).void }
+    def initialize(id:, code:, message:, data: nil)
+      @id = id
+      @code = code
+      @message = message
+      @data = data
+    end
+
     sig { returns(T::Hash[Symbol, T.untyped]) }
-    attr_reader :request
+    def to_hash
+      {
+        id: @id,
+        error: {
+          code: @code,
+          message: @message,
+          data: @data,
+        },
+      }
+    end
+  end
 
-    sig { returns(T::Boolean) }
-    attr_reader :cancelled
+  # The final result of running a request before its IO is finalized
+  class Result
+    extend T::Sig
 
-    sig { params(request: T::Hash[Symbol, T.untyped], cancelled: T::Boolean).void }
-    def initialize(request:, cancelled:)
-      @request = request
-      @cancelled = cancelled
+    sig { returns(T.untyped) }
+    attr_reader :response
+
+    sig { params(id: Integer, response: T.untyped).void }
+    def initialize(id:, response:)
+      @id = id
+      @response = response
     end
 
-    sig { void }
-    def cancel
-      @cancelled = true
+    sig { returns(T::Hash[Symbol, T.untyped]) }
+    def to_hash
+      { id: @id, result: @response }
     end
   end
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.14.6
+  version: 0.16.4
 platform: ruby
 authors:
 - Shopify
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2024-03-15 00:00:00.000000000 Z
+date: 2024-04-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: language_server-protocol
@@ -93,9 +93,10 @@ files:
 - lib/ruby_indexer/test/prefix_tree_test.rb
 - 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/executor.rb
+- lib/ruby_lsp/global_state.rb
 - lib/ruby_lsp/internal.rb
 - lib/ruby_lsp/listeners/code_lens.rb
 - lib/ruby_lsp/listeners/completion.rb
@@ -108,12 +109,14 @@ files:
 - lib/ruby_lsp/listeners/inlay_hints.rb
 - lib/ruby_lsp/listeners/semantic_highlighting.rb
 - lib/ruby_lsp/listeners/signature_help.rb
+- lib/ruby_lsp/load_sorbet.rb
 - lib/ruby_lsp/parameter_scope.rb
 - lib/ruby_lsp/requests.rb
 - lib/ruby_lsp/requests/code_action_resolve.rb
 - lib/ruby_lsp/requests/code_actions.rb
 - lib/ruby_lsp/requests/code_lens.rb
 - lib/ruby_lsp/requests/completion.rb
+- lib/ruby_lsp/requests/completion_resolve.rb
 - lib/ruby_lsp/requests/definition.rb
 - lib/ruby_lsp/requests/diagnostics.rb
 - lib/ruby_lsp/requests/document_highlight.rb
@@ -131,16 +134,14 @@ files:
 - lib/ruby_lsp/requests/signature_help.rb
 - lib/ruby_lsp/requests/support/annotation.rb
 - lib/ruby_lsp/requests/support/common.rb
-- lib/ruby_lsp/requests/support/dependency_detector.rb
-- lib/ruby_lsp/requests/support/formatter_runner.rb
+- lib/ruby_lsp/requests/support/formatter.rb
 - lib/ruby_lsp/requests/support/rubocop_diagnostic.rb
-- lib/ruby_lsp/requests/support/rubocop_diagnostics_runner.rb
-- lib/ruby_lsp/requests/support/rubocop_formatting_runner.rb
+- lib/ruby_lsp/requests/support/rubocop_formatter.rb
 - lib/ruby_lsp/requests/support/rubocop_runner.rb
 - lib/ruby_lsp/requests/support/selection_range.rb
 - lib/ruby_lsp/requests/support/sorbet.rb
 - lib/ruby_lsp/requests/support/source_uri.rb
-- lib/ruby_lsp/requests/support/syntax_tree_formatting_runner.rb
+- lib/ruby_lsp/requests/support/syntax_tree_formatter.rb
 - lib/ruby_lsp/requests/workspace_symbol.rb
 - lib/ruby_lsp/response_builders.rb
 - lib/ruby_lsp/response_builders/collection_response_builder.rb
@@ -153,6 +154,7 @@ files:
 - lib/ruby_lsp/server.rb
 - lib/ruby_lsp/setup_bundler.rb
 - lib/ruby_lsp/store.rb
+- lib/ruby_lsp/test_helper.rb
 - lib/ruby_lsp/utils.rb
 homepage: https://github.com/Shopify/ruby-lsp
 licenses:
@@ -175,7 +177,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.6
+rubygems_version: 3.5.7
 signing_key: 
 specification_version: 4
 summary: An opinionated language server for Ruby