edouard-metric_fu 1.1.1 → 1.2.0

data/lib/graphs/engines/gchart.rb

@@ -0,0 +1,119 @@
+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
+    
+    NUMBER_OF_TICKS = 6
+    def determine_y_axis_scale(values)
+      values.collect! {|val| val || 0.0 }
+      if values.empty?
+        @max_value = 10
+        @yaxis = [0, 2, 4, 6, 8, 10]
+      else
+        @max_value = values.max + Integer(0.1 * values.max)
+        portion_size = (@max_value / (NUMBER_OF_TICKS - 1).to_f).ceil
+        @yaxis = []
+        NUMBER_OF_TICKS.times {|n| @yaxis << Integer(portion_size * n) }
+        @max_value = @yaxis.last
+      end
+    end
+  end
+  
+  class Grapher
+    include MetricFu::GchartGrapher
+    
+    def self.require_graphing_gem
+      require 'gchart'
+    rescue LoadError
+      puts "#"*99 + "\n" +
+           "If you want to use google charts for graphing, you'll need to install the googlecharts rubygem." +
+           "\n" + "#"*99
+    end
+  end
+
+  class FlayGchartGrapher < FlayGrapher
+    def graph!
+      determine_y_axis_scale(@flay_score)
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Flay: duplication"),
+        :data => @flay_score,
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'flay.png'))
+    end
+  end
+
+  class FlogGchartGrapher < FlogGrapher
+    def graph!
+      determine_y_axis_scale(@top_five_percent_average + @flog_average)
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Flog: code complexity"),
+        :data => [@flog_average, @top_five_percent_average],
+        :stacked => false,
+        :bar_colors => COLORS[0..1],
+        :legend => ['average', 'top 5%25 average'],
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'flog.png'))
+    end
+  end
+  
+  class RcovGchartGrapher < RcovGrapher
+    def graph!
+      determine_y_axis_scale(self.rcov_percent)
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Rcov: code coverage"),
+        :data => self.rcov_percent,
+        :max_value => 101,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [self.labels.values, [0,20,40,60,80,100]],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'rcov.png')
+      )
+    end
+  end
+
+  class ReekGchartGrapher < ReekGrapher
+    def graph!
+      determine_y_axis_scale(@reek_count.values.flatten.uniq)
+      values = []
+      legend = @reek_count.keys.sort
+      legend.collect {|k| values << @reek_count[k]}
+    
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Reek: code smells"),
+        :data => values,
+        :stacked => false,
+        :bar_colors => COLORS,
+        :legend => legend,
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'reek.png'))
+    end
+  end
+  
+  class RoodiGchartGrapher < RoodiGrapher
+    def graph!
+      determine_y_axis_scale(@roodi_count)
+      url = Gchart.line(
+        :size => GCHART_GRAPH_SIZE,
+        :title => URI.escape("Roodi: potential design problems"),
+        :data => @roodi_count,
+        :max_value => @max_value,
+        :axis_with_labels => 'x,y',
+        :axis_labels => [@labels.values, @yaxis],
+        :format => 'file',
+        :filename => File.join(MetricFu.output_directory, 'roodi.png'))
+    end
+  end
+end

data/lib/graphs/flay_grapher.rb

@@ -1,32 +1,18 @@
-require 'gruff'
 module MetricFu
   
-  class FlayGrapher
+  class FlayGrapher < Grapher
     
     attr_accessor :flay_score, :labels
     
     def initialize
-      self.flay_score = []
-      self.labels = {}
+      super
+      @flay_score = []
+      @labels = {}
     end
     
     def get_metrics(metrics, date)
-      self.flay_score.push(metrics[:flay][:total_score].to_i)
-      self.labels.update( { self.labels.size => date })
-    end
-    
-    def graph!
-      g = Gruff::Line.new(MetricFu.graph_size)
-      g.title = "Flay: duplication"
-      g.theme = MetricFu.graph_theme
-      g.font = MetricFu.graph_font
-      g.data('flay', self.flay_score)
-      g.labels = self.labels
-      g.title_font_size = MetricFu.graph_title_font_size
-      g.legend_box_size = MetricFu.graph_legend_box_size
-      g.legend_font_size = MetricFu.graph_legend_font_size
-      g.marker_font_size = MetricFu.graph_marker_font_size
-      g.write(File.join(MetricFu.output_directory, 'flay.png'))
+      @flay_score.push(metrics[:flay][:total_score].to_i)
+      @labels.update( { @labels.size => date })
     end
     
   end

data/lib/graphs/flog_grapher.rb

@@ -1,35 +1,38 @@
-require 'gruff'
 module MetricFu
   
-  class FlogGrapher
+  class FlogGrapher < Grapher
     
-    attr_accessor :flog_total, :flog_average, :labels
+    attr_accessor :flog_average, :labels, :top_five_percent_average
     
     def initialize
-      self.flog_total = []
-      self.flog_average = []
-      self.labels = {}
+      super
+      @flog_average = []
+      @labels = {}
+      @top_five_percent_average =[]
     end
     
     def get_metrics(metrics, date)
-      self.flog_total.push(metrics[:flog][:total])
-      self.flog_average.push(metrics[:flog][:average])
-      self.labels.update( { self.labels.size => date })
+      @top_five_percent_average.push(calc_top_five_percent_average(metrics))
+      @flog_average.push(metrics[:flog][:average])
+      @labels.update( { @labels.size => date })
     end
     
-    def graph!
-      g = Gruff::Line.new(MetricFu.graph_size)
-      g.title = "Flog: code complexity"
-      g.theme = MetricFu.graph_theme
-      g.font = MetricFu.graph_font
-      g.data('flog total', self.flog_total)
-      g.data('flog average', self.flog_average)
-      g.labels = self.labels
-      g.title_font_size = MetricFu.graph_title_font_size
-      g.legend_box_size = MetricFu.graph_legend_box_size
-      g.legend_font_size = MetricFu.graph_legend_font_size
-      g.marker_font_size = MetricFu.graph_marker_font_size
-      g.write(File.join(MetricFu.output_directory, 'flog.png'))
+    private
+    
+    def calc_top_five_percent_average(metrics)
+      methods = metrics[:flog][:pages].inject([]) {|methods, page| methods << page[:scanned_methods]}
+      methods.flatten!
+      methods = methods.sort_by {|method| method[:score]}.reverse
+
+      number_of_methods_that_is_five_percent = (methods.size * 0.05).ceil
+
+      total_for_five_percent =
+        methods[0...number_of_methods_that_is_five_percent].inject(0) {|total, method| total += method[:score] }
+      if number_of_methods_that_is_five_percent == 0
+        0.0
+      else
+        total_for_five_percent / number_of_methods_that_is_five_percent.to_f
+      end
     end
     
   end

data/lib/graphs/grapher.rb

@@ -0,0 +1,11 @@
+module MetricFu
+  class Grapher
+    def initialize
+      self.class.require_graphing_gem
+    end
+    
+    def self.require_graphing_gem
+      # to be overridden by charting engines
+    end
+  end
+end

data/lib/graphs/rcov_grapher.rb

@@ -1,11 +1,11 @@
-require 'gruff'
 module MetricFu
   
-  class RcovGrapher
+  class RcovGrapher < Grapher
     
     attr_accessor :rcov_percent, :labels
     
     def initialize
+      super
       self.rcov_percent = []
       self.labels = {}
     end
@@ -15,20 +15,6 @@ module MetricFu
       self.labels.update( { self.labels.size => date })
     end
     
-    def graph!
-      g = Gruff::Line.new(MetricFu.graph_size)
-      g.title = "Rcov: code coverage"
-      g.theme = MetricFu.graph_theme
-      g.font = MetricFu.graph_font
-      g.data('rcov', self.rcov_percent)
-      g.labels = self.labels
-      g.title_font_size = MetricFu.graph_title_font_size
-      g.legend_box_size = MetricFu.graph_legend_box_size
-      g.legend_font_size = MetricFu.graph_legend_font_size
-      g.marker_font_size = MetricFu.graph_marker_font_size
-      g.write(File.join(MetricFu.output_directory, 'rcov.png'))
-    end
-    
   end
   
 end

data/lib/graphs/reek_grapher.rb

@@ -1,44 +1,32 @@
-require 'gruff'
 module MetricFu
   
-  class ReekGrapher
+  class ReekGrapher < Grapher
     
     attr_accessor :reek_count, :labels
     
     def initialize
-      self.reek_count = {}
-      self.labels= {}
+      super
+      @reek_count = {}
+      @labels = {}
     end
     
     def get_metrics(metrics, date)
-      counter = self.labels.size
-      self.labels.update( { counter => date })
+      counter = @labels.size
+      @labels.update( { @labels.size => date })
       
       metrics[:reek][:matches].each do |reek_chunk|
         reek_chunk[:code_smells].each do |code_smell|
           # speaking of code smell...
-          self.reek_count[code_smell[:type]] = [] if self.reek_count[code_smell[:type]].nil?
-          self.reek_count[code_smell[:type]][counter].nil? ? self.reek_count[code_smell[:type]][counter] = 1 : self.reek_count[code_smell[:type]][counter] += 1
+          @reek_count[code_smell[:type]] = [] if @reek_count[code_smell[:type]].nil?
+          if @reek_count[code_smell[:type]][counter].nil?
+            @reek_count[code_smell[:type]][counter] = 1
+          else
+            @reek_count[code_smell[:type]][counter] += 1
+          end
         end
       end
     end
     
-    def graph!
-      g = Gruff::Line.new(MetricFu.graph_size)
-      g.title = "Reek: code smells"
-      g.theme = MetricFu.graph_theme
-      g.font = MetricFu.graph_font
-      self.reek_count.each_pair do |type, count|
-        g.data(type, count)
-      end
-      g.labels = self.labels
-      g.title_font_size = MetricFu.graph_title_font_size
-      g.legend_box_size = MetricFu.graph_legend_box_size
-      g.legend_font_size = MetricFu.graph_legend_font_size
-      g.marker_font_size = MetricFu.graph_marker_font_size
-      g.write(File.join(MetricFu.output_directory, 'reek.png'))
-    end
-    
   end
   
 end

data/lib/graphs/roodi_grapher.rb

@@ -1,32 +1,18 @@
-require 'gruff'
 module MetricFu
   
-  class RoodiGrapher
+  class RoodiGrapher < Grapher
     
     attr_accessor :roodi_count, :labels
     
     def initialize
-      self.roodi_count = []
-      self.labels = {}
+      super
+      @roodi_count = []
+      @labels = {}
     end
     
     def get_metrics(metrics, date)
-      self.roodi_count.push(metrics[:roodi][:problems].size)
-      self.labels.update( { self.labels.size  => date })
-    end
-    
-    def graph!
-      g = Gruff::Line.new(MetricFu.graph_size)
-      g.title = "Roodi: design problems"
-      g.theme = MetricFu.graph_theme
-      g.font = MetricFu.graph_font
-      g.data('roodi', self.roodi_count)
-      g.labels = self.labels
-      g.title_font_size = MetricFu.graph_title_font_size
-      g.legend_box_size = MetricFu.graph_legend_box_size
-      g.legend_font_size = MetricFu.graph_legend_font_size
-      g.marker_font_size = MetricFu.graph_marker_font_size
-      g.write(File.join(MetricFu.output_directory, 'roodi.png'))
+      @roodi_count.push(metrics[:roodi][:problems].size)
+      @labels.update( { @labels.size => date })
     end
     
   end

data/lib/metric_fu.rb

@@ -1,11 +1,13 @@
+require 'rake'
+require 'yaml'
 # Load a few things to make our lives easier elsewhere.
 module MetricFu
   LIB_ROOT = File.dirname(__FILE__)
 end
 base_dir = File.join(MetricFu::LIB_ROOT, 'base')
-generator_dir = File.join(MetricFu::LIB_ROOT, 'generators')
-template_dir  = File.join(MetricFu::LIB_ROOT, 'templates')
-graph_dir     = File.join(MetricFu::LIB_ROOT, 'graphs')
+generator_dir    = File.join(MetricFu::LIB_ROOT, 'generators')
+template_dir     = File.join(MetricFu::LIB_ROOT, 'templates')
+graph_dir        = File.join(MetricFu::LIB_ROOT, 'graphs')
 
 # We need to require these two things first because our other classes
 # depend on them.
@@ -13,12 +15,17 @@ require File.join(base_dir, 'report')
 require File.join(base_dir, 'generator')
 require File.join(base_dir, 'graph')
 
-# Load the rakefile so users of the gem get the default metric_fu task
-load File.join(MetricFu::LIB_ROOT, '..', 'tasks', 'metric_fu.rake')
+# prevent the task from being run multiple times.
+unless Rake::Task.task_defined? "metrics:all"
+  # Load the rakefile so users of the gem get the default metric_fu task
+  load File.join(MetricFu::LIB_ROOT, '..', 'tasks', 'metric_fu.rake')
+end
 
 # Now load everything else that's in the directory
 Dir[File.join(base_dir, '*.rb')].each{|l| require l }
 Dir[File.join(generator_dir, '*.rb')].each {|l| require l }
 Dir[File.join(template_dir, 'standard/*.rb')].each {|l| require l}
 Dir[File.join(template_dir, 'awesome/*.rb')].each {|l| require l}
-Dir[File.join(graph_dir, '*.rb')].each {|l| require l}
+require graph_dir + "/grapher"
+Dir[File.join(graph_dir, '*.rb')].each {|l| require l}
+Dir[File.join(graph_dir, 'engines', '*.rb')].each {|l| require l}

data/lib/templates/awesome/awesome_template.rb

@@ -1,9 +1,16 @@
+require 'fileutils'
+
 class AwesomeTemplate < MetricFu::Template
 
   def write
     # Getting rid of the crap before and after the project name from integrity
     @name = File.basename(Dir.pwd).gsub(/^\w+-|-\w+$/, "")
 
+    # Copy Bluff javascripts to output directory
+    Dir[File.join(this_directory, '..', 'javascripts', '*')].each do |f|
+      FileUtils.copy(f, File.join(MetricFu.output_directory, File.basename(f)))
+    end
+
     report.each_pair do |section, contents|
       if template_exists?(section)
         create_instance_var(section, contents)

data/lib/templates/awesome/css/buttons.css

@@ -0,0 +1,82 @@
+/* --------------------------------------------------------------
+
+   buttons.css
+   * Gives you some great CSS-only buttons.
+
+   Created by Kevin Hale [particletree.com]
+   * particletree.com/features/rediscovering-the-button-element
+
+   See Readme.txt in this folder for instructions.
+
+-------------------------------------------------------------- */
+
+button {
+  display:block;
+  float:left;
+  margin:0 0.583em 0.667em 0;
+  padding:5px 10px 5px 7px;   /* Links */
+
+  border:1px solid #dedede;
+  border-top:1px solid #eee;
+  border-left:1px solid #eee;
+
+  background-color:#f5f5f5;
+  font-family:"Lucida Grande", Tahoma, Arial, Verdana, sans-serif;
+  font-size:100%;
+  line-height:130%;
+  text-decoration:none;
+  font-weight:bold;
+  color:#565656;
+  cursor:pointer;
+}
+button {
+  width:auto;
+  overflow:visible;
+  padding:4px 10px 3px 7px;   /* IE6 */
+}
+button[type] {
+  padding:4px 10px 4px 7px;   /* Firefox */
+  line-height:17px;           /* Safari */
+}
+*:first-child+html button[type] {
+  padding:4px 10px 3px 7px;   /* IE7 */
+}
+button img {
+  margin:0 3px -3px 0 !important;
+  padding:0;
+  border:none;
+  width:16px;
+  height:16px;
+  float:none;
+}
+
+
+/* Button colors
+-------------------------------------------------------------- */
+
+/* Standard */
+button:hover {
+  background-color:#dff4ff;
+  border:1px solid #c2e1ef;
+  color:#336699;
+}
+
+/* Positive */
+body .positive {
+  color:#529214;
+}
+button.positive:hover {
+  background-color:#E6EFC2;
+  border:1px solid #C6D880;
+  color:#529214;
+}
+
+/* Negative */
+body .negative {
+  color:#d12f19;
+}
+button.negative:hover {
+  background:#fbe3e4;
+  border:1px solid #fbc2c4;
+  color:#d12f19;
+}