simplecov-html 0.3.0

data/lib/simplecov-html.rb

@@ -0,0 +1,109 @@
+require 'erb'
+require 'fileutils'
+require 'digest/sha1'
+require 'time'
+require 'simple_cov'
+
+# Ensure we are using an compatible version of SimpleCov
+if Gem::Version.new(SimpleCov::VERSION) < Gem::Version.new("0.2.0")
+  raise RuntimeError, "The version of SimpleCov you are using is too old. Please update with 'gem install simplecov'"
+end
+
+class SimpleCov::Formatter::HTMLFormatter
+  VERSION = File.read(File.join(File.dirname(__FILE__), '../VERSION')).strip.chomp
+  
+  def format(result)
+    Dir[File.join(File.dirname(__FILE__), '../assets/*')].each do |path|
+      FileUtils.cp_r(path, asset_output_path)
+    end
+    
+    File.open(File.join(output_path, "index.html"), "w+") do |file|
+      file.puts template('layout').result(binding)
+    end
+    puts "Coverage report generated for #{result.command_name} to #{output_path}"
+  end
+  
+  private
+  
+  # Returns the an erb instance for the template of given name
+  def template(name)
+    ERB.new(File.read(File.join(File.dirname(__FILE__), '../views/', "#{name}.erb")))
+  end
+  
+  def output_path
+    SimpleCov.coverage_path
+  end
+  
+  def asset_output_path
+    return @asset_output_path if @asset_output_path
+    @asset_output_path = File.join(output_path, 'assets', SimpleCov::Formatter::HTMLFormatter::VERSION)
+    FileUtils.mkdir_p(@asset_output_path)
+    @asset_output_path
+  end
+  
+  def assets_path(name)
+    File.join('./assets', SimpleCov::Formatter::HTMLFormatter::VERSION, name)
+  end
+  
+  # Returns the html for the given source_file
+  def formatted_source_file(source_file)
+    template('source_file').result(binding)
+  end
+  
+  # Returns a table containing the given source files
+  def formatted_file_list(title, source_files)
+    template('file_list').result(binding)
+  end
+  
+  # Computes the coverage based upon lines covered and lines missed
+  def coverage(file_list)
+    return 100.0 if file_list.length == 0
+    lines_missed = file_list.map {|f| f.missed_lines.count }.inject(&:+)
+    
+    lines_covered(file_list) * 100 / lines_of_code(file_list).to_f
+  end
+  
+  def lines_of_code(file_list)
+    lines_missed(file_list) + lines_covered(file_list)
+  end
+  
+  def lines_covered(file_list)
+    return 0.0 if file_list.length == 0
+    file_list.map {|f| f.covered_lines.count }.inject(&:+)
+  end
+  
+  def lines_missed(file_list)
+    return 0.0 if file_list.length == 0
+    file_list.map {|f| f.missed_lines.count }.inject(&:+)
+  end
+  
+  def coverage_css_class(covered_percent)
+    if covered_percent > 90
+      'green'
+    elsif covered_percent > 80
+      'yellow'
+    else
+      'red'
+    end
+  end
+  
+  # Return a (kind of) unique id for the source file given. Uses SHA1 on path for the id
+  def id(source_file)
+    Digest::SHA1.hexdigest(source_file.filename)
+  end
+  
+  def timeago(time)
+    "<abbr class=\"timeago\" title=\"#{time.iso8601}\">#{time.iso8601}</abbr>"
+  end
+  
+  def shortened_filename(source_file)
+    source_file.filename.gsub(SimpleCov.root, '.')
+  end
+  
+  def link_to_source_file(source_file)
+    %Q(<a href="##{id source_file}" class="src_link" title="#{shortened_filename source_file}">#{shortened_filename source_file}</a>)
+  end
+end
+
+# Set up the html formatter
+SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter

data/simplecov-html.gemspec

@@ -0,0 +1,103 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{simplecov-html}
+  s.version = "0.3.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Christoph Olszowka"]
+  s.date = %q{2010-08-22}
+  s.description = %q{HTML formatter for SimpleCov code coverage tool for ruby 1.9+}
+  s.email = %q{christoph at olszowka de}
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.rdoc"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.rdoc",
+     "Rakefile",
+     "VERSION",
+     "assets/app.js",
+     "assets/fancybox/blank.gif",
+     "assets/fancybox/fancy_close.png",
+     "assets/fancybox/fancy_loading.png",
+     "assets/fancybox/fancy_nav_left.png",
+     "assets/fancybox/fancy_nav_right.png",
+     "assets/fancybox/fancy_shadow_e.png",
+     "assets/fancybox/fancy_shadow_n.png",
+     "assets/fancybox/fancy_shadow_ne.png",
+     "assets/fancybox/fancy_shadow_nw.png",
+     "assets/fancybox/fancy_shadow_s.png",
+     "assets/fancybox/fancy_shadow_se.png",
+     "assets/fancybox/fancy_shadow_sw.png",
+     "assets/fancybox/fancy_shadow_w.png",
+     "assets/fancybox/fancy_title_left.png",
+     "assets/fancybox/fancy_title_main.png",
+     "assets/fancybox/fancy_title_over.png",
+     "assets/fancybox/fancy_title_right.png",
+     "assets/fancybox/fancybox-x.png",
+     "assets/fancybox/fancybox-y.png",
+     "assets/fancybox/fancybox.png",
+     "assets/fancybox/jquery.fancybox-1.3.1.css",
+     "assets/fancybox/jquery.fancybox-1.3.1.pack.js",
+     "assets/jquery-1.4.2.min.js",
+     "assets/jquery.dataTables.min.js",
+     "assets/jquery.timeago.js",
+     "assets/loading.gif",
+     "assets/magnify.png",
+     "assets/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png",
+     "assets/smoothness/images/ui-bg_flat_75_ffffff_40x100.png",
+     "assets/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png",
+     "assets/smoothness/images/ui-bg_glass_65_ffffff_1x400.png",
+     "assets/smoothness/images/ui-bg_glass_75_dadada_1x400.png",
+     "assets/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png",
+     "assets/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png",
+     "assets/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png",
+     "assets/smoothness/images/ui-icons_222222_256x240.png",
+     "assets/smoothness/images/ui-icons_2e83ff_256x240.png",
+     "assets/smoothness/images/ui-icons_454545_256x240.png",
+     "assets/smoothness/images/ui-icons_888888_256x240.png",
+     "assets/smoothness/images/ui-icons_cd0a0a_256x240.png",
+     "assets/smoothness/jquery-ui-1.8.4.custom.css",
+     "assets/stylesheet.css",
+     "lib/simplecov-html.rb",
+     "simplecov-html.gemspec",
+     "test/helper.rb",
+     "test/test_simple_cov-html.rb",
+     "views/file_list.erb",
+     "views/layout.erb",
+     "views/source_file.erb"
+  ]
+  s.homepage = %q{http://github.com/colszowka/simplecov-html}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{HTML formatter for SimpleCov code coverage tool for ruby 1.9+}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_simple_cov-html.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.3.0"])
+      s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
+    else
+      s.add_dependency(%q<simplecov>, [">= 0.3.0"])
+      s.add_dependency(%q<shoulda>, ["= 2.10.3"])
+    end
+  else
+    s.add_dependency(%q<simplecov>, [">= 0.3.0"])
+    s.add_dependency(%q<shoulda>, ["= 2.10.3"])
+  end
+end
+

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'simple_cov-html'
+
+class Test::Unit::TestCase
+end

data/test/test_simple_cov-html.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestSimpleCovHtml < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

data/views/file_list.erb

@@ -0,0 +1,36 @@
+<div class="file_list_container">
+  <h2 id="<%= title.gsub(/[^a-zA-Z]/, '') %>">
+    <%= title %>
+    (<span class="<%= coverage_css_class(coverage(source_files)) %>"><%= coverage(source_files).round(2) %>%</span>)
+  </h2>
+  <div>
+    <b><%= source_files.length %></b> files in total.
+    <b><%= lines_of_code(source_files) %></b> relevant lines. 
+    <span class="green"><b><%= lines_covered(source_files) %></b> lines covered</span> and
+    <span class="red"><b><%= lines_missed(source_files) %></b> lines missed </span>
+  </div>
+  <table class="file_list">
+    <thead>
+      <tr>
+        <th>File</th>
+        <th>% covered</th>
+        <th>Lines</th>
+        <th>Relevant Lines</th>
+        <th>Lines covered</th>
+        <th>Lines missed</th>
+      </tr>
+    </thead>
+    <tbody>
+      <% source_files.each do |source_file| %>
+      <tr>
+        <td><%= link_to_source_file(source_file) %></td>
+        <td class="<%= coverage_css_class(source_file.covered_percent) %>"><%= source_file.covered_percent.round(2).to_s %> %</td>
+        <td><%= source_file.lines.count %></td>
+        <td><%= source_file.covered_lines.count + source_file.missed_lines.count %></td>
+        <td><%= source_file.covered_lines.count %></td>
+        <td><%= source_file.missed_lines.count %></td>
+      </tr>
+      <% end %>
+    </tbody>
+  </table>
+</div>

data/views/layout.erb

@@ -0,0 +1,42 @@
+<html>
+  <head>
+    <title>Code coverage for <%= SimpleCov.project_name %></title>
+    <script src='<%= assets_path('jquery-1.4.2.min.js') %>' type='text/javascript'></script>
+    <script src='<%= assets_path('jquery.dataTables.min.js') %>' type='text/javascript'></script>   
+    <script src='<%= assets_path('fancybox/jquery.fancybox-1.3.1.pack.js') %>' type='text/javascript'></script>   
+    <script src='<%= assets_path('jquery.timeago.js') %>' type='text/javascript'></script>   
+    <script src='<%= assets_path('app.js') %>' type='text/javascript'></script>    
+    <link href='<%= assets_path('stylesheet.css') %>' media='screen, projection, print' rel='stylesheet' type='text/css'>
+    <link href='<%= assets_path('fancybox/jquery.fancybox-1.3.1.css') %>' media='screen, projection, print' rel='stylesheet' type='text/css'>
+    <link href='<%= assets_path('smoothness/jquery-ui-1.8.4.custom.css') %>' media='screen, projection, print' rel='stylesheet' type='text/css'>    
+  </head>
+  
+  <body>
+    <div id="loading">
+      <img src="<%= assets_path('loading.gif') %>" alt="loading"/>
+    </div>
+    <div id="wrapper" style="display:none;">
+      <div class="timestamp">Generated <%= timeago(Time.now) %></div>
+      <ul class="group_tabs"></ul>
+
+      <div id="content">
+        <%= formatted_file_list("All Files", result.source_files) %>
+
+        <% result.groups.each do |name, files| %>
+          <%= formatted_file_list(name, files) %>
+        <% end %>
+      </div>
+    
+      <div id="footer">
+        Generated by <a href="http://github.com/colszowka/simple_cov">SimpleCov</a> v<%= SimpleCov::VERSION %><br/>
+        using <%= result.command_name %>
+      </div>
+    
+      <div class="source_files">
+      <% result.source_files.each do |source_file| %>
+        <%= formatted_source_file(source_file) %>
+      <% end %>
+      </div>
+    </div>
+  </body>
+</html>

data/views/source_file.erb

@@ -0,0 +1,33 @@
+<div class="source_table" id="<%= id source_file %>">
+  <table>
+    <thead>
+    <tr>
+      <td colspan="3">
+        <h3><%= shortened_filename source_file %></h3>
+        <h4><span class="<%= coverage_css_class(source_file.covered_percent) %>"><%= source_file.covered_percent.round(2).to_s %> %</span> covered</h4>
+      </td>
+    </tr>
+    <tr>
+      <th>#</th>
+      <th></th>
+      <th>Hits</th>
+    </tr>
+    </thead>
+    <tbody>
+  <% source_file.lines.each do |line| %>
+    <% classname = line.coverage ? (line.coverage > 0 ? 'hit' : 'miss') : 'never' %>
+    <tr class="<%= classname %>" <%= line.coverage ? "data-hits=\"#{line.coverage}\"" : '' %>>
+      <td class="line_number">
+        <pre><%= line.number %></pre>
+      </td>
+      <td>
+        <pre><%= line.src.chomp %></pre>
+      </td>
+      <td class="hits">
+        <%= line.coverage %>
+      </td>
+    </tr>
+  <% end %>
+    </tbody>
+  </table>
+</div>

metadata

@@ -0,0 +1,150 @@
+--- !ruby/object:Gem::Specification 
+name: simplecov-html
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 3
+  - 0
+  version: 0.3.0
+platform: ruby
+authors: 
+- Christoph Olszowka
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-08-22 00:00:00 +02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 0
+        version: 0.3.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 10
+        - 3
+        version: 2.10.3
+  type: :development
+  version_requirements: *id002
+description: HTML formatter for SimpleCov code coverage tool for ruby 1.9+
+email: christoph at olszowka de
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- assets/app.js
+- assets/fancybox/blank.gif
+- assets/fancybox/fancy_close.png
+- assets/fancybox/fancy_loading.png
+- assets/fancybox/fancy_nav_left.png
+- assets/fancybox/fancy_nav_right.png
+- assets/fancybox/fancy_shadow_e.png
+- assets/fancybox/fancy_shadow_n.png
+- assets/fancybox/fancy_shadow_ne.png
+- assets/fancybox/fancy_shadow_nw.png
+- assets/fancybox/fancy_shadow_s.png
+- assets/fancybox/fancy_shadow_se.png
+- assets/fancybox/fancy_shadow_sw.png
+- assets/fancybox/fancy_shadow_w.png
+- assets/fancybox/fancy_title_left.png
+- assets/fancybox/fancy_title_main.png
+- assets/fancybox/fancy_title_over.png
+- assets/fancybox/fancy_title_right.png
+- assets/fancybox/fancybox-x.png
+- assets/fancybox/fancybox-y.png
+- assets/fancybox/fancybox.png
+- assets/fancybox/jquery.fancybox-1.3.1.css
+- assets/fancybox/jquery.fancybox-1.3.1.pack.js
+- assets/jquery-1.4.2.min.js
+- assets/jquery.dataTables.min.js
+- assets/jquery.timeago.js
+- assets/loading.gif
+- assets/magnify.png
+- assets/smoothness/images/ui-bg_flat_0_aaaaaa_40x100.png
+- assets/smoothness/images/ui-bg_flat_75_ffffff_40x100.png
+- assets/smoothness/images/ui-bg_glass_55_fbf9ee_1x400.png
+- assets/smoothness/images/ui-bg_glass_65_ffffff_1x400.png
+- assets/smoothness/images/ui-bg_glass_75_dadada_1x400.png
+- assets/smoothness/images/ui-bg_glass_75_e6e6e6_1x400.png
+- assets/smoothness/images/ui-bg_glass_95_fef1ec_1x400.png
+- assets/smoothness/images/ui-bg_highlight-soft_75_cccccc_1x100.png
+- assets/smoothness/images/ui-icons_222222_256x240.png
+- assets/smoothness/images/ui-icons_2e83ff_256x240.png
+- assets/smoothness/images/ui-icons_454545_256x240.png
+- assets/smoothness/images/ui-icons_888888_256x240.png
+- assets/smoothness/images/ui-icons_cd0a0a_256x240.png
+- assets/smoothness/jquery-ui-1.8.4.custom.css
+- assets/stylesheet.css
+- lib/simplecov-html.rb
+- simplecov-html.gemspec
+- test/helper.rb
+- test/test_simple_cov-html.rb
+- views/file_list.erb
+- views/layout.erb
+- views/source_file.erb
+has_rdoc: true
+homepage: http://github.com/colszowka/simplecov-html
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: HTML formatter for SimpleCov code coverage tool for ruby 1.9+
+test_files: 
+- test/helper.rb
+- test/test_simple_cov-html.rb