mwilden-metric_fu 1.1.1 → 1.1.3

data/lib/templates/awesome/css/reset.css

@@ -0,0 +1,7 @@
+/*
+Copyright (c) 2008, Yahoo! Inc. All rights reserved.
+Code licensed under the BSD License:
+http://developer.yahoo.net/yui/license.txt
+version: 2.5.2
+*/
+html{color:#000;background:#FFF;}body,div,dl,dt,dd,ul,ol,li,h1,h2,h3,h4,h5,h6,pre,code,form,fieldset,legend,input,textarea,p,blockquote,th,td{margin:0;padding:0;}table{border-collapse:collapse;border-spacing:0;}fieldset,img{border:0;}address,caption,cite,code,dfn,em,strong,th,var{font-style:normal;font-weight:normal;}li{list-style:none;}caption,th{text-align:left;}h1,h2,h3,h4,h5,h6{font-size:100%;font-weight:normal;}q:before,q:after{content:'';}abbr,acronym {border:0;font-variant:normal;}sup {vertical-align:text-top;}sub {vertical-align:text-bottom;}input,textarea,select{font-family:inherit;font-size:inherit;font-weight:inherit;}input,textarea,select{*font-size:100%;}legend{color:#000;}

data/lib/templates/awesome/flog.html.erb

@@ -29,6 +29,7 @@
   <h2 id="<%= page[:path].gsub(/[^a-z]+/, '_') %>"><%= link_to_filename page[:path] %></h2>
     <% page[:scanned_methods].each do |sm| %>
       <p><%= sm[:name] %></p>
+      <p>Total Score: <%=sm[:score]%></p>
       <table>
         <tr>
           <th>Score</th>

data/lib/templates/awesome/layout.html.erb

@@ -4,11 +4,11 @@
     <meta content='text/html; charset=utf-8' http-equiv='Content-Type' />
     <meta content='en' http-equiv='Content-Language' />
     <title>metrics</title>
-    <link href='/reset.css' rel='stylesheet' type='text/css' />
-    <link href='/buttons.css' rel='stylesheet' type='text/css' />
-    <link href='/integrity.css' rel='stylesheet' type='text/css' />
     <style>
-    <%= inline_css("default.css") %>
+    <%= inline_css("css/reset.css") %>
+    <%= inline_css("css/buttons.css") %>
+    <%= inline_css("css/integrity.css") %>
+    <%= inline_css("css/default.css") %>
     </style>
     <link REL="SHORTCUT ICON" HREF="/favicon.ico">
   </head>

data/spec/base/configuration_spec.rb

@@ -30,53 +30,6 @@ describe MetricFu::Configuration do
     @config.instance_variable_get(:@metric_fu_root_directory)
   end
 
-  describe '#warn_about_deprecated_config_options' do
-
-    def get_new_config_and_raise_runtime_error
-      lambda { get_new_config  }.should raise_error
-    end
-
-    describe 'when ::MetricFu::CHURN_OPTIONS is present' do
-      before(:each) { ::MetricFu::CHURN_OPTIONS = 'option' }
-      after(:each)  { ::MetricFu.send(:remove_const, 'CHURN_OPTIONS') }
-      
-      it 'should raise a RuntimeError with "Use config.churn '+ 
-      'instead of MetricFu::CHURN_OPTIONS"' do
-        get_new_config_and_raise_runtime_error
-      end
-    end
-    
-    describe 'when ::MetricFu::DIRECTORIES_TO_FLOG is present' do
-      before(:each) { ::MetricFu::DIRECTORIES_TO_FLOG = 'option' }
-      after(:each)  { ::MetricFu.send(:remove_const,'DIRECTORIES_TO_FLOG')}
-
-      it 'should raise a RuntimeError with "Use config.flog '+
-      '[:dirs_to_flog] instead of MetricFu::DIRECTORIES_TO_FLOG' do
-        get_new_config_and_raise_runtime_error
-      end 
-    end
-
-    describe 'when ::MetricFu::SAIKURO_OPTIONS is present' do
-      before(:each) { ::MetricFu::SAIKURO_OPTIONS = 'option' }
-      after(:each)  { ::MetricFu.send(:remove_const,'SAIKURO_OPTIONS')}
-      
-      it 'should raise a RuntimeError with "Use config.saikuro '+
-      'instead of MetricFu::SAIKURO_OPTIONS' do 
-        get_new_config_and_raise_runtime_error
-      end
-    end
-
-    describe 'when SAIKURO_OPTIONS is present' do
-      before(:each) { SAIKURO_OPTIONS = 'option' }
-      after(:each)  { Object.send(:remove_const,'SAIKURO_OPTIONS')}
-      
-      it 'should raise a RuntimeError with "Use config.saikuro '+
-      'instead of SAIKURO_OPTIONS' do
-        get_new_config_and_raise_runtime_error
-      end
-    end
-  end
-
   describe "#reset" do
     
     before(:each) { get_new_config } 
@@ -128,7 +81,7 @@ describe MetricFu::Configuration do
       output_directory.should == output_dir
     end
     
-    it 'should set @template_class to StandardTemplate' do
+    it 'should set @template_class to AwesomeTemplate' do
       template_class.should == AwesomeTemplate
     end
 
@@ -191,7 +144,7 @@ describe MetricFu::Configuration do
                                  :error_cyclo => "7",
                                  :formater => "text" }' do
       @config.instance_variable_get(:@saikuro).
-              should ==  { :output_directory => 'tmp/metric_fu/scratch/saikuro', 
+              should ==  { :output_directory => "#{scratch_directory}/saikuro", 
                     :input_directory => ['lib'],
                     :cyclo => "",
                     :filter_cyclo => "0",
@@ -199,7 +152,38 @@ describe MetricFu::Configuration do
                     :error_cyclo => "7",
                     :formater => "text"}
     end
-
+    
+    it 'should set @graph_theme to { 
+                    :colors => %w(orange purple green white red blue pink yellow),
+                    :marker_color => "blue",
+                    :background_colors => %w(white white)}' do
+      @config.instance_variable_get(:@graph_theme).
+              should ==  { :colors => %w(orange purple green white red blue pink yellow),
+              :marker_color => "blue",
+              :background_colors => %w(white white) }
+    end
+    
+    it 'should set @graph_font to the path to the font directory' do
+      @config.instance_variable_get(:@graph_font).
+              should include(File.join('vendor', '_fonts', 'monaco.ttf'))
+    end
+    
+    it 'should set @graph_title_font_size to 12' do
+      @config.instance_variable_get(:@graph_title_font_size).should eql(12)
+    end
+    
+    it 'should set @graph_legend_box_size to 12' do
+      @config.instance_variable_get(:@graph_legend_box_size).should eql(12)
+    end
+    
+    it 'should set @graph_legend_box_size to 10' do
+      @config.instance_variable_get(:@graph_legend_font_size).should eql(10)
+    end
+    
+    it 'should set @graph_marker_font_size to 10' do
+      @config.instance_variable_get(:@graph_marker_font_size).should eql(10)
+    end
+    
     describe 'if #rails? is true ' do
       before(:each) do
         @config.stub!(:rails?).and_return(true)
@@ -213,6 +197,13 @@ describe MetricFu::Configuration do
         end
       end
 
+      describe '#set_graphs ' do
+        it 'should set the @graphs instance var to AVAILABLE_GRAPHS' do
+          @config.instance_variable_get(:@graphs).
+                  should == MetricFu::AVAILABLE_GRAPHS
+        end
+      end
+
       describe '#set_code_dirs ' do
         it 'should set the @code_dirs instance var to ["app", "lib"]' do
           # This is hard to spec properly because the @code_dirs variable
@@ -264,7 +255,13 @@ describe MetricFu::Configuration do
 
     MetricFu::AVAILABLE_METRICS.each do |metric|
       it "should add a #{metric} class method to the MetricFu module " do
-        MetricFu.respond_to?(metric).should be_true
+        MetricFu.should respond_to(metric)
+      end
+    end
+    
+    MetricFu::AVAILABLE_GRAPHS.each do |graph|
+      it "should add a #{graph} class metrhod to the MetricFu module" do
+        MetricFu.should respond_to(graph)
       end
     end
   end
@@ -274,7 +271,7 @@ describe MetricFu::Configuration do
     before(:each) { get_new_config }
 
     it 'should return the value of the PLATFORM constant' do
-      this_platform = PLATFORM
+      this_platform = RUBY_PLATFORM
       @config.platform.should == this_platform
     end
   end

data/spec/base/graph_spec.rb

@@ -0,0 +1,24 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MetricFu do
+  
+  describe "responding to #graph" do
+    it "should return an instance of Graph" do
+      MetricFu.graph.should be_a(Graph)
+    end
+  end
+end
+
+describe MetricFu::Graph do
+  
+  before(:each) do
+    @graph = MetricFu::Graph.new
+  end
+  
+  describe "responding to #add" do
+    it 'should instantiate a grapher and push it to clazz' do
+      @graph.clazz.should_receive(:push).with(an_instance_of(RcovGrapher))
+      @graph.add("rcov")
+    end
+  end  
+end

data/spec/graphs/flay_grapher_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe FlayGrapher do 
+  before :each do
+    @flay_grapher = MetricFu::FlayGrapher.new
+    MetricFu.configuration
+  end
+  
+  it "should respond to flay_score and labels" do
+    @flay_grapher.should respond_to(:flay_score)
+    @flay_grapher.should respond_to(:labels)
+  end
+  
+  describe "responding to #initialize" do
+    it "should initialise flay_score and labels" do
+      @flay_grapher.flay_score.should == []
+      @flay_grapher.labels.should == {}
+    end
+  end
+  
+  describe "responding to #get_metrics" do
+    before(:each) do
+      @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+      @date = "01022003"
+    end
+    
+    it "should push 476 to flay_score" do
+      @flay_grapher.flay_score.should_receive(:push).with(476)      
+      @flay_grapher.get_metrics(@metrics, @date)
+    end
+    
+    it "should update labels with the date" do
+      @flay_grapher.labels.should_receive(:update).with({ 0 => "01022003" })
+      @flay_grapher.get_metrics(@metrics, @date)
+    end
+  end
+  
+  describe "responding to #graph!" do
+    it "should write flay.png" do
+      @flay_grapher.graph!
+      lambda{ File.open(File.join(MetricFu.output_directory, 'flay.png')) }.should_not raise_error
+    end
+  end
+end

data/spec/graphs/flog_grapher_spec.rb

@@ -1,15 +1,61 @@
 require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
 describe MetricFu::FlogGrapher do
-  it "should not fall over when given empty results" do
-    MetricFu::Configuration.run {}
+  before :each do
+    @flog_grapher = MetricFu::FlogGrapher.new
+    MetricFu.configuration
+  end
+  
+  it "should respond to flog_total, flog_average and labels" do
+    @flog_grapher.should respond_to(:flog_average)
+    @flog_grapher.should respond_to(:labels)
+    @flog_grapher.should respond_to(:top_five_percent_average)
+  end
+  
+  describe "responding to #initialize" do
+    it "should initialize top_five_percent_average, flog_average and labels" do
+      @flog_grapher.flog_average.should == []
+      @flog_grapher.labels.should == {}
+      @flog_grapher.top_five_percent_average.should == []
+    end
+  end
+  
+  describe "responding to #get_metrics" do
+    before(:each) do
+      @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+      @date = "01022003"
+    end
+    
+    it "should push to top_five_percent_average" do
+      average = (73.6 + 68.5 + 66.1 + 46.6 + 44.8 + 44.1 + 41.2 + 36.0) / 8.0
+      @flog_grapher.top_five_percent_average.should_receive(:push).with(average)      
+      @flog_grapher.get_metrics(@metrics, @date)
+    end
     
-    gruff_line = Gruff::Line.new(MetricFu.graph_size)
-    gruff_line.stub!(:write)
-    Gruff::Line.stub!(:new).and_return(gruff_line)
+    it "should push 9.9 to flog_average" do
+      @flog_grapher.flog_average.should_receive(:push).with(9.9)
+      @flog_grapher.get_metrics(@metrics, @date)
+    end
     
-    grapher = FlogGrapher.new()
-    metrics_hash = {:flog => {:average => 0, :pages => [], :total => 0}}
-    grapher.get_metrics(metrics_hash ,"20090629")
-    grapher.graph!
+    it "should update labels with the date" do
+      @flog_grapher.labels.should_receive(:update).with({ 0 => "01022003" })
+      @flog_grapher.get_metrics(@metrics, @date)
+    end
   end
-end
+  
+  describe "responding to #graph!" do
+    it "should write flog.png" do
+      @flog_grapher.graph!
+      lambda{ File.open(File.join(MetricFu.output_directory, 'flog.png')) }.should_not raise_error
+    end
+  
+    it "should not fall over when given empty results" do    
+      gruff_line = Gruff::Line.new(MetricFu.graph_size)
+      gruff_line.stub!(:write)
+      Gruff::Line.stub!(:new).and_return(gruff_line)
+      metrics_hash = { :flog => {:average => 0, :pages => [], :total => 0} }
+      @flog_grapher.get_metrics(metrics_hash ,"20090629")
+      @flog_grapher.graph!
+    end
+  end  
+end

data/spec/graphs/grapher_spec.rb

@@ -0,0 +1,9 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+describe Grapher do
+  it "should blow up if gruff is not availible" do
+    Grapher.should_receive(:require).and_raise(LoadError)
+    Grapher.should_receive(:puts).with(/config\.graphs/)
+    lambda {Grapher.new}.should raise_error(LoadError) 
+  end
+end

data/spec/graphs/rcov_grapher_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe RcovGrapher do 
+  before :each do
+    @rcov_grapher = MetricFu::RcovGrapher.new
+    MetricFu.configuration
+  end
+  
+  it "should respond to rcov_percent and labels" do
+    @rcov_grapher.should respond_to(:rcov_percent)
+    @rcov_grapher.should respond_to(:labels)
+  end
+  
+  describe "responding to #initialize" do
+    it "should initialise rcov_percent and labels" do
+      @rcov_grapher.rcov_percent.should == []
+      @rcov_grapher.labels.should == {}
+    end
+  end
+  
+  describe "responding to #get_metrics" do
+    before(:each) do
+      @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+      @date = "01022003"
+    end
+    
+    it "should push 49.6 to rcov_percent" do
+      @rcov_grapher.rcov_percent.should_receive(:push).with(49.6)      
+      @rcov_grapher.get_metrics(@metrics, @date)
+    end
+    
+    it "should update labels with the date" do
+      @rcov_grapher.labels.should_receive(:update).with({ 0 => "01022003" })
+      @rcov_grapher.get_metrics(@metrics, @date)
+    end
+  end
+  
+  describe "responding to #graph!" do
+    it "should write rcov.png" do
+      @rcov_grapher.graph!
+      lambda{ File.open(File.join(MetricFu.output_directory, 'rcov.png')) }.should_not raise_error
+    end
+  end
+end

data/spec/graphs/reek_grapher_spec.rb

@@ -0,0 +1,53 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe ReekGrapher do 
+  before :each do
+    @reek_grapher = MetricFu::ReekGrapher.new
+    MetricFu.configuration
+  end
+  
+  it "should respond to reek_count and labels" do
+    @reek_grapher.should respond_to(:reek_count)
+    @reek_grapher.should respond_to(:labels)
+  end
+  
+  describe "responding to #initialize" do
+    it "should initialise reek_count and labels" do
+      @reek_grapher.reek_count.should == {}
+      @reek_grapher.labels.should == {}
+    end
+  end
+  
+  describe "responding to #get_metrics" do
+    before(:each) do
+      @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+      @date = "01022003"
+    end
+    
+    it "should set a hash of code smells to reek_count" do
+      @reek_grapher.get_metrics(@metrics, @date)
+      @reek_grapher.reek_count.should == {
+        "Uncommunicative Name" => [27],
+        "Feature Envy" => [20],
+        "Utility Function" => [15],
+        "Long Method" => [26],
+        "Nested Iterators" => [12],
+        "Control Couple" => [4],
+        "Duplication" => [48],
+        "Large Class" => [1] 
+      }
+    end
+    
+    it "should update labels with the date" do
+      @reek_grapher.labels.should_receive(:update).with({ 0 => "01022003" })
+      @reek_grapher.get_metrics(@metrics, @date)
+    end
+  end
+  
+  describe "responding to #graph!" do
+    it "should write reek.png" do
+      @reek_grapher.graph!
+      lambda{ File.open(File.join(MetricFu.output_directory, 'reek.png')) }.should_not raise_error
+    end
+  end
+end

data/spec/graphs/roodi_grapher_spec.rb

@@ -0,0 +1,44 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe RoodiGrapher do 
+  before :each do
+    @roodi_grapher = MetricFu::RoodiGrapher.new
+    MetricFu.configuration
+  end
+  
+  it "should respond to roodi_count and labels" do
+    @roodi_grapher.should respond_to(:roodi_count)
+    @roodi_grapher.should respond_to(:labels)
+  end
+  
+  describe "responding to #initialize" do
+    it "should initialise roodi_count and labels" do
+      @roodi_grapher.roodi_count.should == []
+      @roodi_grapher.labels.should == {}
+    end
+  end
+  
+  describe "responding to #get_metrics" do
+    before(:each) do
+      @metrics = YAML::load(File.open(File.join(File.dirname(__FILE__), "..", "resources", "yml", "20090630.yml")))
+      @date = "01022003"
+    end
+    
+    it "should push 13 to roodi_count" do
+      @roodi_grapher.roodi_count.should_receive(:push).with(13)      
+      @roodi_grapher.get_metrics(@metrics, @date)
+    end
+    
+    it "should update labels with the date" do
+      @roodi_grapher.labels.should_receive(:update).with({ 0 => "01022003" })
+      @roodi_grapher.get_metrics(@metrics, @date)
+    end
+  end
+  
+  describe "responding to #graph!" do
+    it "should write rcov.png" do
+      @roodi_grapher.graph!
+      lambda{ File.open(File.join(MetricFu.output_directory, 'roodi.png')) }.should_not raise_error
+    end
+  end
+end