metric_fu 1.5.1 → 2.0.0

data/lib/metric_fu.rb

@@ -1,16 +1,17 @@
 require 'rake'
 require 'yaml'
 begin
+  require 'active_support/core_ext/object/to_json'
+  require 'active_support/core_ext/object/blank'
+rescue LoadError  
   require 'activesupport'
-rescue LoadError
-  require 'active_support'
 end
 
 # 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')
+base_dir         = File.join(MetricFu::LIB_ROOT, 'base')
 generator_dir    = File.join(MetricFu::LIB_ROOT, 'generators')
 template_dir     = File.join(MetricFu::LIB_ROOT, 'templates')
 graph_dir        = File.join(MetricFu::LIB_ROOT, 'graphs')
@@ -20,6 +21,7 @@ graph_dir        = File.join(MetricFu::LIB_ROOT, 'graphs')
 require File.join(base_dir, 'report') 
 require File.join(base_dir, 'generator')
 require File.join(base_dir, 'graph')
+require File.join(base_dir, 'scoring_strategies')
 
 # prevent the task from being run multiple times.
 unless Rake::Task.task_defined? "metrics:all"

data/lib/templates/awesome/hotspots.html.erb

@@ -0,0 +1,54 @@
+<h3>Hotspot Results</h3>
+<p>Meta analysis of your metrics to find hotspots in your code.</p>
+<br/>
+
+<% if !@hotspots || @hotspots.size == 0 %>
+No Hotspots were found.
+<% elsif @hotspots && @hotspots.size > 0 %>
+
+<% granularities = [:files, :classes, :methods] %>
+<table>
+<tr valign="top">
+<% granularities.each do |granularity| %>  
+   <th width='33%'> 
+<%= granularity.to_s.capitalize %></th>
+<% end %>
+</tr>
+
+<% items = [] %>
+<% granularities.each_index do |index| %>
+  <% granularity = granularities[index] %>
+  <% items << @hotspots[granularity] %>
+<% end %>
+
+<% items_length = 0 %>
+<% columns = [0, 1, 2] %>
+<% while (items_length < items[0].length || items_length < items[1].length || items_length < items[2].length) do %>
+    <tr  valign="top"> 
+       <% columns.each do |column| %>
+       <% item = items[column].length >= items_length ? items[column][items_length] : nil %>
+       <% if item %>
+       <td>
+       <b>
+          <%= display_location(item[:location], nil) %>
+        </b>
+        <br/><br/>
+        <!-- TODO HOTSPOTS for metric fu nice metric_link method -->
+        <% item[:details].each do |metric, info| %>
+          <%#= metric_link(@stat, metric, h(metric.to_s.capitalize)) + ": " + h(info)%><br/>
+          <%= "#{metric.to_s.capitalize}: #{info}" %><br/>
+          <% end %>
+          </td>
+      <% else %>
+      <td> &nbsp; </td>
+      <% end %>
+      <% end %>
+      <% items_length += 1 %>
+      </tr>
+    <% end %>
+
+</table>
+<% end %>
+
+
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -27,5 +27,8 @@
 <% if @rails_best_practices %>
   <li class='even failure'><a href="rails_best_practices.html">Rails Best Practices report</a></li>
 <% end %>
+<% if @hotspots %>
+  <li class='even failure'><a href="hotspots.html">Hotspots</a></li>
+<% end %>
 </ul>
 <p>Generated on <%= Time.now.localtime %></p>	

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

@@ -0,0 +1,54 @@
+<h3>Hotspot Results</h3>
+<p>Meta analysis of your metrics to find hotspots in your code.</p>
+<br/>
+
+<% if !@hotspots || @hotspots.size == 0 %>
+No Hotspots were found.
+<% elsif @hotspots && @hotspots.size > 0 %>
+
+<% granularities = [:files, :classes, :methods] %>
+<table>
+<tr valign="top">
+<% granularities.each do |granularity| %>  
+   <th width='33%'> 
+<%= granularity.to_s.capitalize %></th>
+<% end %>
+</tr>
+
+<% items = [] %>
+<% granularities.each_index do |index| %>
+  <% granularity = granularities[index] %>
+  <% items << @hotspots[granularity] %>
+<% end %>
+
+<% items_length = 0 %>
+<% columns = [0, 1, 2] %>
+<% while (items_length < items[0].length || items_length < items[1].length || items_length < items[2].length) do %>
+    <tr  valign="top"> 
+       <% columns.each do |column| %>
+       <% item = items[column].length >= items_length ? items[column][items_length] : nil %>
+       <% if item %>
+       <td>
+       <b>
+          <%= display_location(item[:location], nil) %>
+        </b>
+        <br/><br/>
+        <!-- TODO HOTSPOTS for metric fu nice metric_link method -->
+        <% item[:details].each do |metric, info| %>
+          <%#= metric_link(@stat, metric, h(metric.to_s.capitalize)) + ": " + h(info)%><br/>
+          <%= "#{metric.to_s.capitalize}: #{info}" %><br/>
+          <% end %>
+          </td>
+      <% else %>
+      <td> &nbsp; </td>
+      <% end %>
+      <% end %>
+      <% items_length += 1 %>
+      </tr>
+    <% end %>
+
+</table>
+<% end %>
+
+
+<p>Generated on <%= Time.now.localtime %></p>	

data/spec/base/line_numbers_spec.rb

@@ -0,0 +1,62 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe LineNumbers do
+  
+  describe "in_method?" do
+    it "should know if a line is NOT in a method" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.in_method?(2).should == false
+    end
+  
+    it "should know if a line is in an instance method" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.in_method?(8).should == true
+    end
+  
+    it "should know if a line is in an class method" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.in_method?(3).should == true
+    end
+  end
+  
+  describe "method_at_line" do
+    it "should know the name of an instance method at a particular line" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.method_at_line(8).should == "Foo#what"
+    end
+    
+    it "should know the name of a class method at a particular line" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.method_at_line(3).should == "Foo::awesome"
+    end
+    
+    it "should know the name of a private method at a particular line" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.method_at_line(28).should == "Foo#whoop"
+    end
+    
+    it "should know the name of a class method defined in a 'class << self block at a particular line" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/foo.rb"))
+      ln.method_at_line(23).should == "Foo::neat"
+    end
+    
+    it "should know the name of an instance method at a particular line in a file with two classes" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/two_classes.rb"))
+      ln.method_at_line(3).should == "Foo#stuff"
+      ln.method_at_line(9).should == "Bar#stuff"
+    end
+    
+    it "should work with modules" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/module.rb"))
+      ln.method_at_line(4).should == 'KickAss#get_beat_up?'
+    end
+    
+    it "should work with module surrounding class" do
+      ln = LineNumbers.new(File.read(File.dirname(__FILE__) + "/../resources/line_numbers/module_surrounds_class.rb"))
+      ln.method_at_line(5).should == "StuffModule::ThingClass#do_it"
+      # ln.method_at_line(12).should == "StuffModule#blah" #why no work?
+    end
+
+  end
+  
+end

data/spec/generators/rails_best_practices_spec.rb

@@ -0,0 +1,52 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe RailsBestPractices do
+  describe "emit method" do
+    it "should gather the raw data" do
+      MetricFu::Configuration.run {}
+      practices = MetricFu::RailsBestPractices.new
+      practices.should_receive(:`).with("rails_best_practices .")
+      practices.emit
+    end
+  end
+  
+  describe "analyze method" do
+    before :each do
+      output = <<-HERE.gsub(/^[^\S\n]*/, "")
+      ./app/views/admin/testimonials/_form.html.erb:17 - replace instance variable with local variable
+      ./app/controllers/admin/campaigns_controller.rb:24,45,68,85 - use before_filter for show,edit,update,destroy
+      
+      go to http://wiki.github.com/flyerhzm/rails_best_practices to see how to solve these errors.
+      
+      Found 2 errors.
+      HERE
+      MetricFu::Configuration.run {}
+      practices = MetricFu::RailsBestPractices.new
+      practices.instance_variable_set(:@output, output)
+      @results = practices.analyze
+    end
+    
+    it "should get the total" do
+      @results[:total].should == ["Found 2 errors."]
+    end
+    
+    it "should get the problems" do
+      @results[:problems].size.should == 2
+      @results[:problems].first.should == { :line => "17",
+        :problem => "replace instance variable with local variable",
+        :file => "./app/views/admin/testimonials/_form.html.erb" }
+      @results[:problems][1].should == { :line => "24,45,68,85",
+        :problem => "use before_filter for show,edit,update,destroy",
+        :file => "./app/controllers/admin/campaigns_controller.rb" }
+    end
+  end
+  
+  describe "to_h method" do
+    it "should put things into a hash" do
+      MetricFu::Configuration.run {}
+      practices = MetricFu::RailsBestPractices.new
+      practices.instance_variable_set(:@rails_best_practices_results, "the_practices")
+      practices.to_h[:rails_best_practices].should == "the_practices"
+    end
+  end
+end

data/spec/generators/rcov_spec.rb

@@ -0,0 +1,180 @@
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
+
+describe MetricFu::Rcov do
+  
+  before :each do
+    MetricFu::Configuration.run {}
+    File.stub!(:directory?).and_return(true)
+    @rcov = MetricFu::Rcov.new('base_dir')
+  end
+  
+  describe "emit" do
+    before :each do
+      @rcov.stub!(:puts)
+      MetricFu.rcov[:external] = nil
+    end
+
+    it "should clear out previous output and make output folder" do
+      @rcov.stub!(:`)
+      FileUtils.should_receive(:rm_rf).with(MetricFu::Rcov.metric_directory, :verbose => false)
+      Dir.should_receive(:mkdir).with(MetricFu::Rcov.metric_directory)
+      @rcov.emit
+    end
+    
+    it "should set the RAILS_ENV" do
+      FileUtils.stub!(:rm_rf)
+      Dir.stub!(:mkdir)
+      MetricFu.rcov[:environment] = "metrics"
+      @rcov.should_receive(:`).with(/RAILS_ENV=metrics/)
+      @rcov.emit
+    end
+  end
+  
+  describe "with RCOV_OUTPUT fed into" do
+    before :each do
+      MetricFu.rcov[:external] = nil
+      File.should_receive(:open).
+            with(MetricFu::Rcov.metric_directory + '/rcov.txt').
+            and_return(mock("io", :read => RCOV_OUTPUT))
+      @files = @rcov.analyze
+    end
+    
+    describe "analyze" do
+      it "should compute percent of lines run" do
+        @files["lib/templates/awesome/awesome_template.rb"][:percent_run].should == 13
+        @files["lib/templates/standard/standard_template.rb"][:percent_run].should == 14
+      end
+
+      it "should know which lines were run" do
+        @files["lib/templates/awesome/awesome_template.rb"][:lines].
+              should include({:content=>"   require 'fileutils'", :was_run=>true})
+      end
+
+      it "should know which lines NOT were run" do
+        @files["lib/templates/awesome/awesome_template.rb"][:lines].
+              should include({:content=>"         if template_exists?(section)", :was_run=>false})
+      end
+    end
+
+    describe "to_h" do
+      it "should calculate total percentage for all files" do
+        @rcov.to_h[:rcov][:global_percent_run].should == 13.7
+      end
+    end
+  end
+  describe "with external configuration option set" do
+    before :each do
+      @rcov.stub!(:puts)
+      MetricFu.rcov[:external] = "coverage/rcov.txt"
+    end
+
+    it "should emit nothing if external configuration option is set" do
+      FileUtils.should_not_receive(:rm_rf)
+      @rcov.emit
+    end
+    
+    it "should open the external rcov analysis file" do
+      File.should_receive(:open).
+            with(MetricFu.rcov[:external]).
+            and_return(mock("io", :read => RCOV_OUTPUT))
+      @files = @rcov.analyze
+    end
+    
+  end
+
+
+RCOV_OUTPUT = <<-HERE
+Profiling enabled.
+.............................................................................................................................................................................................
+
+
+Top 10 slowest examples:
+0.2707830 MetricFu::RoodiGrapher responding to #get_metrics should push 13 to roodi_count
+0.1994550 MetricFu::RcovGrapher responding to #get_metrics should update labels with the date
+0.1985800 MetricFu::ReekGrapher responding to #get_metrics should set a hash of code smells to reek_count
+0.1919860 MetricFu::ReekGrapher responding to #get_metrics should update labels with the date
+0.1907400 MetricFu::RoodiGrapher responding to #get_metrics should update labels with the date
+0.1883000 MetricFu::FlogGrapher responding to #get_metrics should update labels with the date
+0.1882650 MetricFu::FlayGrapher responding to #get_metrics should push 476 to flay_score
+0.1868780 MetricFu::FlogGrapher responding to #get_metrics should push to top_five_percent_average
+0.1847730 MetricFu::FlogGrapher responding to #get_metrics should push 9.9 to flog_average
+0.1844090 MetricFu::FlayGrapher responding to #get_metrics should update labels with the date
+
+Finished in 2.517686 seconds
+
+189 examples, 0 failures
+================================================================================
+lib/templates/awesome/awesome_template.rb
+================================================================================
+   require 'fileutils'
+   
+   class AwesomeTemplate < MetricFu::Template
+   
+     def write
+!!     # Getting rid of the crap before and after the project name from integrity
+!!     @name = File.basename(Dir.pwd).gsub(/^\w+-|-\w+$/, "")
+!! 
+!!     # Copy Bluff javascripts to output directory
+!!     Dir[File.join(this_directory, '..', 'javascripts', '*')].each do |f|
+!!       FileUtils.copy(f, File.join(MetricFu.output_directory, File.basename(f)))
+!!     end
+!! 
+!!     report.each_pair do |section, contents|
+!!       if template_exists?(section)
+!!         create_instance_var(section, contents)
+!!         @html = erbify(section)
+!!         html = erbify('layout')
+!!         fn = output_filename(section)
+!!         MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+!!       end
+!!     end
+!! 
+!!     # Instance variables we need should already be created from above
+!!     if template_exists?('index')
+!!       @html = erbify('index')
+!!       html = erbify('layout')
+!!       fn = output_filename('index')
+!!       MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+!!     end
+!!   end
+   
+     def this_directory
+!!     File.dirname(__FILE__)
+!!   end
+!! end
+   
+================================================================================
+lib/templates/standard/standard_template.rb
+================================================================================
+   class StandardTemplate < MetricFu::Template
+   
+   
+     def write
+!!     report.each_pair do |section, contents|
+!!       if template_exists?(section)
+!!         create_instance_var(section, contents)
+!!         html = erbify(section)
+!!         fn = output_filename(section)
+!!         MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+!!       end
+!!     end
+!! 
+!!     # Instance variables we need should already be created from above
+!!     if template_exists?('index')
+!!       html = erbify('index')
+!!       fn = output_filename('index')
+!!       MetricFu.report.save_output(html, MetricFu.output_directory, fn)
+!!     end
+!!   end
+   
+     def this_directory
+!!     File.dirname(__FILE__)
+!!   end
+!! end
+
+HERE
+
+end
+
+
+