metric_fu 4.2.1 → 4.3.0

data/spec/metric_fu/metrics/generator_spec.rb

@@ -39,7 +39,7 @@ describe MetricFu::Generator do
   describe "#create_metric_dir_if_missing " do
     describe "when the metric_dir exists " do
       it 'should not call mkdir_p on FileUtils' do
-        File.stub!(:directory?).and_return(true)
+        File.stub(:directory?).and_return(true)
         FileUtils.should_not_receive(:mkdir_p)
         @concrete_class.create_metric_dir_if_missing
       end
@@ -47,7 +47,7 @@ describe MetricFu::Generator do
 
     describe "when the metric_dir does not exist " do
       it 'should call mkdir_p on FileUtils' do
-        File.stub!(:directory?).and_return(false)
+        File.stub(:directory?).and_return(false)
         FileUtils.should_receive(:mkdir_p)
         @concrete_class.create_metric_dir_if_missing
       end
@@ -57,7 +57,7 @@ describe MetricFu::Generator do
   describe "#create_output_dir_if_missing" do
     describe "when the output_dir exists " do
       it 'should not call mkdir_p on FileUtils' do
-        File.stub!(:directory?).and_return(true)
+        File.stub(:directory?).and_return(true)
         FileUtils.should_not_receive(:mkdir_p)
         @concrete_class.create_output_dir_if_missing
       end
@@ -65,7 +65,7 @@ describe MetricFu::Generator do
 
     describe "when the output_dir does not exist " do
       it 'should call mkdir_p on FileUtils' do
-        File.stub!(:directory?).and_return(false)
+        File.stub(:directory?).and_return(false)
         FileUtils.should_receive(:mkdir_p)
         @concrete_class.create_output_dir_if_missing
       end
@@ -74,22 +74,22 @@ describe MetricFu::Generator do
 
   describe '#metric_directory' do
     it 'should return the results of ConcreteClass#metric_directory' do
-      ConcreteClass.stub!(:metric_directory).and_return('foo')
+      ConcreteClass.stub(:metric_directory).and_return('foo')
       @concrete_class.metric_directory.should == 'foo'
     end
   end
 
-  describe 'ConcreteClass#generate_report' do
+  describe 'ConcreteClass#generate_result' do
     it 'should create a new instance of ConcreteClass' do
       ConcreteClass.should_receive(:new).and_return(@concrete_class)
-      @concrete_class.should_receive(:generate_report).and_return(true)
-      ConcreteClass.generate_report
+      @concrete_class.should_receive(:generate_result).and_return(true)
+      ConcreteClass.generate_result
     end
 
-    it 'should call #generate_report on the new ConcreteClass' do
+    it 'should call #generate_result on the new ConcreteClass' do
       ConcreteClass.should_receive(:new).and_return(@concrete_class)
-      @concrete_class.should_receive(:generate_report).and_return(true)
-      ConcreteClass.generate_report
+      @concrete_class.should_receive(:generate_result).and_return(true)
+      ConcreteClass.generate_result
     end
   end
 
@@ -112,50 +112,50 @@ describe MetricFu::Generator do
     end
   end
 
-  describe "#generate_report" do
+  describe "#generate_result" do
     it 'should  raise an error when calling #emit' do
       @abstract_class = MetricFu::Generator.new
-      lambda { @abstract_class.generate_report }.should  raise_error
+      lambda { @abstract_class.generate_result }.should  raise_error
     end
 
     it 'should call #analyze' do
       @abstract_class = MetricFu::Generator.new
-      lambda { @abstract_class.generate_report }.should  raise_error
+      lambda { @abstract_class.generate_result }.should  raise_error
     end
 
     it 'should call #to_h' do
       @abstract_class = MetricFu::Generator.new
-      lambda { @abstract_class.generate_report }.should  raise_error
+      lambda { @abstract_class.generate_result }.should  raise_error
     end
   end
 
-  describe "#generate_report (in a concrete class)" do
+  describe "#generate_result (in a concrete class)" do
 
     %w[emit analyze].each do |meth|
       it "should call #before_#{meth}" do
         @concrete_class.should_receive("before_#{meth}")
-        @concrete_class.generate_report
+        @concrete_class.generate_result
       end
 
       it "should call ##{meth}" do
         @concrete_class.should_receive("#{meth}")
-        @concrete_class.generate_report
+        @concrete_class.generate_result
       end
 
       it "should call #after_#{meth}" do
         @concrete_class.should_receive("after_#{meth}")
-        @concrete_class.generate_report
+        @concrete_class.generate_result
       end
     end
 
     it "should call #before_to_h" do
       @concrete_class.should_receive("before_to_h")
-      @concrete_class.generate_report
+      @concrete_class.generate_result
     end
 
     it "should call #to_h" do
       @concrete_class.should_receive(:to_h)
-      @concrete_class.generate_report
+      @concrete_class.generate_result
     end
 
   end

data/spec/metric_fu/metrics/graph_spec.rb

@@ -31,18 +31,18 @@ describe MetricFu::Graph do
 
   describe "setting the date on the graph" do
     before(:each) do
-      @graph.stub!(:mf_log)
+      @graph.stub(:mf_log)
     end
 
     it "should set the date once for one data point" do
       Dir.should_receive(:[]).and_return(["metric_fu/tmp/_data/20101105.yml"])
       File.should_receive(:join)
       File.should_receive(:open).and_return("Metrics")
-      mock_grapher = stub
-      mock_grapher.should_receive(:get_metrics).with("Metrics", "11/5")
-      mock_grapher.should_receive(:graph!)
+      double_grapher = double
+      double_grapher.should_receive(:get_metrics).with("Metrics", "11/5")
+      double_grapher.should_receive(:graph!)
 
-      @graph.clazz = [mock_grapher]
+      @graph.clazz = [double_grapher]
       @graph.generate
     end
 
@@ -50,11 +50,11 @@ describe MetricFu::Graph do
       Dir.should_receive(:[]).and_return(["/some/kind/of/weird/directory/somebody/configured/_data/20101105.yml"])
       File.should_receive(:join)
       File.should_receive(:open).and_return("Metrics")
-      mock_grapher = stub
-      mock_grapher.should_receive(:get_metrics).with("Metrics", "11/5")
-      mock_grapher.should_receive(:graph!)
+      double_grapher = double
+      double_grapher.should_receive(:get_metrics).with("Metrics", "11/5")
+      double_grapher.should_receive(:graph!)
 
-      @graph.clazz = [mock_grapher]
+      @graph.clazz = [double_grapher]
       @graph.generate
     end
   end

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

@@ -6,7 +6,7 @@ describe Hotspots do
   describe "analyze method" do
     before :each do
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       @yaml =<<END
 --- 
 :reek: 

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

@@ -5,26 +5,26 @@ describe MetricFu::Rcov do
   before :each do
     MetricFu.configure
     MetricFu.run_rcov
-    File.stub!(:directory?).and_return(true)
+    File.stub(:directory?).and_return(true)
     @rcov = MetricFu::Rcov.new('base_dir')
   end
 
   describe "emit" do
     before :each do
-      @rcov.stub!(:mf_log)
+      @rcov.stub(:mf_log)
       MetricFu.rcov[:external] = nil
     end
 
     it "should clear out previous output and make output folder" do
-      @rcov.stub!(:`)
+      @rcov.stub(:`)
       FileUtils.should_receive(:rm_rf).with(MetricFu::Rcov.metric_directory, :verbose => false)
       Dir.should_receive(:mkdir).with(MetricFu::Rcov.metric_directory)
       @rcov.emit
     end
 
     it "should set the RAILS_ENV" do
-      FileUtils.stub!(:rm_rf)
-      Dir.stub!(:mkdir)
+      FileUtils.stub(:rm_rf)
+      Dir.stub(:mkdir)
       MetricFu.rcov[:environment] = "metrics"
       @rcov.should_receive(:`).with(/RAILS_ENV=metrics/)
       @rcov.emit
@@ -36,7 +36,7 @@ describe MetricFu::Rcov do
       MetricFu.rcov[:external] = nil
       File.should_receive(:open).
             with(MetricFu::Rcov.metric_directory + '/rcov.txt').
-            and_return(mock("io", :read => RCOV_OUTPUT))
+            and_return(double("io", :read => RCOV_OUTPUT))
       @files = @rcov.analyze
     end
 
@@ -65,7 +65,7 @@ describe MetricFu::Rcov do
   end
   describe "with external configuration option set" do
     before :each do
-      @rcov.stub!(:mf_log)
+      @rcov.stub(:mf_log)
       MetricFu.rcov[:external] = "coverage/rcov.txt"
     end
 
@@ -77,7 +77,7 @@ describe MetricFu::Rcov do
     it "should open the external rcov analysis file" do
       File.should_receive(:open).
             with(MetricFu.rcov[:external]).
-            and_return(mock("io", :read => RCOV_OUTPUT))
+            and_return(double("io", :read => RCOV_OUTPUT))
       @files = @rcov.analyze
     end
 

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

@@ -32,7 +32,7 @@ LinkTargetsController#authorize_user calls current_user.role multiple times (Dup
 NewlineController#some_method calls current_user.<< "new line\n" multiple times (Duplication)
       HERE
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       reek = MetricFu::Reek.new
       reek.instance_variable_set(:@output, @lines)
       @matches = reek.analyze

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

@@ -4,9 +4,9 @@ describe Saikuro do
   describe "to_h method" do
     before :all do
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       saikuro = MetricFu::Saikuro.new
-      saikuro.stub!(:metric_directory).and_return("#{resources_path}/saikuro")
+      saikuro.stub(:metric_directory).and_return("#{resources_path}/saikuro")
       saikuro.analyze
       @output = saikuro.to_h
     end
@@ -37,9 +37,9 @@ describe Saikuro do
   describe "per_file_info method" do
     before :all do
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       @saikuro = MetricFu::Saikuro.new
-      @saikuro.stub!(:metric_directory).and_return("#{resources_path}/saikuro")
+      @saikuro.stub(:metric_directory).and_return("#{resources_path}/saikuro")
       @saikuro.analyze
       @output = @saikuro.to_h
     end
@@ -53,7 +53,7 @@ describe Saikuro do
   describe "format_directories method" do
     it "should format the directories" do
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       saikuro = MetricFu::Saikuro.new
 
       MetricFu.saikuro[:input_directory] = ["app", "lib"]

data/spec/metric_fu/metrics/stats/stats_spec.rb

@@ -5,7 +5,7 @@ describe Stats do
     it "should gather the raw data" do
       ENV['CC_BUILD_ARTIFACTS'] = nil
       MetricFu.configure.reset
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       stats = MetricFu::Stats.new
       stats.should_receive(:`).with("mf-stats > tmp/metric_fu/scratch/stats/stats.txt")
       stats.emit
@@ -35,9 +35,9 @@ describe Stats do
       HERE
       ENV['CC_BUILD_ARTIFACTS'] = nil
       MetricFu.configure.reset
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       stats = MetricFu::Stats.new
-      File.should_receive(:open).and_return(mock("file", :read => @lines))
+      File.should_receive(:open).and_return(double("file", :read => @lines))
       @results = stats.analyze
     end
 
@@ -68,7 +68,7 @@ describe Stats do
     it "should put things into a hash" do
       ENV['CC_BUILD_ARTIFACTS'] = nil
       MetricFu.configure.reset
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       stats = MetricFu::Stats.new
       stats.instance_variable_set(:@stats, "the_stats")
       stats.to_h[:stats].should == "the_stats"

data/spec/metric_fu/reporter_spec.rb

@@ -0,0 +1,41 @@
+require "spec_helper"
+
+describe MetricFu::Reporter do
+
+  context 'given a single formatter' do
+    before do
+      @formatter = double('formatter')
+      @formatter.stub(:to_a).and_return([@formatter])
+      @reporter = Reporter.new(@formatter)
+    end
+
+    it 'notifies the formatter' do
+      @formatter.should_receive(:start)
+      @formatter.should_receive(:finish)
+      @reporter.start
+      @reporter.finish
+    end
+
+    it 'only sends notifications when supported by formatter' do
+      @formatter.stub(:respond_to?).with(:display_results).and_return(false)
+      @formatter.should_not_receive(:display_results)
+      @reporter.display_results
+    end
+  end
+
+  context 'given multiple formatters' do
+    before do
+      @formatters = [double('formatter'), double('formatter')]
+      @reporter = Reporter.new(@formatters)
+    end
+
+    it 'notifies all formatters' do
+      @formatters.each do |formatter|
+        formatter.should_receive(:start)
+        formatter.should_receive(:finish)
+      end
+      @reporter.start
+      @reporter.finish
+    end
+  end
+end

data/spec/metric_fu/reporting/graphs/engines/gchart_spec.rb

@@ -41,7 +41,7 @@ describe "Gchart graphers" do
       grapher = FlayGchartGrapher.new
       expected = {
         :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
-        :title => URI.escape("Flay: duplication"),
+        :title => URI.encode("Flay: duplication"),
         :axis_with_labels => 'x,y',
         :format => 'file',
         :filename => File.join(MetricFu.output_directory, 'flay.png'),
@@ -56,7 +56,7 @@ describe "Gchart graphers" do
       grapher = FlogGchartGrapher.new
       expected = {
         :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
-        :title => URI.escape("Flog: code complexity"),
+        :title => URI.encode("Flog: code complexity"),
         :stacked => false,
         :bar_colors => MetricFu::GchartGrapher::COLORS[0..1],
         :legend => ['average', 'top 5% average'],
@@ -75,7 +75,7 @@ describe "Gchart graphers" do
       grapher = RcovGchartGrapher.new
       expected = {
         :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
-        :title => URI.escape("Rcov: code coverage"),
+        :title => URI.encode("Rcov: code coverage"),
         :max_value => 101,
         :axis_with_labels => 'x,y',
         :axis_labels => [grapher.labels.values, [0,20,40,60,80,100]],
@@ -92,7 +92,7 @@ describe "Gchart graphers" do
       grapher = ReekGchartGrapher.new
       expected = {
         :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
-        :title => URI.escape("Reek: code smells"),
+        :title => URI.encode("Reek: code smells"),
         :stacked => false,
         :bar_colors => MetricFu::GchartGrapher::COLORS,
         :axis_with_labels => 'x,y',
@@ -109,7 +109,7 @@ describe "Gchart graphers" do
       grapher = RoodiGchartGrapher.new
       expected = {
         :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
-        :title => URI.escape("Roodi: potential design problems"),
+        :title => URI.encode("Roodi: potential design problems"),
         :axis_with_labels => 'x,y',
         :format => 'file',
         :filename => File.join(MetricFu.output_directory, 'roodi.png'),
@@ -124,7 +124,7 @@ describe "Gchart graphers" do
       grapher = StatsGchartGrapher.new
       expected = {
         :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
-        :title => URI.escape("Stats: LOC & LOT"),
+        :title => URI.encode("Stats: LOC & LOT"),
         :bar_colors => MetricFu::GchartGrapher::COLORS[0..1],
         :legend => ['Lines of code', 'Lines of test'],
         :custom => "chdlp=t",
@@ -142,7 +142,7 @@ describe "Gchart graphers" do
       grapher = RailsBestPracticesGchartGrapher.new
       expected = {
         :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
-        :title => URI.escape("Rails Best Practices: design problems"),
+        :title => URI.encode("Rails Best Practices: design problems"),
         :bar_colors => MetricFu::GchartGrapher::COLORS[0..1],
         :legend => ['Problems'],
         :custom => "chdlp=t",

data/spec/metric_fu/reporting/result_spec.rb

@@ -0,0 +1,51 @@
+require "spec_helper"
+
+describe MetricFu do
+
+  describe "#result" do
+    it 'should return an instance of Result' do
+      MetricFu.result.instance_of?(Result).should be(true)
+    end
+  end
+end
+
+describe MetricFu::Result do
+
+  before(:each) do
+    @result = MetricFu::Result.new
+  end
+
+  describe "#as_yaml" do
+    it 'should call #result_hash' do
+      result_hash = double('result_hash')
+      result_hash.should_receive(:to_yaml)
+
+      @result.should_receive(:result_hash).and_return(result_hash)
+      @result.as_yaml
+    end
+  end
+
+  describe "#result_hash" do
+  end
+
+  describe "#add" do
+    it 'should add a passed hash to the result_hash instance variable' do
+      result_type = double('result_type')
+      result_type.stub(:to_s).and_return('type')
+
+      result_inst = double('result_inst')
+      result_type.should_receive(:new).and_return(result_inst)
+
+      result_inst.should_receive(:generate_result).and_return({:a => 'b'})
+      result_inst.should_receive(:respond_to?).and_return(false)
+
+      MetricFu.should_receive(:send).with(result_type).and_return({})
+      MetricFu.should_receive(:const_get).
+               with('Type').and_return(result_type)
+      result_hash = double('result_hash')
+      result_hash.should_receive(:merge!).with({:a => 'b'})
+      @result.should_receive(:result_hash).and_return(result_hash)
+      @result.add(result_type)
+    end
+  end
+end