ruby-lsp-reek 0.3.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dae5db882de49d44fa828397d1b3edb0c4c1f1a66133a9fd8418621f799d0d8b
-  data.tar.gz: 0ec106ffb86fa62903d979a1a13a02de06c92773b23e03df4e0dfb97ee30a5dd
+  metadata.gz: 6ca16a81679c7c225ef738124db24b59751b5b76e356e233dda6b408fdc8dd04
+  data.tar.gz: 9c0eb73687b558b3289a90a520496309f2c7b63bcc8a03a9b29048e0e4e6bbed
 SHA512:
-  metadata.gz: 3c8ad667879e4a2e110c68d65ea3bca3825e9dd71cf8a6b05b942db9362ab9e7b2e67f04496bf5a12ae9adb97dd78732da15aa9739b50c75455b8d80f7dc7104
-  data.tar.gz: 85aaa5e72ff6ed6c9019f4ff0256335ef3be659b3479e87d1f30f6737a5344b99e600fbef03b4be4bbb885570dec13b1235afb716f8070bd109193bbd48e7e7b
+  metadata.gz: b16a943228c71549373623164061fc43cdf69348cef47e3b31d32ca565125f4964d9f78c4a02bb798a4149348d76818629928d080d982608183a54a19f4709d7
+  data.tar.gz: 993900224be3508be1a13ec40687573010b6571d31777fecee630eaa0ea5cbb9282514968e9948a25cf47fe9b9a89e756868409d4ce72ca87365ca41e9c87e01

data/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 @@ module RubyLsp
         "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)

data/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

data/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 @@ module RubyLsp
         @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)

data/lib/ruby_lsp/reek/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby-lsp-reek
 version: !ruby/object:Gem::Version
-  version: 0.3.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Iain Gray
@@ -17,9 +17,6 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -27,49 +24,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '6.0'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: ruby-lsp
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.0
+        version: '0.26'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '0.17'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.12.0
-- !ruby/object:Gem::Dependency
-  name: sorbet-runtime
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.5685
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '0.5'
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: 0.5.5685
+        version: '0.26'
 - !ruby/object:Gem::Dependency
   name: minitest
   requirement: !ruby/object:Gem::Requirement
@@ -166,6 +134,7 @@ files:
 - README.md
 - Rakefile
 - lib/ruby_lsp/reek/addon.rb
+- lib/ruby_lsp/reek/diagnostic.rb
 - lib/ruby_lsp/reek/runner.rb
 - lib/ruby_lsp/reek/version.rb
 homepage: https://github.com/igray/ruby-lsp-reek
@@ -184,7 +153,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.5.0
+      version: 3.0.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="