metric_fu 4.3.1 → 4.4.0

data/spec/metric_fu/formatter/html_spec.rb

@@ -12,63 +12,72 @@ describe MetricFu::Formatter::HTML do
     # for some platforms.
     @metric_with_graph = MetricFu.configuration.mri? ? :cane : :flay
     @metric_without_graph = :hotspots
+    MetricFu.configuration.configure_metrics.each do |metric|
+      metric.enabled = true if [@metric_with_graph, @metric_without_graph].include?(metric.name)
+    end
+
     MetricFu.result.add(@metric_with_graph) # metric w/ graph
     MetricFu.result.add(@metric_without_graph) # metric w/out graph
   end
 
+  def directory(name)
+    MetricFu::Io::FileSystem.directory(name)
+  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")
+      }.to create_file("#{directory('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")
+      }.to create_file("#{directory('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")
+      }.to create_file("#{directory('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"
+        "#{directory('output_directory')}/#{@metric_with_graph}.html",
+        "#{directory('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")
+      }.to create_file("#{directory('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",
+        "#{directory('output_directory')}/#{@metric_with_graph}.js",
       ])
     end
 
     context 'when on OS X' do
       before do
-        MetricFu.configuration.stub(:platform).and_return('darwin')
+        MetricFu.configuration.stub(:osx?).and_return(true)
+        MetricFu.configuration.stub(:is_cruise_control_rb?).and_return(false)
       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.should_receive(:system).with("open #{Pathname.pwd.join(directory('output_directory')).join('index.html')}")
         formatter.finish
         formatter.display_results
       end
@@ -85,40 +94,41 @@ describe MetricFu::Formatter::HTML do
     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")
+      }.to create_file("#{directory('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"
+        "#{directory('base_directory')}/#{@output}/#{@metric_with_graph}.html",
+        "#{directory('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")
+      }.to create_file("#{directory('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",
+        "#{directory('base_directory')}/#{@output}/#{@metric_with_graph}.js",
       )
     end
 
     context 'when on OS X' do
       before do
-        MetricFu.configuration.stub(:platform).and_return('darwin')
+        MetricFu.configuration.stub(:osx?).and_return(true)
+        MetricFu.configuration.stub(:is_cruise_control_rb?).and_return(false)
       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")
+        path = Pathname.pwd.join("#{directory('base_directory')}/#{@output}/index.html")
         formatter.should_receive(:system).with("open #{path}")
         formatter.finish
         formatter.display_results

data/spec/metric_fu/formatter/yaml_spec.rb

@@ -17,7 +17,7 @@ describe MetricFu::Formatter::YAML do
     it "creates a report yaml file" do
       expect {
       MetricFu::Formatter::YAML.new.finish
-      }.to create_file("#{MetricFu.base_directory}/report.yml")
+      }.to create_file("#{directory('base_directory')}/report.yml")
     end
 
   end
@@ -31,7 +31,7 @@ describe MetricFu::Formatter::YAML do
     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")
+      }.to create_file("#{directory('base_directory')}/customreport.yml")
     end
 
   end

data/spec/metric_fu/metric_spec.rb

@@ -0,0 +1,50 @@
+require 'spec_helper'
+
+describe MetricFu::Metric do
+  before do
+    @metric = MetricFu::Metric.get_metric(:flog)
+    #@original_options = @metric.run_options.dup
+  end
+
+  #it 'can have its run_options over-written' do
+    #new_options = {:foo => 'bar'}
+    #@metric.run_options = new_options
+    #expect(@original_options).to_not eq(new_options)
+    #expect(@metric.run_options).to eq(new_options)
+  #end
+
+  #it 'can have its run_options modified' do
+    #new_options = {:foo => 'bar'}
+    #@metric.run_options.merge!(new_options)
+    #expect(@metric.run_options).to eq(@original_options.merge(new_options))
+  #end
+
+  context 'given a valid configurable option' do
+
+    before do
+      @metric.stub(:default_run_options).and_return({:foo => 'baz'})
+    end
+
+    it 'can be configured as an attribute' do
+      @metric.foo = 'qux'
+      expect(@metric.run_options[:foo]).to eq('qux')
+    end
+
+  end
+
+  context 'given an invalid configurable option' do
+
+    before do
+      @metric.stub(:default_run_options).and_return({})
+    end
+
+    it 'raises an error' do
+      expect { @metric.foo = 'bar' }.to raise_error(RuntimeError, /not a valid configuration option/)
+    end
+
+  end
+
+  after do
+    @metric.configured_run_options.clear
+  end
+end

data/spec/metric_fu/metrics/base_template_spec.rb

@@ -87,9 +87,10 @@ describe MetricFu::Template do
     describe "when on OS X" do
       before(:each) do
         config = double("configuration")
+        config.stub(:osx?).and_return(true)
         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::Formatter::Templates.stub(:option).with('darwin_txmt_protocol_no_thanks').and_return(false)
+        MetricFu::Formatter::Templates.stub(:option).with('link_prefix').and_return(nil)
         MetricFu.stub(:configuration).and_return(config)
       end
 
@@ -117,9 +118,11 @@ describe MetricFu::Template do
       describe "but no thanks for txtmt" do
         before(:each) do
           config = double("configuration")
+          config.stub(:osx?).and_return(true)
           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::Formatter::Templates.stub(:option).with('darwin_txmt_protocol_no_thanks').and_return(true)
+          MetricFu::Formatter::Templates.stub(:option).with('link_prefix').and_return(nil)
           MetricFu.stub(:configuration).and_return(config)
           @template.should_receive(:complete_file_path).and_return('filename')
         end
@@ -144,9 +147,8 @@ describe MetricFu::Template do
     describe "when on other platforms"  do
       before(:each) do
         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)
+        config.should_receive(:osx?).and_return(false)
+        MetricFu::Formatter::Templates.stub(:option).with('link_prefix').and_return(nil)
         MetricFu.stub(:configuration).and_return(config)
         @template.should_receive(:complete_file_path).and_return('filename')
       end
@@ -160,7 +162,7 @@ describe MetricFu::Template do
     describe "when configured with a link_prefix" do
       before(:each) do
         config = double("configuration")
-        config.should_receive(:link_prefix).and_return('http://example.org/files')
+          MetricFu::Formatter::Templates.stub(:option).with('link_prefix').and_return('http://example.org/files')
         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

@@ -1,59 +1,53 @@
 require 'spec_helper'
 
-describe Cane do
+describe CaneGenerator do
   describe "emit method" do
-    def configure_cane_with(options={})
-      MetricFu::Configuration.run {|config|
-        config.add_metric(:cane)
-        config.configure_metric(:cane, options)
-      }
-    end
 
     it "should execute cane command" do
-      configure_cane_with({})
-      @cane = MetricFu::Cane.new('base_dir')
+      options = {}
+      @cane = MetricFu::CaneGenerator.new(options)
       @cane.should_receive(:`).with("mf-cane")
       output = @cane.emit
     end
 
     it "should use abc max option" do
-      configure_cane_with({abc_max: 20})
-      @cane = MetricFu::Cane.new('base_dir')
+      options = {abc_max: 20}
+      @cane = MetricFu::CaneGenerator.new(options)
       @cane.should_receive(:`).with("mf-cane --abc-max 20")
       output = @cane.emit
     end
 
     it "should use style max line length option" do
-      configure_cane_with({line_length: 100})
-      @cane = MetricFu::Cane.new('base_dir')
+      options = {line_length: 100}
+      @cane = MetricFu::CaneGenerator.new(options)
       @cane.should_receive(:`).with("mf-cane --style-measure 100")
       output = @cane.emit
     end
 
     it "should use no-doc if specified" do
-      configure_cane_with({no_doc: 'y'})
-      @cane = MetricFu::Cane.new('base_dir')
+      options = {no_doc: 'y'}
+      @cane = MetricFu::CaneGenerator.new(options)
       @cane.should_receive(:`).with("mf-cane --no-doc")
       output = @cane.emit
     end
 
     it "should include doc violations if no_doc != 'y'" do
-      configure_cane_with({no_doc: 'n'})
-      @cane = MetricFu::Cane.new('base_dir')
+      options = {no_doc: 'n'}
+      @cane = MetricFu::CaneGenerator.new(options)
       @cane.should_receive(:`).with("mf-cane")
       output = @cane.emit
     end
 
     it "should use no-readme if specified" do
-      configure_cane_with({no_readme: 'y'})
-      @cane = MetricFu::Cane.new('base_dir')
+      options = {no_readme: 'y'}
+      @cane = MetricFu::CaneGenerator.new(options)
       @cane.should_receive(:`).with("mf-cane --no-readme")
       output = @cane.emit
     end
 
     it "should include README violations if no_readme != 'y'" do
-      configure_cane_with({no_readme: 'n'})
-      @cane = MetricFu::Cane.new('base_dir')
+      options = {no_readme: 'n'}
+      @cane = MetricFu::CaneGenerator.new(options)
       @cane.should_receive(:`).with("mf-cane")
       output = @cane.emit
     end
@@ -61,9 +55,10 @@ describe Cane do
 
   describe "parse cane empty output" do
     before :each do
-      MetricFu::Configuration.run {}
+      # MetricFu::Configuration.run {}
       File.stub(:directory?).and_return(true)
-      @cane = MetricFu::Cane.new('base_dir')
+      options = {}
+      @cane = MetricFu::CaneGenerator.new(options)
       @cane.instance_variable_set(:@output, '')
     end
 
@@ -81,7 +76,7 @@ describe Cane do
       lines = sample_cane_output
       MetricFu::Configuration.run {}
       File.stub(:directory?).and_return(true)
-      @cane = MetricFu::Cane.new('base_dir')
+      @cane = MetricFu::CaneGenerator.new('base_dir')
       @cane.instance_variable_set(:@output, lines)
     end
 

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

@@ -1,6 +1,6 @@
 require "spec_helper"
 
-describe Churn do
+describe MetricFu::ChurnGenerator do
 
   let(:churn_yaml) { "--- \n:churn: \n  :changed_files: \n  - spec/graphs/flog_grapher_spec.rb\n  - spec/base/graph_spec.rb\n  - lib/templates/awesome/layout.html.erb\n  - lib/graphs/rcov_grapher.rb\n  - lib/base/base_template.rb\n  - spec/graphs/grapher_spec.rb\n  - lib/templates/awesome/flog.html.erb\n  - lib/templates/awesome/flay.html.erb\n  - lib/graphs/roodi_grapher.rb\n  - lib/graphs/reek_grapher.rb\n  - HISTORY\n  - spec/graphs/roodi_grapher_spec.rb\n  - lib/generators/rcov.rb\n  - spec/graphs/engines/gchart_spec.rb\n  - spec/graphs/rcov_grapher_spec.rb\n  - lib/templates/javascripts/excanvas.js\n  - lib/templates/javascripts/bluff-min.js\n  - spec/graphs/reek_grapher_spec.rb\n" }
 
@@ -16,12 +16,12 @@ describe Churn do
     end
 
     it "initializes with yaml option" do
-      churn = MetricFu::Churn.new
+      churn = MetricFu::ChurnGenerator.new
       churn.send(:build_churn_options).should == "--yaml"
     end
 
     it "initializes with given minimum_churn_count option" do
-      churn = MetricFu::Churn.new( { :minimum_churn_count => 5 })
+      churn = MetricFu::ChurnGenerator.new( { :minimum_churn_count => 5 })
       churn.send(:build_churn_options).should == "--yaml --minimum_churn_count=5"
     end
   end
@@ -34,21 +34,21 @@ describe Churn do
     end
 
     it "should be empty on error text" do
-      churn = MetricFu::Churn.new
+      churn = MetricFu::ChurnGenerator.new
       churn.instance_variable_set(:@output, "Churning requires a subversion or git repo")
       result = churn.analyze
       result.should == {:churn => {}}
     end
 
     it "should be empty on error no output captured" do
-      churn = MetricFu::Churn.new
+      churn = MetricFu::ChurnGenerator.new
       churn.instance_variable_set(:@output, nil)
       result = churn.analyze
       result.should == {:churn => {}}
     end
 
     it "should return yaml results" do
-      churn = MetricFu::Churn.new
+      churn = MetricFu::ChurnGenerator.new
       churn.instance_variable_set(:@output, churn_yaml)
       result = churn.analyze
       result.should == {:churn => {:changed_files => ["spec/graphs/flog_grapher_spec.rb", "spec/base/graph_spec.rb", "lib/templates/awesome/layout.html.erb", "lib/graphs/rcov_grapher.rb", "lib/base/base_template.rb", "spec/graphs/grapher_spec.rb", "lib/templates/awesome/flog.html.erb", "lib/templates/awesome/flay.html.erb", "lib/graphs/roodi_grapher.rb", "lib/graphs/reek_grapher.rb", "HISTORY", "spec/graphs/roodi_grapher_spec.rb", "lib/generators/rcov.rb", "spec/graphs/engines/gchart_spec.rb", "spec/graphs/rcov_grapher_spec.rb", "lib/templates/javascripts/excanvas.js", "lib/templates/javascripts/bluff-min.js", "spec/graphs/reek_grapher_spec.rb"]}}
@@ -63,7 +63,7 @@ describe Churn do
     end
 
     it "should put the changes into a hash" do
-      churn = MetricFu::Churn.new
+      churn = MetricFu::ChurnGenerator.new
       churn.instance_variable_set(:@churn, {:churn => 'results'})
       churn.to_h[:churn].should == "results"
     end
@@ -73,7 +73,7 @@ describe Churn do
   describe "emit method" do
     before :each do
       config_setup
-      @churn = MetricFu::Churn.new
+      @churn = MetricFu::ChurnGenerator.new
     end
 
     it "returns churn output" do

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

@@ -1,26 +1,20 @@
 require "spec_helper"
 
-describe Flay do
+describe MetricFu::FlayGenerator do
   describe "emit method" do
     it "should look at the dirs" do
-      MetricFu::Configuration.run {|config|
-        config.add_metric(:flay)
-        config.configure_metric(:flay, { :dirs_to_flay => ['app', 'lib'], :filetypes => ['rb']  })
-      }
+      options = { :dirs_to_flay => ['app', 'lib'], :filetypes => ['rb']  }
       File.stub(:directory?).and_return(true)
-      @flay = MetricFu::Flay.new('base_dir')
+      @flay = MetricFu::FlayGenerator.new(options)
 
       @flay.should_receive(:`).with("mf-flay  app lib")
       output = @flay.emit
     end
 
     it "should limit flay scores by the minimum_score" do
-      MetricFu::Configuration.run {|config|
-        config.add_metric(:flay)
-        config.configure_metric(:flay, { :dirs_to_flay => [], :minimum_score => 99 })
-      }
+      options = { :dirs_to_flay => [], :minimum_score => 99 }
       File.stub(:directory?).and_return(true)
-      @flay = MetricFu::Flay.new('base_dir')
+      @flay = MetricFu::FlayGenerator.new(options)
 
       @flay.should_receive(:`).with("mf-flay --mass 99  ")
       output = @flay.emit
@@ -45,7 +39,7 @@ Total score (lower is better) = 246
       HERE
       MetricFu::Configuration.run {}
       File.stub(:directory?).and_return(true)
-      @flay = MetricFu::Flay.new('base_dir')
+      @flay = MetricFu::FlayGenerator.new('base_dir')
       @flay.instance_variable_set(:@output, lines)
     end
 
@@ -89,7 +83,7 @@ Total score (lower is better) = 246
 
       MetricFu::Configuration.run {}
       File.stub(:directory?).and_return(true)
-      flay = MetricFu::Flay.new('base_dir')
+      flay = MetricFu::FlayGenerator.new('base_dir')
       flay.instance_variable_set(:@matches, lines)
       @results = flay.to_h
     end