nielsm-metric_fu 1.1.1 → 1.3.1

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/churn.html.erb

@@ -16,4 +16,43 @@
     <% count += 1 %>
   <% end %>
 </table>
+
+<% if @churn[:class_churn] %>
+<p>Classes that change a lot in your project may be bad a sign.</p>
+<table>
+  <tr>
+    <th>File Path</th>
+    <th>Times Changed</th>
+  </tr>
+  <% count = 0 %>
+  <% @churn[:class_churn].each do |change| %>
+    <tr>
+      <td><%= link_to_filename(change['klass']['file']) %> <%= change['klass']['klass'] %></td>
+      <td><%= change['times_changed'] %></td>
+    </tr>
+    <% count += 1 %>
+  <% end %>
+</table>
+<% end %>
+
+<% if @churn[:method_churn] %>
+<p>Methods that change a lot in your project may be bad a sign.</p>
+<table>
+  <tr>
+    <th>File Path</th>
+    <th>Times Changed</th>
+  </tr>
+  <% count = 0 %>
+  <% @churn[:method_churn].each do |change| %>
+    <tr>
+      <td><%= link_to_filename(change['method']['file']) %> <%= change['method']['method'] %></td>
+      <td><%= change['times_changed'] %></td>
+    </tr>
+    <% count += 1 %>
+  <% end %>
+</table>
+<% end %>
+
+
+
 <p>Generated on <%= Time.now.localtime %></p>	

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;
+}

data/lib/templates/awesome/{default.css → css/default.css}

@@ -73,3 +73,19 @@ table td.score {
   overflow: auto;
   font-size: 50%;
 }
+
+.bluff-tooltip {
+	background: #fff;
+	border: 1px solid #d1edf5;
+	padding: 8px 8px 6px;
+}
+.bluff-tooltip .color {
+	display: block;
+	height: 4px;
+	width: 30px;
+	margin: 0 0 4px;
+	overflow: hidden;
+}
+.bluff-tooltip .data {
+	font-weight: bold;
+}

data/lib/templates/awesome/css/integrity.css

@@ -0,0 +1,335 @@
+html {
+  background-color: #e0e0e0; }
+
+body {
+  font-size: 100%;
+  font-family: Helvetica Neue, Helvetica, Arial, sans-serif;
+  color: #333333; }
+
+a {
+  color: #ed1556;
+  text-decoration: none; }
+  a:hover {
+    color: #ffffff;
+    background-color: #ed1556; }
+
+#header, #content, #footer {
+  margin: 0 auto;
+  background: #eeeeee;
+  padding: 0 2em;
+  z-index: 0;
+  position: relative;
+  font-size: 1em; }
+
+#header {
+  background: #ffffff; }
+  #header h1 {
+    font-weight: bold;
+    font-size: 1.5em; }
+  #header address.watermark {
+    position: absolute;
+    font-weight: bold;
+    right: 3em;
+    top: 0;
+    font-size: .75em;
+    color: #cccccc; }
+    #header address.watermark a {
+      color: #cccccc;
+      font-weight: bold;
+      font-size: 2em; }
+      #header address.watermark a:hover {
+        background: transparent;
+        color: #aaaaaa; }
+
+#content {
+  padding-top: 1em;
+  padding-bottom: 2em; }
+  #content strong {
+    font-weight: bold; }
+  #content em {
+    font-style: italic; }
+  #content h1, #content h2, #content h3, #content h4, #content h5, #content h6 {
+    color: #4e4e4e; }
+  #content h1 {
+    font-size: 2em;
+    font-weight: bold;
+    margin-bottom: .75em;
+    padding: .25em 0;
+    line-height: 1.2;
+    border-bottom: 1px solid #c0c0c0; }
+  #content h2 {
+    font-weight: bold;
+    font-size: 1.5em;
+    margin: 1em 0 .2em; }
+  #content h3 {
+    font-weight: bold;
+    font-size: 1.25em;
+    margin: .25em 0; }
+  #content h4, #content h5, #content h6 {
+    font-weight: bold;
+    margin-top: .5em; }
+  #content code, #content pre, #content textarea, #content input {
+    font-family: Monaco, Deja Vu Sans Mono, Inconsolata, Consolas, monospace; }
+  #content form p {
+    margin-top: 1em;
+    position: relative; }
+    #content form p.checkbox label {
+      margin-top: 0 !important; }
+  #content form input.text, #content form textarea {
+    width: 30em;
+    padding: .2em .4em;
+    color: #4e4e4e; }
+  #content form input.text {
+    height: 1.4em; }
+  #content form label {
+    float: left;
+    display: block;
+    margin-top: .5em;
+    width: 8em;
+    margin-right: .75em; }
+  #content form .with_errors label {
+    background: red;
+    color: white;
+    position: relative;
+    top: -.7em; }
+  #content form .with_errors.required label {
+    position: static;
+    margin-right: .25em;
+    padding: 0 .2em; }
+  #content form .with_errors input, #content form .with_errors textarea {
+    border: 2px solid #f22;
+    background: #fee;
+    color: #222222; }
+  #content form .required label {
+    float: none;
+    display: block;
+    width: auto;
+    position: relative;
+    font-weight: bold;
+    margin-top: 1em;
+    text-indent: -.65em; }
+    #content form .required label:before {
+      content: "* ";
+      color: #ed1556; }
+  #content form .required input.text {
+    width: 25.6em;
+    font-size: 24px;
+    font-weight: bold; }
+  #content form .normal {
+    margin-top: 2em; }
+  #content form h2.notifier label {
+    float: none;
+    width: auto;
+    margin-right: 0; }
+    #content form h2.notifier label .warning {
+      font-size: .5em;
+      font-weight: normal;
+      color: #999999; }
+  #content form fieldset {
+    padding-bottom: 1em;
+    margin-left: 1.35em;
+    border-bottom: 1px solid #c0c0c0;
+    margin-bottom: 1em; }
+    #content form fieldset h3 {
+      margin-top: 1em;
+      margin-bottom: 0; }
+    #content form fieldset p.normal {
+      margin-top: 1em; }
+    #content form fieldset p label {
+      width: 6.7em; }
+  #content form p.submit {
+    margin-top: 2em; }
+    #content form p.submit:after {
+      display: block;
+      clear: both;
+      float: none;
+      content: ".";
+      text-indent: -9999em;
+      text-align: left; }
+    #content form p.submit.destroy button,     #content form p.submit.manual-build button {
+      float: none;
+      display: inline; }
+    #content form p.submit.manual-build button {
+      margin-right: 0; }
+  #content #build form, #content #last_build form {
+    font-size: .75em; }
+    #content #build form p.submit,     #content #last_build form p.submit {
+      margin: 0;
+      padding: 0;
+      position: absolute;
+      right: .5em;
+      top: 1.25em; }
+  #content .blank_slate p,   #content .error p {
+    position: relative;
+    top: .3em; }
+  #content .blank_slate h1,   #content .error h1 {
+    border-width: 0;
+    margin: 0;
+    padding: 0; }
+    #content .blank_slate h1 button,     #content .error h1 button {
+      float: none;
+      border: 0 none;
+      background: transparent;
+      display: inline;
+      color: #ed1556;
+      padding: 0.25em 0;
+      margin: 0; }
+      #content .blank_slate h1 button:hover,       #content .error h1 button:hover {
+        background: #ed1556;
+        color: #ffffff; }
+  #content .error dt {
+    margin-top: 1.4em;
+    margin-bottom: .3em;
+    font-size: 1.75em;
+    font-family: Georgia, Times New Roman, serif; }
+  #content .error dd {
+    line-height: 1.4; }
+  #content .error .backtrace {
+    margin: 1em 0;
+    overflow: scroll;
+    height: 30em;
+    border: 1px solid #c0c0c0;
+    line-height: 1.6; }
+  #content #projects {
+    margin: 1em 0 2em;
+    border-top: 1px solid #c0c0c0; }
+    #content #projects li {
+      position: relative;
+      border-bottom: 1px solid #c0c0c0; }
+      #content #projects li.odd {
+        background: #e6e6e6; }
+      #content #projects li.building {
+        background: transparent url(/spinner.gif) no-repeat scroll right; }
+      #content #projects li a {
+        font-size: 2em;
+        padding: .25em;
+        line-height: 1.2;
+        font-weight: bold;
+        display: block; }
+        #content #projects li a.success {
+          color: #337022; }
+        #content #projects li a.failed {
+          color: #ff1100; }
+      #content #projects li .meta {
+        position: absolute;
+        right: .6em;
+        top: 1.5em;
+        font-size: 0.8em;
+        color: #999999;
+        text-align: right; }
+      #content #projects li.building .meta {
+        right: 1.6em; }
+      #content #projects li.success .meta {
+        color: #337022; }
+      #content #projects li.failed .meta {
+        color: #ff1100; }
+  #content #previous_builds li a {
+    display: block;
+    padding: .25em;
+    margin-bottom: .25em;
+    border-width: 1px;
+    border-style: solid; }
+    #content #previous_builds li a strong {
+      font-size: 1.3em; }
+    #content #previous_builds li a .attribution {
+      font-size: .9em; }
+  #content #projects li.success a,   #content #previous_builds li.success a {
+    background-color: #bbf8aa;
+    border-color: #99d688;
+    color: #337022; }
+    #content #projects li.success a .attribution,     #content #previous_builds li.success a .attribution {
+      color: #77b466; }
+    #content #projects li.success a:hover,     #content #previous_builds li.success a:hover {
+      background-color: #ddffcc; }
+  #content #projects li.failed a,   #content #previous_builds li.failed a {
+    background-color: #ffbbaa;
+    border-color: #dd9988;
+    color: #ff1100; }
+    #content #projects li.failed a .attribution,     #content #previous_builds li.failed a .attribution {
+      color: #bb7766; }
+    #content #projects li.failed a:hover,     #content #previous_builds li.failed a:hover {
+      background-color: #ffddcc; }
+  #content #build, #content #last_build {
+    position: relative; }
+    #content #build h1, #content #build blockquote,     #content #last_build h1, #content #last_build blockquote {
+      border-width: 0 1px;
+      border-style: solid; }
+    #content #build h1,     #content #last_build h1 {
+      border-top-width: 1px; }
+    #content #build blockquote,     #content #last_build blockquote {
+      bottom-bottom-width: 1px;
+      line-height: 1.4; }
+    #content #build.success h1, #content #build.success blockquote,     #content #last_build.success h1, #content #last_build.success blockquote {
+      background-color: #bbf8aa;
+      border-color: #99d688 #ccffbb #ccffbb #99d688; }
+    #content #build.success h1,     #content #last_build.success h1 {
+      color: #337022; }
+    #content #build.success .meta,     #content #last_build.success .meta {
+      color: #77b466; }
+    #content #build.failed h1, #content #build.failed blockquote,     #content #last_build.failed h1, #content #last_build.failed blockquote {
+      background-color: #ffbbaa;
+      border-color: #dd9988 #ffccbb #ffccbb #dd9988; }
+    #content #build.failed h1,     #content #last_build.failed h1 {
+      color: #ff1100; }
+    #content #build.failed .meta,     #content #last_build.failed .meta {
+      color: #bb7766; }
+    #content #build h1,     #content #last_build h1 {
+      margin-top: .5em;
+      margin-bottom: 0;
+      padding: .25em;
+      color: #337022; }
+    #content #build blockquote,     #content #last_build blockquote {
+      padding: .75em;
+      margin-bottom: 2em; }
+      #content #build blockquote .meta,       #content #last_build blockquote .meta {
+        margin-top: 1em;
+        display: block;
+        font-size: .9em; }
+    #content #build pre.output,     #content #last_build pre.output {
+      background: #111;
+      color: #fff;
+      padding: .5em;
+      overflow: auto;
+      max-height: 50em;
+      font-size: .825em; }
+      #content #build pre.output .color30,       #content #last_build pre.output .color30 {
+        color: #333; }
+      #content #build pre.output .color31,       #content #last_build pre.output .color31 {
+        color: #e33; }
+      #content #build pre.output .color32,       #content #last_build pre.output .color32 {
+        color: #3e3; }
+      #content #build pre.output .color33,       #content #last_build pre.output .color33 {
+        color: #ee3; }
+      #content #build pre.output .color34,       #content #last_build pre.output .color34 {
+        color: #33e; }
+      #content #build pre.output .color35,       #content #last_build pre.output .color35 {
+        color: #e3e; }
+      #content #build pre.output .color36,       #content #last_build pre.output .color36 {
+        color: #3ee; }
+      #content #build pre.output .color37,       #content #last_build pre.output .color37 {
+        color: #fff; }
+  #content #push_path {
+    display: block;
+    margin-top: 1em;
+    margin-left: 2em; }
+
+a.success {
+  color: #bbf8aa; }
+  a.success:hover {
+    background-color: #bbf8aa;
+    color: white; }
+a.failed {
+  color: #ffbbaa; }
+  a.failed:hover {
+    background-color: #ffbbaa;
+    color: white; }
+
+#footer {
+  padding: 1.5em 2.5em;
+  border-top: 1px solid #ccc;
+  font-size: .8em;
+  color: #666;
+  text-align: right; }
+  #footer strong {
+    font-weight: bold; }
+