nielsm-metric_fu 0.9.1 → 1.1.1

data/lib/tasks/metric_fu.rake

@@ -1,24 +0,0 @@
-# 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

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

data/lib/tasks/railroad.rake

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

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

data/lib/tasks/roodi.rake

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

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

@@ -1,14 +0,0 @@
-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/flog.html.erb

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

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

data/lib/templates/reek.html.erb

@@ -1,30 +0,0 @@
-<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>Code Smell</th>
-		</tr>
-		<% @matches.each_with_index do |match, count| %>
-  		<tr class='<%= cycle("light", "dark", count) %>'>
-  		  <td><%= match.first %></td>
-  		  <td>
-  			  <% match[1..-1].each do |line| %>
-  			  <%= line %><br>
-  			  <% end %>
-  		  </td>
-  		</tr>
-		<% end %>
-	</table>
-	<p>Generated on <%= Time.now.localtime %></p>
-</body>
-</html>

data/spec/base_spec.rb

@@ -1,57 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe MetricFu::Base::Generator do
-  describe "save_html" do
-    it "should save to a index.html in the base_dir" do
-      @generator = MetricFu::Base::Generator.new
-      @generator.should_receive(:open).with("#{MetricFu::BASE_DIRECTORY}/generator/index.html", "w")
-      @generator.save_html("<html>")
-    end
-
-    it "should save to a custom.html to the base_dir if 'custom' is passed as name" do
-      @generator = MetricFu::Base::Generator.new
-      @generator.should_receive(:open).with("#{MetricFu::BASE_DIRECTORY}/generator/metric_fu/custom.html", "w")
-      @generator.save_html("<html>", 'metric_fu/custom.html')
-    end
-  end
-
-  describe "generate_report class method" do
-    it "should create a new Generator and call generate_report on it" do
-      @generator = mock('generator')
-      @generator.should_receive(:generate_report)
-      MetricFu::Base::Generator.should_receive(:new).and_return(@generator)
-      MetricFu::Base::Generator.generate_report('base_dir')
-    end
-  end
-
-  describe "generate_html" do
-    it "should create a new Generator and call generate_report on it" do
-      @generator = MetricFu::Base::Generator.new
-      @generator.should_receive(:open).with("#{MetricFu::BASE_DIRECTORY}/generator/index.html", "w")
-      @generator.should_receive(:generate_html).and_return('<html>')
-      @generator.generate_report
-    end
-  end
-  
-  describe "cycle" do
-    it "should create a new Generator and call generate_report on it" do
-      @generator = MetricFu::Base::Generator.new
-      @generator.cycle("light", "dark", 0).should == 'light'
-      @generator.cycle("light", "dark", 1).should == 'dark'      
-    end
-  end
-  
-  describe "template_name" do
-    it "should return the class name in lowercase" do
-      @generator = MetricFu::Base::Generator.new
-      @generator.template_name.should == 'generator'
-    end
-  end
-
-  describe "metric_dir" do
-    it "should return tmp/metric_fu/{the class name in lowercase}" do
-      MetricFu::Base::Generator.metric_dir.should == "#{MetricFu::BASE_DIRECTORY}/generator"
-    end
-  end
-
-end

data/spec/churn_spec.rb

@@ -1,117 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe MetricFu::Churn do
-  describe "generate_report" do
-    after do
-      load File.dirname(__FILE__) + '/../lib/metric_fu/churn.rb' #need to reload file to wipe out mock of private static
-    end
-
-    it "should strip out files that have less than the min count" do
-      logs = ["accept", "accept", "accept", "reject", "reject"]
-      git_mock = mock('git')
-      git_mock.should_receive(:get_logs).and_return(logs)
-      Churn::Git.should_receive(:new).and_return(git_mock)
-      churn = Churn.new(:scm => :git, :minimum_churn_count => 3)
-      churn.analyze
-      churn.instance_variable_get(:@changes).should == {"accept"=>3}
-    end
-
-    it "should have a default min count of 5" do
-      churn = Churn.new('base_dir')
-      churn.instance_variable_get(:@minimum_churn_count).should == 5
-    end
-
-  end
-  
-  describe "template_name" do
-    it "should return the class name in lowercase" do
-      churn = Churn.new
-      churn.template_name.should == 'churn'
-    end
-  end  
-
-  describe "parse_log_for_changes" do
-    it "should count the changes with git" do
-      logs = ["home_page/index.html", "README", "History.txt", "README", "History.txt", "README"]
-      git_mock = mock('git')
-      git_mock.should_receive(:get_logs).and_return(logs)
-      Churn::Git.should_receive(:new).and_return(git_mock)
-      File.should_receive(:exist?).with(".git").and_return(true)
-      changes = Churn.new.send(:parse_log_for_changes)
-      changes["home_page/index.html"].should == 1
-      changes["History.txt"].should == 2
-      changes["README"].should == 3
-    end
-
-    it "should count the changes with svn" do
-      logs = ["home_page/index.html", "README", "History.txt", "README", "History.txt", "README"]
-      svn_mock = mock('svn')
-      svn_mock.should_receive(:get_logs).and_return(logs)
-      Churn::Svn.should_receive(:new).and_return(svn_mock)
-      File.should_receive(:exist?).with(".git").and_return(false)
-      File.should_receive(:exist?).with(".svn").and_return(true)
-      changes = Churn.new.send(:parse_log_for_changes)
-      changes["home_page/index.html"].should == 1
-      changes["History.txt"].should == 2
-      changes["README"].should == 3
-    end
-  end
-end
-
-describe MetricFu::Churn::Svn do
-
-  describe "get_logs" do
-    it "should use the start date if supplied" do
-      @churn = Churn::Svn.new
-      @churn.should_receive(:`).with('svn log  --verbose').and_return("")
-      @churn.get_logs
-    end
-    it "should use the start date if supplied" do
-      Time.should_receive(:now).and_return(Date.new(2001, 1, 2))
-      @churn = Churn::Svn.new(lambda{Date.new(2000, 1, 1)})
-      @churn.should_receive(:require_rails_env)
-      @churn.should_receive(:`).with("svn log --revision {2000-01-01}:{2001-01-02} --verbose").and_return("")
-      @churn.get_logs
-    end
-  end
-
-  describe "clean_up_svn_line" do
-    it "should return nil for non matches" do
-      Churn::Svn.new.send(:clean_up_svn_line, "Adding Google analytics").should be_nil
-      Churn::Svn.new.send(:clean_up_svn_line, "A bunch of new files").should be_nil
-    end
-
-    it "should strip out all but the full path" do
-      Churn::Svn.new.send(:clean_up_svn_line, "   A /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "A   /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "   A   /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "   A /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "A /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "A   /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
-
-      Churn::Svn.new.send(:clean_up_svn_line, "   M /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "M   /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "   M   /trunk/lib/server.rb   ").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "   M /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "M /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
-      Churn::Svn.new.send(:clean_up_svn_line, "M   /trunk/lib/server.rb").should == "/trunk/lib/server.rb"
-    end
-  end
-end
-
-describe MetricFu::Churn::Git do
-
-  describe "get_logs" do
-    it "should use the start date if supplied" do
-      @churn = Churn::Git.new
-      @churn.should_receive(:`).with('git log  --name-only --pretty=format:').and_return("")
-      @churn.get_logs
-    end
-    it "should use the start date if supplied" do
-      @churn = Churn::Git.new(lambda{Date.new(2000, 1, 1)})
-      @churn.should_receive(:require_rails_env)
-      @churn.should_receive(:`).with("git log --after=2000-01-01 --name-only --pretty=format:").and_return("")
-      @churn.get_logs
-    end
-  end
-end

data/spec/config_spec.rb

@@ -1,110 +0,0 @@
-require File.dirname(__FILE__) + '/spec_helper.rb'
-
-describe MetricFu::Configuration do
-  before do
-    MetricFu.configuration.reset
-  end
-  after do
-    ENV['CC_BUILD_ARTIFACTS'] = nil
-  end
-  describe "open_in_browser" do
-    it "should return false if running in cruise" do
-      unless ENV['CC_BUILD_ARTIFACTS']
-        MetricFu.open_in_browser?.should == !!PLATFORM['darwin']
-        ENV['CC_BUILD_ARTIFACTS'] = ''
-        MetricFu.open_in_browser?.should == false
-      end
-    end    
-  end
-
-  describe "metrics" do
-    it "should be configurable" do
-      MetricFu.metrics.should == [:coverage, :churn, :flog, :flay, :reek, :roodi, :saikuro]
-      MetricFu::Configuration.run do |config|
-        config.metrics = [:coverage, :flog]
-      end
-      MetricFu.metrics.should == [:coverage, :flog]
-    end
-  end  
-  
-  describe "churn" do
-    it "should be configurable" do
-      now = Time.now
-      MetricFu.churn.should == {}
-      MetricFu::Configuration.run do |config|
-        config.churn[:start_date] = now
-      end
-      MetricFu.churn.should == {:start_date => now }
-    end
-  end
-  
-  describe "coverage" do
-    it "should be configurable" do
-      MetricFu.coverage[:test_files].should == ['test/**/*_test.rb', 'spec/**/*_spec.rb']
-      MetricFu::Configuration.run do |config|
-        config.coverage[:test_files] = ['test/**/test_*.rb']
-      end
-      MetricFu.coverage[:test_files].should == ['test/**/test_*.rb']
-    end
-  end
-
-  describe "flay" do
-    it "should be configurable" do
-      now = Time.now
-      MetricFu.flay.should == { :dirs_to_flay =>  ['lib'] }
-      MetricFu::Configuration.run do |config|
-        config.flay[:dirs_to_flay] =  ['cms/app', 'cms/lib']
-      end
-      MetricFu.flay.should == { :dirs_to_flay =>  ['cms/app', 'cms/lib'] }
-    end
-  end
-
-  describe "flog" do
-    it "should be configurable" do
-      MetricFu.flog.should == { :dirs_to_flog =>  ['lib'] }
-      MetricFu::Configuration.run do |config|
-        config.flog[:dirs_to_flog] =  ['cms/app', 'cms/lib']
-      end
-      MetricFu.flog.should == { :dirs_to_flog =>  ['cms/app', 'cms/lib'] }
-    end
-  end
-
-  describe "saikuro" do
-    it "should be configurable" do
-      MetricFu.saikuro.should == {}
-      MetricFu::Configuration.run do |config|
-        config.saikuro = { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
-      end
-      MetricFu.saikuro.should == { "--warn_cyclo" => "3", "--error_cyclo" => "4" }
-    end
-    
-    it "should only accept a Hash" do
-      MetricFu.saikuro.should == {}
-      lambda {
-        MetricFu::Configuration.run do |config|
-          config.saikuro = ''
-        end
-      }.should raise_error
-    end    
-  end
-  
-  describe "reek" do
-    it "should be configurable" do
-      MetricFu.reek.should == { :dirs_to_reek =>  ['lib'] }
-      MetricFu::Configuration.run do |config|
-        config.reek[:dirs_to_reek] =  ['cms/app', 'cms/lib']
-      end
-      MetricFu.reek.should == { :dirs_to_reek =>  ['cms/app', 'cms/lib'] }
-    end
-  end
-  
-  describe "roodi" do
-    it "should be configurable" do
-      MetricFu.roodi.should == { :dirs_to_roodi =>  ['lib'] }
-      MetricFu::Configuration.run do |config|
-        config.roodi[:dirs_to_roodi] =  ['cms/app', 'cms/lib']
-      end
-      MetricFu.roodi.should == { :dirs_to_roodi =>  ['cms/app', 'cms/lib'] }
-    end
-  end   
-end