metric_fu 4.2.1 → 4.3.0

data/spec/metric_fu/formatter/html_spec.rb

@@ -0,0 +1,134 @@
+require "spec_helper"
+require 'fakefs/safe'
+
+describe MetricFu::Formatter::HTML do
+
+  before do
+    setup_fs
+
+    # TODO: Use mock metrics?
+    # Right now, have to select from metrics
+    # based on platform, resulting in slow specs
+    # for some platforms.
+    @metric_with_graph = MetricFu.configuration.mri? ? :cane : :flay
+    @metric_without_graph = :hotspots
+    MetricFu.result.add(@metric_with_graph) # metric w/ graph
+    MetricFu.result.add(@metric_without_graph) # metric w/out graph
+  end
+
+  context "In general" do
+
+    it "creates a report yaml file" do
+      # For backward compatibility.
+      expect {
+      MetricFu::Formatter::HTML.new.finish
+      }.to create_file("#{MetricFu.base_directory}/report.yml")
+    end
+
+    it "creates a data yaml file" do
+      # For use with graphs.
+      expect {
+      MetricFu::Formatter::HTML.new.finish
+      }.to create_file("#{MetricFu.data_directory}/#{Time.now.strftime("%Y%m%d")}.yml")
+    end
+
+    it "creates a report index html file" do
+      expect {
+      MetricFu::Formatter::HTML.new.finish
+      }.to create_file("#{MetricFu.output_directory}/index.html")
+    end
+
+    it "creates templatized html files for each metric" do
+      expect {
+      MetricFu::Formatter::HTML.new.finish
+      }.to create_files([
+        "#{MetricFu.output_directory}/#{@metric_with_graph}.html",
+        "#{MetricFu.output_directory}/#{@metric_without_graph}.html"
+      ])
+    end
+
+    it "copies common javascripts to the output directory" do
+      expect {
+      MetricFu::Formatter::HTML.new.finish
+      }.to create_file("#{MetricFu.output_directory}/bluff*.js")
+    end
+
+    it "creates graphs for appropriate metrics" do
+      expect {
+      MetricFu::Formatter::HTML.new.finish
+      }.to create_files([
+        "#{MetricFu.output_directory}/#{@metric_with_graph}.js",
+      ])
+    end
+
+    context 'when on OS X' do
+      before do
+        MetricFu.configuration.stub(:platform).and_return('darwin')
+      end
+
+      it "can open the results in the browser" do
+        formatter = MetricFu::Formatter::HTML.new
+        formatter.should_receive(:system).with("open #{Pathname.pwd.join(MetricFu.output_directory).join('index.html')}")
+        formatter.finish
+        formatter.display_results
+      end
+    end
+
+  end
+
+  context "given a custom output directory" do
+
+    before do
+      @output = 'customdir'
+    end
+
+    it "creates the report index html file in the custom output directory" do
+      expect {
+      MetricFu::Formatter::HTML.new(output: @output).finish
+      }.to create_file("#{MetricFu.base_directory}/#{@output}/index.html")
+    end
+
+    it "creates templatized html files for each metric in the custom output directory" do
+      expect {
+      MetricFu::Formatter::HTML.new(output: @output).finish
+      }.to create_files([
+        "#{MetricFu.base_directory}/#{@output}/#{@metric_with_graph}.html",
+        "#{MetricFu.base_directory}/#{@output}/#{@metric_without_graph}.html"
+      ])
+    end
+
+    it "copies common javascripts to the custom output directory" do
+      expect {
+      MetricFu::Formatter::HTML.new(output: @output).finish
+      }.to create_file("#{MetricFu.base_directory}/#{@output}/bluff*.js")
+    end
+
+    it "creates graphs for appropriate metrics in the custom output directory " do
+      expect {
+      MetricFu::Formatter::HTML.new(output: @output).finish
+      }.to create_file(
+        "#{MetricFu.base_directory}/#{@output}/#{@metric_with_graph}.js",
+      )
+    end
+
+    context 'when on OS X' do
+      before do
+        MetricFu.configuration.stub(:platform).and_return('darwin')
+      end
+
+      it "can open the results in the browser from the custom output directory" do
+        formatter = MetricFu::Formatter::HTML.new(output: @output)
+        path = Pathname.pwd.join("#{MetricFu.base_directory}/#{@output}/index.html")
+        formatter.should_receive(:system).with("open #{path}")
+        formatter.finish
+        formatter.display_results
+      end
+    end
+
+  end
+
+  after do
+    cleanup_fs
+  end
+
+end

data/spec/metric_fu/formatter/yaml_spec.rb

@@ -0,0 +1,59 @@
+require "spec_helper"
+require 'fakefs/safe'
+
+describe MetricFu::Formatter::YAML do
+
+  before do
+    setup_fs
+
+    @metric1 = MetricFu.configuration.mri? ? :cane : :flay
+    @metric2 = :hotspots
+    MetricFu.result.add(@metric1)
+    MetricFu.result.add(@metric2)
+  end
+
+  context "In general" do
+
+    it "creates a report yaml file" do
+      expect {
+      MetricFu::Formatter::YAML.new.finish
+      }.to create_file("#{MetricFu.base_directory}/report.yml")
+    end
+
+  end
+
+  context "given a custom output file" do
+
+    before do
+      @output = "customreport.yml"
+    end
+
+    it "creates a report yaml file to the custom output path" do
+      expect {
+      MetricFu::Formatter::YAML.new(output: @output).finish
+      }.to create_file("#{MetricFu.base_directory}/customreport.yml")
+    end
+
+  end
+
+  context "given a custom output stream" do
+
+    before do
+      @output = $stdout
+    end
+
+    it "creates a report yaml in the custom stream" do
+      out = MfDebugger::Logger.capture_output {
+        MetricFu::Formatter::YAML.new(output: @output).finish
+      }
+      out.should include ":#{@metric1}:"
+      out.should include ":#{@metric2}:"
+    end
+
+  end
+
+  after do
+    cleanup_fs
+  end
+
+end

data/spec/metric_fu/formatter_spec.rb

@@ -0,0 +1,49 @@
+require "spec_helper"
+
+describe MetricFu::Formatter do
+  describe "formatter class loading" do
+    context 'given a built-in formatter (string)' do
+      subject { MetricFu::Formatter.class_for('html') }
+
+      it 'returns the formatter class' do
+        subject.should eq(MetricFu::Formatter::HTML)
+      end
+    end
+
+    context 'given a built-in formatter (symbol)' do
+      subject { MetricFu::Formatter.class_for(:yaml) }
+
+      it 'returns the formatter class' do
+        subject.should eq(MetricFu::Formatter::YAML)
+      end
+    end
+
+    context 'given an unknown built-in formatter' do
+      subject { MetricFu::Formatter.class_for(:unknown) }
+
+      it 'raises an error' do
+        lambda{ subject }.should raise_error(NameError)
+      end
+    end
+
+    context 'given a custom formatter that exists' do
+      subject { MetricFu::Formatter.class_for('MyCustomFormatter') }
+
+      before do
+        stub_const('MyCustomFormatter', Class.new() { def initialize(*);end })
+      end
+
+      it 'returns the formatter class' do
+        subject.should eq(MyCustomFormatter)
+      end
+    end
+
+    context 'given a custom formatter that doesnt exist' do
+      subject { MetricFu::Formatter.class_for('MyNonExistentCustomFormatter') }
+
+      it 'raises an error' do
+        lambda{ subject }.should raise_error(NameError)
+      end
+    end
+  end
+end

data/spec/metric_fu/metrics/base_template_spec.rb

@@ -10,8 +10,8 @@ describe MetricFu::Template do
   describe "#erbify" do
     it 'should evaluate a erb doc' do
       section = 'section'
-      File.stub!(:read).and_return('foo')
-      erb = mock('erb')
+      File.stub(:read).and_return('foo')
+      erb = double('erb')
       erb.should_receive(:result)
       ERB.should_receive(:new).with('foo').and_return(erb)
       @template.should_receive(:template).and_return('foo')
@@ -22,7 +22,7 @@ describe MetricFu::Template do
   describe "#template_exists? " do
 
     before(:each) do
-      @section = mock('section')
+      @section = double('section')
       @template.should_receive(:template).
                 with(@section).and_return(@section)
     end
@@ -55,8 +55,8 @@ describe MetricFu::Template do
 
   describe "#template" do
     it 'should generate the filename of the template file' do
-      section = mock('section')
-      section.should_receive(:to_s).any_number_of_times.and_return('section')
+      section = double('section')
+      section.stub(:to_s).and_return('section')
       @template.should_receive(:template_directory).and_return('dir')
       result = @template.send(:template, section)
       result.should == "dir/section.html.erb"
@@ -65,7 +65,7 @@ describe MetricFu::Template do
 
   describe "#output_filename" do
     it 'should generate the filename of the output file' do
-      section = mock('section')
+      section = double('section')
       section.should_receive(:to_s).and_return('section')
       result = @template.send(:output_filename, section)
       result.should == "section.html"
@@ -76,7 +76,7 @@ describe MetricFu::Template do
     it 'should return the contents of a css file' do
       css = 'mycss.css'
       @template.should_receive(:template_directory).and_return('dir')
-      io = mock('io', :read => "css contents")
+      io = double('io', :read => "css contents")
       @template.should_receive(:open).and_yield(io)
       result = @template.send(:inline_css, css)
       result.should == 'css contents'
@@ -86,11 +86,11 @@ describe MetricFu::Template do
   describe "#link_to_filename " do
     describe "when on OS X" do
       before(:each) do
-        config = mock("configuration")
-        config.stub!(:platform).and_return('universal-darwin-9.0')
-        config.stub!(:darwin_txmt_protocol_no_thanks).and_return(false)
-        config.stub!(:link_prefix).and_return(nil)
-        MetricFu.stub!(:configuration).and_return(config)
+        config = double("configuration")
+        config.stub(:platform).and_return('universal-darwin-9.0')
+        config.stub(:darwin_txmt_protocol_no_thanks).and_return(false)
+        config.stub(:link_prefix).and_return(nil)
+        MetricFu.stub(:configuration).and_return(config)
       end
 
       it 'should return a textmate protocol link' do
@@ -116,11 +116,11 @@ describe MetricFu::Template do
 
       describe "but no thanks for txtmt" do
         before(:each) do
-          config = mock("configuration")
-          config.stub!(:platform).and_return('universal-darwin-9.0')
-          config.stub!(:darwin_txmt_protocol_no_thanks).and_return(true)
-          config.stub!(:link_prefix).and_return(nil)
-          MetricFu.stub!(:configuration).and_return(config)
+          config = double("configuration")
+          config.stub(:platform).and_return('universal-darwin-9.0')
+          config.stub(:darwin_txmt_protocol_no_thanks).and_return(true)
+          config.stub(:link_prefix).and_return(nil)
+          MetricFu.stub(:configuration).and_return(config)
           @template.should_receive(:complete_file_path).and_return('filename')
         end
 
@@ -143,11 +143,11 @@ describe MetricFu::Template do
 
     describe "when on other platforms"  do
       before(:each) do
-        config = mock("configuration")
+        config = double("configuration")
         config.should_receive(:platform).and_return('other')
-        config.stub!(:link_prefix).and_return(nil)
-        config.stub!(:darwin_txmt_protocol_no_thanks).and_return(false)
-        MetricFu.stub!(:configuration).and_return(config)
+        config.stub(:link_prefix).and_return(nil)
+        config.stub(:darwin_txmt_protocol_no_thanks).and_return(false)
+        MetricFu.stub(:configuration).and_return(config)
         @template.should_receive(:complete_file_path).and_return('filename')
       end
 
@@ -159,9 +159,9 @@ describe MetricFu::Template do
     end
     describe "when configured with a link_prefix" do
       before(:each) do
-        config = mock("configuration")
+        config = double("configuration")
         config.should_receive(:link_prefix).and_return('http://example.org/files')
-        MetricFu.stub!(:configuration).and_return(config)
+        MetricFu.stub(:configuration).and_return(config)
         @template.should_receive(:complete_file_path).and_return('filename')
       end
 

data/spec/metric_fu/metrics/cane/cane_spec.rb

@@ -62,7 +62,7 @@ describe Cane do
   describe "parse cane empty output" do
     before :each do
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       @cane = MetricFu::Cane.new('base_dir')
       @cane.instance_variable_set(:@output, '')
     end
@@ -80,7 +80,7 @@ describe Cane do
     before :each do
       lines = sample_cane_output
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       @cane = MetricFu::Cane.new('base_dir')
       @cane.instance_variable_set(:@output, lines)
     end

data/spec/metric_fu/metrics/churn/churn_spec.rb

@@ -7,7 +7,7 @@ describe Churn do
   let(:config_setup) {
     ENV['CC_BUILD_ARTIFACTS'] = nil
     MetricFu.configure.reset
-    File.stub!(:directory?).and_return(true)
+    File.stub(:directory?).and_return(true)
   }
 
   describe "new method" do

data/spec/metric_fu/metrics/flay/flay_spec.rb

@@ -7,7 +7,7 @@ describe Flay do
         config.add_metric(:flay)
         config.configure_metric(:flay, { :dirs_to_flay => ['app', 'lib'], :filetypes => ['rb']  })
       }
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       @flay = MetricFu::Flay.new('base_dir')
 
       @flay.should_receive(:`).with("mf-flay  app lib")
@@ -19,7 +19,7 @@ describe Flay do
         config.add_metric(:flay)
         config.configure_metric(:flay, { :dirs_to_flay => [], :minimum_score => 99 })
       }
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       @flay = MetricFu::Flay.new('base_dir')
 
       @flay.should_receive(:`).with("mf-flay --mass 99  ")
@@ -44,7 +44,7 @@ Total score (lower is better) = 246
   app/controllers/primary_sites_controller.rb:89
       HERE
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       @flay = MetricFu::Flay.new('base_dir')
       @flay.instance_variable_set(:@output, lines)
     end
@@ -88,7 +88,7 @@ Total score (lower is better) = 246
                     "app/controllers/bookmarklet_integration_controller.rb:17"]]
 
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       flay = MetricFu::Flay.new('base_dir')
       flay.instance_variable_set(:@matches, lines)
       @results = flay.to_h

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

@@ -3,7 +3,7 @@ describe Flog do
   if MetricFu.configuration.mri?
     before :each do
       MetricFu::Configuration.run {}
-      File.stub!(:directory?).and_return(true)
+      File.stub(:directory?).and_return(true)
       @flog = MetricFu::Flog.new('base_dir')
     end
 
@@ -11,7 +11,7 @@ describe Flog 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 = mock('flogger'))
+        ::Flog.should_receive(:new).with("options").and_return(flogger = double('flogger'))
         flogger.should_receive(:flog).with(["found/file.rb"])
         @flog.emit
       end
@@ -22,7 +22,7 @@ describe Flog do
         first_full_method_name = "ClassName#first_method_name"
         second_full_method_name = "ClassName#second_method_name"
 
-        flogger = mock('flogger', :calls => {first_full_method_name => {:branch => 11.1, :puts => 1.1},
+        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'},
@@ -53,11 +53,11 @@ describe Flog do
 
     describe "to_h method" do
       it "should make-a nice hash" do
-        flogger = mock('flogger', :total => 111.1, :average => 7.3)
+        flogger = double('flogger', :total => 111.1, :average => 7.3)
         @flog.instance_variable_set(:@flogger, flogger)
-        method_containers = {:ignore_me_1 =>  mock('container_1', :highest_score => 11.1, :to_h => 'container_1'),
-                             :ignore_me_2 =>  mock('container_2', :highest_score => 33.3, :to_h => 'container_2'),
-                             :ignore_me_3 =>  mock('container_3', :highest_score => 22.2, :to_h => 'container_3')}
+        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,