khall-metric_fu 1.0.2.1

data/lib/generators/saikuro.rb

@@ -0,0 +1,212 @@
+module MetricFu
+
+class Saikuro < Generator
+
+
+  def emit
+    relative_path = [File.dirname(__FILE__), '..', '..', 
+                     'vendor', 'saikuro', 'saikuro.rb']
+    saikuro = File.expand_path(File.join(relative_path))
+    
+    format_directories
+    
+    options_string = MetricFu.saikuro.inject("") do |options, option|
+      options + "--#{option.join(' ')} " 
+    end
+    
+    sh %{ruby "#{saikuro}" #{options_string}} do |ok, response|
+      unless ok
+        puts "Saikuro failed with exit status: #{response.exitstatus}"
+        exit 1
+      end
+    end
+  end
+  
+  def format_directories
+    dirs = MetricFu.saikuro[:input_directory].join(" | ")
+    dirs = "\"#{dirs}\""
+    MetricFu.saikuro[:input_directory] = dirs
+  end
+
+  def analyze
+    @files = []
+    saikuro_results.each do |path|
+      if Saikuro::SFile.is_valid_text_file?(path)
+        file = Saikuro::SFile.new(path) 
+        if file 
+          @files << file 
+        end
+      end
+    end
+    @files = @files.sort_by do |file|
+      file.elements.
+           max {|a,b| a.complexity.to_i <=> b.complexity.to_i}.
+           complexity.to_i
+    end
+    @files.reverse!
+    klasses = []
+    @files.each {|f| klasses << f.elements}
+    klasses.flatten!
+    @classes = klasses.sort_by {|k| k.complexity.to_i}
+    @classes.reverse!
+    meths = []
+    @files.each {|f| 
+      f.elements.each {|el|
+        el.defs.each {|defn|
+          defn.name = "#{el.name}##{defn.name}"
+          meths <<  defn}
+      }
+    }
+    meths = meths.sort_by {|meth| meth.complexity.to_i}
+    @meths = meths.reverse
+    
+  end
+
+  def to_h
+    files = @files.map do |file|
+      my_file = file.to_h
+      my_file[:filename] = file.filename
+      my_file 
+    end
+    {:saikuro => {:files => files, 
+                  :classes => @classes.map {|c| c.to_h},
+                  :methods => @meths.map {|m| m.to_h} 
+                 }
+    }  
+  end
+
+  def saikuro_results
+    Dir.glob("#{metric_directory}/**/*.html")
+  end
+
+  private
+
+
+end
+
+class Saikuro::SFile
+
+  attr_reader :elements
+  
+  def initialize(path)
+    @path = path
+    @file_handle = File.open(@path, "r")
+    @elements = []
+    get_elements
+  end
+
+  def self.is_valid_text_file?(path)
+    File.open(path, "r") do |f|
+      if f.eof? || !f.readline.match /--/
+        return false
+      else
+        return true
+      end
+    end
+  end
+
+  def filename
+    File.basename(@path, '_cyclo.html')
+  end
+
+  def to_h
+    merge_classes
+    {:classes => @elements}
+  end
+
+  def get_elements
+    begin
+      while (line = @file_handle.readline) do
+        return [] if line.blank?
+        if line.match /START/
+          line = @file_handle.readline
+          element = Saikuro::ParsingElement.new(line)
+        elsif line.match /END/
+          @elements << element 
+          element = nil
+        else
+          element << line
+        end
+      end
+    rescue EOFError
+      nil
+    end
+  end
+
+
+  def merge_classes
+    new_elements = []
+    get_class_names.each do |target_class|
+      elements = @elements.find_all {|el| el.name == target_class }
+      complexity = 0
+      lines = 0
+      defns = []
+      elements.each do |el|
+        complexity += el.complexity.to_i
+        lines += el.lines.to_i
+        defns << el.defs
+      end
+
+      new_element = {:class_name => target_class,
+                     :complexity => complexity,
+                     :lines      => lines,
+                     :methods => defns.flatten.map {|d| d.to_h}}
+      new_element[:methods] = new_element[:methods].
+                              sort_by {|x| x[:complexity] }.
+                              reverse
+
+      new_elements << new_element
+    end
+    @elements = new_elements if new_elements
+  end
+
+  def get_class_names
+    class_names = []
+    @elements.each do |element|
+      unless class_names.include?(element.name)
+        class_names << element.name
+      end
+    end
+    class_names
+  end
+
+end
+
+class Saikuro::ParsingElement
+  TYPE_REGEX=/Type:(.*) Name/
+  NAME_REGEX=/Name:(.*) Complexity/
+  COMPLEXITY_REGEX=/Complexity:(.*) Lines/
+  LINES_REGEX=/Lines:(.*)/
+
+  attr_reader :complexity, :lines, :defs, :element_type
+  attr_accessor :name
+
+  def initialize(line)
+    @line = line
+    @element_type = line.match(TYPE_REGEX)[1].strip
+    @name = line.match(NAME_REGEX)[1].strip
+    @complexity  = line.match(COMPLEXITY_REGEX)[1].strip
+    @lines = line.match(LINES_REGEX)[1].strip
+    @defs = []
+  end
+
+  def <<(line)
+    @defs << Saikuro::ParsingElement.new(line) 
+  end
+
+  def to_h
+    base = {:name => @name, :complexity => @complexity.to_i, :lines => @lines.to_i}
+    unless @defs.empty?
+      defs = @defs.map do |my_def|
+        my_def = my_def.to_h
+        my_def.delete(:defs)
+        my_def
+      end
+      base[:defs] = defs
+    end
+    return base
+  end
+end
+
+
+end

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/metric_fu.rb

@@ -0,0 +1,20 @@
+# 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')
+
+# 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')
+
+# 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}

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

@@ -0,0 +1,30 @@
+<html>
+<head>
+	<title>Source Control Churn Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+	<h1>Source Control Churn Results</h1>
+	<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><%= change[:file_path] %></td>
+        <td><%= change[:times_changed] %></td>
+      </tr>
+      <% count += 1 %>
+		<% end %>
+	</table>
+	<p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>

data/lib/templates/standard/default.css

@@ -0,0 +1,64 @@
+body {
+	background-color: #efefef;
+	margin: 20px;
+	padding: 0;
+	font: 12px verdana, arial, helvetica;
+}
+
+table {
+	border-collapse: collapse;
+	border: 1px solid #666;
+	background: #fff;
+	margin-bottom: 20px;	
+}
+
+	table tr.light {
+	 	background: #fff;
+	}
+
+	table tr.dark {
+		background: #f9f9f9;
+	}
+
+	table td, table th {
+		padding: 4px 10px;
+		font-size: 13px;
+	}
+	table th {
+		text-align: center;
+		color: #fc0;
+		background: #336;		
+		font-weight: bold;
+		border: #d0d0d0 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;
+}

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

@@ -0,0 +1,33 @@
+<html>
+<head>
+	<title>Flay Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+	<h1>Flay Results</h1>
+	<h2>Total Score (lower is better): <%= @flay[:total_score] %></h2>
+  <p><a href='http://ruby.sadi.st/Flay.html'>Flay</a> analyzes ruby code for structural similarities.</p>  
+	<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| %>
+            <%= file[:name] %>:<%= file[:line] %><br />
+          <% end %>
+  		  </td>
+    		<td><%= match[:reason] %></td>
+      </tr>
+      <% count += 1 %>
+		<% end %>
+	</table>
+	<p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>

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

@@ -0,0 +1,52 @@
+<html>
+<head>
+	<title>Flog Reporter</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+<body>
+	<h1>Flog Results</h1>
+	<p><a href='http://ruby.sadi.st/Flog.html'>Flog</a> measures code complexity.</p>
+	<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><%= page[:path] %></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><%= 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>	
+</body>
+</html>

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

@@ -0,0 +1,38 @@
+<html>
+<head>
+	<title>Metric Fu Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+	<h1>Metric Fu Results</h1>
+  <% if @churn %>
+    <p><a href="churn.html">Churn report</a></p>
+  <% end %>
+  <% if @flay %>
+    <p><a href="flay.html">Flay report</a></p>
+  <% end %>
+  <% if @flog %>
+    <p><a href="flog.html">Flog report</a></p>
+  <% end %>
+  <% if @rcov %>
+    <p><a href="rcov.html">Rcov report</a></p>
+  <% end %>
+  <% if @reek %>
+    <p><a href="reek.html">Reek report</a></p>
+  <% end %>
+  <% if @roodi %>
+    <p><a href="roodi.html">Roodi report</a></p>
+  <% end %>
+  <% if @saikuro %>
+    <p><a href="saikuro.html">Saikuro report</a></p>
+  <% end %>
+  <% if @stats %>
+    <p><a href="stats.html">Stats report</a></p>
+  <% end %>
+  <p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>
+

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

@@ -0,0 +1,42 @@
+<html>
+<head>
+	<title>Rcov Code Coverage Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+	<h1>Rcov Code Coverage Results</h1>
+	<p>C0 code coverage information.</p>
+  <p>Total Coverage: <%= @rcov.delete(:global_percent_run) %>% </p>
+	<table>
+    <tr>
+      <th>File Path</th>
+      <th>Percent run</th>
+    </tr>
+    <% count = 0 %>
+    <% @rcov.each_pair do |fname, file| %>
+      <tr>
+        <td><%= fname %></td>
+        <td><%= file[:percent_run] %></td>
+      </tr>
+      <% count += 1 %>
+		<% end %>
+  </table>
+
+  <% @rcov.each_pair do |fname, file| %>
+    <h2> <%= fname %></h2>
+    <table class="rcov_code">
+    <% file[:lines].each do |line| %>
+      <tr>
+        <% css_class = line[:was_run] ? "rcov_run" : "rcov_not_run" %>
+        <td class="<%= css_class %>"><pre><%= line[:content] %></pre></td>
+      </tr>
+    <% end %>
+    </table>
+  <% end %>
+	<p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>
+

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

@@ -0,0 +1,41 @@
+<html>
+<head>
+	<title>Reek Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+	<h1>Reek Results</h1>
+	<p><a href="http://reek.rubyforge.org/">Reek</a> detects common code smells in ruby code.</p>
+	<table>
+		<tr>
+		  <th>File Path</th>
+      <th>Method</th>
+      <th>Description</th>
+      <th>Type</th>
+    </tr>
+    <% count = 0 %>
+    <% @reek[:matches].each do |match| %>
+      <% match[:code_smells].each do |smell| %>
+  		  <tr class='<%= cycle("light", "dark", count) %>'>
+  		    <td><%= match[:file_path] %></td>
+          <td>
+            <%= smell[:method] %>
+          </td>
+          <td>
+            <%= smell[:message] %>
+    		  </td>
+    		  <td>
+            <%= smell[:type] %>
+    		  </td>
+        </tr>
+        <% count += 1 %>
+      <% end %>
+    <% end %>
+
+	</table>
+	<p>Generated on <%= Time.now.localtime %></p>
+</body>
+</html>

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

@@ -0,0 +1,28 @@
+<html>
+<head>
+	<title>Roodi Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+	<h1>Roodi Results</h1>
+  <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>
+	<table>
+		<tr>
+		  <th>File Path</th>
+		  <th>Warning</th>
+    </tr>
+    <% count = 0 %>
+    <% @roodi[:problems].each do |problem| %>
+      <tr class='<%= cycle("light", "dark", count) %>'>
+        <td><%= problem[:file] %>:<%= problem[:line] %></td>
+        <td><%= problem[:problem] %></td>
+      </tr>
+      <% count += 1 %>
+  	<% end %>
+	</table>
+	<p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>

data/lib/templates/standard/saikuro.html.erb

@@ -0,0 +1,83 @@
+<html>
+<head>
+	<title>Saikuro Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</style>
+</head>
+
+<body>
+  <h1>Saikuro Results</h1>
+  <p><a href='http://saikuro.rubyforge.org/'>Saikuro</a> analyzes ruby code for cyclomatic complexity.</p>
+
+  <h2>Analyzed Methods</h2>
+    <table>
+      <tr>
+        <th>Method Name</th>
+        <th>Complexity</th>
+        <th># Lines</th>
+      </tr>
+      <% @saikuro[:methods].each do |method| %>
+      <tr>
+        <td><%= method[:name] %></td>
+        <td><%= method[:complexity] %></td>
+        <td><%= method[:lines] %></td>
+      </tr>
+      <% end %>
+    </table>
+
+
+
+  <h2>Analyzed Classes</h2>
+    <table>
+      <tr>
+        <th>Class Name</th>
+        <th>Complexity</th>
+        <th># Lines</th>
+      </tr>
+      <% @saikuro[:classes].each do |klass| %>
+      <tr>
+        <td><%= klass[:name] %></td>
+        <td><%= klass[:complexity] %></td>
+        <td><%= klass[:lines] %></td>
+      </tr>
+      <% end %>
+    </table>
+
+
+  <h2>Analyzed Files</h2>
+  <% @saikuro[:files].each do |file| %>
+    <% file[:classes].each do |klass| %>
+        <% if !klass[:methods].empty? %>
+          <h3><%= file[:filename] %></h3>
+          <h4>Class : <%= klass[:class_name] %></h4>
+          <h5>Total complexity : <%= klass[:complexity] %></h5>
+          <h5>Total lines : <%= klass[:lines] %></h5>
+          <table>
+              <tr>
+                <th>Method</th>
+                <th>Complexity</th>
+                <th># Lines</th>
+              </tr>
+            <% klass[:methods].each do |method| %>
+              <tr>
+                <td>
+                  <%= method[:name] %>
+                </td>
+                <td>
+                  <%= method[:complexity] %> 
+                </td>
+                <td>
+                  <%= method[:lines]  %>
+                </td>
+              </tr>
+            <% end %>
+          </table> 
+        <% end %>
+    <% end %>
+ <% end %>
+
+	<p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>
+