metric_fu 4.3.1 → 4.4.0

data/spec/metric_fu/metrics/flog/flog_spec.rb

@@ -1,72 +1,77 @@
 require "spec_helper"
-describe Flog do
-  if MetricFu.configuration.mri?
-    before :each do
-      MetricFu::Configuration.run {}
-      File.stub(:directory?).and_return(true)
-      @flog = MetricFu::Flog.new('base_dir')
-    end
 
-    describe "emit method" do
-      it "should look for files and flog them" do
-        Dir.should_receive(:glob).with("lib/**/*.rb").and_return(["found/file.rb"])
-        ::Flog.should_receive(:parse_options).with(["--all"]).and_return("options")
-        ::Flog.should_receive(:new).with("options").and_return(flogger = double('flogger'))
-        flogger.should_receive(:flog).with(["found/file.rb"])
-        @flog.emit
-      end
+describe MetricFu::FlogGenerator do
+
+  break if metric_not_activated?(:flog)
+
+  before :each do
+    File.stub(:directory?).and_return(true)
+    options = MetricFu::Metric.get_metric(:flog).run_options
+    @flog = MetricFu::FlogGenerator.new(options)
+  end
+
+  describe "emit method" do
+    it "should look for files and flog them" do
+      FlogCLI.should_receive(:parse_options).with(["--all","--continue"]).and_return("options")
+      FlogCLI.should_receive(:new).with("options").and_return(flogger = double('flogger'))
+      flogger.should_receive(:flog).with("lib")
+      @flog.emit
     end
+  end
 
-    describe "analyze method" do
-      it "should harvest the flog information and put it into method_containers" do
-        first_full_method_name = "ClassName#first_method_name"
-        second_full_method_name = "ClassName#second_method_name"
+  describe "analyze method" do
+    it "should harvest the flog information and put it into method_containers" do
+      first_full_method_name = "ClassName#first_method_name"
+      second_full_method_name = "ClassName#second_method_name"
 
-        flogger = double('flogger', :calls => {first_full_method_name => {:branch => 11.1, :puts => 1.1},
-                                             second_full_method_name => {:branch => 22.2, :puts => 2.2}},
-                                  :method_locations => {first_full_method_name => '/file/location.rb:11',
-                                                        second_full_method_name => '/file/location.rb:22'},
-                                  :totals => {first_full_method_name => 11.11,
-                                              second_full_method_name => 22.22})
-        @flog.instance_variable_set(:@flogger, flogger)
-        @flog.analyze
-        method_containers = @flog.instance_variable_get(:@method_containers)
-        method_containers.size.should == 1
+      flogger = double('flogger', :method_locations => {first_full_method_name => '/file/location.rb:11',
+                                                      second_full_method_name => '/file/location.rb:22'},
+                                :totals => {first_full_method_name => 11.11,
+                                            second_full_method_name => 22.22})
+      flogger.should_receive(:calculate)
+      flogger.should_receive(:each_by_score).and_yield(
+        first_full_method_name, 11.11, {:branch => 11.1, :puts => 1.1}
+      ).and_yield(
+        second_full_method_name, 22.22, {:branch => 22.2, :puts => 2.2}
+      )
+      @flog.instance_variable_set(:@flogger, flogger)
+      @flog.analyze
+      method_containers = @flog.instance_variable_get(:@method_containers)
+      method_containers.size.should == 1
 
-        expected={:methods=>{"ClassName#first_method_name" => { :path=>"/file/location.rb:11",
-                                                                :score=>11.11,
-                                                                :operators=>{ :branch=>11.1,
-                                                                              :puts=>1.1}},
-                             "ClassName#second_method_name" => {:path=>"/file/location.rb:22",
-                                                                :score=>22.22,
-                                                                :operators=>{ :branch=>22.2,
-                                                                              :puts=>2.2}}},
-                  :path=>"/file/location.rb",
-                  :average_score=>((11.11 + 22.22) / 2.0),
-                  :total_score=>33.33,
-                  :highest_score=>22.22,
-                  :name=>"ClassName"}
+      expected={:methods=>{"ClassName#first_method_name" => { :path=>"/file/location.rb:11",
+                                                              :score=>11.11,
+                                                              :operators=>{ :branch=>11.1,
+                                                                            :puts=>1.1}},
+                           "ClassName#second_method_name" => {:path=>"/file/location.rb:22",
+                                                              :score=>22.22,
+                                                              :operators=>{ :branch=>22.2,
+                                                                            :puts=>2.2}}},
+                :path=>"/file/location.rb",
+                :average_score=>((11.11 + 22.22) / 2.0),
+                :total_score=>33.33,
+                :highest_score=>22.22,
+                :name=>"ClassName"}
 
-        method_containers["ClassName"].to_h.should == expected
-      end
+      method_containers["ClassName"].to_h.should == expected
     end
+  end
 
-    describe "to_h method" do
-      it "should make-a nice hash" do
-        flogger = double('flogger', :total => 111.1, :average => 7.3)
-        @flog.instance_variable_set(:@flogger, flogger)
-        method_containers = {:ignore_me_1 =>  double('container_1', :highest_score => 11.1, :to_h => 'container_1'),
-                             :ignore_me_2 =>  double('container_2', :highest_score => 33.3, :to_h => 'container_2'),
-                             :ignore_me_3 =>  double('container_3', :highest_score => 22.2, :to_h => 'container_3')}
-        @flog.instance_variable_set(:@method_containers, method_containers)
-
-        expected = {:flog => { :total => 111.1,
-                    :average => 7.3,
-                    :method_containers => ['container_2', 'container_3', 'container_1']}}
+  describe "to_h method" do
+    it "should make-a nice hash" do
+      flogger = double('flogger', :total_score => 111.1, :average => 7.3)
+      @flog.instance_variable_set(:@flogger, flogger)
+      method_containers = {:ignore_me_1 =>  double('container_1', :highest_score => 11.1, :to_h => 'container_1'),
+                           :ignore_me_2 =>  double('container_2', :highest_score => 33.3, :to_h => 'container_2'),
+                           :ignore_me_3 =>  double('container_3', :highest_score => 22.2, :to_h => 'container_3')}
+      @flog.instance_variable_set(:@method_containers, method_containers)
 
-        @flog.to_h.should == expected
-      end
+      expected = {:flog => { :total => 111.1,
+                  :average => 7.3,
+                  :method_containers => ['container_2', 'container_3', 'container_1']}}
 
+      @flog.to_h.should == expected
     end
+
   end
 end

data/spec/metric_fu/metrics/generator_spec.rb

@@ -6,6 +6,10 @@ describe MetricFu::Generator do
 
 
   class ConcreteClass < MetricFu::Generator
+    def self.metric
+      :concrete
+    end
+
     def emit
     end
 

data/spec/metric_fu/metrics/hotspots/hotspots_spec.rb

@@ -1,7 +1,7 @@
 require 'multi_json'
 require "spec_helper"
 
-describe Hotspots do
+describe MetricFu::HotspotsGenerator do
 
   describe "analyze method" do
     before :each do
@@ -59,32 +59,32 @@ END
     end
 
     it "should be empty on error" do
-      hotspots = MetricFu::Hotspots.new
+      hotspots = MetricFu::HotspotsGenerator.new
       hotspots.instance_variable_set(:@analyzer, nil)
       result = hotspots.analyze
       result.should == {}
     end
 
     it "should return yaml results" do
-      hotspots = MetricFu::Hotspots.new
+      hotspots = MetricFu::HotspotsGenerator.new
       analyzer = HotspotAnalyzer.new(@yaml)
       hotspots.instance_variable_set(:@analyzer, analyzer)
       result = hotspots.analyze
       expected = MultiJson.load("{\"methods\":[{\"location\":{\"class_name\":\"Client\",\"method_name\":\"Client#client_requested_sync\",\"file_path\":\"lib/client/client.rb\",\"hash\":7919384682,\"simple_method_name\":\"#client_requested_sync\"},\"details\":{\"reek\":\"found 1 code smells\",\"flog\":\"complexity is 37.9\"}}],\"classes\":[{\"location\":{\"class_name\":\"Client\",\"method_name\":null,\"file_path\":\"lib/client/client.rb\",\"hash\":7995629750},\"details\":{\"reek\":\"found 2 code smells\",\"flog\":\"complexity is 37.9\"}}],\"files\":[{\"location\":{\"class_name\":null,\"method_name\":null,\"file_path\":\"lib/client/client.rb\",\"hash\":-5738801681},\"details\":{\"reek\":\"found 2 code smells\",\"flog\":\"complexity is 37.9\",\"churn\":\"detected high level of churn (changed 54 times)\"}},{\"location\":{\"class_name\":null,\"method_name\":null,\"file_path\":\"lib/client/foo.rb\",\"hash\":-7081271905},\"details\":{\"churn\":\"detected high level of churn (changed 52 times)\"}}]}")
-      compare_hashes(MultiJson.load(hotspots.to_h[:hotspots].to_json), expected)
+      compare_hashes(MultiJson.load(MultiJson.dump(hotspots.to_h[:hotspots])), expected)
     end
 
     it "should put the changes into a hash" do
-      hotspots = MetricFu::Hotspots.new
+      hotspots = MetricFu::HotspotsGenerator.new
       analyzer = HotspotAnalyzer.new(@yaml)
       hotspots.instance_variable_set(:@analyzer, analyzer)
       hotspots.analyze
       expected =  MultiJson.load("{\"methods\":[{\"location\":{\"class_name\":\"Client\",\"method_name\":\"Client#client_requested_sync\",\"file_path\":\"lib/client/client.rb\",\"hash\":7919384682,\"simple_method_name\":\"#client_requested_sync\"},\"details\":{\"reek\":\"found 1 code smells\",\"flog\":\"complexity is 37.9\"}}],\"classes\":[{\"location\":{\"class_name\":\"Client\",\"method_name\":null,\"file_path\":\"lib/client/client.rb\",\"hash\":7995629750},\"details\":{\"reek\":\"found 2 code smells\",\"flog\":\"complexity is 37.9\"}}],\"files\":[{\"location\":{\"class_name\":null,\"method_name\":null,\"file_path\":\"lib/client/client.rb\",\"hash\":-5738801681},\"details\":{\"reek\":\"found 2 code smells\",\"flog\":\"complexity is 37.9\",\"churn\":\"detected high level of churn (changed 54 times)\"}},{\"location\":{\"class_name\":null,\"method_name\":null,\"file_path\":\"lib/client/foo.rb\",\"hash\":-7081271905},\"details\":{\"churn\":\"detected high level of churn (changed 52 times)\"}}]}")
-      compare_hashes(MultiJson.load(hotspots.to_h[:hotspots].to_json), expected)
+      compare_hashes(MultiJson.load(MultiJson.dump(hotspots.to_h[:hotspots])), expected)
     end
     # really testing the output of analyzed_problems#worst_items
     it "should return the worst item granularities: files, classes, methods" do
-      hotspots = MetricFu::Hotspots.new
+      hotspots = MetricFu::HotspotsGenerator.new
       analyzer = HotspotAnalyzer.new(@yaml)
       hotspots.instance_variable_set(:@analyzer, analyzer)
       hotspots.analyze.keys.should =~ [:files, :classes, :methods]

data/spec/metric_fu/metrics/rails_best_practices/rails_best_practices_spec.rb

@@ -1,43 +1,24 @@
 require "spec_helper"
 
-describe RailsBestPractices do
+describe RailsBestPracticesGenerator do
+
+  break if metric_not_activated?(:rails_best_practices)
+
   describe "emit method" do
-    it "should gather the raw data" do
-      MetricFu::Configuration.run {}
-      practices = MetricFu::RailsBestPractices.new
-      practices.should_receive(:`).with("mf-rails_best_practices --without-color .")
-      practices.emit
+    let(:analyzer) { ::RailsBestPractices::Analyzer.new('.', { 'silent' => true }) }
+    context "RailsBestPractices provides the expected API" do
+      it { analyzer.should respond_to :analyze }
+      it { analyzer.should respond_to :errors }
     end
   end
 
   describe "analyze method" do
-    before :each do
-      output = <<-HERE.gsub(/^[^\S\n]*/, "")
-      ./app/views/admin/testimonials/_form.html.erb:17 - replace instance variable with local variable
-      ./app/controllers/admin/campaigns_controller.rb:24,45,68,85 - use before_filter for show,edit,update,destroy
-
-      go to http://wiki.github.com/railsbp/rails_best_practices to see how to solve these errors.
-
-      Found 2 errors.
-      HERE
-      MetricFu::Configuration.run {}
-      practices = MetricFu::RailsBestPractices.new
-      practices.instance_variable_set(:@output, output)
-      @results = practices.analyze
-    end
-
-    it "should get the total" do
-      @results[:total].should == ["Found 2 errors."]
-    end
-
-    it "should get the problems" do
-      @results[:problems].size.should == 2
-      @results[:problems].first.should == { :line => "17",
-        :problem => "replace instance variable with local variable",
-        :file => "app/views/admin/testimonials/_form.html.erb" }
-      @results[:problems][1].should == { :line => "24,45,68,85",
-        :problem => "use before_filter for show,edit,update,destroy",
-        :file => "app/controllers/admin/campaigns_controller.rb" }
+    let(:error) { ::RailsBestPractices::Core::Error.new }
+    context "RailsBestPractices provdies the expected API" do
+      it { error.should respond_to :filename }
+      it { error.should respond_to :line_number }
+      it { error.should respond_to :message }
+      it { error.should respond_to :url }
     end
   end
 

data/spec/metric_fu/metrics/rcov/rcov_spec.rb

@@ -1,31 +1,32 @@
 require "spec_helper"
 
-describe MetricFu::Rcov do
+describe MetricFu::RcovGenerator do
 
   before :each do
-    MetricFu.configure
-    MetricFu.run_rcov
-    File.stub(:directory?).and_return(true)
-    @rcov = MetricFu::Rcov.new('base_dir')
+    MetricFu.configuration.configure_metric(:rcov) do |rcov|
+      rcov.enabled = true
+    end
+    @default_options = MetricFu::Metric.get_metric(:rcov).run_options
   end
 
   describe "emit" do
     before :each do
-      @rcov.stub(:mf_log)
-      MetricFu.rcov[:external] = nil
+      options = {:external =>  nil}
+      @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
     end
 
     it "should clear out previous output and make output folder" do
       @rcov.stub(:`)
-      FileUtils.should_receive(:rm_rf).with(MetricFu::Rcov.metric_directory, :verbose => false)
-      Dir.should_receive(:mkdir).with(MetricFu::Rcov.metric_directory)
+      FileUtils.should_receive(:rm_rf).with(MetricFu::RcovGenerator.metric_directory, :verbose => false)
+      Dir.should_receive(:mkdir).with(MetricFu::RcovGenerator.metric_directory)
       @rcov.emit
     end
 
     it "should set the RAILS_ENV" do
       FileUtils.stub(:rm_rf)
       Dir.stub(:mkdir)
-      MetricFu.rcov[:environment] = "metrics"
+      options = {:environment => 'metrics'}
+      @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
       @rcov.should_receive(:`).with(/RAILS_ENV=metrics/)
       @rcov.emit
     end
@@ -33,9 +34,10 @@ describe MetricFu::Rcov do
 
   describe "with RCOV_OUTPUT fed into" do
     before :each do
-      MetricFu.rcov[:external] = nil
+      options = {:external =>  nil}
+      @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
       File.should_receive(:open).
-            with(MetricFu::Rcov.metric_directory + '/rcov.txt').
+            with(MetricFu::RcovGenerator.metric_directory + '/rcov.txt').
             and_return(double("io", :read => RCOV_OUTPUT))
       @files = @rcov.analyze
     end
@@ -65,8 +67,8 @@ describe MetricFu::Rcov do
   end
   describe "with external configuration option set" do
     before :each do
-      @rcov.stub(:mf_log)
-      MetricFu.rcov[:external] = "coverage/rcov.txt"
+      options = {:external =>  'coverage/rcov.txt'}
+      @rcov = MetricFu::RcovGenerator.new(@default_options.merge(options))
     end
 
     it "should emit nothing if external configuration option is set" do
@@ -76,7 +78,7 @@ describe MetricFu::Rcov do
 
     it "should open the external rcov analysis file" do
       File.should_receive(:open).
-            with(MetricFu.rcov[:external]).
+            with('coverage/rcov.txt').
             and_return(double("io", :read => RCOV_OUTPUT))
       @files = @rcov.analyze
     end
@@ -176,6 +178,3 @@ lib/templates/standard/standard_template.rb
 HERE
 
 end
-
-
-

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

@@ -1,14 +1,13 @@
 require "spec_helper"
 
-describe Reek do
+describe MetricFu::ReekGenerator do
   describe "emit" do
     it "should include config parameters" do
-      MetricFu::Configuration.run do |config|
-        config.add_metric(:reek)
-        config.configure_metric(:reek,{:config_file_pattern => 'lib/config/*.reek', :dirs_to_reek => []})
-      end
-      reek = MetricFu::Reek.new
-      reek.should_receive(:`).with(/--config lib\/config\/\*\.reek/).and_return("")
+      options = {:config_file_pattern => 'lib/config/*.reek', :dirs_to_reek => []}
+      reek = MetricFu::ReekGenerator.new(options)
+      files_to_analyze = ['lib/foo.rb','lib/bar.rb']
+      reek.stub(:files_to_analyze).and_return(files_to_analyze)
+      reek.should_receive(:`).with(/--config lib\/config\/\*\.reek lib\/foo.rb lib\/bar.rb/).and_return("")
       reek.emit
     end
   end
@@ -33,7 +32,7 @@ NewlineController#some_method calls current_user.<< "new line\n" multiple times
       HERE
       MetricFu::Configuration.run {}
       File.stub(:directory?).and_return(true)
-      reek = MetricFu::Reek.new
+      reek = MetricFu::ReekGenerator.new
       reek.instance_variable_set(:@output, @lines)
       @matches = reek.analyze
     end
@@ -70,10 +69,10 @@ NewlineController#some_method calls current_user.<< "new line\n" multiple times
 
 end
 
-describe Reek do
+describe MetricFu::ReekGenerator do
   before :each do
     MetricFu::Configuration.run {}
-    @reek = MetricFu::Reek.new
+    @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)

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

@@ -1,23 +1,17 @@
 require "spec_helper"
 
-describe Roodi do
+describe MetricFu::RoodiGenerator do
   describe "emit" do
     it "should add config options when present" do
-      MetricFu::Configuration.run do |config|
-        config.add_metric(:roodi)
-        config.configure_metric(:roodi,{:roodi_config => 'lib/config/roodi_config.yml', :dirs_to_roodi => []})
-      end
-      roodi = MetricFu::Roodi.new
+      options = {:roodi_config => 'lib/config/roodi_config.yml', :dirs_to_roodi => []}
+      roodi = MetricFu::RoodiGenerator.new(options)
       roodi.should_receive(:`).with(/-config=lib\/config\/roodi_config\.yml/).and_return("")
       roodi.emit
     end
 
     it "should NOT add config options when NOT present" do
-      MetricFu::Configuration.run do |config|
-        config.add_metric(:roodi)
-        config.configure_metric(:roodi,{:dirs_to_roodi => []})
-      end
-      roodi = MetricFu::Roodi.new
+      options = {:dirs_to_roodi => []}
+      roodi = MetricFu::RoodiGenerator.new(options)
       roodi.stub(:`)
       roodi.should_receive(:`).with(/-config/).never
       roodi.emit

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

@@ -3,10 +3,11 @@ require "spec_helper"
 describe Saikuro do
   describe "to_h method" do
     before :all do
-      MetricFu::Configuration.run {}
-      File.stub(:directory?).and_return(true)
-      saikuro = MetricFu::Saikuro.new
-      saikuro.stub(:metric_directory).and_return("#{resources_path}/saikuro")
+      options = {}
+      saikuro = MetricFu::Saikuro.new(options)
+      def saikuro.metric_directory
+        "#{resources_path}/saikuro"
+      end
       saikuro.analyze
       @output = saikuro.to_h
     end
@@ -33,17 +34,18 @@ describe Saikuro do
       @output[:saikuro][:methods].first[:lines].should == 15
     end
   end
-  
+
   describe "per_file_info method" do
     before :all do
-      MetricFu::Configuration.run {}
-      File.stub(:directory?).and_return(true)
-      @saikuro = MetricFu::Saikuro.new
-      @saikuro.stub(:metric_directory).and_return("#{resources_path}/saikuro")
+      options = {}
+      @saikuro = MetricFu::Saikuro.new(options)
+      def @saikuro.metric_directory
+        "#{resources_path}/saikuro"
+      end
       @saikuro.analyze
       @output = @saikuro.to_h
     end
-    
+
     it "doesn't try to get information if the file does not exist" do
       File.should_receive(:exists?).at_least(:once).and_return(false)
       @saikuro.per_file_info('ignore_me')
@@ -52,11 +54,10 @@ describe Saikuro do
 
   describe "format_directories method" do
     it "should format the directories" do
-      MetricFu::Configuration.run {}
-      File.stub(:directory?).and_return(true)
-      saikuro = MetricFu::Saikuro.new
+      options = {:input_directory  =>["app", "lib"]}
+      saikuro = MetricFu::Saikuro.new(options)
 
-      MetricFu.saikuro[:input_directory] = ["app", "lib"]
+      MetricFu::Metric.get_metric(:saikuro).run_options
 
       saikuro.format_directories.should == "\"app | lib\""
     end