p8-metric_fu 0.8.0.16 → 0.8.2

data/lib/metric_fu/flog_reporter/page.rb

@@ -0,0 +1,33 @@
+module MetricFu::FlogReporter
+  class Page < MetricFu::Base::Generator
+    attr_accessor :score, :scanned_methods
+
+    def initialize(score, scanned_methods = [])
+      @score = score.to_f
+      @scanned_methods = scanned_methods
+    end
+
+    def to_html
+      ERB.new(File.read(template_file)).result(binding)
+    end
+
+    def average_score
+      sum = 0
+      scanned_methods.each do |m|
+        sum += m.score
+      end
+      sum / scanned_methods.length
+    end
+
+    def highest_score
+      scanned_methods.inject(0) do |highest, m|
+        m.score > highest ? m.score : highest
+      end
+    end
+
+    # should be dynamically read from the class
+    def template_name
+      'flog_page'
+    end
+  end
+end

data/lib/metric_fu/flog_reporter/scanned_method.rb

@@ -0,0 +1,28 @@
+module MetricFu::FlogReporter
+  class ScannedMethod
+    attr_accessor :name, :score, :operators
+
+    def initialize(name, score, operators = [])
+      @name = name
+      @score = score.to_f
+      @operators = operators
+    end
+
+    def to_html
+      output = "<p><strong>#{name} (#{score})</strong></p>\n"
+      output << "<table>\n"
+      output << "<tr><th>Score</th><th>Operator</th></tr>\n"
+      count = 0
+      operators.each do |operator|
+        output << <<-EOF
+                    <tr class='#{Base.cycle("light", "dark", count)}'>
+                      <td class='score'>#{sprintf(SCORE_FORMAT, operator.score)}</td>
+                      <td class='score'>#{operator.operator}</td>
+                    </tr>
+                  EOF
+        count += 1
+      end
+      output << "</table>\n\n"
+    end
+  end
+end

data/lib/metric_fu/flog_reporter.rb

@@ -0,0 +1,5 @@
+require File.join(File.dirname(__FILE__), 'flog_reporter', 'base')
+require File.join(File.dirname(__FILE__), 'flog_reporter', 'page')
+require File.join(File.dirname(__FILE__), 'flog_reporter', 'scanned_method')
+require File.join(File.dirname(__FILE__), 'flog_reporter', 'operator')
+require File.join(File.dirname(__FILE__), 'flog_reporter', 'generator')

data/lib/tasks/churn.rake

@@ -4,6 +4,8 @@ namespace :metrics do
 
   desc "Which files change the most"
   task :churn do
-    MetricFu.generate_churn_report
+    churn_dir = File.join(MetricFu::BASE_DIRECTORY, 'churn')
+    MetricFu::Churn.generate_report(churn_dir, defined?(MetricFu::CHURN_OPTIONS) ? MetricFu::CHURN_OPTIONS : {} )
+    system("open #{churn_dir}/index.html") if PLATFORM['darwin']
   end
 end

data/lib/tasks/coverage.rake

@@ -1,54 +1,40 @@
 require 'fileutils'
- 
-begin
-  require 'rcov'
-  require 'rcov/rcovtask'
-  require 'spec/rake/spectask'
- 
-  namespace :metrics do
- 
-    COVERAGE_DIR = File.join(MetricFu::BASE_DIRECTORY, 'coverage')
-    COVERAGE_DATA_FILE = File.join(MetricFu::BASE_DIRECTORY, 'coverage.data')
-    SPEC_HTML_FILE = File.join(MetricFu::BASE_DIRECTORY, 'specs.html')
- 
-    namespace :coverage do
-      rcov_output = COVERAGE_DIR
- 
-      desc "Delete aggregate coverage data."
-      task(:clean) { rm_f("rcov_tmp", :verbose => false) }
- 
-      desc "RCov task to generate report"
-      Rcov::RcovTask.new(:do => :clean) do |t|
-        FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
-        t.test_files = FileList[*MetricFu.coverage[:test_files]]
-        t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
-        t.output_dir = COVERAGE_DIR
-        # this line is a fix for Rails 2.1 relative loading issues
-        t.libs << 'test'
-      end
-      # TODO not sure what this improves but it requires the diff-lcs gem
-      # http://github.com/indirect/metric_fu/commit/b9c1cf75f09d5b531b388cd01661eb16b5126968#diff-1
-      # Spec::Rake::SpecTask.new(:do => :clean) do |t|
-      # FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
-      # t.ruby_opts = ['-rtest/unit']
-      # t.spec_files = FileList['test/**/*_test.rb', 'spec/**/*spec.rb']
-      # t.spec_opts = ["--format", "html:#{SPEC_HTML_FILE}", "--diff"]
-      # t.rcov = true
-      # t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
-      # t.rcov_dir = COVERAGE_DIR
-      # end
+require 'spec/rake/spectask'
+require 'spec/rake/verify_rcov'
+
+namespace :metrics do
+
+  COVERAGE_DIR = File.join(MetricFu::BASE_DIRECTORY, 'coverage')
+  COVERAGE_DATA_FILE = File.join(MetricFu::BASE_DIRECTORY, 'coverage.data')
+  SPEC_HTML_FILE = File.join(MetricFu::BASE_DIRECTORY, 'specs.html')
+
+  namespace :coverage do
+    rcov_output = COVERAGE_DIR
+
+    desc "Delete aggregate coverage data."
+    task(:clean) { rm_f("rcov_tmp", :verbose => false) }
+
+    desc "RCov task to generate report"
+    Spec::Rake::SpecTask.new(:do => :clean) do |t|
+      FileUtils.mkdir_p(MetricFu::BASE_DIRECTORY) unless File.directory?(MetricFu::BASE_DIRECTORY)
+      t.ruby_opts = ['-rtest/unit']
+      t.spec_files = FileList['test/**/*_test.rb', 'spec/**/*spec.rb']
+      t.spec_opts = ["--format", "html:#{SPEC_HTML_FILE}", "--diff"]
+      t.rcov = true
+      t.rcov_opts = ["--sort coverage", "--html", "--rails", "--exclude /gems/,/Library/"]
+      t.rcov_dir = COVERAGE_DIR
     end
- 
-    desc "Generate and open coverage report"
-    task :coverage => ['coverage:do'] do
-      system("open #{COVERAGE_DIR}/index.html") if MetricFu.open_in_browser?
+
+    RCov::VerifyTask.new(:verify => :do) do |t|
+      t.threshold = ( ENV['THRESHOLD'] ? ENV['THRESHOLD'].to_f : 100.0 )
+      t.index_html = File.join(COVERAGE_DIR, 'index.html')
     end
   end
-rescue LoadError
-  if RUBY_PLATFORM =~ /java/
-    puts 'running in jruby - rcov tasks not available'
-  else
-    puts 'sudo gem install rcov # if you want the rcov tasks'
- 
+
   end
-end
+
+  desc "Generate and open coverage report"
+  task :coverage => ['coverage:do'] do
+    system("open #{COVERAGE_DIR}/index.html") if PLATFORM['darwin']
+  end
+end

data/lib/tasks/flay.rake

@@ -1,6 +1,9 @@
+FLAY_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flay')
+
 namespace :metrics do
   desc "Generate code duplication report with flay"
   task :flay do
-    MetricFu.generate_flay_report
+    MetricFu::FlayReporter.generate_report(FLAY_DIR)
+    system("open #{FLAY_DIR}/index.html") if PLATFORM['darwin']
   end
 end

data/lib/tasks/flog.rake

@@ -1,13 +1,11 @@
 begin
+  FLOG_DIR = File.join(MetricFu::BASE_DIRECTORY, 'flog')
 
   def flog(output, directory)
-    metric_dir = MetricFu::Flog::Generator.metric_dir
     Dir.glob("#{directory}/**/*.rb").each do |filename|
-      output_dir = "#{metric_dir}/#{filename.split("/")[0..-2].join("/")}"
+      output_dir = "#{FLOG_DIR}/#{filename.split("/")[0..-2].join("/")}"
       mkdir_p(output_dir, :verbose => false) unless File.directory?(output_dir)
-      if MetricFu::MD5Tracker.file_changed?(filename, metric_dir)
-        `flog #{filename} > #{metric_dir}/#{filename.split('.')[0]}.txt`
-      end
+      `flog #{filename} > #{FLOG_DIR}/#{filename.split('.')[0]}.txt` if MetricFu::MD5Tracker.file_changed?(filename, FLOG_DIR)
     end
   end
 
@@ -18,7 +16,7 @@ begin
 
     namespace :flog do
       desc "Delete aggregate flog data."
-      task(:clean) { rm_rf(MetricFu::Flog.metric_dir, :verbose => false) }
+      task(:clean) { rm_rf(FLOG_DIR, :verbose => false) }
 
       desc "Flog code in app/models"
       task :models do
@@ -42,18 +40,20 @@ begin
 
       desc "Generate a flog report from specified directories"
       task :custom do
-        MetricFu::flog[:dirs_to_flog].each { |directory| flog(directory, directory) }
-        MetricFu.generate_flog_report
+        MetricFu::CODE_DIRS.each { |directory| flog(directory, directory) }
+        MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
       end
 
       desc "Generate and open flog report"
       if MetricFu::RAILS
         task :all => [:models, :controllers, :helpers, :lib] do
-          MetricFu.generate_flog_report
+          MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+          system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
         end
       else
         task :all => [:custom] do
-          MetricFu.generate_flog_report
+          MetricFu::FlogReporter::Generator.generate_report(FLOG_DIR)
+          system("open #{FLOG_DIR}/index.html") if PLATFORM['darwin']
         end
       end
 

data/lib/tasks/metric_fu.rake

@@ -1,11 +1,8 @@
-# only load configured metrics
-MetricFu.metrics.each { |task| import "#{File.dirname(__FILE__)}/#{task}.rake" }
-
 namespace :metrics do
   if MetricFu::RAILS
 
-    desc "Generate coverage, cyclomatic complexity, flog, flay, railroad, reek, roodi, stats and churn reports"
-    task :all => MetricFu.metrics
+    desc "Generate coverage, cyclomatic complexity, flog, stats, duplication and churn reports"
+    task :all => [:coverage, :stats, :saikuro, :churn, :flog, :flay]
 
     task :set_testing_env do
       RAILS_ENV = 'test'
@@ -16,9 +13,8 @@ namespace :metrics do
 
   else
 
-    desc "Generate coverage, cyclomatic complexity, flog, flay, railroad and churn reports"
-    task :all => MetricFu.metrics
+    desc "Generate coverage, cyclomatic complexity, flog, duplication and churn reports"
+    task :all => [:coverage, :saikuro, :churn, :flog, :flay]
 
   end
-
 end

data/lib/tasks/metric_fu.rb

@@ -3,4 +3,4 @@ require 'rubygems'
 require 'rake'
 
 # Load rake files
-import "#{File.dirname(__FILE__)}/metric_fu.rake"
+Dir["#{File.dirname(__FILE__)}/*.rake"].each { |ext| load ext }

data/lib/tasks/saikuro.rake

@@ -30,6 +30,6 @@ namespace :metrics do
          "#{SAIKURO_DIR}/index.html"
     end
 
-    system("open #{SAIKURO_DIR}/index.html") if MetricFu.open_in_browser?
+    system("open #{SAIKURO_DIR}/index.html") if PLATFORM['darwin']
   end
 end

data/lib/tasks/stats.rake

@@ -9,6 +9,6 @@ namespace :metrics do
     `echo '<pre>' > #{STATS_FILE}`
     `rake stats >> #{STATS_FILE}`
     `echo '</pre>' >> #{STATS_FILE}`
-    system("open #{STATS_FILE}") if MetricFu.open_in_browser?
+    system("open #{STATS_FILE}") if PLATFORM['darwin']
   end
 end

data/lib/templates/churn.css

@@ -0,0 +1,38 @@
+body {
+	margin: 20px;
+	padding: 0;
+	font-size: 12px;
+	font-family: bitstream vera sans, verdana, arial, sans serif;
+	background-color: #efefef;
+}
+
+table {	
+	border-collapse: collapse;
+	/*border-spacing: 0;*/
+	border: 1px solid #666;
+	background-color: #fff;
+	margin-bottom: 20px;
+}
+
+table, th, th+th, td, td+td  {
+	border: 1px solid #ccc;
+}
+
+table th {
+	font-size: 12px;
+	color: #fc0;
+	padding: 4px 0;
+	background-color: #336;
+}
+
+th, td {
+	padding: 4px 10px;
+}
+
+td {	
+	font-size: 13px;
+}
+
+.warning {
+	background-color: yellow;
+}

data/lib/templates/churn.html.erb

@@ -2,21 +2,18 @@
 <head>
 	<title>Source Control Churn Results</title>
 	<style>
-	<%= inline_css("default.css") %>	
+	<%= open(File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.css")) { |f| f.read } %>
 	</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>
+	<table width="100%" border="1">
 		<tr><th>File Path</th><th>Times Changed</th></tr>
 		<% @changes.to_a.sort {|x,y| y[1] <=> x[1]}.each do |change| %>
 		<tr><td><%= change[0] %></td><td class='warning'><%= change[1] %></td></tr>
 		<% end %>
+
 	</table>
-	<p>Generated on <%= Time.now.localtime %></p>	
 </body>
 </html>

data/lib/templates/flay.css

@@ -0,0 +1,38 @@
+body {
+	margin: 20px;
+	padding: 0;
+	font-size: 12px;
+	font-family: bitstream vera sans, verdana, arial, sans serif;
+	background-color: #efefef;
+}
+
+table {	
+	border-collapse: collapse;
+	/*border-spacing: 0;*/
+	border: 1px solid #666;
+	background-color: #fff;
+	margin-bottom: 10px;
+}
+
+table, th, th+th, td, td+td  {
+	border: 1px solid #ccc;
+}
+
+table th {
+	font-size: 14px;
+	color: #fc0;
+	background-color: #336;
+	text-align: left;
+}
+
+th, td {
+	padding: 4px 10px;
+}
+
+td {	
+	font-size: 13px;
+}
+
+.warning {
+	background-color: yellow;
+}

data/lib/templates/flay.html.erb

@@ -2,29 +2,22 @@
 <head>
 	<title>Flay Results</title>
 	<style>
-	<%= inline_css("default.css") %>	
+	<%= open(File.join(MetricFu::TEMPLATE_DIR, "#{template_name}.css")) { |f| f.read } %>
 	</style>
 </head>
 
 <body>
 	<h1>Flay Results</h1>
-  <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>
-  	<% @matches.each_with_index do |match, count| %>
-  		<tr class='<%= cycle("light", "dark", count) %>'>
-  		  <td>
-  			  <% match[1..-1].each do |filename| %>
-  			  <%= link_to_filename(*filename.split(":")) %><br>
-  			  <% end %>
-  		  </td>
-    		<td><%= match.first %></td>
-  		</tr>
+
+	<% @matches.each do |match| %>
+	<table width="80%" border="1">
+		<tr><th><%= match.first %></th></tr>
+		<tr><td>
+			<% match[1..-1].each do |filename| %>
+			<%= link_to_filename(*filename.split(":")) %><br>
+			<% end %>
+		</td></tr>
 		<% end %>
 	</table>
-	<p>Generated on <%= Time.now.localtime %></p>	
 </body>
 </html>

data/lib/templates/flog.css

@@ -0,0 +1,39 @@
+body {
+	background-color: rgb(240, 240, 245);
+	font-family: verdana, arial, helvetica;
+}
+
+table {
+	border-collapse: collapse;
+}
+
+table.report {
+	width: 100%;
+}
+
+table th {
+	text-align: center;
+}
+
+table td.score {
+	text-align: right;
+}
+
+table th {
+	background: #dcecff;
+	border: #d0d0d0 1px solid;
+	font-weight: bold;
+}
+
+table td {
+	border: #d0d0d0 1px solid;
+}
+
+table tr.light {
+ background-color: rgb(240, 240, 245);
+}
+
+table tr.dark {
+ background-color: rgb(230, 230, 235);
+}
+