simplecov-rcov 0.1.4 → 0.2.0

data/lib/simplecov-rcov.rb

@@ -1,29 +1,65 @@
-class SimpleCov::Formatter::RcovFormatter
-  PATH_RESULT = "/rcov/index.html"
+require 'bundler'
+Bundler.setup(:default)
+
+require 'erb'
+require 'cgi'
+require 'fileutils'
+require 'time'
+
+unless defined?(SimpleCov)
+  raise RuntimeError, "simplecov-rcov is a formatter for simplecov. Please update your test helper and gemfile to require 'simplecov'!"
+end
 
+class SimpleCov::Formatter::RcovFormatter
   def format( result )
+    Dir[File.join(File.dirname(__FILE__), '../assets/*')].each do |path|
+      FileUtils.cp_r(path, asset_output_path)
+    end
+
+    @path_relativizer = Hash.new{|h,base|
+      h[base] = Pathname.new(base).cleanpath.to_s.gsub(%r{^\w:[/\\]}, "").gsub(/\./, "_").gsub(/[\\\/]/, "-") + ".html"
+    }
+
+    generated_on = Time.now
+
     @files = result.files
 
     @total_lines =  result.files.map { |e| e.lines.count }.inject(:+)
     @total_lines_code =  result.files.map { |e| e.covered_lines.count + e.missed_lines.count }.inject(:+)
     @total_coverage = coverage(result.files)
+    @total_coverage_code = coverage_code(result.files)
 
-    template = ERB.new( File.read( "#{File.dirname(__FILE__)}/../views/index.erb.html" ) )
-    rcov_result = template.result( binding )
+    FileUtils.mkdir_p( SimpleCov::Formatter::RcovFormatter.output_path )
 
-    FileUtils.mkdir_p( File.dirname( SimpleCov::Formatter::RcovFormatter.path_result ) )
+    write_file(template("index.html"), File.join(SimpleCov::Formatter::RcovFormatter.output_path, "/index.html") , binding)
 
-    File.open( SimpleCov::Formatter::RcovFormatter.path_result, "w" ) do |file_result|
-     file_result.write rcov_result
+    template = template("detail.html")
+    result.files.each do |file|
+      write_file(template, File.join(SimpleCov::Formatter::RcovFormatter.output_path, relative_filename(shortened_filename(file))), binding)
     end
 
-    puts "Coverage report Rcov style generated for #{result.command_name} to #{SimpleCov::Formatter::RcovFormatter.path_result}"
-
-    return rcov_result
+    puts "Coverage report Rcov style generated for #{result.command_name} to #{SimpleCov::Formatter::RcovFormatter.output_path}"
   end
 
   private
 
+  def write_file(template, output_filename, binding)
+    rcov_result = template.result( binding )
+
+    File.open( output_filename, "w" ) do |file_result|
+     file_result.write rcov_result
+    end
+  end
+
+  def template(name)
+    ERB.new(File.read(File.join(File.dirname(__FILE__), '../views/', "#{name}.erb")), nil, '-')
+  end
+
+  def lines(file_list)
+    return 0.0 if file_list.length == 0
+    file_list.map { |e| e.lines.count }.inject(:+)
+  end
+
   def lines_covered(file_list)
     return 0.0 if file_list.length == 0
     file_list.map {|f| f.covered_lines.count }.inject(&:+)
@@ -40,12 +76,77 @@ class SimpleCov::Formatter::RcovFormatter
 
   def coverage(file_list)
     return 100.0 if file_list.length == 0 or lines_of_code(file_list) == 0
-    lines_missed = file_list.map {|f| f.missed_lines.count }.inject(&:+)
+    never_lines = file_list.map {|f| f.never_lines.count }.inject(&:+)
+
+    (lines_covered(file_list) + never_lines) * 100 / lines(file_list).to_f
+  end
+
+  def coverage_code(file_list)
+    return 100.0 if file_list.length == 0 or lines_of_code(file_list) == 0
 
     lines_covered(file_list) * 100 / lines_of_code(file_list).to_f
   end
 
-  def self.path_result
-    File.join( SimpleCov.coverage_path, SimpleCov::Formatter::RcovFormatter::PATH_RESULT )
+  def self.output_path
+    File.join( SimpleCov.coverage_path, "/rcov" )
+  end
+
+  def asset_output_path
+    return @asset_output_path if @asset_output_path
+    @asset_output_path = File.join(SimpleCov::Formatter::RcovFormatter.output_path, 'assets', SimpleCov::Formatter::RcovFormatter::VERSION)
+    FileUtils.mkdir_p(@asset_output_path)
+    @asset_output_path
+  end
+
+  def project_name
+    SimpleCov.project_name
+  end
+
+  def assets_path(name)
+    File.join('./assets', SimpleCov::Formatter::RcovFormatter::VERSION, name)
+  end
+
+  def code_coverage_html(code_coverage_percentage, is_total=false)
+    %{<div class="percent_graph_legend"><tt class='#{ is_total ? 'coverage_total' : ''}'>#{ "%3.2f" % code_coverage_percentage }%</tt></div>
+      <div class="percent_graph">
+        <div class="covered" style="width:#{ code_coverage_percentage.round }px"></div>
+        <div class="uncovered" style="width:#{ 100 - code_coverage_percentage.round }px"></div>
+      </div>}
+  end
+
+  def total_coverage_for_report(file)
+    return 100.0 if file.lines.count == 0
+    (file.covered_lines.count + file.never_lines.count)  * 100 / file.lines.count.to_f
+  end
+
+  def coverage_threshold_classes(percentage)
+    return 110 if percentage == 100
+    return (1..10).find_all{|i| i * 10 > percentage}.map{|i| i.to_i * 10} * " "
+  end
+
+  def shortened_filename(file)
+    file.filename.gsub("#{SimpleCov.root}/", '')
+  end
+
+  def relative_filename(path)
+    @path_relativizer[path]
+  end
+
+  def file_filter_classes(file_path)
+    file_path.split('/')[0..-2] * " "
+  end
+
+  def line_css_for(coverage)
+    unless coverage.nil?
+      if coverage > 0
+        "marked"
+      else
+        "uncovered"
+      end
+    else
+      "inferred"
+    end
   end
 end
+
+require 'simplecov-rcov/version'

data/lib/simplecov-rcov/version.rb

@@ -0,0 +1,8 @@
+module SimpleCov
+  module Formatter
+    class RcovFormatter
+      VERSION = "0.2.0"
+      UPSTREAM_URL = "https://github.com/fguillen/simplecov-rcov"
+    end
+  end
+end

data/simplecov-rcov.gemspec

@@ -1,40 +1,26 @@
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require 'simplecov-rcov/version'
 
 Gem::Specification.new do |s|
-  s.name = %q{simplecov-rcov}
-  s.version = "0.1.4"
+  s.name        = %q{simplecov-rcov}
+  s.version     = SimpleCov::Formatter::RcovFormatter::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Fernando Guillen http://fernandoguillen.info", "Wes Morgan http://github.com/cap10morgan", "Wandenberg Peixoto http://github.com/wandenberg"]
+  s.email       = ["fguillen.mail@gmail.com", "cap10morgan@gmail.com"]
+  s.homepage    = %q{http://github.com/fguillen/simplecov-rcov}
+  s.summary     = %q{Rcov style formatter for SimpleCov}
+  s.description = %q{Rcov style formatter for SimpleCov}
+  s.date        = %q{2011-02-10}
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Fernando Guillen http://fernandoguillen.info, Wes Morgan http://github.com/cap10morgan"]
-  s.date = %q{2011-02-10}
-  s.description = %q{Rcov style formatter for SimpleCov}
-  s.email = ["fguillen.mail@gmail.com", "cap10morgan@gmail.com"]
   s.extra_rdoc_files = ["README.md", "lib/simplecov-rcov.rb"]
-  s.files = ["Gemfile", "Gemfile.lock", "Manifest", "README.md", "Rakefile", "lib/simplecov-rcov.rb", "simplecov-rcov.gemspec", "test/fixtures/app/controllers/sample.rb", "test/fixtures/app/models/airplane.rb", "test/fixtures/app/models/dog.rb", "test/fixtures/app/models/house.rb", "test/fixtures/app/models/robot.rb", "test/fixtures/app/models/user.rb", "test/fixtures/file_tr.html", "test/fixtures/sample.rb", "test/fixtures/totals_tr.html", "test/helper.rb", "test/simplecov-rcov_test.rb", "views/index.erb.html"]
-  s.homepage = %q{http://github.com/fguillen/simplecov-rcov}
   s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Simplecov-rcov", "--main", "README.md"]
-  s.require_paths = ["lib"]
   s.rubyforge_project = %q{simplecov-rcov}
   s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Rcov style formatter for SimpleCov}
-  s.test_files = ["test/simplecov-rcov_test.rb"]
 
-  if s.respond_to? :specification_version then
-    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
-    s.specification_version = 3
-
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
-      s.add_runtime_dependency(%q<simplecov>, [">= 0"])
-      s.add_development_dependency(%q<echoe>, [">= 0"])
-      s.add_development_dependency(%q<mocha>, [">= 0"])
-    else
-      s.add_dependency(%q<simplecov>, [">= 0"])
-      s.add_dependency(%q<echoe>, [">= 0"])
-      s.add_dependency(%q<mocha>, [">= 0"])
-    end
-  else
-    s.add_dependency(%q<simplecov>, [">= 0"])
-    s.add_dependency(%q<echoe>, [">= 0"])
-    s.add_dependency(%q<mocha>, [">= 0"])
-  end
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
 end

data/test/fixtures/detail_trs.html

@@ -0,0 +1,30 @@
+        <tr class="inferred">
+          <td><pre><a name="line2">2</a> # Foo class</pre></td>
+        </tr>
+        <tr class="marked">
+          <td><pre><a name="line3">3</a> class Foo</pre></td>
+        </tr>
+        <tr class="marked">
+          <td><pre><a name="line4">4</a>   def initialize</pre></td>
+        </tr>
+        <tr class="marked">
+          <td><pre><a name="line5">5</a>     @foo = 'baz'</pre></td>
+        </tr>
+        <tr class="marked">
+          <td><pre><a name="line6">6</a>   end</pre></td>
+        </tr>
+        <tr class="uncovered">
+          <td><pre><a name="line7">7</a>   </pre></td>
+        </tr>
+        <tr class="marked">
+          <td><pre><a name="line8">8</a>   def bar</pre></td>
+        </tr>
+        <tr class="uncovered">
+          <td><pre><a name="line9">9</a>     @foo</pre></td>
+        </tr>
+        <tr class="inferred">
+          <td><pre><a name="line10">10</a>   end</pre></td>
+        </tr>
+        <tr class="inferred">
+          <td><pre><a name="line11">11</a> end</pre></td>
+        </tr>

data/test/fixtures/file_tr.html

@@ -1,7 +1,15 @@
-            <tr class="all_files">
-              <td class="left_align"><a href="#./test/fixtures/app/models/user.rb">./test/fixtures/app/models/user.rb</a></td>
+            <tr class="all_files all_coverage 80 90 100 test fixtures app models odd">
+              <td class="left_align"><a href="test-fixtures-app-models-user_rb.html">test/fixtures/app/models/user.rb</a></td>
               <td class='right_align'><tt>10</tt></td>
               <td class='right_align'><tt>7</tt></td>
-              <td class="left_align"><tt class=''>71.43%</tt></td>
-              <td class="left_align"><tt class=''>71.43%</tt></td>
+              <td class="left_align"><div class="percent_graph_legend"><tt class=''>80.00%</tt></div>
+      <div class="percent_graph">
+        <div class="covered" style="width:80px"></div>
+        <div class="uncovered" style="width:20px"></div>
+      </div></td>
+              <td class="left_align"><div class="percent_graph_legend"><tt class=''>71.43%</tt></div>
+      <div class="percent_graph">
+        <div class="covered" style="width:71px"></div>
+        <div class="uncovered" style="width:29px"></div>
+      </div></td>
             </tr>

data/test/fixtures/totals_tr.html

@@ -2,6 +2,14 @@
             <td class="left_align">TOTAL</td>
             <td class='right_align'><tt>60</tt></td>
             <td class='right_align'><tt>34</tt></td>
-            <td class="left_align"><tt class=''>67.65%</tt></td>
-            <td class="left_align"><tt class='coverage_total'>67.65%</tt></td>
+            <td class="left_align"><div class="percent_graph_legend"><tt class=''>81.67%</tt></div>
+      <div class="percent_graph">
+        <div class="covered" style="width:82px"></div>
+        <div class="uncovered" style="width:18px"></div>
+      </div></td>
+            <td class="left_align"><div class="percent_graph_legend"><tt class='coverage_total'>67.65%</tt></div>
+      <div class="percent_graph">
+        <div class="covered" style="width:68px"></div>
+        <div class="uncovered" style="width:32px"></div>
+      </div></td>
           </tr>

data/test/test_simplecov-rcov.rb

@@ -0,0 +1,45 @@
+require "#{File.expand_path(File.dirname(__FILE__))}/helper"
+
+class SimplecovRcovFormatterTest < Test::Unit::TestCase
+  def test_format
+    SimpleCov.stubs(:coverage_path).returns('/tmp')
+    index = File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/index.html")
+    if File.exists?( index )
+      File.delete( index )
+    end
+
+    @original_result = {
+      source_fixture( 'sample.rb' )                  => [nil, 1, 1, 1, nil, 0, 1, 1, nil, nil],
+      source_fixture( 'app/models/user.rb' )         => [nil, 1, 1, 1, 1, 0, 1, 0, nil, nil],
+      source_fixture( 'app/models/robot.rb' )        => [1, 1, 1, 1, nil, nil, 1, 0, nil, nil],
+      source_fixture( 'app/models/house.rb' )        => [nil, nil, nil, nil, nil, nil, nil, nil, nil, nil],
+      source_fixture( 'app/models/airplane.rb' )     => [0, 0, 0, 0, 0],
+      source_fixture( 'app/models/dog.rb' )          => [1, 1, 1, 1, 1],
+      source_fixture( 'app/controllers/sample.rb' )  => [nil, 1, 1, 1, nil, nil, 0, 0, nil, nil]
+    }
+
+    @result = SimpleCov::Result.new( @original_result )
+    SimpleCov::Formatter::RcovFormatter.new().format( @result )
+
+    assert( File.exists?( index ) )
+
+    rcov_result = File.read( index )
+    assert_match( File.read( "#{File.dirname(__FILE__)}/fixtures/totals_tr.html"), rcov_result )
+    assert_match( File.read( "#{File.dirname(__FILE__)}/fixtures/file_tr.html"), rcov_result )
+
+    assert( File.exists?( File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/test-fixtures-sample_rb.html") ) )
+    assert( File.exists?( File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/test-fixtures-app-models-user_rb.html") ) )
+    assert( File.exists?( File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/test-fixtures-app-models-robot_rb.html") ) )
+    assert( File.exists?( File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/test-fixtures-app-models-house_rb.html") ) )
+    assert( File.exists?( File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/test-fixtures-app-models-airplane_rb.html") ) )
+    assert( File.exists?( File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/test-fixtures-app-models-dog_rb.html") ) )
+    assert( File.exists?( File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/test-fixtures-app-controllers-sample_rb.html") ) )
+
+    assert_match( File.read( "#{File.dirname(__FILE__)}/fixtures/detail_trs.html"), File.read(File.join( SimpleCov::Formatter::RcovFormatter.output_path, "/test-fixtures-app-models-user_rb.html")) )
+
+  end
+
+  def source_fixture( filename )
+    File.expand_path( File.join( File.dirname( __FILE__ ), 'fixtures', filename ) )
+  end
+end

data/views/detail.html.erb

@@ -0,0 +1,56 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <title><%= shortened_filename(file) %></title>
+    <link href="<%= assets_path('screen.css')%>" media="all" rel="stylesheet" type="text/css" />
+    <link href="<%= assets_path('print.css')%>" media="print" rel="stylesheet" type="text/css" />
+    <meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
+    <script type="text/javascript" src="<%= assets_path('rcov.js')%>"></script>
+  </head>
+  <body>
+    <h1><%= "#{project_name} C0 Coverage Information - Simploco - RCov" %></h1>
+    <h2><%= shortened_filename(file) %></h2>
+
+    <div class="report_table_wrapper">
+      <table class='report' id='report_table'>
+        <thead>
+          <tr>
+            <th class="left_align">Name</th>
+            <th class="right_align">Total Lines</th>
+            <th class="right_align">Lines of Code</th>
+            <th class="left_align">Total Coverage</th>
+            <th class="left_align">Code Coverage</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr>
+            <td class="left_align"><a href="<%= relative_filename(shortened_filename(file)) %>"><%= shortened_filename(file) %></a></td>
+            <td class='right_align'><tt><%= file.lines.count %></tt></td>
+            <td class='right_align'><tt><%= file.covered_lines.count + file.missed_lines.count %></tt></td>
+            <td class="left_align"><%= code_coverage_html(total_coverage_for_report(file)) %></td>
+            <td class="left_align"><%= code_coverage_html(file.covered_percent) %></td>
+          </tr>
+        </tbody>
+      </table>
+    </div>
+
+    <h3>Key</h3>
+
+    <div class="key"><pre><span class='marked'>Code reported as executed by Ruby looks like this...</span><span class='marked1'>and this: this line is also marked as covered.</span><span class='inferred'>Lines considered as run by rcov, but not reported by Ruby, look like this,</span><span class='inferred1'>and this: these lines were inferred by rcov (using simple heuristics).</span><span class='uncovered'>Finally, here's a line marked as not executed.</span></pre></div>
+
+    <h3>Coverage Details</h3>
+
+    <table class="details">
+      <tbody>
+        <%- file.lines.each do |line| -%>
+        <tr class="<%= line_css_for(line.coverage) %>">
+          <td><pre><a name="line<%= line.number.next %>"><%= line.number.next %></a> <%= CGI::escapeHTML(line.src.chomp) %></pre></td>
+        </tr>
+        <%- end -%>
+      </tbody>
+    </table>
+
+    <p>Generated on <%= generated_on %> with <a href="<%= SimpleCov::Formatter::RcovFormatter::UPSTREAM_URL %>">SimpleCov-RCov <%= SimpleCov::Formatter::RcovFormatter::VERSION %></a></p>
+
+  </body>
+</html>

data/views/index.html.erb

@@ -0,0 +1,88 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+<html lang='en' xml:lang='en' xmlns='http://www.w3.org/1999/xhtml'>
+  <head>
+    <meta http-equiv="Content-type" content="text/html;charset=UTF-8" />
+    <title><%= "#{project_name} C0 Coverage Information - SimpleCov - RCov style" %></title>
+    <link href="<%= assets_path('screen.css')%>" media="all" rel="stylesheet" type="text/css" />
+    <link href="<%= assets_path('print.css')%>" media="print" rel="stylesheet" type="text/css" />
+    <script type="text/javascript" src="<%= assets_path('jquery-1.3.2.min.js')%>"></script>
+    <script type="text/javascript" src="<%= assets_path('jquery.tablesorter.min.js')%>"></script>
+    <script type="text/javascript" src="<%= assets_path('rcov.js')%>"></script>
+  </head>
+  <body>
+    <h1><%= "#{project_name} C0 Coverage Information - SimpleCov - RCov style" %></h1>
+
+    <noscript><style type="text/css">.if_js { display:none; }</style></noscript>
+
+    <div class="filters if_js">
+      <fieldset>
+        <label>File Filter:</label>
+        <select id="file_filter" class="filter">
+          <option value="all_files">Show All</option>
+          <% @files.map{|f| shortened_filename(f).split('/')[0..-2]}.flatten.uniq.sort.each do |f| %><option value="<%= f %>"><%= f %>/</option><% end %>
+        </select>
+      </fieldset>
+      <fieldset>
+        <label>Code Coverage Threshold:</label>
+        <select id="coverage_filter" class="filter">
+          <option value="all_coverage">Show All</option>
+          <% (1..10).each do |i| %><option value="<%= i * 10 %>">&lt; <%= i * 10 %>% Coverage</option><% end %>
+          <option value="110">= 100% Coverage</option>
+        </select>
+      </fieldset>
+    </div>
+
+    <div class="report_table_wrapper">
+      <table class='report' id='report_table'>
+        <thead>
+          <tr>
+            <th class="left_align">Name</th>
+            <th class="right_align">Total Lines</th>
+            <th class="right_align">Lines of Code</th>
+            <th class="left_align">Total Coverage</th>
+            <th class="left_align">Code Coverage</th>
+          </tr>
+        </thead>
+        <tfoot>
+          <tr>
+            <td class="left_align">TOTAL</td>
+            <td class='right_align'><tt><%= @total_lines %></tt></td>
+            <td class='right_align'><tt><%= @total_lines_code %></tt></td>
+            <td class="left_align"><%= code_coverage_html(@total_coverage) %></td>
+            <td class="left_align"><%= code_coverage_html(@total_coverage_code, true) %></td>
+          </tr>
+        </tfoot>
+        <tbody>
+          <% @files.each_with_index do |file,i| %>
+            <tr class="all_files all_coverage <%= coverage_threshold_classes(file.covered_percent) %> <%= file_filter_classes(shortened_filename(file)) %> <%= i.odd? ? 'odd' : 'even' %>">
+              <td class="left_align"><a href="<%= CGI::escapeHTML(relative_filename(shortened_filename(file))) %>"><%= CGI::escapeHTML(shortened_filename(file)) %></a></td>
+              <td class='right_align'><tt><%= file.lines.count %></tt></td>
+              <td class='right_align'><tt><%= file.covered_lines.count + file.missed_lines.count %></tt></td>
+              <td class="left_align"><%= code_coverage_html(total_coverage_for_report(file)) %></td>
+              <td class="left_align"><%= code_coverage_html(file.covered_percent) %></td>
+            </tr>
+          <% end %>
+        </tbody>
+      </table>
+    </div>
+
+    <p>Generated on <%= generated_on %> with <a href="<%= SimpleCov::Formatter::RcovFormatter::UPSTREAM_URL %>">SimpleCov-RCov <%= SimpleCov::Formatter::RcovFormatter::VERSION %></a></p>
+
+    <script type="text/javascript">
+      $(document).ready(function(){$("#report_table").tablesorter({widgets: ['zebra'], textExtraction: 'complex'});});
+      $('.filter').change(function(){
+        ff = $('#file_filter').val();
+        cf = $('#coverage_filter').val();
+        $('table#report_table tbody tr').each(function(i){
+          if ((this.className.split(" ").indexOf(ff) > -1) && (this.className.split(" ").indexOf(cf) > -1)) {
+            this.style.display = "";
+          } else {
+            this.style.display = "none";
+          };
+          restripe();
+        })
+      })
+    </script>
+
+  </body>
+</html>