RubyGems - p8-metric_fu - Versions diffs - 0.8.0.16 - Mend

p8-metric_fu 0.8.0.16

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (42) hide show

data/HISTORY +79 -0
data/MIT-LICENSE +22 -0
data/Manifest.txt +25 -0
data/README +147 -0
data/Rakefile +11 -0
data/TODO +13 -0
data/lib/metric_fu.rb +3 -0
data/lib/metric_fu/base.rb +159 -0
data/lib/metric_fu/churn.rb +88 -0
data/lib/metric_fu/flay.rb +17 -0
data/lib/metric_fu/flog.rb +139 -0
data/lib/metric_fu/md5_tracker.rb +52 -0
data/lib/metric_fu/reek.rb +17 -0
data/lib/metric_fu/roodi.rb +17 -0
data/lib/metric_fu/saikuro/saikuro.rb +1214 -0
data/lib/tasks/churn.rake +9 -0
data/lib/tasks/coverage.rake +54 -0
data/lib/tasks/flay.rake +6 -0
data/lib/tasks/flog.rake +69 -0
data/lib/tasks/metric_fu.rake +24 -0
data/lib/tasks/metric_fu.rb +6 -0
data/lib/tasks/railroad.rake +36 -0
data/lib/tasks/reek.rake +6 -0
data/lib/tasks/roodi.rake +7 -0
data/lib/tasks/saikuro.rake +35 -0
data/lib/tasks/stats.rake +14 -0
data/lib/templates/churn.html.erb +22 -0
data/lib/templates/default.css +45 -0
data/lib/templates/flay.html.erb +30 -0
data/lib/templates/flog.html.erb +31 -0
data/lib/templates/flog_page.html.erb +25 -0
data/lib/templates/reek.html.erb +30 -0
data/lib/templates/roodi.html.erb +26 -0
data/spec/base_spec.rb +57 -0
data/spec/churn_spec.rb +117 -0
data/spec/config_spec.rb +110 -0
data/spec/flay_spec.rb +19 -0
data/spec/flog_spec.rb +147 -0
data/spec/md5_tracker_spec.rb +57 -0
data/spec/reek_spec.rb +26 -0
data/spec/spec_helper.rb +11 -0
metadata +152 -0

data/lib/templates/reek.html.erb ADDED Viewed

@@ -0,0 +1,30 @@
+<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/lib/templates/roodi.html.erb ADDED Viewed

@@ -0,0 +1,26 @@
+<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>
+		<% @matches.each_with_index do |match, count| %>
+  		<tr class='<%= cycle("light", "dark", count) %>'>
+  		  <td><%= link_to_filename(match.first.split(':').first) if match.first %></td>
+  		  <td><%= match[1] %></td>
+  		</tr>
+  		<% end %>
+	</table>
+	<p>Generated on <%= Time.now.localtime %></p>
+</body>
+</html>

data/spec/base_spec.rb ADDED Viewed

@@ -0,0 +1,57 @@
+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("tmp/metric_fu/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("tmp/metric_fu/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("tmp/metric_fu/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 == 'tmp/metric_fu/generator'
+    end
+  end
+end

data/spec/churn_spec.rb ADDED Viewed

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

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

data/spec/flay_spec.rb ADDED Viewed

@@ -0,0 +1,19 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+describe MetricFu::Flay do
+  describe "generate_html" do
+    it "should create a new Generator and call generate_report on it" do
+      @generator = MetricFu::Flay.new('other_dir')
+      @generator.should_receive(:`).and_return("Matches found in :call (mass = 55)\n\tlib/metric_fu/flog_reporter.rb:2\n\tlib/metric_fu/flog_reporter.rb:3")
+      @generator.generate_html
+    end
+  end
+  describe "template_name" do
+    it "should return the class name in lowercase" do
+      flay = MetricFu::Flay.new('base_dir')
+      flay.template_name.should == 'flay'
+    end
+  end
+end

data/spec/flog_spec.rb ADDED Viewed

@@ -0,0 +1,147 @@
+require File.dirname(__FILE__) + '/spec_helper.rb'
+include MetricFu::Flog
+describe "Flog::Base" do
+  before do
+    @alpha_only_method = <<-AOM
+    Total flog = 13.6283678106927
+    ErrorMailer#errormail: (12.5)
+        12.0: assignment
+         1.2: []
+         1.2: now
+         1.2: content_type
+AOM
+    @method_that_has_digits = <<-MTHD
+    Total flog = 7.08378429936994
+    NoImmunizationReason#to_c32: (7.1)
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+MTHD
+    @bang_method = <<-BM
+    Total flog = 7.08378429936994
+    NoImmunizationReason#to_c32!: (7.1)
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+BM
+    @invalid_method = <<-IM
+    Total flog = 7.08378429936994
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+IM
+  end
+  it "should be able to parse an alpha only method" do
+    page = Base.parse(@alpha_only_method)
+    page.should_not be_nil
+    page.score.should == 13.6283678106927
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'ErrorMailer#errormail'
+    sm.score.should == 12.5
+  end
+  it "should be able to parse method that has digits" do
+    page = Base.parse(@method_that_has_digits)
+    page.should_not be_nil
+    page.score.should == 7.08378429936994
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'NoImmunizationReason#to_c32'
+    sm.score.should == 7.1
+  end
+  it "should be able to parse bang method" do
+    page = Base.parse(@bang_method)
+    page.should_not be_nil
+    page.score.should == 7.08378429936994
+    page.scanned_methods.size.should == 1
+    sm = page.scanned_methods.first
+    sm.name.should == 'NoImmunizationReason#to_c32!'
+    sm.score.should == 7.1
+  end
+  it "should return nil when parsing invalid method" do
+    page = Base.parse(@invalid_method)
+    page.should be_nil
+  end
+end
+IM = <<-IM
+    Total flog = 7.08378429936994
+         3.0: code
+         2.3: branch
+         1.4: templateId
+         1.2: act
+         1.1: entryRelationship
+IM
+describe MetricFu::Flog do
+  describe "generate_report" do
+    it "should generate reports" do
+      generator = Flog::Generator.new('other_dir')
+      generator.should_receive(:flog_results).and_return(['A', 'B'])
+      generator.should_receive(:save_html).at_least(3).times.and_return('')
+      generator.should_receive(:open).any_number_of_times.and_return(['Total Flog = 1273.9 (9.3 +/- 259.2 flog / method)', 'TokenCounter#list_tokens_per_line: (15.2)', '9.0: assignment'].join("\n"))
+      generator.generate_report
+    end
+    it "should be able to handle InvalidFlogs" do
+      generator = Flog::Generator.new('other_dir')
+      generator.should_receive(:flog_results).and_return(['A', 'B'])
+      generator.should_receive(:inline_css).any_number_of_times.and_return('')
+      generator.should_receive(:save_html).once
+      generator.should_receive(:open).any_number_of_times.and_return(IM)
+      generator.generate_report
+    end
+  end
+  describe "template_name" do
+    it "should return the class name in lowercase" do
+      flog = Flog::Generator.new('base_dir')
+      flog.template_name.should == 'flog'
+    end
+  end
+end
+describe MetricFu::Flog::Page do
+  describe "average_score" do
+    it "should calculate the average score" do
+      page = Page.new(10)
+      page.should_receive(:scanned_methods).any_number_of_times.and_return([ScannedMethod.new(:test, 10), ScannedMethod.new(:test, 20)])
+      page.average_score.should == 15
+    end
+    it "should be able to handle divide by zero" do
+      page = Page.new(10)
+      page.should_receive(:scanned_methods).any_number_of_times.and_return([])
+      page.average_score.should == 0
+    end
+  end
+  describe "highest_score" do
+    it "should calculate the average score" do
+      page = Page.new(10)
+      page.should_receive(:scanned_methods).any_number_of_times.and_return([ScannedMethod.new(:test, 10), ScannedMethod.new(:test, 20)])
+      page.highest_score.should == 20
+    end
+  end
+end