metric_fu 1.3.0 → 1.4.0

data/lib/generators/stats.rb

@@ -8,18 +8,39 @@ module MetricFu
 
     def analyze
       output = File.open(metric_directory + '/stats.txt').read
-      output = output.split("\n")
-      output = output.find_all {|line| line[0].chr != "+" }
-      output = output.find_all {|line| line[0].chr != "(" }
-      output.shift
-      totals = output.pop
-      totals = totals.split("  ").find_all {|el| ! el.empty? }
+      lines = remove_noise(output)
+
       @stats = {}
+      
+      set_global_stats(lines.pop)
+      set_granular_stats(lines)
+
+      @stats
+    end
+
+    def to_h
+      {:stats => @stats}
+    end
+    
+    private
+    
+    def remove_noise(output)
+      lines = output.split("\n")
+      lines = lines.find_all {|line| line[0].chr != "+" }
+      lines = lines.find_all {|line| line[0].chr != "(" }
+      lines.shift
+      lines
+    end
+    
+    def set_global_stats(totals)
+      totals = totals.split("  ").find_all {|el| ! el.empty? }
       @stats[:codeLOC] = totals[0].match(/\d.*/)[0].to_i
       @stats[:testLOC] = totals[1].match(/\d.*/)[0].to_i
       @stats[:code_to_test_ratio] = totals[2].match(/1\:(\d.*)/)[1].to_f
-      
-      @stats[:lines] = output.map do |line|
+    end
+    
+    def set_granular_stats(lines)
+      @stats[:lines] = lines.map do |line|
         elements = line.split("|")
         elements.map! {|el| el.strip }
         elements = elements.find_all {|el| ! el.empty? }
@@ -32,11 +53,6 @@ module MetricFu
         end
         info_line
       end
-      @stats
-    end
-
-    def to_h
-      {:stats => @stats}
     end
 
   end

data/lib/graphs/engines/bluff.rb

@@ -83,4 +83,31 @@ module MetricFu
       File.open(File.join(MetricFu.output_directory, 'roodi.js'), 'w') {|f| f << content }
     end
   end
+
+  class StatsBluffGrapher < StatsGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Stats: LOC & LOT';
+        g.data('LOC', [#{@loc_counts.join(',')}]);
+        g.data('LOT', [#{@lot_counts.join(',')}])
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'stats.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RailsBestPracticesBluffGrapher < RailsBestPracticesGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Rails Best Practices: design problems';
+        g.data('rails_best_practices', [#{@rails_best_practices_count.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'rails_best_practices.js'), 'w') {|f| f << content }
+    end
+  end
 end

data/lib/graphs/engines/gchart.rb

@@ -1,7 +1,7 @@
 module MetricFu
   module GchartGrapher
     COLORS = %w{009999 FF7400 A60000 008500 E6399B 344AD7 00B860 D5CCB9}    
-    GCHART_GRAPH_SIZE = "1000x300" # maximum permitted image size is 300000 pixels
+    GCHART_GRAPH_SIZE = "945x317" # maximum permitted image size is 300000 pixels
     
     NUMBER_OF_TICKS = 6
     def determine_y_axis_scale(values)
@@ -23,7 +23,7 @@ module MetricFu
     include MetricFu::GchartGrapher
     
     def self.require_graphing_gem
-      require 'gchart'
+      require 'gchart' if MetricFu.graph_engine == :gchart
     rescue LoadError
       puts "#"*99 + "\n" +
            "If you want to use google charts for graphing, you'll need to install the googlecharts rubygem." +
@@ -55,7 +55,8 @@ module MetricFu
         :data => [@flog_average, @top_five_percent_average],
         :stacked => false,
         :bar_colors => COLORS[0..1],
-        :legend => ['average', 'top 5%25 average'],
+        :legend => ['average', 'top 5% average'],
+        :custom => "chdlp=t",
         :max_value => @max_value,
         :axis_with_labels => 'x,y',
         :axis_labels => [@labels.values, @yaxis],
@@ -93,6 +94,7 @@ module MetricFu
         :stacked => false,
         :bar_colors => COLORS,
         :legend => legend,
+        :custom => "chdlp=t",
         :max_value => @max_value,
         :axis_with_labels => 'x,y',
         :axis_labels => [@labels.values, @yaxis],
@@ -115,4 +117,23 @@ module MetricFu
         :filename => File.join(MetricFu.output_directory, 'roodi.png'))
     end
   end
+
+  class StatsGchartGrapher < StatsGrapher
+    def graph!
+      determine_y_axis_scale(@loc_counts + @lot_counts)
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Stats: LOC & LOT"),
+        :data => [@loc_counts, @lot_counts],
+        :bar_colors => COLORS[0..1],
+        :legend => ['Lines of code', 'Lines of test'],
+        :custom => "chdlp=t",
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'stats.png'))
+    end
+  end
+
 end

data/lib/graphs/rails_best_practices_grapher.rb

@@ -0,0 +1,25 @@
+module MetricFu
+  
+  class RailsBestPracticesGrapher < Grapher
+    
+    attr_accessor :rails_best_practices_count, :labels
+    
+    def initialize
+      super
+      @rails_best_practices_count = []
+      @labels = {}
+    end
+    
+    def get_metrics(metrics, date)
+      if metrics[:rails_best_practices] && metrics[:rails_best_practices][:problems]
+        size = metrics[:rails_best_practices][:problems].size
+      else
+        size = 0
+      end
+      @rails_best_practices_count.push(size)
+      @labels.update( { @labels.size => date })
+    end
+    
+  end
+  
+end

data/lib/graphs/stats_grapher.rb

@@ -0,0 +1,23 @@
+
+module MetricFu
+  
+  class StatsGrapher < Grapher
+    
+    attr_accessor :loc_counts, :lot_counts, :labels
+    
+    def initialize
+      super
+      self.loc_counts = []
+      self.lot_counts = []
+      self.labels = {}
+    end
+    
+    def get_metrics(metrics, date)
+      self.loc_counts.push(metrics[:stats][:codeLOC].to_i)
+      self.lot_counts.push(metrics[:stats][:testLOC].to_i)
+      self.labels.update( { self.labels.size => date })
+    end
+    
+  end
+  
+end

data/lib/metric_fu.rb

@@ -1,5 +1,6 @@
 require 'rake'
 require 'yaml'
+require 'activesupport'
 # Load a few things to make our lives easier elsewhere.
 module MetricFu
   LIB_ROOT = File.dirname(__FILE__)

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

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

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

@@ -23,6 +23,9 @@
 <% end %>
 <% if @stats %>
   <li class='even failure'><a href="stats.html">Stats</a></li>
+<% end %>  
+<% if @rails_best_practices %>
+  <li class='even failure'><a href="rails_best_practices.html">Rails Best Practices report</a></li>
 <% end %>
 </ul>
 <p>Generated on <%= Time.now.localtime %></p>	

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

@@ -0,0 +1,27 @@
+<h3>Rails Best Practices Results</h3>
+
+<p><a href="http://github.com/flyerhzm/rails_best_practices">rails_best_practices</a> checks quality of rails app files according to ihower’s presentation from Kungfu RailsConf in Shanghai China.</p>
+
+<% graph_name = 'rails_best_practices' %>
+<% if MetricFu.configuration.graph_engine == :gchart %>
+<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
+<% else %>
+<canvas id="graph"></canvas>
+<script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
+<% end %>
+
+<table>
+  <tr>
+    <th>File Path</th>
+    <th>Warning</th>
+  </tr>
+  <% count = 0 %>
+  <% @rails_best_practices[:problems].each do |problem| %>
+    <tr class='<%= cycle("light", "dark", count) %>'>
+      <td><%= link_to_filename(problem[:file], problem[:line]) %></td>
+      <td><%= problem[:problem] %></td>
+    </tr>
+    <% count += 1 %>
+  <% end %>
+</table>
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -1,4 +1,14 @@
 <h3>Rake Stats  Results</h3>
+
+<% graph_name = 'stats' %>
+<% if MetricFu.configuration.graph_engine == :gchart %>
+<img src="<%= graph_name %>.png?<%= Time.now.to_i %>" />
+<% else %>
+<canvas id="graph"></canvas>
+<script language="javascript" src="<%= graph_name %>.js?<%= Time.now.to_i %>" type="text/javascript"></script>
+<% end %>
+
+
 <p>Rails rake stats results.</p>
 <table>
   <tr>

data/lib/templates/standard/index.html.erb

@@ -32,6 +32,9 @@
   <% if @stats %>
     <p><a href="stats.html">Stats report</a></p>
   <% end %>
+  <% if @rails_best_practices %>
+    <p><a href="rails_best_practices.html">Rails Best Practices report</a></p>
+  <% end %>
   <p>Generated on <%= Time.now.localtime %></p>	
 </body>
 </html>

data/lib/templates/standard/rails_best_practices.html.erb

@@ -0,0 +1,29 @@
+<html>
+<head>
+	<title>Rails Best Practices Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+	<h1>Rails Best Practices Results</h1>
+  <a href="index.html">back to menu</a>
+  <p><a href="http://github.com/flyerhzm/rails_best_practices">rails_best_practices</a> checks quality of rails app files according to ihower’s presentation from Kungfu RailsConf in Shanghai China.</p>
+	<table>
+		<tr>
+		  <th>File Path</th>
+		  <th>Warning</th>
+    </tr>
+    <% count = 0 %>
+    <% @rails_best_practices[:problems].each do |problem| %>
+      <tr class='<%= cycle("light", "dark", count) %>'>
+        <td><%= problem[:file] %>:<%= problem[:line] %></td>
+        <td><%= problem[:problem] %></td>
+      </tr>
+      <% count += 1 %>
+  	<% end %>
+	</table>
+	<p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>

data/spec/base/configuration_spec.rb

@@ -87,7 +87,7 @@ describe MetricFu::Configuration do
 
     it 'should set @flay to {:dirs_to_flay => @code_dirs}' do
       @config.instance_variable_get(:@flay).
-              should == {:dirs_to_flay => ['lib'], :minimum_score => 100}
+              should == {:dirs_to_flay => ['lib'], :filetypes=>["rb"], :minimum_score => 100}
     end
     
     it 'should set @flog to {:dirs_to_flog => @code_dirs}' do
@@ -134,7 +134,8 @@ describe MetricFu::Configuration do
                                          "--no-color",
                                          "--profile",
                                          "--rails",
-                                         "--exclude /gems/,/Library/,/usr/,spec"]}
+                                         "--exclude /gems/,/Library/,/usr/,spec"],
+                          :external => nil}
     end
 
     it 'should set @saikuro to { :output_directory => @scratch_directory + "/saikuro",

data/spec/generators/flay_spec.rb

@@ -6,7 +6,7 @@ describe Flay do
   end
   describe "emit method" do
     it "should look at the dirs" do
-      MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => ['app', 'lib']  } }
+      MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => ['app', 'lib'], :filetypes => ['rb']  } }
       File.stub!(:directory?).and_return(true)
       @flay = MetricFu::Flay.new('base_dir')    
     
@@ -15,6 +15,17 @@ describe Flay do
       @flay.should_receive(:`).with("flay path/to/app path/to/lib")
       output = @flay.emit
     end
+
+    it "should look at the filetypes" do
+      MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => ['lib'], :filetypes => ['rb','haml']  } }
+      File.stub!(:directory?).and_return(true)
+      @flay = MetricFu::Flay.new('base_dir')    
+    
+      Dir.should_receive(:[]).with(File.join("lib", "**/*.rb")).and_return("path/to/lib/stuff.rb")
+      Dir.should_receive(:[]).with(File.join("lib", "**/*.haml")).and_return("path/to/lib/view/blah.html.haml")
+      @flay.should_receive(:`).with("flay path/to/lib/stuff.rb path/to/lib/view/blah.html.haml")
+      output = @flay.emit
+    end
     
     it "should limit flay scores by the minimum_score" do
       MetricFu::Configuration.run {|config| config.flay = { :dirs_to_flay => [], :minimum_score => 99 } }

data/spec/generators/flog_spec.rb

@@ -170,6 +170,30 @@ describe Flog do
         flog_page.scanned_methods.first.name.should == "SomeNamespace::UsersController#create"
     end
 
+    it "should find the line number for the method" do
+      text = <<-HERE
+      157.9: flog total
+       11.3: flog/method average
+
+       34.8: SomeNamespace::UsersController#create lib/blah/file.rb:37
+      HERE
+      flog = MetricFu::Flog.new('base_dir')
+      flog_page = flog.parse(text)
+      flog_page.scanned_methods.first.line.should == "37"
+    end
+
+    it "should not add a line number, when none is found" do
+      text = <<-HERE
+      157.9: flog total
+       11.3: flog/method average
+
+       34.8: UsersController#none lib/blah/file.rb
+      HERE
+      flog = MetricFu::Flog.new('base_dir')
+      flog_page = flog.parse(text)
+      flog_page.scanned_methods.first.line.should == nil
+    end
+
     it "should parse empty flog files" do
       text = ""
       flog = MetricFu::Flog.new('base_dir')

data/spec/graphs/engines/bluff_spec.rb

@@ -4,8 +4,11 @@ describe "Bluff graphers responding to #graph!" do
   it "should write chart file" do
     MetricFu.configuration
     graphs = {}
-    MetricFu::AVAILABLE_GRAPHS.each do |graph|
-      graphs[graph] = MetricFu.const_get("#{graph.to_s.capitalize}BluffGrapher").new
+    available_graphs = MetricFu::AVAILABLE_GRAPHS + [:stats]
+    available_graphs.each do |graph|
+      grapher_name = graph.to_s.gsub("MetricFu::",'').gsub(/\/(.?)/) { "::#{$1.upcase}" }.gsub(/(?:^|_)(.)/) { $1.upcase }
+      grapher_name =  grapher_name+"BluffGrapher"
+      graphs[graph] = MetricFu.const_get(grapher_name).new
     end
     graphs.each do |key, val|
       val.graph!
@@ -13,4 +16,4 @@ describe "Bluff graphers responding to #graph!" do
       lambda{ File.open(File.join(output_dir, "#{key.to_s.downcase}.js")) }.should_not raise_error
     end
   end
-end
+end

data/spec/graphs/engines/gchart_spec.rb

@@ -1,4 +1,15 @@
 require File.expand_path(File.dirname(__FILE__) + "/../../spec_helper")
+describe MetricFu::Grapher do
+  describe "require_graphing_gem" do
+    it "should give a warning if trying to use gchart but gem is not installed" do
+      MetricFu::Configuration.run {|config| config.graph_engine = :gchart}
+      MetricFu::Grapher.should_receive(:require).with('gchart').and_raise(LoadError)
+      MetricFu::Grapher.should_receive(:puts).with(/If you want to use google charts/)
+      MetricFu::Grapher.require_graphing_gem
+    end
+  end
+end
+
 describe MetricFu::GchartGrapher do
   describe "determine_y_axis_scale" do
     it "should set defaults when empty array" do
@@ -21,7 +32,7 @@ end
 
 describe "Gchart graphers" do
   before :each do
-    MetricFu.configuration
+    MetricFu::Configuration.run {|config| config.graph_engine = :gchart}
   end
   
   describe "FlayGchartGrapher graph! method" do
@@ -47,7 +58,8 @@ describe "Gchart graphers" do
         :title => URI.escape("Flog: code complexity"),
         :stacked => false,
         :bar_colors => MetricFu::GchartGrapher::COLORS[0..1],
-        :legend => ['average', 'top 5%25 average'],
+        :legend => ['average', 'top 5% average'],
+        :custom => "chdlp=t",
         :axis_with_labels => 'x,y',
         :format => 'file',
         :filename => File.join(MetricFu.output_directory, 'flog.png'),
@@ -105,4 +117,23 @@ describe "Gchart graphers" do
       grapher.graph!
     end
   end
+  
+  describe "StatsGchartGrapher graph! method" do
+    it "should set static values for graph" do
+      grapher = StatsGchartGrapher.new
+      expected = {
+        :size => MetricFu::GchartGrapher::GCHART_GRAPH_SIZE,
+        :title => URI.escape("Stats: LOC & LOT"),
+        :bar_colors => MetricFu::GchartGrapher::COLORS[0..1],
+        :legend => ['Lines of code', 'Lines of test'],
+        :custom => "chdlp=t",
+        :axis_with_labels => 'x,y',
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'stats.png'),
+      }
+      Gchart.should_receive(:line).with(hash_including(expected))
+      grapher.graph!
+    end
+  end
+ 
 end