ruby-lsp 0.23.20 → 0.26.1

data/lib/ruby_lsp/test_reporters/minitest_reporter.rb

@@ -8,7 +8,6 @@ rescue LoadError
 end
 
 require_relative "lsp_reporter"
-require "ruby_indexer/lib/ruby_indexer/uri"
 
 module RubyLsp
   # An override of the default progress reporter in Minitest to add color to the output
@@ -31,6 +30,30 @@ module RubyLsp
     end
   end
 
+  # This patch is here to prevent other gems from overriding or adding more Minitest reporters. Otherwise, they may
+  # break the integration between the server and extension
+  module PreventReporterOverridePatch
+    @lsp_reporters = [] #: Array[Minitest::AbstractReporter]
+
+    class << self
+      #: Array[Minitest::AbstractReporter]
+      attr_accessor :lsp_reporters
+    end
+
+    # Patch the writer to prevent replacing the entire array
+    #: (untyped) -> void
+    def reporters=(reporters)
+      # Do nothing. We don't want other gems to override our reporter
+    end
+
+    # Patch the reader to prevent appending more reporters. This method always returns a temporary copy of the real
+    # reporters so that if any gem mutates it, it continues to return the original reporters
+    #: -> Array[untyped]
+    def reporters
+      PreventReporterOverridePatch.lsp_reporters.dup
+    end
+  end
+
   class MinitestReporter < Minitest::AbstractReporter
     class << self
       #: (Hash[untyped, untyped]) -> void
@@ -46,23 +69,42 @@ module RubyLsp
 
         # Add the JSON RPC reporter
         reporters << MinitestReporter.new
+        PreventReporterOverridePatch.lsp_reporters = reporters
+        Minitest.reporter.class.prepend(PreventReporterOverridePatch)
       end
     end
 
-    #: (singleton(Minitest::Test) test_class, String method_name) -> void
-    def prerecord(test_class, method_name)
-      uri, line = LspReporter.instance.uri_and_line_for(test_class.instance_method(method_name))
+    #: (untyped, String) -> void
+    def prerecord(test_class_or_wrapper, method_name)
+      # In frameworks like Rails, they can control the Minitest execution by wrapping the test class
+      # But they conform to responding to `name`, so we can use that as a guarantee
+      # We are interested in the test class, not the wrapper
+      name = test_class_or_wrapper.name
+
+      klass = begin
+        Object.const_get(name) # rubocop:disable Sorbet/ConstantsFromStrings
+      rescue NameError
+        # Handle Minitest specs that create classes with invalid constant names like "MySpec::when something is true"
+        # If we can't resolve the constant, it means we were given the actual test class object, not the wrapper
+        test_class_or_wrapper
+      end
+
+      uri, line = LspReporter.instance.uri_and_line_for(klass.instance_method(method_name))
       return unless uri
 
-      LspReporter.instance.start_test(id: "#{test_class.name}##{method_name}", uri: uri, line: line)
+      id = "#{name}##{handle_spec_test_id(method_name, line)}"
+      LspReporter.instance.start_test(id: id, uri: uri, line: line)
     end
 
     #: (Minitest::Result result) -> void
     def record(result)
-      id = "#{result.klass}##{result.name}"
-      file_path, _line = result.source_location
+      file_path, line = result.source_location
       return unless file_path
 
+      zero_based_line = line ? line - 1 : nil
+      name = handle_spec_test_id(result.name, zero_based_line)
+      id = "#{result.klass}##{name}"
+
       uri = URI::Generic.from_path(path: File.expand_path(file_path))
 
       if result.error?
@@ -82,6 +124,11 @@ module RubyLsp
     def report
       LspReporter.instance.shutdown
     end
+
+    #: (String, Integer?) -> String
+    def handle_spec_test_id(method_name, line)
+      method_name.gsub(/(?<=test_)\d{4}(?=_)/, format("%04d", line.to_s))
+    end
   end
 end
 

data/lib/ruby_lsp/test_reporters/test_unit_reporter.rb

@@ -10,7 +10,6 @@ rescue LoadError
 end
 
 require_relative "lsp_reporter"
-require "ruby_indexer/lib/ruby_indexer/uri"
 
 module RubyLsp
   class TestUnitReporter < Test::Unit::UI::Console::TestRunner

data/lib/ruby_lsp/utils.rb

@@ -5,7 +5,6 @@ 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
@@ -20,6 +19,7 @@ module RubyLsp
     "Gemfile"
   end #: String
   GUESSED_TYPES_URL = "https://shopify.github.io/ruby-lsp/#guessed-types"
+  TEST_PATH_PATTERN = "**/{test,spec,features}/**/{*_test.rb,test_*.rb,*_spec.rb,*.feature}"
 
   # Request delegation for embedded languages is not yet standardized into the language server specification. Here we
   # use this custom error class as a way to return a signal to the client that the request should be delegated to the
@@ -31,29 +31,30 @@ module RubyLsp
     CODE = -32900
   end
 
+  class AbstractMethodInvokedError < StandardError; end
+
   BUNDLE_COMPOSE_FAILED_CODE = -33000
 
   # A notification to be sent to the client
+  # @abstract
   class Message
-    extend T::Sig
-    extend T::Helpers
-
     #: String
     attr_reader :method
 
     #: Object
     attr_reader :params
 
-    abstract!
-
     #: (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
+    # @abstract
+    #: -> Hash[Symbol, untyped]
+    def to_hash
+      raise AbstractMethodInvokedError
+    end
   end
 
   class Notification < Message
@@ -246,9 +247,6 @@ module RubyLsp
 
   # A request configuration, to turn on/off features
   class RequestConfig
-    #: Hash[Symbol, bool]
-    attr_accessor :configuration
-
     #: (Hash[Symbol, bool] configuration) -> void
     def initialize(configuration)
       @configuration = configuration
@@ -258,6 +256,11 @@ module RubyLsp
     def enabled?(feature)
       @configuration[:enableAll] || @configuration[feature]
     end
+
+    #: (Hash[Symbol, bool]) -> void
+    def merge!(hash)
+      @configuration.merge!(hash)
+    end
   end
 
   class SorbetLevel
@@ -302,4 +305,37 @@ module RubyLsp
     #: -> bool
     def true_or_higher? = @level == :true || @level == :strict
   end
+
+  # Reads JSON RPC messages from the given IO in a loop
+  class MessageReader
+    #: (IO) -> void
+    def initialize(io)
+      @io = io
+    end
+
+    #: () { (Hash[Symbol, untyped]) -> void } -> void
+    def each_message(&block)
+      while (headers = @io.gets("\r\n\r\n"))
+        raw_message = @io.read(headers[/Content-Length: (\d+)/i, 1].to_i) #: as !nil
+        block.call(JSON.parse(raw_message, symbolize_names: true))
+      end
+    end
+  end
+
+  # Writes JSON RPC messages to the given IO
+  class MessageWriter
+    #: (IO) -> void
+    def initialize(io)
+      @io = io
+    end
+
+    #: (Hash[Symbol, untyped]) -> void
+    def write(message)
+      message[:jsonrpc] = "2.0"
+      json_message = message.to_json
+
+      @io.write("Content-Length: #{json_message.bytesize}\r\n\r\n#{json_message}")
+      @io.flush
+    end
+  end
 end

data/static_docs/break.md

@@ -0,0 +1,103 @@
+# Break
+
+In Ruby, the `break` keyword is used to exit a loop or block prematurely. Unlike `next` which skips to the next iteration, `break` terminates the loop entirely and continues with the code after the loop.
+
+```ruby
+# Basic break usage in a loop
+5.times do |i|
+  break if i == 3
+
+  puts i
+end
+# Output:
+# 0
+# 1
+# 2
+```
+
+The `break` statement can be used with any of Ruby's iteration methods or loops.
+
+```ruby
+array = [1, 2, 3, 4, 5]
+
+# Break in each iteration
+array.each do |num|
+  break if num > 3
+
+  puts "Number: #{num}"
+end
+# Output:
+# Number: 1
+# Number: 2
+# Number: 3
+
+# Break in an infinite loop
+count = 0
+loop do
+  count += 1
+  break if count >= 3
+
+  puts "Count: #{count}"
+end
+# Output:
+# Count: 1
+# Count: 2
+```
+
+## Break with a Value
+
+When used inside a block, `break` can return a value that becomes the result of the method call.
+
+```ruby
+# Break with a return value in map
+result = [1, 2, 3, 4, 5].map do |num|
+  break "Too large!" if num > 3
+
+  num * 2
+end
+puts result # Output: "Too large!"
+
+# Break with a value in find
+number = (1..10).find do |n|
+  break n if n > 5 && n.even?
+end
+puts number # Output: 6
+```
+
+## Break in Nested Loops
+
+When using `break` in nested loops, it only exits the innermost loop. To break from nested loops, you typically need to use a flag or return.
+
+```ruby
+# Break in nested iteration
+(1..3).each do |i|
+  puts "Outer: #{i}"
+
+  (1..3).each do |j|
+    break if j == 2
+
+    puts "  Inner: #{j}"
+  end
+end
+# Output:
+# Outer: 1
+#   Inner: 1
+# Outer: 2
+#   Inner: 1
+# Outer: 3
+#   Inner: 1
+
+# Breaking from nested loops with a flag
+found = false
+(1..3).each do |i|
+  (1..3).each do |j|
+    if i * j == 4
+      found = true
+      break
+    end
+  end
+  break if found
+end
+```
+
+The `break` keyword is essential for controlling loop execution and implementing early exit conditions. It's particularly useful when you've found what you're looking for and don't need to continue iterating.

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp
 version: !ruby/object:Gem::Version
-  version: 0.23.20
+  version: 0.26.1
 platform: ruby
 authors:
 - Shopify
@@ -52,7 +52,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
+        version: '5'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -62,21 +62,7 @@ dependencies:
         version: '3'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4'
-- !ruby/object:Gem::Dependency
-  name: sorbet-runtime
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.10782
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.10782
+        version: '5'
 description: An opinionated language server for Ruby
 email:
 - ruby@shopify.com
@@ -84,6 +70,7 @@ executables:
 - ruby-lsp
 - ruby-lsp-check
 - ruby-lsp-launcher
+- ruby-lsp-test-exec
 extensions: []
 extra_rdoc_files: []
 files:
@@ -93,6 +80,7 @@ files:
 - exe/ruby-lsp
 - exe/ruby-lsp-check
 - exe/ruby-lsp-launcher
+- exe/ruby-lsp-test-exec
 - lib/rubocop/cop/ruby_lsp/use_language_server_aliases.rb
 - lib/rubocop/cop/ruby_lsp/use_register_with_handler_method.rb
 - lib/ruby-lsp.rb
@@ -143,7 +131,6 @@ files:
 - lib/ruby_lsp/listeners/spec_style.rb
 - lib/ruby_lsp/listeners/test_discovery.rb
 - lib/ruby_lsp/listeners/test_style.rb
-- lib/ruby_lsp/load_sorbet.rb
 - lib/ruby_lsp/node_context.rb
 - lib/ruby_lsp/rbs_document.rb
 - lib/ruby_lsp/requests/code_action_resolve.rb
@@ -207,6 +194,7 @@ files:
 - lib/ruby_lsp/test_reporters/test_unit_reporter.rb
 - lib/ruby_lsp/type_inferrer.rb
 - lib/ruby_lsp/utils.rb
+- static_docs/break.md
 - static_docs/yield.md
 homepage: https://github.com/Shopify/ruby-lsp
 licenses:
@@ -228,7 +216,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 3.6.9
 specification_version: 4
 summary: An opinionated language server for Ruby
 test_files: []

data/lib/ruby_lsp/load_sorbet.rb

@@ -1,62 +0,0 @@
-# typed: true
-# frozen_string_literal: true
-
-require "sorbet-runtime"
-
-begin
-  T::Configuration.default_checked_level = :never
-  # Suppresses call validation errors
-  T::Configuration.call_validation_error_handler = ->(*arg) {}
-  # Suppresses errors caused by T.cast, T.let, T.must, etc.
-  T::Configuration.inline_type_error_handler = ->(*arg) {}
-  # Suppresses errors caused by incorrect parameter ordering
-  T::Configuration.sig_validation_error_handler = ->(*arg) {}
-rescue
-  # Need this rescue so that if another gem has
-  # already set the checked level by the time we
-  # get to it, we don't fail outright.
-  nil
-end
-
-module RubyLsp
-  # No-op all inline type assertions defined in T
-  module InlineTypeAssertions
-    def absurd(value)
-      value
-    end
-
-    def any(type_a, type_b, *types)
-      T::Types::Union.new([type_a, type_b, *types])
-    end
-
-    def assert_type!(value, type, checked: true)
-      value
-    end
-
-    def bind(value, type, checked: true)
-      value
-    end
-
-    def cast(value, type, checked: true)
-      value
-    end
-
-    def let(value, type, checked: true)
-      value
-    end
-
-    def must(arg)
-      arg
-    end
-
-    def nilable(type)
-      T::Types::Union.new([type, T::Utils::Nilable::NIL_TYPE])
-    end
-
-    def unsafe(value)
-      value
-    end
-
-    T.singleton_class.prepend(self)
-  end
-end