duvet 0.0.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+cov
+doc
+.yardoc

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2009 Joshua Hawxwell
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,31 @@
+# duvet
+
+Install with
+  
+    (sudo) gem install duvet
+
+Then add this to the __very__ top of your `test/helper.rb` (or similar)
+
+    require 'duvet
+    Duvet.start
+
+You can change the defaults by passing an options hash to Duvet.start, eg
+
+    Duvet.start({:dir => 'coverage', :filter => 'app/lib'})
+
+`:dir` is the directory to write the coverage to.
+`:filter` allows you to display only coverage for files that include the string.
+
+## Note on Patches/Pull Requests
+ 
+* Fork the project.
+* Make your feature addition or bug fix.
+* Add tests for it. This is important so I don't break it in a
+  future version unintentionally.
+* Commit, do not mess with rakefile, version, or history.
+  (if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
+* Send me a pull request. Bonus points for topic branches.
+
+## Copyright
+
+Copyright (c) 2010 Joshua Hawxwell. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,53 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "duvet"
+    gem.summary = %Q{Duvet a simple code coverage tool for 1.9}
+    gem.description = %Q{Duvet a simple code coverage tool for 1.9}
+    gem.email = "m@hawx.me"
+    gem.homepage = "http://github.com/hawx/duvet"
+    gem.authors = ["Joshua Hawxwell"]
+    gem.add_development_dependency "thoughtbot-shoulda", ">= 0"
+    gem.add_development_dependency "yard", ">= 0"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+begin
+  require 'yard'
+  YARD::Rake::YardocTask.new
+rescue LoadError
+  task :yardoc do
+    abort "YARD is not available. In order to run yardoc, you must: sudo gem install yard"
+  end
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.0

data/bin/duvet

@@ -0,0 +1,46 @@
+#!/usr/bin/env ruby
+#
+# A command line tool for coverage testing, I'm not sure if this
+# will even work but it is worth a try!
+#
+# Example:
+#   duvet test/test_class.rb
+#
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
+require 'clive'
+require 'duvet'
+
+opts = {:dir => 'cov', :style => 'rcov'}
+c = Clive.new do
+  
+  header "Usage: duvet [options] [paths]"
+  
+  flag(:css, "PATH", "Use custom css file") do |i| 
+    opts[:css] = i
+  end
+  
+  flag(:s, :style, "ARG", "Choose style") do |i|
+    opts[:style] = i
+  end
+  
+  flag(:d, :dir, "PATH", "Directory to write coverage results") do |i|
+    opts[:dir] = i
+  end
+  
+  flag(:f, :filter, "FILTER", "Use a filter to see only needed results") do |i|
+    opts[:filter] = i
+  end
+  
+end
+
+# Start coverage, then require paths
+def run(paths, opts)
+  Duvet.start(opts)
+  paths.each do |p|
+    require p
+  end
+end
+
+args = c.parse(ARGV)
+run(args, opts)

data/duvet.gemspec

@@ -0,0 +1,72 @@
+# 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{duvet}
+  s.version = "0.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Joshua Hawxwell"]
+  s.date = %q{2010-09-01}
+  s.default_executable = %q{duvet}
+  s.description = %q{Duvet a simple code coverage tool for 1.9}
+  s.email = %q{m@hawx.me}
+  s.executables = ["duvet"]
+  s.extra_rdoc_files = [
+    "LICENSE",
+     "README.md"
+  ]
+  s.files = [
+    ".document",
+     ".gitignore",
+     "LICENSE",
+     "README.md",
+     "Rakefile",
+     "VERSION",
+     "bin/duvet",
+     "duvet.gemspec",
+     "lib/duvet.rb",
+     "lib/duvet/cov.rb",
+     "lib/duvet/covs.rb",
+     "lib/duvet/ext.rb",
+     "lib/duvet/resources/jquery.js",
+     "lib/duvet/resources/main.js",
+     "lib/duvet/resources/plugins.js",
+     "lib/duvet/resources/rcov.sass",
+     "lib/duvet/templates/file.erb",
+     "lib/duvet/templates/index.erb",
+     "test/helper.rb",
+     "test/test_duvet.rb",
+     "test_duvet/lib/klass.rb",
+     "test_duvet/lib/run.rb",
+     "test_duvet/test/test_all.rb"
+  ]
+  s.homepage = %q{http://github.com/hawx/duvet}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Duvet a simple code coverage tool for 1.9}
+  s.test_files = [
+    "test/helper.rb",
+     "test/test_duvet.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_development_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_development_dependency(%q<yard>, [">= 0"])
+    else
+      s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+      s.add_dependency(%q<yard>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<thoughtbot-shoulda>, [">= 0"])
+    s.add_dependency(%q<yard>, [">= 0"])
+  end
+end
+

data/lib/duvet.rb

@@ -0,0 +1,86 @@
+$:.unshift File.dirname(__FILE__)
+
+# Add this to test/helper.rb at the before __anything__ else
+#
+#   require 'duvet'
+#   Duvet.start
+#
+require 'coverage'
+require 'ostruct'
+require 'erubis'
+require 'pathname'
+require 'sass'
+
+require 'duvet/ext'
+require 'duvet/covs'
+require 'duvet/cov'
+
+
+module Duvet
+
+  attr_accessor :opts
+  
+  DEFAULTS = {:dir => 'cov', :style => 'rcov'}
+
+  # 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 = {}
+      cov.each do |k, v|
+        if k.include?(@opts[:filter])
+          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(@opts[:dir], @opts[:style]) 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
+  
+  # Reads the current version from VERSION
+  #
+  # @return [String] current version
+  def self.version
+    File.read( File.join(File.dirname(__FILE__), '..', 'VERSION') )
+  end
+  
+  # @return [Hash] hash to merge for templating
+  def self.template_hash
+    {
+      'time' => Time.now,
+      'version' => self.version,
+      'name' => 'duvet'
+    }
+  end
+
+end
+
+at_exit do
+  Duvet.at_exit.call
+end

data/lib/duvet/cov.rb

@@ -0,0 +1,118 @@
+module Duvet
+  class Cov
+    attr_accessor :cov, :path
+    
+    def initialize(path, cov)
+      if path.include?(Dir.pwd)
+        @path = path.to_p.relative_path_from(Pathname.pwd)
+      else
+        @path = path.to_p
+      end
+
+      @cov = cov
+      write
+    end
+    
+    # @return [Integer] number of lines in file
+    def lines
+      @cov.length
+    end
+    
+    # @return [Array] all lines which can be executed
+    def code_lines
+      @cov.reject {|i| i.nil?}
+    end
+    
+    # @return [Integer] number of lines of code that can be executed
+    def lines_of_code
+      code_lines.length
+    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 [Integer] lines of code executed as a fraction
+    def code_coverage
+      ran_lines = code_lines.reject {|i| i.zero?}.length
+      ran_lines.to_f / lines_of_code.to_f
+    end
+    
+    # @return [String] #code_coverage as ??.??%
+    def code_coverage_percent
+      "%.2f%" % (code_coverage*100)
+    end
+    
+    # Similar to #code_coverage but counts all lines, executable
+    # or not.
+    #
+    # @return [Integer] lines executed as a fraction
+    def total_coverage
+      ran_lines = @cov.reject {|i| i.nil? || i.zero?}.length
+      ran_lines.to_f / lines.to_f
+    end
+    
+    # @return [String] #total_coverage as ??.??%
+    def total_coverage_percent
+      "%.2f%" % (total_coverage*100)
+    end
+    
+    # Creates a report showing the source code.
+    #
+    # @return [String] a report showing line number, source and 
+    #   times run
+    def source_report
+      source = @path.readlines
+      str = ""
+      source.zip(@cov).each_with_index do |a, i|
+        line, count = a[0], a[1]
+        str << "#{i}| #{line.gsub("\n", "")}"
+        str << " #=> #{count}" if count
+        str << "\n"
+      end
+      str
+    end
+    
+    # @return [String]
+    def report
+      str = "For #{@path}\n\n" << source_report << "\n"
+      str << "total coverage: #{total_coverage}\n"
+      str << "code coverage:  #{code_coverage}\n"
+      str
+    end
+    
+    # @return [Hash] a hash of data for templating
+    def data
+      {
+        "file" => {
+          "path" => @path,
+          "url" => @path.file_name + '.html',
+          "source" => @path.readlines,
+          "lines" => lines,
+          "lines_code" => lines_of_code
+        },
+        "coverage" => {
+          "code" => code_coverage_percent,
+          "total" => total_coverage_percent,
+          "lines" => @cov
+        }
+      }
+    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 = File.read(File.join( File.dirname(__FILE__), "templates", "file.erb" ))
+      e = Erubis::Eruby.new(template).result(Duvet.template_hash.merge(self.data))
+      e
+    end
+    
+    def write(dir='cov')
+      f = File.new((dir.to_p + @path.file_name).to_s + '.html', "w" )
+      f.write(format)
+    end
+  
+  end
+end