nielsm-metric_fu 0.9.1 → 1.1.1

data/lib/graphs/flog_grapher.rb

@@ -0,0 +1,37 @@
+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(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'))
+    end
+    
+  end
+  
+end

data/lib/graphs/rcov_grapher.rb

@@ -0,0 +1,34 @@
+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(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

@@ -0,0 +1,44 @@
+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(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

@@ -0,0 +1,34 @@
+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(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'))
+    end
+    
+  end
+  
+end

data/lib/metric_fu.rb

@@ -1,3 +1,24 @@
-require File.join(File.dirname(__FILE__), 'metric_fu', 'base') #require first because of dependecies
-require File.join(File.dirname(__FILE__), 'tasks', 'metric_fu')
-Dir[File.join(File.dirname(__FILE__), 'metric_fu/*.rb')].each{|l| require l }
+# 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')
+
+# Load the rakefile so users of the gem get the default metric_fu task
+load File.join(MetricFu::LIB_ROOT, '..', 'tasks', 'metric_fu.rake')
+
+# 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}

data/lib/templates/awesome/awesome_template.rb

@@ -0,0 +1,30 @@
+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+$/, "")
+
+    report.each_pair do |section, contents|
+      if template_exists?(section)
+        create_instance_var(section, contents)
+        @html = erbify(section)
+        html = erbify('layout')
+        fn = output_filename(section)
+        MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+      end
+    end
+
+    # Instance variables we need should already be created from above
+    if template_exists?('index')
+      @html = erbify('index')
+      html = erbify('layout')
+      fn = output_filename('index')
+      MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+    end
+  end
+
+  def this_directory
+    File.dirname(__FILE__)
+  end
+end
+

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

@@ -0,0 +1,19 @@
+<h3>Source Control Churn Results</h3>
+<p>Files that change a lot in your project may be bad a sign.
+  This task uses your source control log to identify those files.
+  </p>
+<table>
+  <tr>
+    <th>File Path</th>
+    <th>Times Changed</th>
+  </tr>
+  <% count = 0 %>
+  <% @churn[:changes].each do |change| %>
+    <tr>
+      <td><%= link_to_filename(change[:file_path]) %></td>
+      <td><%= change[:times_changed] %></td>
+    </tr>
+    <% count += 1 %>
+  <% end %>
+</table>
+<p>Generated on <%= Time.now.localtime %></p>	

data/lib/templates/awesome/default.css

@@ -0,0 +1,75 @@
+table {
+  margin-top: 20px;
+  border-collapse: collapse;
+  border: 1px solid #666;
+  background: #fff;
+  margin-bottom: 20px;
+}
+
+table tr.light {
+   background: #fff;
+}
+
+table tr.dark {
+  background: #f9f9f9;
+}
+
+table tr:hover {
+  background: #FFFFC0;
+}
+
+table td, table th {
+  padding: 4px;
+  font-size: 11px;
+}
+table th {
+  text-align: center;
+  color: #337022;
+  background: #DDFFCC;
+  font-weight: bold;
+  border: #99D688 1px solid;
+}
+
+table td {
+  border: #d0d0d0 1px solid;
+}
+
+table td.score {
+  text-align: right;
+}
+
+.warning {
+  background: yellow;
+}
+.rcov_code td {
+  border-bottom: 1px solid #ddd ;
+  padding: 0;
+  margin: 0;
+}
+.rcov_code tr {
+  border: 0px;
+  padding:0px;
+  margin: 0px;
+}
+.rcov_code pre {
+  border: 0px;
+  padding: 0px;
+  margin: 0px;
+}
+.rcov_run {}
+.rcov_not_run {
+  background-color: #d88;
+}
+.rcov_run a, .rcov_not_run a {
+  text-decoration: none;
+}
+.rcov_run a {
+  color: #333;
+}
+.rcov_not_run a {
+  color: #000;
+}
+.rcov_overflow {
+  overflow: auto;
+  font-size: 50%;
+}

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

@@ -0,0 +1,27 @@
+<h3>Flay Results</h3>
+
+<p><a href='http://ruby.sadi.st/Flay.html'>Flay</a> analyzes ruby code for structural similarities.</p>
+
+<img src="flay.png?<%= Time.now %>">
+
+<h4>Total Score (lower is better): <%= @flay[:total_score] %></h4>
+
+<table>
+  <tr>
+    <th>Files</th>
+    <th>Matches</th>		  
+  </tr>
+  <% count = 0 %>
+  <% @flay[:matches].each do |match| %>
+    <tr class='<%= cycle("light", "dark", count) %>'>
+      <td>
+        <% match[:matches].each do |file| %>
+          <%= link_to_filename(file[:name], file[:line]) %><br/>
+        <% end %>
+      </td>
+      <td><%= match[:reason] %></td>
+    </tr>
+    <% count += 1 %>
+  <% end %>
+</table>
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -0,0 +1,46 @@
+<h3>Flog Results</h3>
+<p><a href='http://ruby.sadi.st/Flog.html'>Flog</a> measures code complexity.</p>
+
+<img src="flog.png?<%= Time.now %>">
+
+<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>
+    <th>Total score</th>
+    <th>Methods</th>
+    <th>Average score</th>
+    <th>Highest score</th>
+  </tr>
+    <% @flog[:pages].each do |page| %>
+    <tr>
+      <td><a href="#<%= page[:path].gsub(/[^a-z]+/, '_') %>"><%= page[:path] %></a></td>
+      <td><%= page[:score].round %></td>
+      <td><%= page[:scanned_methods].length %></td>
+      <td><%= page[:average_score].round %></td>
+      <td><%= page[:highest_score].round %></td>
+    </tr>
+  <% end %>
+</table>
+
+<% @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>
+      <table>
+        <tr>
+          <th>Score</th>
+          <th>Operator</th>
+        </tr>
+        <% sm[:operators].each do |operator| %>
+          <tr>
+            <td><%= operator[:score] %></td>
+            <td><%= operator[:operator] %></td>
+          </tr>
+        <% end %>
+      </table>
+    <% end %>
+<% end %>
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -0,0 +1,28 @@
+<h3>Metric Fu Results</h3>
+<ul id='projects'>
+<% if @churn %>
+  <li class='even failure'><a href="churn.html">Churn</a></li>
+<% end %>
+<% if @flay %>
+  <li class='even failure'><a href="flay.html">Flay</a></li>
+<% end %>
+<% if @flog %>
+  <li class='even failure'><a href="flog.html">Flog</a></li>
+<% end %>
+<% if @rcov %>
+  <li class='even failure'><a href="rcov.html">Rcov</a></li>
+<% end %>
+<% if @reek %>
+  <li class='even failure'><a href="reek.html">Reek</a></li>
+<% end %>
+<% if @roodi %>
+  <li class='even failure'><a href="roodi.html">Roodi</a></li>
+<% end %>
+<% if @saikuro %>
+  <li class='even failure'><a href="saikuro.html">Saikuro</a></li>
+<% end %>
+<% if @stats %>
+  <li class='even failure'><a href="stats.html">Stats</a></li>
+<% end %>
+</ul>
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -0,0 +1,27 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <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") %>
+    </style>
+    <link REL="SHORTCUT ICON" HREF="/favicon.ico">
+  </head>
+  <body>
+    <div id='header'>
+      <h1><a href="/">metrics</a> | <a href="index.html"><%= @name %></a></h1>
+      <address class='watermark'>
+        built with
+        <a href='http://metric-fu.rubyforge.org/'>metric-fu</a>
+      </address>
+    </div>
+    <div id='content'>
+      <%= @html %>
+    </div>
+  </body>
+</html>