Merge pull request #258 from MGotink/use_reek_directly

Use reek directly

Author: MGotink

HISTORY.md

@@ -8,6 +8,9 @@ As such, a _Feature_ would map to either major (breaking change) or minor. A _bu
 
 * Breaking Changes
 * Features
+  * Add line numbers to reek output. (ggallen, #255)
+  * Use reek directly. (Martin Gotink, #258)
+  * Add support for reek 2. (Martin Gotink, #258)
 * Fixes
   * Use same styling for covered as ignored lines. (Martin Gotink, #254)
 * Misc

lib/metric_fu/metrics/reek/generator.rb

@@ -1,7 +1,5 @@
 module MetricFu
   class ReekGenerator < Generator
-    REEK_REGEX = /^(\S+) (.*) \((.*)\)$/
-
     def self.metric
       :reek
     end
@@ -12,34 +10,25 @@ def emit
         mf_log "Skipping Reek, no files found to analyze"
         @output = ""
       else
-        args = cli_options(files)
-        @output = run!(args)
-        @output = massage_for_reek_12 if reek_12?
+        @output = run!(files, config_files)
       end
     end
 
-    def run!(args)
+    def run!(files, config_files)
+      require "reek"
+      # To load any changing dependencies such as "reek/configuration/app_configuration"
+      #   Added in 1.6.0 https://github.com/troessner/reek/commit/7f4ed2be442ca926e08ccc41945e909e8f710947
+      #   But not always loaded
       require "reek/cli/application"
 
-      MetricFu::Utility.capture_output do
-        Reek::Cli::Application.new(args).execute
-      end
+      examiner = Reek.const_defined?(:Examiner) ? Reek.const_get(:Examiner) : Reek.const_get(:Core).const_get(:Examiner)
+      examiner.new(files, config_files)
     end
 
     def analyze
-      @matches = @output.chomp.split("\n\n").map { |m| m.split("\n") }
-      @matches = @matches.map do |match|
-        break {} if zero_warnings?(match)
-        file_path = match.shift.split(" -- ").first
-        file_path = file_path.gsub('"', " ").strip
-        code_smells = match.map do |smell|
-          match_object = smell.match(REEK_REGEX)
-          next unless match_object
-          { method: match_object[1].strip,
-            message: match_object[2].strip,
-            type: match_object[3].strip }
-        end.compact
-        { file_path: file_path, code_smells: code_smells }
+      @matches = @output.smells.group_by(&:source).collect do |file_path, smells|
+        { file_path: file_path,
+          code_smells: analyze_smells(smells) }
       end
     end
 
@@ -67,31 +56,6 @@ def per_file_info(out)
       end
     end
 
-    def reek_12?
-      return false if @output.length == 0
-      (@output =~ /^"/) != 0
-    end
-
-    def massage_for_reek_12
-      section_break = ""
-      @output.split("\n").map do |line|
-        case line
-        when /^  /
-          "#{line.gsub(/^  /, '')}\n"
-        else
-          parts = line.split(" -- ")
-          if parts[1].nil?
-            "#{line}\n"
-          else
-            warnings = parts[1].gsub(/ \(.*\):/, ":")
-            result = "#{section_break}\"#{parts[0]}\" -- #{warnings}\n"
-            section_break = "\n"
-            result
-          end
-        end
-      end.join
-    end
-
     private
 
     def files_to_analyze
@@ -100,47 +64,26 @@ def files_to_analyze
       remove_excluded_files(files_to_reek)
     end
 
-    def cli_options(files)
-      [
-        disable_line_number_option,
-        turn_off_color,
-        *config_option,
-        *files
-      ].reject(&:empty?)
-    end
-
     # TODO: Check that specified line config file exists
-    def config_option
-      config_file_pattern =  options[:config_file_pattern]
-      if config_file_pattern.to_s.empty?
-        [""]
-      else
-        ["--config", config_file_pattern]
-      end
+    def config_files
+      Array(options[:config_file_pattern])
     end
 
-    # Work around "Error: invalid option: --no-color" in reek < 1.3.7
-    def turn_off_color
-      if reek_version >= "1.3.7"
-        "--no-color"
-      else
-        ""
-      end
+    def analyze_smells(smells)
+      smells.collect(&method(:smell_data))
     end
 
-    def reek_version
-      @reek_version ||=  `reek --version`.chomp.sub(/\s*reek\s*/, "")
-      # use the above, as the below may activate a version not available in
-      # a Bundler context
-      # MetricFu::GemVersion.activated_version('reek').to_s
+    def smell_data(smell)
+      { method: smell.context,
+        message: smell.message,
+        type: smell_type(smell),
+        lines: smell.lines }
     end
 
-    def disable_line_number_option
-      "--no-line-numbers"
-    end
+    def smell_type(smell)
+      return smell.subclass if smell.respond_to?(:subclass)
 
-    def zero_warnings?(match)
-      match.last == "0 total warnings"
+      smell.smell_type
     end
   end
 end

metric_fu.gemspec

@@ -45,7 +45,7 @@ Gem::Specification.new do |s|
   s.add_runtime_dependency "flay",                  [">= 2.0.1",  "~> 2.1"]
   s.add_runtime_dependency "churn",                 ["~> 0.0.35"]
   s.add_runtime_dependency "flog",                  [">= 4.1.1",  "~> 4.1"]
-  s.add_runtime_dependency "reek",                  [">= 1.3.4",  "~> 1.3"]
+  s.add_runtime_dependency "reek",                  [">= 1.3.4",  "< 3.0"]
   s.add_runtime_dependency "cane",                  [">= 2.5.2",  "~> 2.5"]
   s.add_runtime_dependency "rails_best_practices",  [">= 1.14.3", "~> 1.14"]
   s.add_runtime_dependency "metric_fu-Saikuro",     [">= 1.1.3",  "~> 1.1"]