metric_fu 4.11.1 → 4.13.0

data/spec/metric_fu/metrics/reek/configuration_spec.rb

@@ -1,12 +1,12 @@
-require 'spec_helper'
-require 'shared/configured'
+require "spec_helper"
+require "shared/configured"
 
-describe MetricFu::Configuration, 'for reek' do
-  it_behaves_like 'configured' do
-    it 'should set @reek to {:dirs_to_reek => @code_dirs}' do
-      load_metric 'reek'
+describe MetricFu::Configuration, "for reek" do
+  it_behaves_like "configured" do
+    it "should set @reek to {:dirs_to_reek => @code_dirs}" do
+      load_metric "reek"
       expect(MetricFu::Metric.get_metric(:reek).run_options).to eq(
-              {:config_file_pattern=>nil, :dirs_to_reek => ['lib']}
+              config_file_pattern: nil, dirs_to_reek: ["lib"]
       )
     end
   end

data/spec/metric_fu/metrics/reek/generator_spec.rb

@@ -1,74 +1,115 @@
 require "spec_helper"
-MetricFu.metrics_require { 'reek/generator' }
+
+MetricFu.metrics_require { "reek/generator" }
 
 describe MetricFu::ReekGenerator do
   describe "emit" do
-    let(:options) { {:dirs_to_reek => []} }
-    let(:files_to_analyze) { ['lib/foo.rb','lib/bar.rb'] }
+    let(:options) { { dirs_to_reek: [] } }
+    let(:files_to_analyze) { ["lib/foo.rb", "lib/bar.rb"] }
     let(:reek) { MetricFu::ReekGenerator.new(options) }
 
-    before :each do
+    before(:each) do
       allow(reek).to receive(:files_to_analyze).and_return(files_to_analyze)
     end
 
     it "includes config file pattern into reek parameters when specified" do
-      options.merge!({:config_file_pattern => 'lib/config/*.reek' })
-      expect(reek).to receive(:run!).with(/--config lib\/config\/\*\.reek /).and_return("")
-      reek.emit
-    end
+      options.merge!(config_file_pattern: "lib/config/*.reek")
 
-    it "turns off color output from reek output, for reek 1.3.7 or greater" do
-      allow(reek).to receive(:reek_version).and_return('1.3.7')
-      expect(reek).to receive(:run!).with(/(?=--no-color)/).and_return("")
-      reek.emit
-    end
+      expect(reek).to receive(:run!) do |_files, config_files|
+        expect(config_files).to eq(["lib/config/*.reek"])
+      end.and_return("")
 
-    it "does not set an (invalid) --no-color option for reek < 1.3.7" do
-      allow(reek).to receive(:reek_version).and_return('1.3.6')
-      expect(reek).to receive(:run!).with(/(?!--no-color)/).and_return("")
       reek.emit
     end
 
-    it "disables lines numbers from reek output" do
-      expect(reek).to receive(:run!).with(/--no-line-numbers /).and_return("")
+    it "passes an empty array when no config file pattern is specified" do
+      expect(reek).to receive(:run!) do |_files, config_files|
+        expect(config_files).to eq([])
+      end.and_return("")
+
       reek.emit
     end
 
     it "includes files to analyze into reek parameters" do
-      expect(reek).to receive(:run!).with(/lib\/foo.rb lib\/bar.rb$/).and_return("")
+      expect(reek).to receive(:run!) do |files, _config_files|
+        expect(files).to eq(["lib/foo.rb", "lib/bar.rb"])
+      end.and_return("")
+
       reek.emit
     end
   end
 
-  #TODO review tested output
   describe "analyze method" do
-
     before :each do
       MetricFu::Configuration.run {}
       allow(File).to receive(:directory?).and_return(true)
-      @reek = MetricFu::ReekGenerator.new
+      @generator = MetricFu::ReekGenerator.new
+      @examiner = @generator.send(:examiner)
+      @smell_warning = Reek.const_defined?(:SmellWarning) ? Reek.const_get(:SmellWarning) : Reek.const_get(:Smells).const_get(:SmellWarning)
+      if @smell_warning.instance_methods.include?(:subclass)
+        @smell_warning.send(:alias_method, :smell_type, :subclass)
+      end
     end
 
     context "with reek warnings" do
       before :each do
-        @lines = <<-HERE
-"app/controllers/activity_reports_controller.rb" -- 4 warnings:
-ActivityReportsController#authorize_user calls current_user.primary_site_ids multiple times (Duplication)
-ActivityReportsController#authorize_user calls params[id] multiple times (Duplication)
-ActivityReportsController#authorize_user calls params[primary_site_id] multiple times (Duplication)
-ActivityReportsController#authorize_user has approx 6 statements (Long Method)
-
-"app/controllers/application.rb" -- 1 warnings:
-ApplicationController#start_background_task/block/block is nested (Nested Iterators)
-
-"app/controllers/link_targets_controller.rb" -- 1 warnings:
-LinkTargetsController#authorize_user calls current_user.role multiple times (Duplication)
-
-"app/controllers/newline_controller.rb" -- 1 warnings:
-NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
-      HERE
-        @reek.instance_variable_set(:@output, @lines)
-        @matches = @reek.analyze
+        @smells = [
+            instance_double(@smell_warning,
+                            source: "app/controllers/activity_reports_controller.rb",
+                            context: "ActivityReportsController#authorize_user",
+                            message: "calls current_user.primary_site_ids multiple times",
+                            smell_type: "Duplication",
+                            lines: [2, 4]),
+            instance_double(@smell_warning,
+                            source: "app/controllers/activity_reports_controller.rb",
+                            context: "ActivityReportsController#authorize_user",
+                            message: "calls params[id] multiple times",
+                            smell_type: "Duplication",
+                            lines: [5, 7]),
+            instance_double(@smell_warning,
+                            source: "app/controllers/activity_reports_controller.rb",
+                            context: "ActivityReportsController#authorize_user",
+                            message: "calls params[primary_site_id] multiple times",
+                            smell_type: "Duplication",
+                            lines: [11, 15]),
+            instance_double(@smell_warning,
+                            source: "app/controllers/activity_reports_controller.rb",
+                            context: "ActivityReportsController#authorize_user",
+                            message: "has approx 6 statements",
+                            smell_type: "Long Method",
+                            lines: [8]),
+
+            instance_double(@smell_warning,
+                            source: "app/controllers/application.rb",
+                            context: "ApplicationController#start_background_task/block/block",
+                            message: "is nested",
+                            smell_type: "Nested Iterators",
+                            lines: [23]),
+
+            instance_double(@smell_warning,
+                            source: "app/controllers/link_targets_controller.rb",
+                            context: "LinkTargetsController#authorize_user",
+                            message: "calls current_user.role multiple times",
+                            smell_type: "Duplication",
+                            lines: [8]),
+
+            instance_double(@smell_warning,
+                            source: "app/controllers/newline_controller.rb",
+                            context: "NewlineController#some_method",
+                            message: "calls current_user.<< \"new line\n\" multiple times",
+                            smell_type: "Duplication",
+                            lines: [6, 9])
+        ]
+        @examiners = [
+          instance_double(Reek::Examiner, smells: @smells)
+        ]
+        @generator.instance_variable_set(:@output, @examiners)
+        @matches = @generator.analyze
+      end
+
+      it "should find the code smell's line numbers" do
+        smell = @matches.first[:code_smells].first
+        expect(smell[:lines]).to eq([2, 4])
       end
 
       it "should find the code smell's method name" do
@@ -93,91 +134,70 @@ NewlineController#some_method calls current_user.<< "new line\n" multiple times
 
       it "should NOT insert nil smells into the array when there's a newline in the method call" do
         expect(@matches.last[:code_smells]).to eq(@matches.last[:code_smells].compact)
-        expect(@matches.last).to eq({:file_path=>"app/controllers/newline_controller.rb",
-                                  :code_smells=>[{:type=>"Duplication",
-                                                    :method=>"\"",
-                                                    :message=>"multiple times"}]})
-        # Note: hopefully a temporary solution until I figure out how to deal with newlines in the method call more effectively -Jake 5/11/2009
       end
     end
 
-    context "without reek warnings" do
+    context "with reek 1.3 output" do
       before :each do
-        @lines = <<-HERE
-
-0 total warnings
-      HERE
-        @reek.instance_variable_set(:@output, @lines)
-        @matches = @reek.analyze
+        @smells = [
+            double(source: "app/controllers/activity_reports_controller.rb",
+                   context: "ActivityReportsController#authorize_user",
+                   message: "calls current_user.primary_site_ids multiple times",
+                   subclass: "Duplication",
+                   lines: [2, 4]),
+        ]
+        @examiners = [
+          instance_double(Reek::Examiner, smells: @smells)
+        ]
+        @generator.instance_variable_set(:@output, @examiners)
+        @matches = @generator.analyze
       end
 
-      it "returns empty analysis" do
-        expect(@matches).to eq({})
+      it "uses the subclass field to find the smell type" do
+        smell = @matches.first[:code_smells].first
+        expect(smell[:type]).to eq('Duplication')
       end
     end
-  end
-end
 
-describe MetricFu::ReekGenerator do
-  before :each do
-    MetricFu::Configuration.run {}
-    @reek = MetricFu::ReekGenerator.new
-    @lines11 = <<-HERE
-"app/controllers/activity_reports_controller.rb" -- 4 warnings:
-ActivityReportsController#authorize_user calls current_user.primary_site_ids multiple times (Duplication)
-ActivityReportsController#authorize_user calls params[id] multiple times (Duplication)
-ActivityReportsController#authorize_user calls params[primary_site_id] multiple times (Duplication)
-ActivityReportsController#authorize_user has approx 6 statements (Long Method)
-
-"app/controllers/application.rb" -- 1 warnings:
-ApplicationController#start_background_task/block/block is nested (Nested Iterators)
-
-"app/controllers/link_targets_controller.rb" -- 1 warnings:
-LinkTargetsController#authorize_user calls current_user.role multiple times (Duplication)
-
-"app/controllers/newline_controller.rb" -- 1 warnings:
-NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
-      HERE
-    @lines12 = <<-HERE
-app/controllers/activity_reports_controller.rb -- 4 warnings (+3 masked):
-  ActivityReportsController#authorize_user calls current_user.primary_site_ids multiple times (Duplication)
-  ActivityReportsController#authorize_user calls params[id] multiple times (Duplication)
-  ActivityReportsController#authorize_user calls params[primary_site_id] multiple times (Duplication)
-  ActivityReportsController#authorize_user has approx 6 statements (Long Method)
-app/controllers/application.rb -- 1 warnings:
-  ApplicationController#start_background_task/block/block is nested (Nested Iterators)
-app/controllers/link_targets_controller.rb -- 1 warnings (+1 masked):
-  LinkTargetsController#authorize_user calls current_user.role multiple times (Duplication)
-app/controllers/newline_controller.rb -- 1 warnings:
-  NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
-      HERE
-  end
+    context "with real output, not mocked nor doubled" do
+      let(:result) do
+        {
+          file_path: "spec/support/samples/reek/alfa.rb",
+          code_smells: [
+            {
+              lines: [1],
+              message: "has unused parameter 'echo'",
+              method: "foo",
+              type: "UnusedParameters"
+            }
+          ]
+        }
+      end
 
-  context 'with Reek 1.1 output format' do
-    it 'reports 1.1 style when the output is empty' do
-      @reek.instance_variable_set(:@output, "")
-      expect(@reek).not_to be_reek_12
-    end
-    it 'detects 1.1 format output' do
-      @reek.instance_variable_set(:@output, @lines11)
-      expect(@reek).not_to be_reek_12
-    end
+      it "returns real data" do
+        MetricFu.with_run_dir File.expand_path("../../..", __FILE__) do
+          @generator = MetricFu::ReekGenerator.new(dirs_to_reek: ["spec/support/samples"])
+          @generator.emit
 
-    it 'massages empty output to be unchanged' do
-      @reek.instance_variable_set(:@output, "")
-      expect(@reek.massage_for_reek_12).to be_empty
-    end
-  end
+          @matches = @generator.analyze
 
-  context 'with Reek 1.2 output format' do
-    it 'detects 1.2 format output' do
-      @reek.instance_variable_set(:@output, @lines12)
-      expect(@reek).to be_reek_12
+          expect(@matches.first).to eq(result)
+        end
+      end
     end
 
-    it 'correctly massages 1.2 output' do
-      @reek.instance_variable_set(:@output, @lines12)
-      expect(@reek.massage_for_reek_12).to eq(@lines11)
+    context "without reek warnings" do
+      before :each do
+        @examiners = [
+          instance_double(Reek::Examiner, smells: [])
+        ]
+        @generator.instance_variable_set(:@output, @examiners)
+        @matches = @generator.analyze
+      end
+
+      it "returns empty analysis" do
+        expect(@matches).to eq([])
+      end
     end
   end
 end

data/spec/metric_fu/metrics/reek/grapher_spec.rb

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'reek/grapher' }
+MetricFu.metrics_require { "reek/grapher" }
 
 describe ReekGrapher do
   before :each do
@@ -45,7 +45,7 @@ describe ReekGrapher do
 
       it "should set a hash of code smells to reek_count" do
         @reek_grapher.get_metrics(@metrics, @date)
-        expect(@reek_grapher.reek_count).to eq({
+        expect(@reek_grapher.reek_count).to eq(
           "Uncommunicative Name" => [27],
           "Feature Envy" => [20],
           "Utility Function" => [15],
@@ -54,11 +54,11 @@ describe ReekGrapher do
           "Control Couple" => [4],
           "Duplication" => [48],
           "Large Class" => [1]
-        })
+        )
       end
 
       it "should update labels with the date" do
-        expect(@reek_grapher.labels).to receive(:update).with({ 0 => "1/2" })
+        expect(@reek_grapher.labels).to receive(:update).with(0 => "1/2")
         @reek_grapher.get_metrics(@metrics, @date)
       end
     end

data/spec/metric_fu/metrics/roodi/configuration_spec.rb

@@ -1,16 +1,14 @@
-require 'spec_helper'
-require 'shared/configured'
+require "spec_helper"
+require "shared/configured"
 
-describe MetricFu::Configuration, 'for roodi' do
-  it_behaves_like 'configured' do
-
-    it 'should set @roodi to {:dirs_to_roodi => @code_dirs}' do
-      load_metric 'roodi'
+describe MetricFu::Configuration, "for roodi" do
+  it_behaves_like "configured" do
+    it "should set @roodi to {:dirs_to_roodi => @code_dirs}" do
+      load_metric "roodi"
       expect(MetricFu::Metric.get_metric(:roodi).run_options).to eq(
-              { :dirs_to_roodi => directory('code_dirs'),
-                  :roodi_config => "#{directory('root_directory')}/config/roodi_config.yml"}
+               dirs_to_roodi: directory("code_dirs"),
+               roodi_config: "#{directory('root_directory')}/config/roodi_config.yml"
               )
     end
-
   end
 end

data/spec/metric_fu/metrics/roodi/generator_spec.rb

@@ -1,17 +1,17 @@
 require "spec_helper"
-MetricFu.metrics_require { 'roodi/generator' }
+MetricFu.metrics_require { "roodi/generator" }
 
 describe MetricFu::RoodiGenerator do
   describe "emit" do
     it "should add config options when present" do
-      options = {:roodi_config => 'lib/config/roodi_config.yml', :dirs_to_roodi => []}
+      options = { roodi_config: "lib/config/roodi_config.yml", dirs_to_roodi: [] }
       roodi = MetricFu::RoodiGenerator.new(options)
       expect(roodi).to receive(:run!).with(/-config=lib\/config\/roodi_config\.yml/).and_return("")
       roodi.emit
     end
 
     it "should NOT add config options when NOT present" do
-      options = {:dirs_to_roodi => []}
+      options = { dirs_to_roodi: [] }
       roodi = MetricFu::RoodiGenerator.new(options)
       allow(roodi).to receive(:run!)
       expect(roodi).to receive(:run!).with(/-config/).never

data/spec/metric_fu/metrics/roodi/grapher_spec.rb

@@ -1,5 +1,5 @@
 require "spec_helper"
-MetricFu.metrics_require { 'roodi/grapher' }
+MetricFu.metrics_require { "roodi/grapher" }
 
 describe RoodiGrapher do
   before :each do
@@ -49,7 +49,7 @@ describe RoodiGrapher do
       end
 
       it "should update labels with the date" do
-        expect(@roodi_grapher.labels).to receive(:update).with({ 0 => "1/2" })
+        expect(@roodi_grapher.labels).to receive(:update).with(0 => "1/2")
         @roodi_grapher.get_metrics(@metrics, @date)
       end
     end

data/spec/metric_fu/metrics/saikuro/configuration_spec.rb

@@ -1,26 +1,25 @@
-require 'spec_helper'
-require 'shared/configured'
+require "spec_helper"
+require "shared/configured"
 
-describe MetricFu::Configuration, 'for saikuro' do
-  it_behaves_like 'configured' do
-
-      it 'should set @saikuro to { :output_directory => @scratch_directory + "/saikuro",
-                                   :input_directory => @code_dirs,
-                                   :cyclo => "",
-                                   :filter_cyclo => "0",
-                                   :warn_cyclo => "5",
-                                   :error_cyclo => "7",
-                                   :formater => "text" }' do
-        load_metric 'saikuro'
-        expect(MetricFu::Metric.get_metric(:saikuro).run_options).to eq(
-                { :output_directory => "#{scratch_directory}/saikuro",
-                      :input_directory => ['lib'],
-                      :cyclo => "",
-                      :filter_cyclo => "0",
-                      :warn_cyclo => "5",
-                      :error_cyclo => "7",
-                      :formater => "text"}
-                      )
-      end
+describe MetricFu::Configuration, "for saikuro" do
+  it_behaves_like "configured" do
+    it "should set @saikuro to { :output_directory => @scratch_directory + '/saikuro',
+                                 :input_directory => @code_dirs,
+                                 :cyclo => '',
+                                 :filter_cyclo => '0',
+                                 :warn_cyclo => '5',
+                                 :error_cyclo => '7',
+                                 :formater => 'text' }" do
+      load_metric "saikuro"
+      expect(MetricFu::Metric.get_metric(:saikuro).run_options).to eq(
+               output_directory: "#{scratch_directory}/saikuro",
+               input_directory: ["lib"],
+               cyclo: "",
+               filter_cyclo: "0",
+               warn_cyclo: "5",
+               error_cyclo: "7",
+               formater: "text"
+                    )
+    end
   end
 end