jscruggs-metric_fu 1.0.2 → 1.1.0

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

@@ -0,0 +1,36 @@
+<h3>Rcov Code Coverage Results</h3>
+
+<p>C0 code coverage information.</p>
+
+<img src="rcov.png?<%= Time.now %>">
+
+<p>Total Coverage: <%= @rcov.delete(:global_percent_run) %>% </p>
+<table>
+  <tr>
+    <th>File Path</th>
+    <th>Percent run</th>
+  </tr>
+  <% count = 0 %>
+  <% @rcov.sort_by{ |k,v| v[:percent_run] }.each do |fname, file| %>
+    <tr>
+      <td><a href="#<%= fname.gsub(/[^a-z]+/, '_') %>"><%= fname %></a></td>
+      <td><%= file[:percent_run] %></td>
+    </tr>
+    <% count += 1 %>
+  <% end %>
+</table>
+
+<% @rcov.sort_by{ |k,v| v[:percent_run] }.each do |fname, file| %>
+  <h2 id="<%= fname.gsub(/[^a-z]+/, '_') %>"> <%= fname %></h2>
+  <div class="rcov_overflow">
+    <table class="rcov_code">
+    <% file[:lines].each_with_index do |line, index| %>
+      <tr>
+        <% css_class = line[:was_run] ? "rcov_run" : "rcov_not_run" %>
+        <td class="<%= css_class %>"><%= link_to_filename(fname, index + 1, "<pre>#{line[:content]}</pre>") %></td>
+      </tr>
+    <% end %>
+    </table>
+  </div>
+<% end %>
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -0,0 +1,34 @@
+<h3>Reek Results</h3>
+
+<p><a href="http://reek.rubyforge.org/">Reek</a> detects common code smells in ruby code.</p>
+
+<img src="reek.png?<%= Time.now %>">
+
+<table>
+  <tr>
+    <th>File Path</th>
+    <th>Method</th>
+    <th>Description</th>
+    <th>Type</th>
+  </tr>
+  <% count = 0 %>
+  <% @reek[:matches].each do |match| %>
+    <% match[:code_smells].each do |smell| %>
+      <tr class='<%= cycle("light", "dark", count) %>'>
+        <td><%= link_to_filename(match[:file_path]) %></td>
+        <td>
+          <%= smell[:method] %>
+        </td>
+        <td>
+          <%= smell[:message] %>
+        </td>
+        <td>
+          <%= smell[:type] %>
+        </td>
+      </tr>
+      <% count += 1 %>
+    <% end %>
+  <% end %>
+
+</table>
+<p>Generated on <%= Time.now.localtime %></p>

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

@@ -0,0 +1,21 @@
+<h3>Roodi Results</h3>
+
+<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>
+
+<img src="roodi.png?<%= Time.now %>">
+
+<table>
+  <tr>
+    <th>File Path</th>
+    <th>Warning</th>
+  </tr>
+  <% count = 0 %>
+  <% @roodi[:problems].each do |problem| %>
+    <tr class='<%= cycle("light", "dark", count) %>'>
+      <td><%= link_to_filename(problem[:file], problem[:line]) %></td>
+      <td><%= problem[:problem] %></td>
+    </tr>
+    <% count += 1 %>
+  <% end %>
+</table>
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -0,0 +1,71 @@
+<h3>Saikuro Results</h3>
+<p><a href='http://saikuro.rubyforge.org/'>Saikuro</a> analyzes ruby code for cyclomatic complexity.</p>
+
+<h2>Analyzed Methods</h2>
+  <table>
+    <tr>
+      <th>Method Name</th>
+      <th>Complexity</th>
+      <th># Lines</th>
+    </tr>
+    <% @saikuro[:methods].each do |method| %>
+    <tr>
+      <td><%= method[:name] %></td>
+      <td><%= method[:complexity] %></td>
+      <td><%= method[:lines] %></td>
+    </tr>
+    <% end %>
+  </table>
+
+
+
+<h2>Analyzed Classes</h2>
+  <table>
+    <tr>
+      <th>Class Name</th>
+      <th>Complexity</th>
+      <th># Lines</th>
+    </tr>
+    <% @saikuro[:classes].each do |klass| %>
+    <tr>
+      <td><%= klass[:name] %></td>
+      <td><%= klass[:complexity] %></td>
+      <td><%= klass[:lines] %></td>
+    </tr>
+    <% end %>
+  </table>
+
+
+<h2>Analyzed Files</h2>
+<% @saikuro[:files].each do |file| %>
+  <% file[:classes].each do |klass| %>
+      <% if !klass[:methods].empty? %>
+        <h3><%= file[:filename] %></h3>
+        <h4>Class : <%= klass[:class_name] %></h4>
+        <h5>Total complexity : <%= klass[:complexity] %></h5>
+        <h5>Total lines : <%= klass[:lines] %></h5>
+        <table>
+            <tr>
+              <th>Method</th>
+              <th>Complexity</th>
+              <th># Lines</th>
+            </tr>
+          <% klass[:methods].each do |method| %>
+            <tr>
+              <td>
+                <%= method[:name] %>
+              </td>
+              <td>
+                <%= method[:complexity] %> 
+              </td>
+              <td>
+                <%= method[:lines]  %>
+              </td>
+            </tr>
+          <% end %>
+        </table> 
+      <% end %>
+  <% end %>
+<% end %>
+
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -0,0 +1,41 @@
+<h3>Rake Stats  Results</h3>
+<p>Rails rake stats results.</p>
+<table>
+  <tr>
+    <th>Lines of Code</th>
+    <th>Lines of Test</th>
+    <th>Code to test ratio</th>
+  </tr>
+  <tr>
+    <td><%= @stats[:codeLOC] %></td>
+    <td><%= @stats[:testLOC] %></td>
+    <td>1:<%= @stats[:code_to_test_ratio] %></td>
+  </tr>
+</table>
+
+<table>
+  <tr>
+    <th>Name</th>
+    <th>Lines</th>
+    <th>LOC</th>
+    <th>Classes</th>
+    <th>Methods</th>
+    <th>Methods per class</th>
+    <th>LOC per method</th>
+  </tr>
+  <% count = 0 %>
+  <% @stats[:lines].each do |line| %>
+    <tr>
+      <td><%= line[:name] %></td>
+      <td><%= line[:lines] %></td>
+      <td><%= line[:loc] %></td>
+      <td><%= line[:classes] %></td>
+      <td><%= line[:methods] %></td>
+      <td><%= line[:methods_per_class] %></td>
+      <td><%= line[:loc_per_method] %></td>
+    </tr>
+    <% count += 1 %>
+  <% end %>
+</table>
+
+<p>Generated on <%= Time.now.localtime %></p>	

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

@@ -8,6 +8,7 @@
 
 <body>
 	<h1>Source Control Churn Results</h1>
+  <a href="index.html">back to menu</a>
 	<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>

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

@@ -8,6 +8,7 @@
 
 <body>
 	<h1>Flay Results</h1>
+  <a href="index.html">back to menu</a>
 	<h2>Total Score (lower is better): <%= @flay[:total_score] %></h2>
   <p><a href='http://ruby.sadi.st/Flay.html'>Flay</a> analyzes ruby code for structural similarities.</p>  
 	<table>

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

@@ -7,6 +7,7 @@
 </head>
 <body>
 	<h1>Flog Results</h1>
+  <a href="index.html">back to menu</a>
 	<p><a href='http://ruby.sadi.st/Flog.html'>Flog</a> measures code complexity.</p>
 	<h2>Total Flog score for all methods: <%= @flog[:total]%></h2>
 	<h2>Average Flog score for all methods: <%= @flog[:average]%></h2>
@@ -20,7 +21,7 @@
     </tr>
       <% @flog[:pages].each do |page| %>
       <tr>
-        <td><%= page[:path] %></td>
+        <td><a href="#<%= page[:path].gsub(/[^a-z]+/, '_') %>"><%= page[:path] %></a></td>
         <td><%= page[:score].round %></td>
         <td><%= page[:scanned_methods].length %></td>
         <td><%= page[:average_score].round %></td>
@@ -30,7 +31,7 @@
   </table>
 
   <% @flog[:pages].each do |page| %>
-    <h2><%= page[:path] %></h2>
+    <h2 id="<%= page[:path].gsub(/[^a-z]+/, '_') %>"><%= page[:path] %></h2>
       <% page[:scanned_methods].each do |sm| %>
         <p><%= sm[:name] %></p>
         <table>

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

@@ -8,6 +8,7 @@
 
 <body>
 	<h1>Rcov Code Coverage Results</h1>
+  <a href="index.html">back to menu</a>
 	<p>C0 code coverage information.</p>
   <p>Total Coverage: <%= @rcov.delete(:global_percent_run) %>% </p>
 	<table>
@@ -16,17 +17,17 @@
       <th>Percent run</th>
     </tr>
     <% count = 0 %>
-    <% @rcov.each_pair do |fname, file| %>
+    <% @rcov.sort_by{|k,v| v[:percent_run]}.each do |e| %>
       <tr>
-        <td><%= fname %></td>
-        <td><%= file[:percent_run] %></td>
+        <td><a href="#<%= e[0].gsub(/[^a-z]+/, '_') %>"><%= e[0] %></a></td>
+        <td><%= e[1][:percent_run] %></td>
       </tr>
       <% count += 1 %>
 		<% end %>
   </table>
 
   <% @rcov.each_pair do |fname, file| %>
-    <h2> <%= fname %></h2>
+    <h2 id="<%= fname.gsub(/[^a-z]+/, '_') %>"> <%= fname %></h2>
     <table class="rcov_code">
     <% file[:lines].each do |line| %>
       <tr>

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

@@ -8,6 +8,7 @@
 
 <body>
 	<h1>Reek Results</h1>
+  <a href="index.html">back to menu</a>
 	<p><a href="http://reek.rubyforge.org/">Reek</a> detects common code smells in ruby code.</p>
 	<table>
 		<tr>

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

@@ -8,6 +8,7 @@
 
 <body>
 	<h1>Roodi Results</h1>
+  <a href="index.html">back to menu</a>
   <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>

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

@@ -8,6 +8,7 @@
 
 <body>
   <h1>Saikuro Results</h1>
+  <a href="index.html">back to menu</a>
   <p><a href='http://saikuro.rubyforge.org/'>Saikuro</a> analyzes ruby code for cyclomatic complexity.</p>
 
   <h2>Analyzed Methods</h2>

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

@@ -8,6 +8,7 @@
 
 <body>
 	<h1>Rake Stats  Results</h1>
+  <a href="index.html">back to menu</a>
 	<p>Rails rake stats results.</p>
 	<table>
     <tr>

data/spec/base/base_template_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../spec_helper.rb"
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 require 'erb'
 
 describe MetricFu::Template do
@@ -36,7 +36,7 @@ describe MetricFu::Template do
     end
 
     describe 'if the template does not exist' do
-      it 'should return false' do  
+      it 'should return false' do
         File.should_receive(:exist?).with(@section).and_return(false)
         result = @template.send(:template_exists?, @section)
         result.should be_false
@@ -82,27 +82,48 @@ describe MetricFu::Template do
       result.should == 'css contents'
     end
   end
-
+  
   describe "#link_to_filename " do
     describe "when on OS X" do
       before(:each) do
         config = mock("configuration")
-        config.should_receive(:platform).and_return('universal-darwin-9.0')
+        config.stub!(:platform).and_return('universal-darwin-9.0')
         MetricFu.stub!(:configuration).and_return(config)
-        File.should_receive(:expand_path).and_return('filename')
       end
 
       it 'should return a textmate protocol link' do
-        name = "filename" 
-        result = @template.send(:link_to_filename, name)
+        File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
+        result = @template.send(:link_to_filename, 'filename')
+        result.should eql("<a href='txmt://open/?url=file://" \
+                         + "/expanded/filename'>filename</a>")
+      end
+
+      it "should do the right thing with a filename that starts with a slash" do
+        File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
+        result = @template.send(:link_to_filename, '/filename')
         result.should eql("<a href='txmt://open/?url=file://" \
-                         + "filename&line='>filename:</a>")
+                         + "/expanded/filename'>/filename</a>")
       end
 
+      it "should include a line number" do
+        File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
+        result = @template.send(:link_to_filename, 'filename', 6)
+        result.should eql("<a href='txmt://open/?url=file://" \
+                         + "/expanded/filename&line=6'>filename:6</a>")
+      end
+
+      describe "and given link text" do
+        it "should use the submitted link text" do
+          File.stub!(:expand_path).with('filename').and_return('/expanded/filename')
+          result = @template.send(:link_to_filename, 'filename', 6, 'link content')
+          result.should eql("<a href='txmt://open/?url=file://" \
+                           + "/expanded/filename&line=6'>link content</a>")
+        end
+      end
     end
 
     describe "when on other platforms"  do
-      before(:each) do 
+      before(:each) do
         config = mock("configuration")
         config.should_receive(:platform).and_return('other')
         MetricFu.stub!(:configuration).and_return(config)
@@ -110,9 +131,9 @@ describe MetricFu::Template do
       end
 
       it 'should return a file protocol link' do
-        name = "filename" 
+        name = "filename"
         result = @template.send(:link_to_filename, name)
-        result.should == "<a href='file://filename'>filename:</a>" 
+        result.should == "<a href='file://filename'>filename</a>"
       end
     end
   end
@@ -122,15 +143,15 @@ describe MetricFu::Template do
       first_val = "first"
       second_val = "second"
       iter = 2
-      result = @template.send(:cycle, first_val, second_val, iter)  
+      result = @template.send(:cycle, first_val, second_val, iter)
       result.should == first_val
     end
 
     it 'should return the second_value passed if iteration passed is odd' do
       first_val = "first"
       second_val = "second"
-      iter = 1 
-      result = @template.send(:cycle, first_val, second_val, iter)  
+      iter = 1
+      result = @template.send(:cycle, first_val, second_val, iter)
       result.should == second_val
     end
   end

data/spec/base/configuration_spec.rb

@@ -1,4 +1,4 @@
-require File.dirname(__FILE__) + "/../spec_helper.rb"
+require File.expand_path(File.dirname(__FILE__) + "/../spec_helper")
 
 describe MetricFu::Configuration do
     
@@ -129,7 +129,7 @@ describe MetricFu::Configuration do
     end
     
     it 'should set @template_class to StandardTemplate' do
-      template_class.should == StandardTemplate
+      template_class.should == AwesomeTemplate
     end
 
     it 'should set @flay to {:dirs_to_flay => @code_dirs}' do
@@ -170,7 +170,7 @@ describe MetricFu::Configuration do
                                               "--no-color",        
                                               "--profile",         
                                               "--rails",           
-                                              "--exclude /gems/,/Library/,spec"]}' do
+                                              "--exclude /gems/,/Library/,/usr/,spec"]}' do
       @config.instance_variable_get(:@rcov).
               should ==  { :test_files => ['test/**/*_test.rb', 
                                            'spec/**/*_spec.rb'],
@@ -180,7 +180,7 @@ describe MetricFu::Configuration do
                                          "--no-color",
                                          "--profile",
                                          "--rails",
-                                         "--exclude /gems/,/Library/,spec"]}
+                                         "--exclude /gems/,/Library/,/usr/,spec"]}
     end
 
     it 'should set @saikuro to { :output_directory => @scratch_directory + "/saikuro",