flyerhzm-metric_fu 1.0.0

data/lib/generators/stats.rb

@@ -0,0 +1,43 @@
+module MetricFu
+
+  class Stats < Generator
+
+    def emit
+      `rake stats > #{metric_directory + '/stats.txt'}`
+    end
+
+    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? }
+      @stats = {}
+      @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|
+        elements = line.split("|")
+        elements.map! {|el| el.strip }
+        elements = elements.find_all {|el| ! el.empty? }
+        info_line = {}
+        info_line[:name] = elements.shift
+        elements.map! {|el| el.to_i }
+        [:lines, :loc, :classes, :methods, 
+         :methods_per_class, :loc_per_method].each do |sym|
+          info_line[sym] = elements.shift
+        end
+        info_line
+      end
+      @stats
+    end
+
+    def to_h
+      {:stats => @stats}
+    end
+
+  end
+end

data/lib/graphs/engines/bluff.rb

@@ -0,0 +1,98 @@
+require 'activesupport'
+
+module MetricFu
+  class Grapher
+    BLUFF_GRAPH_SIZE = "1000x600"
+    BLUFF_DEFAULT_OPTIONS = <<-EOS
+      var g = new Bluff.Line('graph', "#{BLUFF_GRAPH_SIZE}");
+      g.theme_37signals();
+      g.title_font_size = "24px"
+      g.legend_font_size = "12px"
+      g.marker_font_size = "10px"
+    EOS
+  end
+  
+  class FlayBluffGrapher < FlayGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Flay: duplication';
+        g.data('flay', [#{@flay_score.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'flay.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class FlogBluffGrapher < FlogGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Flog: code complexity';
+        g.data('average', [#{@flog_average.join(',')}]);
+        g.data('top 5% average', [#{@top_five_percent_average.join(',')}])
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'flog.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RcovBluffGrapher < RcovGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Rcov: code coverage';
+        g.data('rcov', [#{@rcov_percent.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'rcov.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class ReekBluffGrapher < ReekGrapher
+    def graph!
+      legend = @reek_count.keys.sort
+      data = ""
+      legend.each do |name|
+        data += "g.data('#{name}', [#{@reek_count[name].join(',')}])\n"
+      end
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Reek: code smells';
+        #{data}
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'reek.js'), 'w') {|f| f << content }
+    end
+  end
+
+  class RoodiBluffGrapher < RoodiGrapher
+    def graph!
+      content = <<-EOS
+        #{BLUFF_DEFAULT_OPTIONS}
+        g.title = 'Roodi: design problems';
+        g.data('roodi', [#{@roodi_count.join(',')}]);
+        g.labels = #{@labels.to_json};
+        g.draw();
+      EOS
+      File.open(File.join(MetricFu.output_directory, 'roodi.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

@@ -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

@@ -0,0 +1,20 @@
+module MetricFu
+  
+  class FlayGrapher < Grapher
+    
+    attr_accessor :flay_score, :labels
+    
+    def initialize
+      super
+      @flay_score = []
+      @labels = {}
+    end
+    
+    def get_metrics(metrics, date)
+      @flay_score.push(metrics[:flay][:total_score].to_i)
+      @labels.update( { @labels.size => date })
+    end
+    
+  end
+  
+end

data/lib/graphs/flog_grapher.rb

@@ -0,0 +1,40 @@
+module MetricFu
+  
+  class FlogGrapher < Grapher
+    
+    attr_accessor :flog_average, :labels, :top_five_percent_average
+    
+    def initialize
+      super
+      @flog_average = []
+      @labels = {}
+      @top_five_percent_average =[]
+    end
+    
+    def get_metrics(metrics, date)
+      @top_five_percent_average.push(calc_top_five_percent_average(metrics))
+      @flog_average.push(metrics[:flog][:average])
+      @labels.update( { @labels.size => date })
+    end
+    
+    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
+  
+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/rails_best_practices_grapher.rb

@@ -0,0 +1,20 @@
+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)
+      @rails_best_practices_count.push(metrics[:rails_best_practices][:problems].size)
+      @labels.update( { @labels.size => date })
+    end
+    
+  end
+  
+end

data/lib/graphs/rcov_grapher.rb

@@ -0,0 +1,20 @@
+module MetricFu
+  
+  class RcovGrapher < Grapher
+    
+    attr_accessor :rcov_percent, :labels
+    
+    def initialize
+      super
+      self.rcov_percent = []
+      self.labels = {}
+    end
+    
+    def get_metrics(metrics, date)
+      self.rcov_percent.push(metrics[:rcov][:global_percent_run])
+      self.labels.update( { self.labels.size => date })
+    end
+    
+  end
+  
+end

data/lib/graphs/reek_grapher.rb

@@ -0,0 +1,32 @@
+module MetricFu
+  
+  class ReekGrapher < Grapher
+    
+    attr_accessor :reek_count, :labels
+    
+    def initialize
+      super
+      @reek_count = {}
+      @labels = {}
+    end
+    
+    def get_metrics(metrics, 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...
+          @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
+    
+  end
+  
+end

data/lib/graphs/roodi_grapher.rb

@@ -0,0 +1,20 @@
+module MetricFu
+  
+  class RoodiGrapher < Grapher
+    
+    attr_accessor :roodi_count, :labels
+    
+    def initialize
+      super
+      @roodi_count = []
+      @labels = {}
+    end
+    
+    def get_metrics(metrics, date)
+      @roodi_count.push(metrics[:roodi][:problems].size)
+      @labels.update( { @labels.size => date })
+    end
+    
+  end
+  
+end

data/lib/metric_fu.rb

@@ -0,0 +1,31 @@
+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')
+
+# We need to require these two things first because our other classes
+# depend on them.
+require File.join(base_dir, 'report') 
+require File.join(base_dir, 'generator')
+require File.join(base_dir, 'graph')
+
+# 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}
+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}