duvet 0.3.2 → 0.3.3

data/lib/duvet.rb

@@ -0,0 +1,77 @@
+# Add this to test/helper.rb at the before __anything__ else
+#
+#   require 'duvet'
+#   Duvet.start
+#
+
+require 'coverage'
+require 'pathname'
+require 'erubis'
+require 'sass'
+
+require 'duvet/core_ext'
+require 'duvet/covs'
+require 'duvet/cov'
+require 'duvet/version'
+
+module Duvet
+
+  attr_accessor :opts
+  
+  DEFAULTS = {:dir => 'cov', :style => 'rcov'}
+  
+  TEMPLATE_PATH = Pathname.new(__FILE__).dirname + '..' + 'templates'
+  
+  TEMPLATE_HASH = {
+    'time' => Time.now,
+    'version' => VERSION,
+    'name' => 'duvet'
+  }
+
+  # Start tracking
+  def self.start(opts={})
+    @opts = DEFAULTS.merge(opts)
+    
+    Coverage.start
+    @running = true
+  end
+  
+  # Get result
+  def self.result
+    cov = Coverage.result if running?
+    if @opts[:filter]
+      filtered = {}
+      @opts[:filter] = /#{@opts[:filter]}/ unless @opts[:filter].is_a?(Regexp)
+      cov.each do |k, v|
+        if @opts[:filter] =~ k
+          filtered[k] = v
+        end
+      end
+      cov = filtered
+    end
+    @result ||= Duvet::Covs.new(cov)
+  ensure
+    @running = false
+  end
+  
+  # Write results
+  def self.write
+    self.result.write(Pathname.new(@opts[:dir])) if running?
+  end
+  
+  # Proc to call when exiting
+  # @todo Allow user to override block used
+  def self.at_exit
+    Proc.new { self.write }
+  end
+  
+  # @return [Boolean] whether coverage is running
+  def self.running?
+    @running
+  end
+
+end
+
+at_exit do
+  Duvet.at_exit.call
+end

data/lib/duvet/core_ext.rb

@@ -0,0 +1,17 @@
+class Pathname
+  
+  # Gets just the extension of the pathname
+  #
+  # @return [String] the extension of the path, without the '.'
+  def extension
+    self.extname[1..-1]
+  end
+  
+  # Gets the name of the file without the extension
+  #
+  # @return [String] name of the file
+  def file_name
+    self.basename.to_s[0...-(self.extension.size+1)]
+  end
+
+end

data/lib/duvet/cov.rb

@@ -0,0 +1,100 @@
+module Duvet
+  class Cov
+    attr_accessor :path
+    
+    def initialize(path, cov)
+      @path = Pathname.new(path)
+      if @path.to_s.include?(Dir.pwd)
+        @path = @path.relative_path_from(Pathname.getwd)
+      end
+      
+      @cov = cov
+    end
+    
+    # @return [Array] lines in file
+    def lines
+      @cov
+    end
+    
+    # @return [Array] all lines which can be executed
+    def code_lines
+      @cov.reject {|i| i.nil?}
+    end
+    
+    # @return [Array] all lines which have been ran
+    def ran_lines
+      @cov.reject {|i| i.nil? || i.zero?}
+    end
+    
+    # Gives a fraction from 0 to 1 of how many lines of code have 
+    # been executed. It ignores all lines that couldn't be executed
+    # such as comments.
+    #
+    # @return [Float] lines of code executed as a fraction
+    def code_coverage
+      return 0.0 if code_lines.size.zero?
+      ran_lines.size.to_f / code_lines.size.to_f
+    end
+
+    # Similar to #code_coverage but counts all lines, executable
+    # or not.
+    #
+    # @return [Integer] lines executed as a fraction
+    def total_coverage
+      return 0.0 if lines.size.zero?
+      ran_lines.size.to_f / lines.size.to_f
+    end
+    
+    # @return [String] #code_coverage as ??.??%
+    def code_coverage_percent
+      "%.2f%" % (code_coverage*100)
+    end
+    
+    # @return [String] #total_coverage as ??.??%
+    def total_coverage_percent
+      "%.2f%" % (total_coverage*100)
+    end
+    
+    # @return [String]
+    def report
+      str = "#{@path}\n"
+      str << "  total: #{total_coverage_percent}\n"
+      str << "  code:  #{code_coverage_percent}\n\n"
+      str
+    end
+    
+    # @return [Hash] a hash of data for templating
+    def data
+      {
+        "file" => {
+          "path" => @path.to_s,
+          "url" => @path.file_name + '.html',
+          "source" => @path.readlines,
+          "lines" => lines.size,
+          "lines_code" => code_lines.size,
+          "lines_ran" => ran_lines.size
+        },
+        "coverage" => {
+          "code" => code_coverage_percent,
+          "total" => total_coverage_percent,
+          "lines" => lines
+        }
+      }
+    end
+    
+    # Formats the coverage for the file to be written to a html
+    # file, then viewed in a web browser.
+    #
+    # @return [String]
+    def format
+      template = (TEMPLATE_PATH + 'html' + 'file.erb').read
+      Erubis::Eruby.new(template).result(TEMPLATE_HASH.merge(self.data))
+    end
+    
+    def write(dir)
+      path = (dir + @path.file_name).to_s + '.html'
+      File.open(path, 'w') {|f| f.write(self.format) }
+    end
+  
+  end
+end

data/lib/duvet/covs.rb

@@ -0,0 +1,49 @@
+module Duvet
+  class Covs < Array
+  
+    def initialize(cov)
+      self.replace []
+      cov.each do |path, c|
+        self << Cov.new(path, c)
+      end
+    end
+  
+    def report
+      map {|i| i.report }.join('')
+    end
+    
+    def data
+      { 'files' => map {|i| i.data } }
+    end
+    
+    def format
+      template = (TEMPLATE_PATH + 'html' + 'index.erb').read
+      Erubis::Eruby.new(template).result(TEMPLATE_HASH.merge(self.data))
+    end
+    
+    def write(dir)
+      if size > 0
+        FileUtils.mkdir_p(dir)
+        File.open(dir + 'index.html', 'w') {|f| f.write(format) }
+        
+        each {|c| c.write(dir) }
+        write_resources(dir)
+      else
+        warn "No files to create coverage for."
+      end
+    end
+
+    def write_resources(dir)
+      Pathname.glob(TEMPLATE_PATH + 'css' + '*').each do |i|
+        f = File.new(dir + 'styles.css', 'w')
+        f.write Sass::Engine.new(i.read).render
+      end
+
+      Pathname.glob(TEMPLATE_PATH + 'js' + '*').each do |i|
+        f = File.new(dir + i.basename, 'w')
+        f.write(i.read)
+      end
+    end
+  
+  end
+end

data/lib/duvet/version.rb

@@ -0,0 +1,3 @@
+module Duvet
+  VERSION = '0.3.3'
+end

data/templates/css/styles.sass

@@ -0,0 +1,178 @@
+$text: rgb(0, 0, 0)
+
+$dark-grey: #333
+$light-grey: #ccc
+$white: #fff
+
+$excluded: #e0dedb
+$unran: #ce8b8c
+$ran: #bed2be
+
+// Main
+html
+  margin: 0
+  padding: 0
+  width: 100%
+
+body
+  background: #f4f2ed
+  font: 12px/1.3em Helvetica
+  margin: 8px
+
+a
+  text-decoration: none
+
+
+// Header
+header
+  margin: 2em .5em
+  text-shadow: 0 1px 0 rgba(255, 255, 255, .5)
+  
+  h1, h1 a
+    color: $dark-grey
+    
+  h2
+    color: lighten($dark-grey, 40%)
+    font-size: 16px
+
+// Filter/Search Box
+#filter
+  position: absolute
+  top: 20px
+  right: 8px
+  border: 1px solid rgb(120, 120, 120)
+  background: rgb(240, 240, 240)
+  -webkit-border-radius: 3px
+  -webkit-box-shadow: inset 0 2px 4px rgba(0, 0, 0, .1), 0 1px 0 white
+  -webkit-transition: all .2s
+  padding: 4px
+  width: 180px
+  
+  &:focus
+    outline: none
+    background: rgb(244, 244, 244)
+    border: 1px solid rgb(100, 100, 100)
+    
+
+// Table
+.table-wrapper
+  min-width: 700px
+
+table
+  border: 1px solid grey
+  background: $excluded
+  border-collapse: collapse
+  width: 100%
+  margin-bottom: 1em
+  -webkit-box-shadow: 0 1px 0 white
+
+table.source, pre, code
+  font: 11px/1.2em Menlo
+
+td pre
+  margin: 0
+
+
+// Summary
+.summary
+  margin-bottom: 1em
+  background: $excluded
+  
+  tbody
+    .name, .name a
+      color: $text
+      font-weight: bold
+  
+  tbody tr:hover 
+    background: darken($excluded, 10%)
+
+  thead
+    background: $dark-grey
+    color: $light-grey
+    
+    th
+      cursor: pointer
+
+  tr
+    text-align: left
+
+  th, td
+    padding: .5em
+    
+  .header::after
+    font-size: 10px
+    margin-left: 10px  
+    
+  .descending::after
+    content: '▼'
+    
+  .ascending::after
+    content: '▲'
+    
+  .lines, .loc, .ran, .cov, .code
+    width: 100px
+    
+// Totals
+.totals
+  border-top: 1px solid grey
+  background: darken($excluded, 10%)
+  font-weight: bold
+  
+  
+// Source
+.source tr
+  pre
+    margin-left: 3px
+
+  .count
+    background: $white
+    -webkit-border-radius: 4px
+    -webkit-border-top-left-radius: 0px
+    -webkit-box-shadow: 0 1px 1px rgba(0, 0, 0, .2)
+    border: 1px solid black
+    display: block
+    padding: 3px
+    position: absolute
+    margin-top: -1.3em
+    right: 15px
+    opacity: 0
+    
+  .no
+    color: $light-grey
+    background: $dark-grey
+    padding: 0 0 0 3px
+    width: 25px
+
+  &:hover 
+    .count
+      opacity: 1
+      
+    .no
+      color: $white
+      
+  // line colouring
+  &.excluded 
+    background: $excluded
+    &:hover
+      background: darken($excluded, 10%)
+    
+  &.unran 
+    background: $unran
+    &:hover
+      background: darken($unran, 10%)
+    
+  &.ran 
+    background: $ran
+    &:hover
+      background: darken($ran, 10%)
+    
+    
+// Footer
+footer
+  color: rgba(0, 0, 0, .6)
+  text-shadow: 0 1px 0 rgba(255, 255, 255, .5)
+  
+  a
+    color: rgb(0, 0, 0)
+    
+    

data/templates/html/file.erb

@@ -0,0 +1,71 @@
+<!DOCTYPE html>
+<html lang="en">
+  <head>
+    <meta charset="utf-8" />
+    <title><%= file['path'] %></title>
+    <link rel="stylesheet" href="styles.css" type="text/css" />
+    <script type="text/javascript" src="jquery.js"></script>
+    <script type="text/javascript" src="main.js"></script>
+    <script type="text/javascript" src="plugins.js"></script>
+  </head>
+  
+  <body>
+    <header>
+      <h1><a href="index.html">Coverage</a></h1>
+      <h2><%= file['path'] %></h2>
+    </header>
+    
+    <div class="table-wrapper">
+      <table class="summary" border="none">
+        <thead>
+           <tr>
+             <th>Name</th>
+             <th>Total Lines</th>
+             <th>Lines of Code</th>
+             <th>Lines Ran</th>
+             <th>Total Coverage</th>
+             <th>Code Coverage</th>
+           </tr>
+         </thead>
+         <tbody>
+           <tr>
+             <td class="name"><%= file['path'] %></td>
+             <td><%= file['lines'] %></td>
+             <td><%= file['lines_code']%></td>
+             <td><%= file['lines_ran']%></td>
+             <td><%= coverage['total']%></td>
+             <td><%= coverage['code']%></td>
+           </tr>
+         </tbody>
+      </table>
+    </div>
+    
+    <div class="table-wrapper">
+      <table class="source" border="none">
+        <% file['source'].zip(coverage['lines']).each_with_index do |(line, count), i| %>
+          <% if count.nil? %>
+            <tr class="excluded">
+              <td class="no"><%= i %></td>
+              <td><pre><code><%= line %></code></pre></td>
+            </tr>
+            
+          <% else %>
+            <tr class="<%= count.zero? ? "unran" : "ran" %>">
+              <td class="no"><%= i %></td>
+              <td><pre><code><%= line %></code></pre><span class="count"><%= count %></span></td>
+            </tr>
+          <% end %>
+        <% end %>
+      </table>
+    </div>
+          
+          
+    <footer>
+      <span>
+        Generated at <%= time %> with 
+        <a href="http://github.com/hawx/duvet"><%= name %> <%= version %></a>
+      </span>
+    </footer>
+  </body>
+</html>
+