ruby-lsp-reek 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8dc0f0d5264c4cb55e08c39e863d49113fc206876b594c37f1c5b495a04c18fc
-  data.tar.gz: a5cacca4c13f0008b4ef9868ee9a4c557e296a0f64ebf9ac8951ad3771fe9875
+  metadata.gz: dae5db882de49d44fa828397d1b3edb0c4c1f1a66133a9fd8418621f799d0d8b
+  data.tar.gz: 0ec106ffb86fa62903d979a1a13a02de06c92773b23e03df4e0dfb97ee30a5dd
 SHA512:
-  metadata.gz: 725b73500121ff791293945ff1fc6a26508abc50d77715a127966fd0de73071fbd51f667643579f5499249cbdfc1f787d8495621b9d56e1e44037fbd1bd045f4
-  data.tar.gz: 595b0d95becf70e30584691601dec34d3a84aab1c390cbeed5ae4ff50c8060d96d0d0e0be62e8ef530ed0088c75341212e951e708e4fac41a5a58fe3ebc7e8b2
+  metadata.gz: 3c8ad667879e4a2e110c68d65ea3bca3825e9dd71cf8a6b05b942db9362ab9e7b2e67f04496bf5a12ae9adb97dd78732da15aa9739b50c75455b8d80f7dc7104
+  data.tar.gz: 85aaa5e72ff6ed6c9019f4ff0256335ef3be659b3479e87d1f30f6737a5344b99e600fbef03b4be4bbb885570dec13b1235afb716f8070bd109193bbd48e7e7b

data/README.md

@@ -14,10 +14,9 @@ And then execute:
 
     $ bundle
 
-Note: `ruby-lsp` does not seem to recognize this addon when installed outside
-of bundler, but YMMV:
-
-    $ gem install ruby-lsp-reek
+Note: Using globally installed linters in Ruby LSP is [not
+supported](https://github.com/Shopify/ruby-lsp/blob/main/vscode/README.md#formatting),
+they must in your Gemfile or gemspec.
 
 ## Usage
 

data/lib/ruby_lsp/reek/addon.rb

@@ -68,7 +68,7 @@ module RubyLsp
       def workspace_did_change_watched_files(changes)
         return unless changes.any? { |change| change[:uri].end_with?(".reek.yml") }
 
-        runner.init!
+        @runner = Runner.new
         warn "Re-initialized Reek Ruby LSP addon v#{::RubyLsp::Reek::VERSION} due to .reek.yml file change"
       end
 

data/lib/ruby_lsp/reek/runner.rb

@@ -24,9 +24,10 @@ module RubyLsp
       # @param uri [String] The URI of the document to run diagnostics on.
       # @param document [RubyLsp::Interface::TextDocumentItem] The document to run diagnostics on.
       def run_diagnostic(uri, document)
-        return [] if config.path_excluded?(Pathname.new(uri.path))
+        path = Pathname.new(uri.path)
+        return [] if path_excluded?(path)
 
-        examiner = ::Reek::Examiner.new(document.source, configuration: config)
+        examiner = build_examiner(path, document)
         examiner.smells.map { |smell| warning_to_diagnostic(smell) }
       end
 
@@ -34,6 +35,23 @@ module RubyLsp
 
       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)
@@ -56,6 +74,14 @@ module RubyLsp
           message: warning.message
         )
       end
+
+      def path_excluded?(path)
+        path.ascend do |ascendant|
+          break true if config.path_excluded?(ascendant)
+
+          false
+        end
+      end
     end
   end
 end

data/lib/ruby_lsp/reek/version.rb

@@ -2,6 +2,6 @@
 
 module RubyLsp
   module Reek
-    VERSION = "0.2.0"
+    VERSION = "0.3.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-reek
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.1
 platform: ruby
 authors:
 - Iain Gray
@@ -194,5 +194,5 @@ requirements: []
 rubygems_version: 3.5.11
 signing_key:
 specification_version: 4
-summary: Ruby LSP Reek
+summary: Reek addon for Ruby-LSP
 test_files: []