edouard-metric_fu 1.0.3.8 → 1.0.4

data/README

@@ -1 +1 @@
-See http://metric-fu.rubyforge.org/ for documentation, or the HISTORY file for a change log.
+Same as jscruggs/metric_fu, but with awesome templates and graphs.

data/Rakefile

@@ -20,8 +20,8 @@ namespace :metrics do
   task :all do
     MetricFu.metrics.each {|metric| MetricFu.report.add(metric) }
     MetricFu.report.save_output(MetricFu.report.to_yaml,
-                                MetricFu.base_directory, 
-                                'report.yml')
+                                MetricFu.data_directory, 
+                                "#{Time.now.strftime("%Y%m%d")}.yml")
     MetricFu.report.save_templatized_report
     if MetricFu.report.open_in_browser?
       MetricFu.report.show_in_browser(MetricFu.output_directory)
@@ -34,8 +34,8 @@ namespace :metrics do
 
       MetricFu.report.add(metric)
       MetricFu.report.save_output(MetricFu.report.to_yaml,
-                                  MetricFu.base_directory,
-                                  'report.yml')
+                                  MetricFu.data_directory,
+                                  "#{Time.now.strftime("%Y%m%d")}.yml")
       MetricFu.report.save_templatized_report
       if MetricFu.report.open_in_browser?
         MetricFu.report.show_in_browser(MetricFu.output_directory)

data/lib/base/configuration.rb

@@ -8,6 +8,7 @@ module MetricFu
   AVAILABLE_METRICS = [:churn, :flog, :flay, :reek, 
                        :roodi, :saikuro, :rcov]
 
+  AVAILABLE_GRAPHS = [:flog, :flay, :reek, :roodi, :rcov]
 
   # The @@configuration class variable holds a global type configuration
   # object for any parts of the system to use.
@@ -118,12 +119,14 @@ module MetricFu
       @base_directory = ENV['CC_BUILD_ARTIFACTS'] || 'tmp/metric_fu'
       @scratch_directory = File.join(@base_directory, 'scratch')
       @output_directory = File.join(@base_directory, 'output')
+      @data_directory = File.join(@base_directory, '_data')
       @metric_fu_root_directory = File.join(File.dirname(__FILE__), 
                                                         '..', '..')
       @template_directory =  File.join(@metric_fu_root_directory, 
                                        'lib', 'templates') 
       @template_class = AwesomeTemplate
       set_metrics
+      set_graphs
       set_code_dirs
       @flay     = { :dirs_to_flay => @code_dirs  } 
       @flog     = { :dirs_to_flog => @code_dirs  }
@@ -147,6 +150,14 @@ module MetricFu
                                    "--profile",
                                    "--rails",
                                    "--exclude /gems/,/Library/,/usr/,spec"]}
+                                   
+      @graph_theme = { :colors => %w(orange purple green white red blue pink yellow),
+                       :marker_color => 'blue',
+                       :background_colors => %w(white white)}
+      
+      relative_font_path = [File.dirname(__FILE__), '..', '..', 'vendor', '_fonts', 'monaco.ttf']
+      @graph_font = File.expand_path(File.join(relative_font_path))
+      
     end
 
     # Perform a simple check to try and guess if we're running
@@ -166,6 +177,10 @@ module MetricFu
         @metrics = MetricFu::AVAILABLE_METRICS
       end 
     end
+    
+    def set_graphs
+      @graphs = MetricFu::AVAILABLE_GRAPHS 
+    end
 
     # Add the 'app' directory if we're running within rails.
     def set_code_dirs

data/lib/base/generator.rb

@@ -35,6 +35,7 @@ module MetricFu
     def initialize(options={})
       create_metric_dir_if_missing
       create_output_dir_if_missing
+      create_data_dir_if_missing
     end
     
     # Creates a new generator and returns the output of the 
@@ -82,6 +83,12 @@ module MetricFu
         FileUtils.mkdir_p(MetricFu.output_directory, :verbose => false) 
       end
     end
+    
+    def create_data_dir_if_missing #:nodoc:
+      unless File.directory?(MetricFu.data_directory)
+        FileUtils.mkdir_p(MetricFu.data_directory, :verbose => false) 
+      end
+    end
 
     # @return String
     #   The path of the metric directory this class is using.
@@ -135,8 +142,8 @@ module MetricFu
         information.
       EOF
     end
-
-    def to_h #:nodoc:
+    
+    def to_graph #:nodoc:
       raise <<-EOF
         This method must be implemented by a concrete class descending
         from Generator.  See generator class documentation for more 

data/lib/base/graph.rb

@@ -0,0 +1,37 @@
+module MetricFu
+
+  def self.graph
+    @graph ||= Graph.new
+  end
+
+  class Graph
+    
+    attr_accessor :clazz
+    
+    def initialize
+      self.clazz = []
+    end
+    
+    def add(graph_type)
+      grapher_name = graph_type.to_s.capitalize + "Grapher"
+      self.clazz.push MetricFu.const_get(grapher_name).new
+    end
+    
+    
+    def generate
+      puts "Generating graphs"
+      Dir[File.join(MetricFu.data_directory, '*.yml')].each do |metric_file|
+        puts "Generating graphs for #{metric_file}"
+        date = metric_file.split('/')[3].split('.')[0]
+        metrics = YAML::load(File.open(metric_file))
+        
+        self.clazz.each do |grapher|
+          grapher.get_metrics(metrics, date)
+        end
+      end
+      self.clazz.each do |grapher|
+        grapher.graph!
+      end
+    end
+  end
+end

data/lib/generators/rcov.rb

@@ -5,7 +5,6 @@ module MetricFu
   class Rcov < Generator
     NEW_FILE_MARKER =  ("=" * 80) + "\n"
 
-
     class Line
       attr_accessor :content, :was_run
 

data/lib/graphs/flay_grapher.rb

@@ -0,0 +1,31 @@
+require 'graph'
+require 'gruff'
+module MetricFu
+  
+  class FlayGrapher
+    
+    attr_accessor :flay_score, :labels
+    
+    def initialize
+      self.flay_score = []
+      self.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("1024x768")
+      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.write(File.join(MetricFu.output_directory, 'flay.png'))
+    end
+    
+  end
+  
+end

data/lib/graphs/flog_grapher.rb

@@ -0,0 +1,34 @@
+require 'graph'
+require 'gruff'
+module MetricFu
+  
+  class FlogGrapher
+    
+    attr_accessor :flog_total, :flog_average, :labels
+    
+    def initialize
+      self.flog_total = []
+      self.flog_average = []
+      self.labels = {}
+    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 })
+    end
+    
+    def graph!
+      g = Gruff::Line.new("1024x768")
+      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.write(File.join(MetricFu.output_directory, 'flog.png'))
+    end
+    
+  end
+  
+end

data/lib/graphs/rcov_grapher.rb

@@ -0,0 +1,31 @@
+require 'graph'
+require 'gruff'
+module MetricFu
+  
+  class RcovGrapher
+    
+    attr_accessor :rcov_percent, :labels
+    
+    def initialize
+      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
+    
+    def graph!
+      g = Gruff::Line.new("1024x768")
+      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.write(File.join(MetricFu.output_directory, 'rcov.png'))
+    end
+    
+  end
+  
+end

data/lib/graphs/reek_grapher.rb

@@ -0,0 +1,41 @@
+require 'graph'
+require 'gruff'
+module MetricFu
+  
+  class ReekGrapher
+    
+    attr_accessor :reek_count, :labels
+    
+    def initialize
+      self.reek_count = {}
+      self.labels= {}
+    end
+    
+    def get_metrics(metrics, date)
+      counter = self.labels.size
+      self.labels.update( { counter => 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
+        end
+      end
+    end
+    
+    def graph!
+      g = Gruff::Line.new("1024x768")
+      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.write(File.join(MetricFu.output_directory, 'reek.png'))
+    end
+    
+  end
+  
+end

data/lib/graphs/roodi_grapher.rb

@@ -0,0 +1,31 @@
+require 'graph'
+require 'gruff'
+module MetricFu
+  
+  class RoodiGrapher
+    
+    attr_accessor :roodi_count, :labels
+    
+    def initialize
+      self.roodi_count = []
+      self.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("1024x768")
+      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.write(File.join(MetricFu.output_directory, 'roodi.png'))
+    end
+    
+  end
+  
+end

data/lib/metric_fu.rb

@@ -5,11 +5,13 @@ 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')
 
 # Load the rakefile so users of the gem get the default metric_fu task
 load File.join(MetricFu::LIB_ROOT, '..', 'tasks', 'metric_fu.rake')
@@ -19,3 +21,4 @@ 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}

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

@@ -1,6 +1,13 @@
 <h3>Flay Results</h3>
+
+<p><a href='http://ruby.sadi.st/Flay.html'>Flay</a> analyzes ruby code for structural similarities.</p>
+
+<a href="flay.png?<%= Time.now.localtime %>">
+  <img src="flay.png?<%= Time.now.localtime %>" width="400">
+</a>
+
 <h4>Total Score (lower is better): <%= @flay[:total_score] %></h4>
-<p><a href='http://ruby.sadi.st/Flay.html'>Flay</a> analyzes ruby code for structural similarities.</p>  
+
 <table>
   <tr>
     <th>Files</th>

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

@@ -1,7 +1,13 @@
 <h3>Flog Results</h3>
 <p><a href='http://ruby.sadi.st/Flog.html'>Flog</a> measures code complexity.</p>
+
+<a href="flog.png?<%= Time.now.localtime %>">
+  <img src="flog.png?<%= Time.now.localtime %>" width="400">
+</a>
+
 <h2>Total Flog score for all methods: <%= @flog[:total]%></h2>
 <h2>Average Flog score for all methods: <%= @flog[:average]%></h2>
+
 <table>
   <tr>
     <th>File</th>

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

@@ -1,5 +1,11 @@
 <h3>Rcov Code Coverage Results</h3>
+
 <p>C0 code coverage information.</p>
+
+<a href="rcov.png?<%= Time.now.localtime %>">
+  <img src="rcov.png?<%= Time.now.localtime %>" width="400">
+</a>
+
 <p>Total Coverage: <%= @rcov.delete(:global_percent_run) %>% </p>
 <table>
   <tr>

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

@@ -1,5 +1,11 @@
 <h3>Reek Results</h3>
+
 <p><a href="http://reek.rubyforge.org/">Reek</a> detects common code smells in ruby code.</p>
+
+<a href="reek.png?<%= Time.now.localtime %>">
+  <img src="reek.png?<%= Time.now.localtime %>" width="400">
+</a>
+
 <table>
   <tr>
     <th>File Path</th>

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

@@ -1,5 +1,11 @@
 <h3>Roodi Results</h3>
+
 <p><a href="http://roodi.rubyforge.org/">Roodi</a> parses your Ruby code and warns you about design issues you have based on the checks that is has configured.</p>
+
+<a href="roodi.png?<%= Time.now.localtime %>">
+  <img src="roodi.png?<%= Time.now.localtime %>" width="400">
+</a>
+
 <table>
   <tr>
     <th>File Path</th>

data/tasks/metric_fu.rake

@@ -5,9 +5,13 @@ namespace :metrics do
     MetricFu::Configuration.run {}
     MetricFu.metrics.each {|metric| MetricFu.report.add(metric) }
     MetricFu.report.save_output(MetricFu.report.to_yaml,
-                                MetricFu.base_directory, 
-                                'report.yml')
+                                MetricFu.data_directory, 
+                                "#{Time.now.strftime("%Y%m%d")}.yml")
     MetricFu.report.save_templatized_report
+    
+    MetricFu.graphs.each {|graph| MetricFu.graph.add(graph) }
+    MetricFu.graph.generate
+    
     if MetricFu.report.open_in_browser?
       MetricFu.report.show_in_browser(MetricFu.output_directory)
     end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: edouard-metric_fu
 version: !ruby/object:Gem::Version 
-  version: 1.0.3.8
+  version: 1.0.4
 platform: ruby
 authors: 
 - Jake Scruggs
@@ -78,8 +78,18 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 0.3.0
     version: 
+- !ruby/object:Gem::Dependency 
+  name: topfunky-gruff
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.3.5
+    version: 
 description: Code metrics from Flog, Flay, RCov, Saikuro, Churn, Reek, Roodi and Rails' stats task
-email: jake.scruggs@gmail.com
+email: edouard.briere@gmail.com
 executables: []
 
 extensions: []
@@ -131,7 +141,14 @@ files:
 - lib/templates/awesome/awesome_template.rb
 - lib/templates/awesome/stats.html.erb
 - lib/templates/awesome/layout.html.erb
+- lib/base/graph.rb
+- lib/graphs/flay_grapher.rb
+- lib/graphs/flog_grapher.rb
+- lib/graphs/rcov_grapher.rb
+- lib/graphs/reek_grapher.rb
+- lib/graphs/roodi_grapher.rb
 - tasks/metric_fu.rake
+- vendor/_fonts/monaco.ttf
 - tasks/railroad.rake
 - vendor/saikuro/saikuro.rb
 - Manifest.txt
@@ -161,7 +178,7 @@ rubyforge_project:
 rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: A fistful of code metrics
+summary: A fistful of code metrics, with awesome templates and graphs
 test_files: 
 - spec/base/base_template_spec.rb
 - spec/base/configuration_spec.rb