ruby-lsp 0.23.16 → 0.23.17

data/lib/ruby_lsp/requests/document_highlight.rb

@@ -25,7 +25,7 @@ module RubyLsp
           code_units_cache: document.code_units_cache,
         )
 
-        @response_builder = ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight]
+        @response_builder = ResponseBuilders::CollectionResponseBuilder
           .new #: ResponseBuilders::CollectionResponseBuilder[Interface::DocumentHighlight]
         Listeners::DocumentHighlight.new(
           @response_builder,

data/lib/ruby_lsp/requests/document_link.rb

@@ -19,7 +19,7 @@ module RubyLsp
       #: (URI::Generic uri, Array[Prism::Comment] comments, Prism::Dispatcher dispatcher) -> void
       def initialize(uri, comments, dispatcher)
         super()
-        @response_builder = ResponseBuilders::CollectionResponseBuilder[Interface::DocumentLink]
+        @response_builder = ResponseBuilders::CollectionResponseBuilder
           .new #: ResponseBuilders::CollectionResponseBuilder[Interface::DocumentLink]
         Listeners::DocumentLink.new(@response_builder, uri, comments, dispatcher)
       end

data/lib/ruby_lsp/requests/folding_ranges.rb

@@ -18,7 +18,7 @@ module RubyLsp
       #: (Array[Prism::Comment] comments, Prism::Dispatcher dispatcher) -> void
       def initialize(comments, dispatcher)
         super()
-        @response_builder = ResponseBuilders::CollectionResponseBuilder[Interface::FoldingRange]
+        @response_builder = ResponseBuilders::CollectionResponseBuilder
           .new #: ResponseBuilders::CollectionResponseBuilder[Interface::FoldingRange]
         @listener = Listeners::FoldingRanges.new(@response_builder, comments, dispatcher) #: Listeners::FoldingRanges
       end

data/lib/ruby_lsp/requests/go_to_relevant_file.rb

@@ -8,8 +8,6 @@ module RubyLsp
     # that navigates to the relevant file for the current document.
     # Currently, it supports source code file <> test file navigation.
     class GoToRelevantFile < Request
-      extend T::Sig
-
       TEST_KEYWORDS = ["test", "spec", "integration_test"]
 
       TEST_PREFIX_PATTERN = /^(#{TEST_KEYWORDS.join("_|")}_)/

data/lib/ruby_lsp/requests/hover.rb

@@ -19,7 +19,7 @@ module RubyLsp
 
       ResponseType = type_member { { fixed: T.nilable(Interface::Hover) } }
 
-      #: ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void
+      #: ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void
       def initialize(document, global_state, position, dispatcher, sorbet_level)
         super()
 

data/lib/ruby_lsp/requests/inlay_hints.rb

@@ -20,7 +20,7 @@ module RubyLsp
       def initialize(document, hints_configuration, dispatcher)
         super()
 
-        @response_builder = ResponseBuilders::CollectionResponseBuilder[Interface::InlayHint]
+        @response_builder = ResponseBuilders::CollectionResponseBuilder
           .new #: ResponseBuilders::CollectionResponseBuilder[Interface::InlayHint]
         Listeners::InlayHints.new(@response_builder, hints_configuration, dispatcher)
       end

data/lib/ruby_lsp/requests/references.rb

@@ -55,22 +55,7 @@ module RubyLsp
           )
         end
 
-        target = T.cast(
-          target,
-          T.any(
-            Prism::ConstantReadNode,
-            Prism::ConstantPathNode,
-            Prism::ConstantPathTargetNode,
-            Prism::InstanceVariableAndWriteNode,
-            Prism::InstanceVariableOperatorWriteNode,
-            Prism::InstanceVariableOrWriteNode,
-            Prism::InstanceVariableReadNode,
-            Prism::InstanceVariableTargetNode,
-            Prism::InstanceVariableWriteNode,
-            Prism::CallNode,
-            Prism::DefNode,
-          ),
-        )
+        target = target #: as Prism::ConstantReadNode | Prism::ConstantPathNode | Prism::ConstantPathTargetNode | Prism::InstanceVariableAndWriteNode | Prism::InstanceVariableOperatorWriteNode | Prism::InstanceVariableOrWriteNode | Prism::InstanceVariableReadNode | Prism::InstanceVariableTargetNode | Prism::InstanceVariableWriteNode | Prism::CallNode | Prism::DefNode, # rubocop:disable Layout/LineLength
 
         reference_target = create_reference_target(target, node_context)
         return @locations unless reference_target

data/lib/ruby_lsp/requests/rename.rb

@@ -51,10 +51,7 @@ module RubyLsp
           )
         end
 
-        target = T.cast(
-          target,
-          T.any(Prism::ConstantReadNode, Prism::ConstantPathNode, Prism::ConstantPathTargetNode),
-        )
+        target = target #: as Prism::ConstantReadNode | Prism::ConstantPathNode | Prism::ConstantPathTargetNode
 
         name = RubyIndexer::Index.constant_name(target)
         return unless name

data/lib/ruby_lsp/requests/request.rb

@@ -60,7 +60,8 @@ module RubyLsp
         return target unless parent.is_a?(Prism::ConstantPathNode)
 
         target = parent #: Prism::Node
-        parent = T.cast(target, Prism::ConstantPathNode).parent #: Prism::Node?
+        parent = target #: as Prism::ConstantPathNode
+          .parent #: Prism::Node?
 
         while parent && cover?(parent.location, position)
           target = parent

data/lib/ruby_lsp/requests/semantic_highlighting.rb

@@ -74,7 +74,7 @@ module RubyLsp
       @result_id = 0 #: Integer
       @mutex = Mutex.new #: Mutex
 
-      #: (GlobalState global_state, Prism::Dispatcher dispatcher, (RubyDocument | ERBDocument) document, String? previous_result_id, ?range: T::Range[Integer]?) -> void
+      #: (GlobalState global_state, Prism::Dispatcher dispatcher, (RubyDocument | ERBDocument) document, String? previous_result_id, ?range: Range[Integer]?) -> void
       def initialize(global_state, dispatcher, document, previous_result_id, range: nil)
         super()
 

data/lib/ruby_lsp/requests/signature_help.rb

@@ -19,7 +19,7 @@ module RubyLsp
         end
       end
 
-      #: ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Hash[Symbol, untyped]? context, Prism::Dispatcher dispatcher, RubyDocument::SorbetLevel sorbet_level) -> void
+      #: ((RubyDocument | ERBDocument) document, GlobalState global_state, Hash[Symbol, untyped] position, Hash[Symbol, untyped]? context, Prism::Dispatcher dispatcher, SorbetLevel sorbet_level) -> void
       def initialize(document, global_state, position, context, dispatcher, sorbet_level) # rubocop:disable Metrics/ParameterLists
         super()
 

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

@@ -5,7 +5,7 @@ module RubyLsp
   module Requests
     module Support
       class Annotation
-        #: (arity: (Integer | T::Range[Integer]), ?receiver: bool) -> void
+        #: (arity: (Integer | Range[Integer]), ?receiver: bool) -> void
         def initialize(arity:, receiver: false)
           @arity = arity
           @receiver = receiver

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

@@ -159,11 +159,6 @@ module RubyLsp
             Constant::SymbolKind::FIELD
           end
         end
-
-        #: (RubyDocument::SorbetLevel sorbet_level) -> bool
-        def sorbet_level_true_or_higher?(sorbet_level)
-          sorbet_level == RubyDocument::SorbetLevel::True || sorbet_level == RubyDocument::SorbetLevel::Strict
-        end
       end
     end
   end

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

@@ -13,6 +13,12 @@ module RubyLsp
         #: String
         attr_reader :id, :label
 
+        #: URI::Generic
+        attr_reader :uri
+
+        #: Interface::Range
+        attr_reader :range
+
         #: (String id, String label, URI::Generic uri, Interface::Range range, Symbol framework) -> void
         def initialize(id, label, uri, range, framework:)
           @id = id

data/lib/ruby_lsp/response_builders/document_symbol.rb

@@ -32,7 +32,7 @@ module RubyLsp
       #: -> Interface::DocumentSymbol?
       def pop
         if @stack.size > 1
-          T.cast(@stack.pop, Interface::DocumentSymbol)
+          @stack.pop #: as Interface::DocumentSymbol
         end
       end
 

data/lib/ruby_lsp/response_builders/test_collection.rb

@@ -8,10 +8,14 @@ module RubyLsp
 
       ResponseType = type_member { { fixed: Requests::Support::TestItem } }
 
+      #: Array[Interface::CodeLens]
+      attr_reader :code_lens
+
       #: -> void
       def initialize
         super
         @items = {} #: Hash[String, ResponseType]
+        @code_lens = [] #: Array[Interface::CodeLens]
       end
 
       #: (ResponseType item) -> void
@@ -19,6 +23,39 @@ module RubyLsp
         @items[item.id] = item
       end
 
+      #: (ResponseType item) -> void
+      def add_code_lens(item)
+        range = item.range
+        arguments = [item.uri.to_standardized_path, item.id]
+
+        @code_lens << Interface::CodeLens.new(
+          range: range,
+          command: Interface::Command.new(
+            title: "▶ Run",
+            command: "rubyLsp.runTest",
+            arguments: arguments,
+          ),
+        )
+
+        @code_lens << Interface::CodeLens.new(
+          range: range,
+          command: Interface::Command.new(
+            title: "▶ Run In Terminal",
+            command: "rubyLsp.runTestInTerminal",
+            arguments: arguments,
+          ),
+        )
+
+        @code_lens << Interface::CodeLens.new(
+          range: range,
+          command: Interface::Command.new(
+            title: "⚙ Debug",
+            command: "rubyLsp.debugTest",
+            arguments: arguments,
+          ),
+        )
+      end
+
       #: (String id) -> ResponseType?
       def [](id)
         @items[id]

data/lib/ruby_lsp/ruby_document.rb

@@ -23,16 +23,6 @@ module RubyLsp
       :private_class_method,
     ].freeze
 
-    class SorbetLevel < T::Enum
-      enums do
-        None = new("none")
-        Ignore = new("ignore")
-        False = new("false")
-        True = new("true")
-        Strict = new("strict")
-      end
-    end
-
     class << self
       #: (Prism::Node node, Integer char_position, code_units_cache: (^(Integer arg0) -> Integer | Prism::CodeUnitsCache), ?node_types: Array[singleton(Prism::Node)]) -> NodeContext
       def locate(node, char_position, code_units_cache:, node_types: [])
@@ -154,29 +144,9 @@ module RubyLsp
     end
 
     # @override
-    #: -> LanguageId
+    #: -> Symbol
     def language_id
-      LanguageId::Ruby
-    end
-
-    #: -> SorbetLevel
-    def sorbet_level
-      sigil = parse_result.magic_comments.find do |comment|
-        comment.key == "typed"
-      end&.value
-
-      case sigil
-      when "ignore"
-        SorbetLevel::Ignore
-      when "false"
-        SorbetLevel::False
-      when "true"
-        SorbetLevel::True
-      when "strict", "strong"
-        SorbetLevel::Strict
-      else
-        SorbetLevel::None
-      end
+      :ruby
     end
 
     #: (Hash[Symbol, untyped] range, ?node_types: Array[singleton(Prism::Node)]) -> Prism::Node?

data/lib/ruby_lsp/server.rb

@@ -242,7 +242,9 @@ module RubyLsp
 
       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]) }
+        env = File.readlines(bundle_env_path).to_h do |line|
+          line.chomp.split("=", 2) #: as [String, String]
+        end
         FileUtils.rm(bundle_env_path)
         env
       end
@@ -385,11 +387,11 @@ module RubyLsp
         text_document = message.dig(:params, :textDocument)
         language_id = case text_document[:languageId]
         when "erb", "eruby"
-          Document::LanguageId::ERB
+          :erb
         when "rbs"
-          Document::LanguageId::RBS
+          :rbs
         else
-          Document::LanguageId::Ruby
+          :ruby
         end
 
         document = @store.set(
@@ -489,13 +491,16 @@ module RubyLsp
       folding_range = Requests::FoldingRanges.new(parse_result.comments, dispatcher)
       document_symbol = Requests::DocumentSymbol.new(uri, dispatcher)
       document_link = Requests::DocumentLink.new(uri, parse_result.comments, dispatcher)
-      code_lens = Requests::CodeLens.new(@global_state, uri, dispatcher)
       inlay_hint = Requests::InlayHints.new(
         document,
         @store.features_configuration.dig(:inlayHint), #: as !nil
         dispatcher,
       )
 
+      # The code lens listener requires the index to be populated, so the DeclarationListener must be inserted first in
+      # the dispatcher's state
+      code_lens = nil #: Requests::CodeLens?
+
       if document.is_a?(RubyDocument) && document.should_index?
         # Re-index the file as it is modified. This mode of indexing updates entries only. Require path trees are only
         # updated on save
@@ -505,10 +510,12 @@ module RubyLsp
           @global_state.index.handle_change(uri) do |index|
             index.delete(uri, skip_require_paths_tree: true)
             RubyIndexer::DeclarationListener.new(index, dispatcher, parse_result, uri, collect_comments: true)
+            code_lens = Requests::CodeLens.new(@global_state, uri, dispatcher)
             dispatcher.dispatch(parse_result.value)
           end
         end
       else
+        code_lens = Requests::CodeLens.new(@global_state, uri, dispatcher)
         dispatcher.dispatch(parse_result.value)
       end
 
@@ -517,7 +524,11 @@ module RubyLsp
       document.cache_set("textDocument/foldingRange", folding_range.perform)
       document.cache_set("textDocument/documentSymbol", document_symbol.perform)
       document.cache_set("textDocument/documentLink", document_link.perform)
-      document.cache_set("textDocument/codeLens", code_lens.perform)
+      document.cache_set(
+        "textDocument/codeLens",
+        code_lens #: as !nil
+          .perform,
+      )
       document.cache_set("textDocument/inlayHint", inlay_hint.perform)
 
       send_message(Result.new(id: message[:id], response: document.cache_get(message[:method])))
@@ -672,6 +683,10 @@ module RubyLsp
         "Formatting error: #{error.message}",
         type: Constant::MessageType::ERROR,
       ))
+      send_message(Notification.window_log_message(
+        "Formatting failed with\r\n: #{error.full_message}",
+        type: Constant::MessageType::ERROR,
+      ))
       send_empty_response(message[:id])
     end
 
@@ -795,12 +810,16 @@ module RubyLsp
       )
     end
 
-    #: (Document[untyped] document) -> RubyDocument::SorbetLevel
+    #: (Document[untyped] document) -> SorbetLevel
     def sorbet_level(document)
-      return RubyDocument::SorbetLevel::Ignore unless @global_state.has_type_checker
-      return RubyDocument::SorbetLevel::Ignore unless document.is_a?(RubyDocument)
+      return SorbetLevel.ignore unless document.is_a?(RubyDocument)
+      return SorbetLevel.ignore unless @global_state.has_type_checker
+
+      sigil = document.parse_result.magic_comments.find do |comment|
+        comment.key == "typed"
+      end&.value
 
-      document.sorbet_level
+      SorbetLevel.new(sigil)
     end
 
     #: (Hash[Symbol, untyped] message) -> void
@@ -871,17 +890,9 @@ module RubyLsp
       end
 
       result = Requests::CodeActionResolve.new(document, @global_state, params).perform
-
-      case result
-      when Requests::CodeActionResolve::Error::EmptySelection
-        fail_request_and_notify(message[:id], "Invalid selection for extract variable refactor")
-      when Requests::CodeActionResolve::Error::InvalidTargetRange
-        fail_request_and_notify(message[:id], "Couldn't find an appropriate location to place extracted refactor")
-      when Requests::CodeActionResolve::Error::UnknownCodeAction
-        fail_request_and_notify(message[:id], "Unknown code action")
-      else
-        send_message(Result.new(id: message[:id], response: result))
-      end
+      send_message(Result.new(id: message[:id], response: result))
+    rescue Requests::CodeActionResolve::CodeActionError => e
+      fail_request_and_notify(message[:id], e.message)
     end
 
     #: (Hash[Symbol, untyped] message) -> void
@@ -921,6 +932,10 @@ module RubyLsp
         "Error running diagnostics: #{error.message}",
         type: Constant::MessageType::ERROR,
       ))
+      send_message(Notification.window_log_message(
+        "Diagnostics failed with\r\n: #{error.full_message}",
+        type: Constant::MessageType::ERROR,
+      ))
       send_empty_response(message[:id])
     end
 

data/lib/ruby_lsp/store.rb

@@ -38,11 +38,11 @@ module RubyLsp
       ext = File.extname(path)
       language_id = case ext
       when ".erb", ".rhtml"
-        Document::LanguageId::ERB
+        :erb
       when ".rbs"
-        Document::LanguageId::RBS
+        :rbs
       else
-        Document::LanguageId::Ruby
+        :ruby
       end
 
       set(uri: uri, source: File.binread(path), version: 0, language_id: language_id)
@@ -51,12 +51,12 @@ module RubyLsp
       raise NonExistingDocumentError, uri.to_s
     end
 
-    #: (uri: URI::Generic, source: String, version: Integer, language_id: Document::LanguageId) -> Document[untyped]
+    #: (uri: URI::Generic, source: String, version: Integer, language_id: Symbol) -> Document[untyped]
     def set(uri:, source:, version:, language_id:)
       @state[uri.to_s] = case language_id
-      when Document::LanguageId::ERB
+      when :erb
         ERBDocument.new(source: source, version: version, uri: uri, global_state: @global_state)
-      when Document::LanguageId::RBS
+      when :rbs
         RBSDocument.new(source: source, version: version, uri: uri, global_state: @global_state)
       else
         RubyDocument.new(source: source, version: version, uri: uri, global_state: @global_state)

data/lib/ruby_lsp/test_reporters/lsp_reporter.rb

@@ -4,21 +4,40 @@
 require "json"
 require "socket"
 require "singleton"
+require "tmpdir"
 
 module RubyLsp
   class LspReporter
     include Singleton
 
+    #: bool
+    attr_reader :invoked_shutdown
+
     #: -> void
     def initialize
+      dir_path = File.join(Dir.tmpdir, "ruby-lsp")
+      FileUtils.mkdir_p(dir_path)
+
+      port_path = File.join(dir_path, "test_reporter_port")
       port = ENV["RUBY_LSP_REPORTER_PORT"]
-      @io = if port
-        TCPSocket.new("localhost", port)
-      else
-        # For tests that don't spawn the TCP server
+
+      @io = begin
+        # The environment variable is only used for tests. The extension always writes to the temporary file
+        if port
+          TCPSocket.new("localhost", port)
+        elsif File.exist?(port_path)
+          TCPSocket.new("localhost", File.read(port_path))
+        else
+          # For tests that don't spawn the TCP server
+          require "stringio"
+          StringIO.new
+        end
+      rescue
         require "stringio"
         StringIO.new
       end #: IO | StringIO
+
+      @invoked_shutdown = false #: bool
     end
 
     #: -> void
@@ -34,6 +53,8 @@ module RubyLsp
     # reporter, use `shutdown` instead
     #: -> void
     def internal_shutdown
+      @invoked_shutdown = true
+
       send_message("finish")
       @io.close
     end
@@ -161,4 +182,10 @@ if ENV["RUBY_LSP_TEST_RUNNER"] == "coverage"
     File.write(File.join(".ruby-lsp", "coverage_result.json"), coverage_results.to_json)
     RubyLsp::LspReporter.instance.internal_shutdown
   end
+elsif ENV["RUBY_LSP_TEST_RUNNER"] && ENV["RUBY_LSP_ENV"] != "test"
+  at_exit do
+    # If the test process crashed immediately without finishing the tests, we still need to tell the extension that the
+    # execution ended so that it can clean up
+    RubyLsp::LspReporter.instance.internal_shutdown unless RubyLsp::LspReporter.instance.invoked_shutdown
+  end
 end

data/lib/ruby_lsp/utils.rb

@@ -259,4 +259,47 @@ module RubyLsp
       @configuration[:enableAll] || @configuration[feature]
     end
   end
+
+  class SorbetLevel
+    class << self
+      #: -> SorbetLevel
+      def ignore
+        new("ignore")
+      end
+    end
+
+    #: (String?) -> void
+    def initialize(sigil)
+      @level = case sigil
+      when "ignore"
+        :ignore
+      when "false"
+        :false
+      when "true"
+        :true
+      when "strict", "strong"
+        :strict
+      else
+        :none
+      end #: Symbol
+    end
+
+    #: -> bool
+    def ignore? = @level == :ignore
+
+    #: -> bool
+    def false? = @level == :false
+
+    #: -> bool
+    def true? = @level == :true
+
+    #: -> bool
+    def strict? = @level == :strict
+
+    #: -> bool
+    def none? = @level == :none
+
+    #: -> bool
+    def true_or_higher? = @level == :true || @level == :strict
+  end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.23.16
+  version: 0.23.17
 platform: ruby
 authors:
 - Shopify