Upgrade to ruby-lsp 0.26

Bump the ruby-lsp dependency from `~> 0.17` to `~> 0.26` and raise
required_ruby_version to >= 3.0.0 to match what ruby-lsp now requires.

Addon changes:

- Implement `version`. Since 0.23 the addon base class treats it as
  abstract and uses it for the `Addon.get(name, constraint)` compatibility
  check, so without it any addon querying this one raises
  AbstractMethodInvokedError.

- Drop the sorbet-runtime dependency. ruby-lsp no longer depends on it and
  the only reference left here was a bare require; there is no `T.` or
  `T::Sig` usage anywhere in the gem.

Test changes: the suite hand-rolled `with_server` against internals that
have since been removed (`core_ext/uri`, `RubyIndexer::IndexablePath`). It
now uses the `RubyLsp::TestHelper` module that ruby-lsp ships for addons,
requires `ruby_lsp/internal` instead of a long explicit require list, and
uses `pop_result` so notifications in the queue don't break the assertions.
The expected reek docs URL is interpolated from `Reek::Version::STRING`
rather than hardcoded.

Clean up the reek warnings so `rake code_analysis` passes:

- `Runner#build_examiner` (FeatureEnvy) is gone. It existed to work around
  Examiner not accepting a separate source and origin, reaching into two of
  its instance variables to do so. `SourceCode.from(source, origin:)` takes
  an explicit origin and Examiner passes a SourceCode through untouched, so
  the workaround is no longer needed.

- `Runner#warning_to_diagnostic` (UtilityFunction) moves to
  `Reek::Diagnostic.from_warning`, which is what the smell was suggesting.

- `Runner#run_formatting` (UtilityFunction) is suppressed in place. The
  Formatter interface requires an instance method and reek is a linter, so
  there is nothing to format and no instance state to depend on.

The origin behaviour from #5 had no test, so add one covering it: a file
under a directory with a `.reek.yml` directory directive is exempt while a
file outside it is not. Verified it fails when the origin is dropped.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>

Author: igray

lib/ruby_lsp/reek/addon.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require "bundler/setup"
-require "sorbet-runtime"
 require "ruby_lsp/addon"
 require "ruby_lsp/base_server"
 require "ruby_lsp/server"
@@ -22,6 +21,11 @@ def name
         "Reek: Code smell detector for Ruby"
       end
 
+      # @return [String] The version of the addon.
+      def version
+        ::RubyLsp::Reek::VERSION
+      end
+
       # @param global_state [GlobalState] The global state of the Ruby LSP server.
       # @param outgoing_queue [Thread::Queue] The outgoing message queue of the Ruby LSP server.
       def activate(global_state, message_queue)

lib/ruby_lsp/reek/diagnostic.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module RubyLsp
+  module Reek
+    # Translates a Reek smell warning into the LSP diagnostic that Ruby LSP
+    # reports back to the editor.
+    module Diagnostic
+      # @param warning [Reek::SmellWarning] The warning to convert to a diagnostic.
+      # @return [RubyLsp::Interface::Diagnostic] The diagnostic.
+      def self.from_warning(warning)
+        lines = warning.lines
+        ::RubyLsp::Interface::Diagnostic.new(
+          range: ::RubyLsp::Interface::Range.new(
+            start: ::RubyLsp::Interface::Position.new(
+              line: lines.first - 1,
+              character: 0
+            ),
+            end: ::RubyLsp::Interface::Position.new(
+              line: lines.last - 1,
+              character: 0
+            )
+          ),
+          severity: Constant::DiagnosticSeverity::WARNING,
+          code: warning.smell_type,
+          code_description: ::RubyLsp::Interface::CodeDescription.new(href: warning.explanatory_link),
+          source: "Reek",
+          message: warning.message
+        )
+      end
+    end
+  end
+end

lib/ruby_lsp/reek/runner.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "reek"
+require_relative "diagnostic"
 
 module RubyLsp
   module Reek
@@ -12,69 +13,41 @@ def initialize
         @config = ::Reek::Configuration::AppConfiguration.from_default_path
       end
 
-      # We are not implementing this method, but it is required by the interface
+      # We are not implementing this method, but it is required by the
+      # interface. Reek is a linter, so there is nothing to format and the
+      # source is handed back untouched.
       #
-      # @param uri [String] The URI of the document to format.
-      # @param document [RubyLsp::Interface::TextDocumentItem] The document to format.
+      # :reek:UtilityFunction { enabled: false } - the interface requires an
+      # instance method, so it cannot depend on instance state.
+      #
+      # @param uri [URI::Generic] The URI of the document to format.
+      # @param document [RubyLsp::RubyDocument] The document to format.
       # @return [String] The formatted document.
       def run_formatting(_uri, document)
         document.source
       end
 
-      # @param uri [String] The URI of the document to run diagnostics on.
-      # @param document [RubyLsp::Interface::TextDocumentItem] The document to run diagnostics on.
+      # @param uri [URI::Generic] The URI of the document to run diagnostics on.
+      # @param document [RubyLsp::RubyDocument] The document to run diagnostics on.
       def run_diagnostic(uri, document)
         path = Pathname.new(uri.path)
         return [] if path_excluded?(path)
 
-        examiner = build_examiner(path, document)
-        examiner.smells.map { |smell| warning_to_diagnostic(smell) }
+        # We lint the source as it currently stands in the editor, but Reek
+        # resolves directory directives from the origin, so the origin has to
+        # be set explicitly to the file on disk rather than defaulting to
+        # "string".
+        examiner = ::Reek::Examiner.new(
+          ::Reek::Source::SourceCode.from(document.source, origin: path.to_s),
+          configuration: config
+        )
+        examiner.smells.map { |smell| Diagnostic.from_warning(smell) }
       end
 
       private
 
       attr_reader :config
 
-      # Examiner does not allow separate source and origin, but we need to
-      # lint the string from the editor AND know what the filename of the
-      # edited file is. This patches the examiner to allow this.
-      def build_examiner(path, document)
-        examiner = ::Reek::Examiner.new(document.source, configuration: config)
-        origin = ::Reek::Source::SourceCode.from(path).origin
-        examiner.instance_variable_set(:@origin, origin)
-        examiner.instance_variable_set(
-          :@detector_repository,
-          ::Reek::DetectorRepository.new(
-            smell_types: examiner.instance_variable_get(:@smell_types),
-            configuration: config.directive_for(origin)
-          )
-        )
-        examiner
-      end
-
-      # @param warning [Reek::SmellWarning] The warning to convert to a diagnostic.
-      # @return [RubyLsp::Interface::Diagnostic] The diagnostic.
-      def warning_to_diagnostic(warning)
-        lines = warning.lines
-        ::RubyLsp::Interface::Diagnostic.new(
-          range: ::RubyLsp::Interface::Range.new(
-            start: ::RubyLsp::Interface::Position.new(
-              line: lines.first - 1,
-              character: 0
-            ),
-            end: ::RubyLsp::Interface::Position.new(
-              line: lines.last - 1,
-              character: 0
-            )
-          ),
-          severity: Constant::DiagnosticSeverity::WARNING,
-          code: warning.smell_type,
-          code_description: ::RubyLsp::Interface::CodeDescription.new(href: warning.explanatory_link),
-          source: "Reek",
-          message: warning.message
-        )
-      end
-
       def path_excluded?(path)
         path.ascend do |ascendant|
           break true if config.path_excluded?(ascendant)

ruby-lsp-reek.gemspec

@@ -12,7 +12,7 @@ Gem::Specification.new do |spec|
   spec.description = "An addon for Ruby LSP that enables linting with reek"
   spec.homepage = "https://github.com/igray/ruby-lsp-reek"
   spec.license = "MIT"
-  spec.required_ruby_version = Gem::Requirement.new(">= 2.5.0")
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
   spec.metadata["homepage_uri"] = spec.homepage
@@ -30,8 +30,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_dependency("reek", "~> 6.0", ">= 5.0")
-  spec.add_dependency("ruby-lsp", "~> 0.17", ">= 0.12.0")
-  spec.add_dependency("sorbet-runtime", "~> 0.5", ">= 0.5.5685")
+  spec.add_dependency("ruby-lsp", "~> 0.26")
 
   spec.add_development_dependency "minitest", "~> 5.20"
   spec.add_development_dependency "pry", "~> 0.14"

test/ruby_lsp_addon_test.rb

@@ -2,29 +2,15 @@
 
 require "bundler/setup"
 require "minitest/autorun"
-require "sorbet-runtime"
-require "uri"
-require "core_ext/uri"
-require "language_server-protocol"
-require "ruby_indexer/ruby_indexer"
-require "ruby_lsp/addon"
-require "ruby_lsp/base_server"
-require "ruby_lsp/client_capabilities"
-require "ruby_lsp/server"
-require "ruby_lsp/requests/request"
-require "ruby_lsp/requests/diagnostics"
-require "ruby_lsp/requests/support/formatter"
-require "ruby_lsp/utils"
-require "ruby_lsp/store"
-require "ruby_lsp/document"
-require "ruby_lsp/global_state"
-require "ruby_lsp/ruby_document"
-require "ruby_lsp/type_inferrer"
-require "prism"
+require "tmpdir"
+require "ruby_lsp/internal"
+require "ruby_lsp/test_helper"
 require "pry"
 require "ruby_lsp/reek/addon"
 
 class RubyLspAddonTest < Minitest::Test
+  include RubyLsp::TestHelper
+
   def setup
     @addon = RubyLsp::Reek::Addon.new
     super
@@ -34,6 +20,10 @@ def test_name
     assert_equal "Reek: Code smell detector for Ruby", @addon.name
   end
 
+  def test_version
+    assert_equal RubyLsp::Reek::VERSION, @addon.version
+  end
+
   def test_diagnostic
     source = <<~RUBY
       def foo
@@ -52,9 +42,8 @@ def foo
         }
       )
 
-      result = server.pop_response
+      result = pop_result(server)
 
-      assert_instance_of(RubyLsp::Result, result)
       assert_equal "full", result.response.kind
       assert_equal 1, result.response.items.size
       item = result.response.items.first
@@ -63,54 +52,64 @@ def foo
       assert_equal RubyLsp::Constant::DiagnosticSeverity::WARNING, item.severity
       assert_equal "UncommunicativeVariableName", item.code
       assert_equal(
-        "https://github.com/troessner/reek/blob/v6.3.0/docs/Uncommunicative-Variable-Name.md",
+        "https://github.com/troessner/reek/blob/v#{Reek::Version::STRING}/docs/Uncommunicative-Variable-Name.md",
         item.code_description.href
       )
       assert_equal "Reek", item.source
       assert_equal("has the variable name 's'", item.message)
     end
   end
 
-  private
+  # The source being linted comes from the editor buffer, but Reek resolves
+  # directory directives from the origin of that source. The origin therefore
+  # has to follow the file on disk, not the buffer.
+  def test_diagnostic_resolves_directives_from_the_file_path
+    Dir.mktmpdir do |tmpdir|
+      workspace = File.realpath(tmpdir)
+      models = File.join(workspace, "app", "models")
+      FileUtils.mkdir_p(models)
+      FileUtils.mkdir_p(File.join(workspace, "lib"))
+      File.write(File.join(workspace, ".reek.yml"), <<~YAML)
+        directories:
+          "app/models":
+            UncommunicativeVariableName:
+              enabled: false
+      YAML
 
-  # Overridden from RubyLsp/TestHelper so that we can override the linters configuration
-  def with_server(
-    source = nil,
-    path = "fake.rb",
-    stub_no_typechecker: false,
-    load_addons: true,
-    &block
-  )
-    server = RubyLsp::Server.new(test_mode: true)
-    uri = Kernel.URI(File.join(server.global_state.workspace_path, path))
-    server.global_state.instance_variable_set(:@linters, ["reek"])
-    server.global_state.stubs(:typechecker).returns(false) if stub_no_typechecker
-
-    if source
-      server.process_message(
-        {
-          method: "textDocument/didOpen",
-          params: {
-            textDocument: {
-              uri:,
-              text: source,
-              version: 1
-            }
-          }
-        }
-      )
+      document = Struct.new(:source).new(<<~RUBY)
+        def foo
+          s = 'hello'
+          puts s
+        end
+      RUBY
+
+      Dir.chdir(workspace) do
+        runner = RubyLsp::Reek::Runner.new
+
+        assert_empty runner.run_diagnostic(
+          URI::Generic.from_path(path: File.join(models, "user.rb")),
+          document
+        )
+
+        assert_equal ["UncommunicativeVariableName"], runner.run_diagnostic(
+          URI::Generic.from_path(path: File.join(workspace, "lib", "user.rb")),
+          document
+        ).map(&:code)
+      end
     end
+  end
+
+  private
+
+  # Overridden from RubyLsp::TestHelper so that we can override the linters
+  # configuration and build a URI inside the workspace, which Reek needs in
+  # order to resolve directory directives from .reek.yml.
+  def with_server(source = nil, path = "fake.rb", **kwargs, &block)
+    uri = URI::Generic.from_path(path: File.join(Dir.pwd, path))
 
-    server.global_state.index.index_single(
-      RubyIndexer::IndexablePath.new(nil, 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
+    super(source, uri, **kwargs) do |server, server_uri|
+      server.global_state.instance_variable_set(:@linters, ["reek"])
+      block.call(server, server_uri)
     end
   end
 end