coverage-printer 0.1.0

data/Gemfile

@@ -0,0 +1,6 @@
+source "http://rubygems.org"
+
+group :development do
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end

data/Gemfile.lock

@@ -0,0 +1,16 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)

data/README

@@ -0,0 +1,27 @@
+= CoveragePrinter
+
+* https://github.com/okkez/coverage-printer
+
+== Description
+
+CoveragePrinter - Format Coverage.result.
+
+== Install
+
+  $ gem install coverage-printer
+
+== Usage
+
+use with test-unit-2.3.0.
+
+  require 'test/unit/coverage'
+  require 'coverage/html_printer'
+  Test::Unit::Coverage.printer = Coverage::HTMLPrinter.new
+
+== License
+LGPLv2.1 or later.
+
+== Authors
+
+* okkez
+

data/Rakefile

@@ -0,0 +1,28 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "coverage-printer"
+  gem.homepage = "http://github.com/okkez/coverage-printer"
+  gem.license = "MIT"
+  gem.summary = %Q{This library provides the ability to visualize code coverage for Ruby1.9.}
+  gem.description = %Q{This library provides the ability to visualize code coverage for Ruby1.9.}
+  gem.email = "okkez000@gmail.com"
+  gem.authors = ["okkez"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+  gem.required_ruby_version = Gem::Requirement.new(">= 1.9.1")
+end
+Jeweler::RubygemsDotOrgTasks.new

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/coverage-printer.gemspec

@@ -0,0 +1,62 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run 'rake gemspec'
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{coverage-printer}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["okkez"]
+  s.date = %q{2011-04-27}
+  s.description = %q{This library provides the ability to visualize code coverage for Ruby1.9.}
+  s.email = %q{okkez000@gmail.com}
+  s.extra_rdoc_files = [
+    "README"
+  ]
+  s.files = [
+    "Gemfile",
+    "Gemfile.lock",
+    "README",
+    "Rakefile",
+    "VERSION",
+    "coverage-printer.gemspec",
+    "data/javascripts/coverage.js",
+    "data/stylesheets/coverage.css",
+    "data/stylesheets/reset.css",
+    "data/templates/detail.html.erb",
+    "data/templates/index.html.erb",
+    "lib/coverage/html_printer.rb",
+    "lib/coverage/statistics.rb",
+    "lib/coverage/utility.rb",
+    "test/coverage/statistics_test.rb",
+    "test/test_helper.rb"
+  ]
+  s.homepage = %q{http://github.com/okkez/coverage-printer}
+  s.licenses = ["MIT"]
+  s.require_paths = ["lib"]
+  s.required_ruby_version = Gem::Requirement.new(">= 1.9.1")
+  s.rubygems_version = %q{1.5.2}
+  s.summary = %q{This library provides the ability to visualize code coverage for Ruby1.9.}
+  s.test_files = [
+    "test/coverage/statistics_test.rb",
+    "test/test_helper.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+      s.add_development_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_development_dependency(%q<jeweler>, ["~> 1.5.2"])
+    else
+      s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+      s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+    end
+  else
+    s.add_dependency(%q<bundler>, ["~> 1.0.0"])
+    s.add_dependency(%q<jeweler>, ["~> 1.5.2"])
+  end
+end
+

data/data/stylesheets/coverage.css

@@ -0,0 +1,58 @@
+body{font:13px/1.5 'Helvetica Neue',Arial,'Liberation Sans',FreeSans,sans-serif}a:focus{outline:1px dotted}hr{border:0 #ccc solid;border-top-width:1px;clear:both;height:0}h1{font-size:25px}h2{font-size:23px}h3{font-size:21px}h4{font-size:19px}h5{font-size:17px}h6{font-size:15px}ol{list-style:decimal}ul{list-style:disc}li{margin-left:30px}p,dl,hr,h1,h2,h3,h4,h5,h6,ol,ul,pre,table,address,fieldset{margin-bottom:20px}
+
+body {
+  background-color: #F4F2ED;
+}
+
+h1, h2, h3, h4 {
+  margin-left: 2%;
+}
+
+table {
+  border: 1px solid #666666;
+  border-collapse: collapse;
+  margin-top: 1em;
+  margin-left: 5%;
+  margin-right: 5%;
+  width: 90%;  
+}
+
+th, td {
+  border: 1px solid #666666;
+}
+
+.covered {
+  background-color: #BED2BE;
+}
+
+.not-code {
+  background-color: #E0DEDB;
+}
+
+.uncovered {
+  background-color: #CD8A8B;
+}
+
+div.code {
+  margin: 2.5% 5% 2.5% 5%;
+  border: 1px solid #666666;
+}
+
+div.code > ol {
+  margin: 0% 0% 0% 1%;
+}
+
+div.bar-container {
+  border: 1px solid #ccc;
+  width: 100px;
+  margin: 2px 5px 2px 0;
+  padding: 0;
+  float: right;
+  background: #A92730;
+}
+
+div.bar-container > div {
+  background-color: #649632;
+  height: 12px;
+}
+

data/data/stylesheets/reset.css

@@ -0,0 +1,102 @@
+/* 
+html5doctor.com Reset Stylesheet
+v1.6.1
+Last Updated: 2010-09-17
+Author: Richard Clark - http://richclarkdesign.com 
+Twitter: @rich_clark
+*/
+
+html, body, div, span, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote, pre,
+abbr, address, cite, code,
+del, dfn, em, img, ins, kbd, q, samp,
+small, strong, sub, sup, var,
+b, i,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, figcaption, figure, 
+footer, header, hgroup, menu, nav, section, summary,
+time, mark, audio, video {
+    margin:0;
+    padding:0;
+    border:0;
+    outline:0;
+    font-size:100%;
+    vertical-align:baseline;
+    background:transparent;
+}
+
+body {
+    line-height:1;
+}
+
+article,aside,details,figcaption,figure,
+footer,header,hgroup,menu,nav,section { 
+	display:block;
+}
+
+nav ul {
+    list-style:none;
+}
+
+blockquote, q {
+    quotes:none;
+}
+
+blockquote:before, blockquote:after,
+q:before, q:after {
+    content:'';
+    content:none;
+}
+
+a {
+    margin:0;
+    padding:0;
+    font-size:100%;
+    vertical-align:baseline;
+    background:transparent;
+}
+
+/* change colours to suit your needs */
+ins {
+    background-color:#ff9;
+    color:#000;
+    text-decoration:none;
+}
+
+/* change colours to suit your needs */
+mark {
+    background-color:#ff9;
+    color:#000; 
+    font-style:italic;
+    font-weight:bold;
+}
+
+del {
+    text-decoration: line-through;
+}
+
+abbr[title], dfn[title] {
+    border-bottom:1px dotted;
+    cursor:help;
+}
+
+table {
+    border-collapse:collapse;
+    border-spacing:0;
+}
+
+/* change border colour to suit your needs */
+hr {
+    display:block;
+    height:1px;
+    border:0;   
+    border-top:1px solid #cccccc;
+    margin:1em 0;
+    padding:0;
+}
+
+input, select {
+    vertical-align:middle;
+}

data/data/templates/detail.html.erb

@@ -0,0 +1,53 @@
+<!DOCTYPE html>
+<html lang="ja">
+  <head>
+    <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+    <%= stylesheet("reset", erb.filename) %>
+    <%= stylesheet("coverage", erb.filename) %>
+    <title><%= page_title %></title>
+  </head>
+  <body>
+    <h1><%= project_name %> C0 Coverage Information</h1>
+    <h2><%= page_title %></h2>
+    <table>
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Total Lines</th>
+          <th>Lines of Code</th>
+          <th>Total Coverage</th>
+          <th>Code Coverage</th>
+        </tr>
+      </thead>
+      <tbody>
+        <tr>
+          <td><%= label %></td>
+          <td><%= total %></td>
+          <td><%= lines_of_code %></td>
+          <td><%= total_coverage %></td>
+          <td><%= code_coverage %></td>
+        </tr>
+      </tbody>
+    </table>
+
+    <h3>Key</h3>
+
+    <div id="key" class="code">
+      <ol>
+        <li class="covered">covered code...</li>
+        <li class="not-code">not code...</li>
+        <li class="uncovered">uncovered code...</li>
+      </ol>
+    </div>
+
+    <h3>Coverage Details</h3>
+
+    <div id="coverage-details" class="code">
+      <ol>
+      <%- each_line do |line| -%>
+        <li class="<%= line.class_name%>"><code><%= line.line %></code></li>
+      <%- end -%>
+      </ol>
+    </div>
+  </body>
+</html>

data/data/templates/index.html.erb

@@ -0,0 +1,43 @@
+<!DOCTYPE html>
+<html lang="ja">
+  <head>
+    <meta content="text/html; charset=utf-8" http-equiv="Content-Type">
+    <%= stylesheet("reset", erb.filename) %>
+    <%= stylesheet("coverage", erb.filename) %>
+    <title>C0 Coverage</title>
+  </head>
+  <body>
+    <h1><%= project_name %> C0 Coverage Information</h1>
+    <table>
+      <thead>
+        <tr>
+          <th>Name</th>
+          <th>Total Lines</th>
+          <th>Lines of Code</th>
+          <th>Total Coverage</th>
+          <th>Code Coverage</th>
+        </tr>
+      </thead>
+      <tbody>
+        <%- @files.each do |detail| -%>
+        <tr>
+          <td><%= detail.link %></td>
+          <td><%= detail.total %></td>
+          <td><%= detail.lines_of_code %></td>
+          <td><%= detail.total_coverage %></td>
+          <td><%= detail.code_coverage %></td>
+        </tr>
+        <%- end -%>
+      </tbody>
+      <tfooter>
+        <tr>
+          <td>Total</td>
+          <td><%= total %></td>
+          <td><%= lines_of_code %></td>
+          <td><%= total_coverage %></td>
+          <td><%= code_coverage %></td>
+        </tr>
+      </tfooter>
+    </table>
+  </body>
+</html>

data/lib/coverage/html_printer.rb

@@ -0,0 +1,248 @@
+require 'coverage'
+require 'coverage/statistics'
+require 'fileutils'
+require 'erb'
+require 'forwardable'
+
+module Coverage
+  class HTMLPrinter
+
+    module Utility
+      def stylesheet(name, html_filename)
+        css = output_directory + "#{name}.css"
+        path = css.relative_path_from(Pathname(html_filename).dirname)
+        %Q!<link rel="stylesheet" type="text/css" href="#{path.to_s}"/>!
+      end
+
+      def javascript(name, html_filename)
+        js = output_directory + "#{name}.js"
+        path = js.relative_path_from(Pathname(html_filename).dirname)
+        %Q!<script src="#{path.to_s}"></script>!
+      end
+
+      def coverage_bar(coverage)
+        %Q!<div class="bar-container"><div style="width: #{coverage}%"></div></div>#{coverage}%!
+      end
+    end
+
+    class PathSettings
+
+      attr_reader :output_directory
+
+      def initialize(output_directory)
+        @output_directory = output_directory
+      end
+
+      def base_directory
+        @base_directory ||= Pathname.pwd
+      end
+
+      def lib_base_directory
+        @lib_base_directory ||= Pathname(__FILE__).dirname.parent.parent
+      end
+
+      def templates_directory
+        lib_base_directory + "data/templates"
+      end
+
+      def javascripts_directory
+        lib_base_directory + "data/javascripts"
+      end
+
+      def stylesheets_directory
+        lib_base_directory + "data/stylesheets"
+      end
+    end
+
+    extend Forwardable
+
+    attr_accessor :output_directory, :project_name
+    def_delegators(:@path_settings, :base_directory, :lib_base_directory, :output_directory,
+                   :templates_directory, :javascripts_directory, :stylesheets_directory)
+
+    def initialize
+      yield self if block_given?
+      output_directory ||=  Pathname.pwd + "coverage"
+      @path_settings = PathSettings.new(output_directory)
+      FileUtils.mkdir_p(output_directory)
+      @project_name ||= base_directory.basename
+    end
+
+    def print(result)
+      target_files = Dir.glob("#{base_directory}/**/*.rb")
+      statistics_list = []
+      files = []
+      result.each do |path, counts|
+        next unless target_files.include?(path)
+        next if Regexp.new("#{base_directory}/(?:test|spec|vendor)") =~ path
+        files << Detail.new(@path_settings, @project_name, path, counts)
+      end
+      files.sort_by!{|detail| detail.path }
+      files.each(&:print)
+      index = Index.new(@path_settings, @project_name, files)
+      index.print
+      install_files
+    end
+
+    def install_files
+      stylesheets_directory.each_child do |path|
+        FileUtils.install(path, output_directory)
+      end
+      javascripts_directory.each_child do |path|
+        FileUtils.install(path, output_directory)
+      end
+    end
+
+    class Index
+      include Utility
+
+      attr_reader :project_name, :files
+
+      def initialize(path_settings, project_name, files)
+        @path_settings = path_settings
+        @project_name = project_name
+        @files = files
+      end
+
+      def print
+        erb = ERB.new(File.read(template_path), nil, '-')
+        index_path = @path_settings.output_directory + "index.html"
+        erb.filename = index_path.to_s
+        File.open(index_path, "wb+") do |html|
+          html.puts(erb.result(binding))
+        end
+      end
+
+      def total
+        @total ||= @files.inject(0){|memo, detail| memo + detail.total }
+      end
+
+      def lines_of_code
+        @lines_of_code ||= @files.inject(0){|memo, detail| memo + detail.lines_of_code }
+      end
+
+      def lines_of_covered_code
+        @lines_of_covered_code ||= @files.inject(0){|memo, detail| memo + detail.lines_of_covered_code }
+      end
+
+      def total_coverage
+        coverage = "%0.2f" % [(lines_of_covered_code / total.to_f) * 100]
+        coverage_bar(coverage)
+      end
+
+      def code_coverage
+        coverage = "%0.2f" % [(lines_of_covered_code / lines_of_code.to_f) * 100]
+        coverage_bar(coverage)
+      end
+
+      private
+      def template_path
+        @path_settings.templates_directory + "index.html.erb"
+      end
+
+      def output_directory
+        @path_settings.output_directory
+      end
+    end
+
+    class Detail
+      extend Forwardable
+      include Utility
+
+      def_delegators(:@statistics, :total, :lines_of_code, :lines_of_covered_code)
+      attr_reader :project_name, :page_title, :path
+
+      def initialize(path_settings, project_name, path, counts)
+        @path_settings = path_settings
+        @project_name = project_name
+        @path = path
+        @counts = counts
+        @statistics = Coverage::Statistics.new(path, counts)
+        @source = Pathname(path)
+        @page_title = @source.basename
+        @sources = []
+        @source.each_line.with_index.zip(@counts) do |(line, index), count|
+          @sources << Line.new(index + 1, line, count)
+        end
+      end
+
+      def print
+        erb = ERB.new(File.read(template_path), nil, '-')
+        path = @path_settings.output_directory + html_filename
+        erb.filename = path.to_s
+        FileUtils.mkdir_p(path.dirname)
+        File.open(path, "wb+") do |file|
+          file.puts(erb.result(binding))
+        end
+      end
+
+      def each_line
+        @sources.each do |line|
+          yield line
+        end
+      end
+
+      def label
+        @label ||= @source.relative_path_from(@path_settings.output_directory).to_s.sub(/\A\.\.\//, '')
+      end
+
+      def link
+        %Q!<a href="#{html_filename}">#{label}</a>!
+      end
+
+      def html_filename
+        dir = @source.sub(Regexp.new(@path_settings.base_directory.to_s), '.').dirname
+        file = @source.basename.sub(/\.rb/, "_rb.html")
+        dir + file
+      end
+
+      def total_coverage
+        coverage_bar(@statistics.total_coverage)
+      end
+
+      def code_coverage
+        coverage_bar(@statistics.code_coverage)
+      end
+
+      private
+      def template_path
+        @path_settings.templates_directory + "detail.html.erb"
+      end
+
+      def output_directory
+        @path_settings.output_directory
+      end
+    end
+
+    class Line
+      include ERB::Util
+
+      attr_accessor :lineno, :count
+
+      def initialize(lineno, line, count)
+        @lineno = lineno
+        @line   = line
+        @count  = count
+      end
+
+      def line
+        return "&#x200c;\n" if @line.chomp.size == 0
+        h(@line).gsub(/ /, '&nbsp;')
+      end
+
+      def class_name
+        case
+        when @count.nil?
+          'not-code'
+        when @count > 0
+          'covered'
+        when @count == 0
+          'uncovered'
+        else
+          raise "must not happen! count=<#{@count}>"
+        end
+      end
+    end
+  end
+end
+

data/lib/coverage/statistics.rb

@@ -0,0 +1,31 @@
+module Coverage
+  class Statistics
+
+    attr_reader :path, :counts
+
+    def initialize(path, counts)
+      @path = path
+      @counts = counts
+    end
+
+    def total
+      counts.size
+    end
+
+    def lines_of_code
+      counts.compact.size
+    end
+
+    def total_coverage
+      "%.2f" % [(lines_of_covered_code / total.to_f) * 100]
+    end
+
+    def code_coverage
+      "%.2f" % [(lines_of_covered_code / lines_of_code.to_f) * 100]
+    end
+
+    def lines_of_covered_code
+      counts.select{|count| count && count > 0 }.size
+    end
+  end
+end

data/lib/coverage/utility.rb

@@ -0,0 +1,5 @@
+
+module Coverage
+  module Utility
+  end
+end

data/test/coverage/statistics_test.rb

@@ -0,0 +1,32 @@
+require 'test_helper'
+require 'coverage/statistics'
+
+module Coverage
+  class StatisticsTest < Test::Unit::TestCase
+
+    def setup
+      @statistics = Statistics.new('test.rb',
+                                   [nil, 1, 0, 1, nil, 0, 1, 0, nil, nil])
+    end
+
+    def test_total
+      assert_equal(10, @statistics.total)
+    end
+
+    def test_lines_of_code
+      assert_equal(6, @statistics.lines_of_code)
+    end
+
+    def test_lines_of_covered_code
+      assert_equal(3, @statistics.lines_of_covered_code)
+    end
+
+    def test_total_coverage
+      assert_equal("30.00", @statistics.total_coverage)
+    end
+
+    def test_code_coverage
+      assert_equal("50.00", @statistics.code_coverage)
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,3 @@
+gem 'test-unit'
+require 'test/unit'
+

metadata

@@ -0,0 +1,93 @@
+--- !ruby/object:Gem::Specification 
+name: coverage-printer
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.0
+platform: ruby
+authors: 
+- okkez
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-27 00:00:00 +09:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.0.0
+  type: :development
+  prerelease: false
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        version: 1.5.2
+  type: :development
+  prerelease: false
+  version_requirements: *id002
+description: This library provides the ability to visualize code coverage for Ruby1.9.
+email: okkez000@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- Gemfile
+- Gemfile.lock
+- README
+- Rakefile
+- VERSION
+- coverage-printer.gemspec
+- data/javascripts/coverage.js
+- data/stylesheets/coverage.css
+- data/stylesheets/reset.css
+- data/templates/detail.html.erb
+- data/templates/index.html.erb
+- lib/coverage/html_printer.rb
+- lib/coverage/statistics.rb
+- lib/coverage/utility.rb
+- test/coverage/statistics_test.rb
+- test/test_helper.rb
+has_rdoc: true
+homepage: http://github.com/okkez/coverage-printer
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: 1.9.1
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: This library provides the ability to visualize code coverage for Ruby1.9.
+test_files: 
+- test/coverage/statistics_test.rb
+- test/test_helper.rb