ruby-lsp 0.23.15 → 0.26.9

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
@@ -26,12 +25,12 @@ module RubyLsp
     def test_started(test)
       super
 
-      current_test = test
-      @current_uri = uri_for_test(current_test)
-      return unless @current_uri
+      uri, line = LspReporter.uri_and_line_for(test.method(test.method_name))
+      return unless uri
 
-      @current_test_id = "#{current_test.class.name}##{current_test.method_name}"
-      LspReporter.instance.start_test(id: @current_test_id, uri: @current_uri)
+      @current_uri = uri
+      @current_test_id = "#{test.class.name}##{test.method_name}"
+      LspReporter.instance.start_test(id: @current_test_id, uri: @current_uri, line: line)
     end
 
     #: (::Test::Unit::TestCase test) -> void
@@ -59,21 +58,10 @@ module RubyLsp
 
     #: (Float) -> void
     def finished(elapsed_time)
+      super
       LspReporter.instance.shutdown
     end
 
-    #: (::Test::Unit::TestCase test) -> URI::Generic?
-    def uri_for_test(test)
-      location = test.method(test.method_name).source_location
-      return unless location
-
-      file, _line = location
-      return if file.start_with?("(eval at ")
-
-      absolute_path = File.expand_path(file, Dir.pwd)
-      URI::Generic.from_path(path: absolute_path)
-    end
-
     #: -> void
     def attach_to_mediator
       # Events we care about
@@ -92,3 +80,13 @@ end
 
 Test::Unit::AutoRunner.register_runner(:ruby_lsp) { |_auto_runner| RubyLsp::TestUnitReporter }
 Test::Unit::AutoRunner.default_runner = :ruby_lsp
+
+if RubyLsp::LspReporter.start_coverage?
+  Test::Unit.at_exit do
+    RubyLsp::LspReporter.instance.at_coverage_exit
+  end
+elsif RubyLsp::LspReporter.executed_under_test_runner?
+  Test::Unit.at_exit do
+    RubyLsp::LspReporter.instance.at_exit
+  end
+end

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
@@ -137,7 +138,12 @@ module RubyLsp
     #: -> Hash[Symbol, untyped]
     def to_hash
       hash = { method: @method }
-      hash[:params] = T.unsafe(@params).to_hash if @params
+
+      if @params
+        hash[:params] = @params #: as untyped
+          .to_hash
+      end
+
       hash
     end
   end
@@ -181,7 +187,12 @@ module RubyLsp
     #: -> Hash[Symbol, untyped]
     def to_hash
       hash = { id: @id, method: @method }
-      hash[:params] = T.unsafe(@params).to_hash if @params
+
+      if @params
+        hash[:params] = @params #: as untyped
+          .to_hash
+      end
+
       hash
     end
   end
@@ -236,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
@@ -248,5 +256,86 @@ module RubyLsp
     def enabled?(feature)
       @configuration[:enableAll] || @configuration[feature]
     end
+
+    #: (Hash[Symbol, bool]) -> void
+    def merge!(hash)
+      @configuration.merge!(hash)
+    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
+
+  # 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.15
+  version: 0.26.9
 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
@@ -108,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
@@ -143,7 +117,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
@@ -176,6 +149,7 @@ files:
 - lib/ruby_lsp/requests/support/annotation.rb
 - lib/ruby_lsp/requests/support/common.rb
 - lib/ruby_lsp/requests/support/formatter.rb
+- lib/ruby_lsp/requests/support/package_url.rb
 - lib/ruby_lsp/requests/support/rubocop_diagnostic.rb
 - lib/ruby_lsp/requests/support/rubocop_formatter.rb
 - lib/ruby_lsp/requests/support/rubocop_runner.rb
@@ -207,6 +181,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 +203,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.6.8
+rubygems_version: 4.0.3
 specification_version: 4
 summary: An opinionated language server for Ruby
 test_files: []

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