nielsm-metric_fu 0.9.0

data/lib/tasks/churn.rake

@@ -0,0 +1,9 @@
+require File.join(File.dirname(__FILE__), '../metric_fu/churn')
+
+namespace :metrics do
+
+  desc "Which files change the most"
+  task :churn do
+    MetricFu.generate_churn_report
+  end
+end

data/lib/tasks/coverage.rake

@@ -0,0 +1,54 @@
+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 = MetricFu.coverage[:rcov_opts]
+        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
+    end
+ 
+    desc "Generate and open coverage report"
+    task :coverage => ['coverage:do'] do
+      system("open #{COVERAGE_DIR}/index.html") if MetricFu.open_in_browser?
+    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

data/lib/tasks/flay.rake

@@ -0,0 +1,6 @@
+namespace :metrics do
+  desc "Generate code duplication report with flay"
+  task :flay do
+    MetricFu.generate_flay_report
+  end
+end

data/lib/tasks/flog.rake

@@ -0,0 +1,69 @@
+begin
+
+  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("/")}"
+      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
+    end
+  end
+
+  namespace :metrics do
+
+    task :flog => ['flog:all'] do
+    end
+
+    namespace :flog do
+      desc "Delete aggregate flog data."
+      task(:clean) { rm_rf(MetricFu::Flog.metric_dir, :verbose => false) }
+
+      desc "Flog code in app/models"
+      task :models do
+        flog "models", "app/models"
+      end
+
+      desc "Flog code in app/controllers"
+      task :controllers do
+        flog "controllers", "app/controllers"
+      end
+
+      desc "Flog code in app/helpers"
+      task :helpers do
+        flog "helpers", "app/helpers"
+      end
+
+      desc "Flog code in lib"
+      task :lib do
+        flog "lib", "lib"
+      end
+
+      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
+      end
+
+      desc "Generate and open flog report"
+      if MetricFu::RAILS
+        task :all => [:models, :controllers, :helpers, :lib] do
+          MetricFu.generate_flog_report
+        end
+      else
+        task :all => [:custom] do
+          MetricFu.generate_flog_report
+        end
+      end
+
+    end
+
+  end
+rescue LoadError
+  if RUBY_PLATFORM =~ /java/
+    puts 'running in jruby - flog tasks not available'
+  else
+    puts 'sudo gem install flog # if you want the flog tasks'
+  end
+end

data/lib/tasks/metric_fu.rake

@@ -0,0 +1,24 @@
+# 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
+
+    task :set_testing_env do
+      RAILS_ENV = 'test'
+    end
+
+    desc "Generate metrics after migrating (for continuous integration)"
+    task :all_with_migrate => [:set_testing_env, "db:migrate", :all]
+
+  else
+
+    desc "Generate coverage, cyclomatic complexity, flog, flay, railroad and churn reports"
+    task :all => MetricFu.metrics
+
+  end
+
+end

data/lib/tasks/metric_fu.rb

@@ -0,0 +1,6 @@
+require 'fileutils'
+require 'rubygems'
+require 'rake'
+
+# Load rake files
+import "#{File.dirname(__FILE__)}/metric_fu.rake"

data/lib/tasks/railroad.rake

@@ -0,0 +1,39 @@
+namespace :metrics do
+  
+  RAILROAD_DIR = File.join(MetricFu::BASE_DIRECTORY, 'railroad')
+  RAILROAD_FILE = File.join(RAILROAD_DIR, 'index.html')
+  
+  task :railroad => ['railroad:all'] do
+  end
+  
+  namespace :railroad do
+  
+    desc "Create all railroad reports"
+    task :all => [:models, :controllers, :aasm] do
+      #system("open #{RAILROAD_INDEX}") if PLATFORM['darwin']
+    end
+  
+    desc "Create a railroad models report"
+    task :models do
+      #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -M -a -m -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'model-diagram.png')}`
+      #`echo "<a href=\"railroad/models.png\">Model diagram</a><br />" >> #{RAILROAD_FILE}`
+    end
+  
+    desc "Create a railroad controllers report"
+    task :controllers do
+      #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -C -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'controller-diagram.png')}`
+      #`echo "<a href=\"railroad/controllers.png\">Controller diagram</a><br />" >> #{RAILROAD_FILE}`
+    end
+  
+    desc "Create a railroad acts_as_state_machine report"
+    task :aasm do
+      #mkdir_p(RAILROAD_DIR) unless File.directory?(RAILROAD_DIR)
+      `railroad -A -l -v | neato -Tpng > #{File.join(MetricFu::BASE_DIRECTORY,'aasm-diagram.png')}`
+      #`echo "<a href=\"railroad/aasm.png\">State machine diagram</a><br />" >> #{RAILROAD_FILE}`
+    end
+    
+  end
+
+end

data/lib/tasks/reek.rake

@@ -0,0 +1,6 @@
+namespace :metrics do
+  desc "A code smell report using Reek"  
+  task :reek do
+    MetricFu.generate_reek_report
+  end
+end

data/lib/tasks/roodi.rake

@@ -0,0 +1,7 @@
+namespace :metrics do
+  
+  desc "A Ruby coding standards report using Roodi"
+  task :roodi do
+    MetricFu.generate_roodi_report
+  end
+end

data/lib/tasks/saikuro.rake

@@ -0,0 +1,35 @@
+require 'fileutils'
+
+namespace :metrics do
+
+  desc "A cyclomatic complexity report using Saikuro"
+  task :saikuro do
+    SAIKURO_DIR = File.join(MetricFu::BASE_DIRECTORY, 'saikuro')
+    SAIKURO = File.expand_path(File.join(File.dirname(__FILE__), '..', 'metric_fu', 'saikuro', 'saikuro.rb'))
+
+    raise "SAIKURO_OPTIONS is now MetricFu::SAIKURO_OPTIONS" if defined?(SAIKURO_OPTIONS)
+    options = { :output_directory => SAIKURO_DIR,
+                        :input_directory => MetricFu::CODE_DIRS,
+                        :cyclo => "",
+                        :filter_cyclo => "0",
+                        :warn_cyclo => "5",
+                        :error_cyclo => "7"}
+
+    options.merge!(MetricFu::SAIKURO_OPTIONS) if defined?(MetricFu::SAIKURO_OPTIONS)
+    options_string = options.inject(""){ |o, h| o + "--#{h.join(' ')} " }
+
+    sh %{ruby "#{SAIKURO}" #{options_string}} do |ok, response|
+      unless ok
+        puts "Saikuro failed with exit status: #{response.exitstatus}"
+        exit 1
+      end
+    end
+
+    if File.exist? "#{SAIKURO_DIR}/index_cyclo.html"
+      mv "#{SAIKURO_DIR}/index_cyclo.html",
+         "#{SAIKURO_DIR}/index.html"
+    end
+
+    system("open #{SAIKURO_DIR}/index.html") if MetricFu.open_in_browser?
+  end
+end

data/lib/tasks/stats.rake

@@ -0,0 +1,14 @@
+namespace :metrics do
+
+  STATS_DIR = File.join(MetricFu::BASE_DIRECTORY, 'stats')
+  STATS_FILE = File.join(STATS_DIR, 'index.html')
+
+  desc "A stats report"
+  task :stats do
+    mkdir_p(STATS_DIR) unless File.directory?(STATS_DIR)
+    `echo '<pre>' > #{STATS_FILE}`
+    `rake stats >> #{STATS_FILE}`
+    `echo '</pre>' >> #{STATS_FILE}`
+    system("open #{STATS_FILE}") if MetricFu.open_in_browser?
+  end
+end

data/lib/templates/churn.html.erb

@@ -0,0 +1,22 @@
+<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>
+		<% @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/default.css

@@ -0,0 +1,45 @@
+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;
+}

data/lib/templates/flay.html.erb

@@ -0,0 +1,30 @@
+<html>
+<head>
+	<title>Flay Results</title>
+	<style>
+	<%= inline_css("default.css") %>	
+	</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>
+		<% end %>
+	</table>
+	<p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>

data/lib/templates/flog.html.erb

@@ -0,0 +1,38 @@
+<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>
+	<table>
+		<tr>
+		  <th>File</th>
+		  <th>Total score</th>
+		  <th>Methods</th>
+		  <th>Average score</th>
+		  <th>Highest score</th>
+		</tr>
+		<% pages.sort {|x,y| y.highest_score <=> x.highest_score }.each_with_index do |page, count| %>
+  		<tr class='<%= cycle("light", "dark", count) %>'>
+  			<td><a href='<%= page.path %>'><%= page.path.sub('.html', '.rb') %></a></td>
+  			<td class='score'><%= sprintf(SCORE_FORMAT, page.score) %></td>
+  			<td class='score'><%=                       page.scanned_methods.length %></td>
+  			<td class='score'><%= sprintf(SCORE_FORMAT, page.average_score) %></td>
+  			<td class='score'><%= sprintf(SCORE_FORMAT, page.highest_score) %></td>
+  		</tr>
+		<% end %>
+		<tr>
+			<td><strong>Totals</strong></td>
+			<td class='score'><strong><%= sprintf(SCORE_FORMAT, pages.inject(0){|sum, page| sum + page.score }) %></strong></td>
+			<td class='score'><strong><%=                       pages.inject(0){|sum, page| sum + page.scanned_methods.length } %></strong></td>
+			<td class='score'></td>
+			<td class='score'></td>
+		</tr>		
+	</table>
+	<p>Generated on <%= Time.now.localtime %></p>	
+</body>
+</html>

data/lib/templates/flog_page.html.erb

@@ -0,0 +1,25 @@
+<html>
+<head>
+	<style>
+	<%= inline_css("default.css") %>
+	</style>
+</head>
+<body>
+	<p>Score: <%= score %></p>
+	<% scanned_methods.each do |sm| %>
+  <p><strong><%= sm.name %> (<%= sm.score %>)</strong></p>
+  <table>
+    <tr>
+      <th>Score</th>
+      <th>Operator</th>
+    </tr>
+    <% sm.operators.each_with_index do |operator, count| %>
+      <tr class='<%= cycle("light", "dark", count) %>'>
+        <td class='score'><%= sprintf(SCORE_FORMAT, operator.score) %></td>
+        <td class='score'><%= operator.operator %></td>
+      </tr>
+    <% end %>
+  </table>
+ <% end %>
+</body>
+</html>