simplecov 0.3.7 → 0.3.9

data/Gemfile

@@ -1,8 +1,2 @@
 source "http://rubygems.org"
-
-gem "simplecov-html", ">= 0.3.7"
-group :development do
-  gem "shoulda", "= 2.10.3"
-  gem "rspec", "~> 2.0.0"
-  gem "jeweler", "= 1.4.0"
-end
+gemspec

data/Gemfile.lock

@@ -1,14 +1,13 @@
+PATH
+  remote: .
+  specs:
+    simplecov (0.3.9)
+      simplecov-html (>= 0.3.7)
+
 GEM
   remote: http://rubygems.org/
   specs:
     diff-lcs (1.1.2)
-    gemcutter (0.6.1)
-    git (1.2.5)
-    jeweler (1.4.0)
-      gemcutter (>= 0.1.0)
-      git (>= 1.2.5)
-      rubyforge (>= 2.0.0)
-    json_pure (1.4.6)
     rspec (2.0.1)
       rspec-core (~> 2.0.1)
       rspec-expectations (~> 2.0.1)
@@ -19,8 +18,6 @@ GEM
     rspec-mocks (2.0.1)
       rspec-core (~> 2.0.1)
       rspec-expectations (~> 2.0.1)
-    rubyforge (2.0.4)
-      json_pure (>= 1.1.7)
     shoulda (2.10.3)
     simplecov-html (0.3.8)
 
@@ -28,7 +25,7 @@ PLATFORMS
   ruby
 
 DEPENDENCIES
-  jeweler (= 1.4.0)
   rspec (~> 2.0.0)
   shoulda (= 2.10.3)
+  simplecov!
   simplecov-html (>= 0.3.7)

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2010 Christoph Olszowka
+Copyright (c) 2010-2011 Christoph Olszowka
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.rdoc

@@ -1,21 +1,22 @@
-= simplecov
+= SimpleCov
 
 SimpleCov is a code coverage analysis tool for Ruby 1.9. It uses 1.9's built-in Coverage library to gather code
 coverage data, but makes processing it's results much easier by providing a clean API to filter, group, merge, format
-and display those results, thus giving you a complete code coverage suite with just a couple lines of code.
+and display those results, thus giving you a complete code coverage suite that can be set up with just a couple lines of 
+code.
 
 In most cases, you'll want overall coverage results for your projects, including all types of tests, cucumber features
 etc. Simplecov automatically takes care of this by caching and then merging results when generating reports, so your
-coverage report gives you a more accurate report on the blank spots in your test coverage.
+report actually covers coverage across your test suites and thereby gives you a better picture of blank spots.
 
-The official formatter of SimpleCov is packaged as a separate gem called simplecov-html and will be installed automatically
-when you do gem install simplecov. You can find it at http://github.com/colszowka/simplecov-html
+The official formatter of SimpleCov is packaged as a separate gem called simplecov-html but will be installed and configured
+automatically when you launch SimpleCov. If you're curious, you can find it at http://github.com/colszowka/simplecov-html
 
 == Basic usage
 
 Update your Gemfile with this and do a bundle install:
   group :test do
-    gem 'simplecov', '>= 0.3.5', :require => false # Will install simplecov-html as a dependency
+    gem 'simplecov', '>= 0.3.8', :require => false # Will install simplecov-html as a dependency
   end
 
 Then, add the following to your Rails test/test_helper.rb (right at the top, line 00):
@@ -250,6 +251,40 @@ You can use your own formatter with:
 When calling SimpleCov.result.format!, it will be invoked with SimpleCov::Formatter::YourFormatter.new.format(result), "result" 
 being an instance of SimpleCov::Result. Do whatever your wish with that!
 
+== Using multiple formatters
+
+There is currently no built-in support for this, but you could help yourself with a wrapper class:
+
+  class SimpleCov::Formatter::MergedFormatter
+    def format(result)
+       SimpleCov::Formatter::HTMLFormatter.new.format(result)
+       SimpleCov::Formatter::CSVFormatter.new.format(result)
+    end
+  end
+
+Then configure the formatter to use the new merger:
+
+  SimpleCov.formatter = SimpleCov::Formatter::MergedFormatter
+  
+== Available formatters
+
+Apart from the direct companion simplecov-html (https://github.com/colszowka/simplecov-html), there are other formatters
+available:
+
+==== simplecov_rcov 
+by Fernando Guillen 
+
+https://github.com/fguillen/simplecov-rcov
+
+"The target of this formatter is to cheat on Hudson so I can use the Ruby metrics plugin with SimpleCov."
+
+==== simplecov_csv 
+by Fernando Guillen 
+
+https://github.com/fguillen/simplecov-csv
+
+CSV formatter for SimpleCov code coverage tool for ruby 1.9+
+
 == Configuration options
 
 === SimpleCov.root '/some/path/to/coverage'
@@ -270,8 +305,25 @@ Thanks to Aaron Patterson (http://engineering.attinteractive.com/2010/08/code-co
 for this!
 
 == TODO
+
 * Improve on tests (integration tests)
 
+== Developer notes
+
+The test suite is built for execution on multiple versions of Ruby to ensure that SimpleCov keeps quiet on Ruby 1.8.
+
+RVM is used for that, and let me tell you that you probably want to install it if you haven't yet.
+
+To invoke the test suite on multiple rubies, install the dev bundle using
+  
+  rake multitest:bundle
+  
+and then you should be ready to launch the tests:
+
+  rake multitest
+  
+The ruby versions used for testing can be found in the Rakefile.
+
 == Note on Patches/Pull Requests
  
 * Fork the project.
@@ -284,4 +336,4 @@ for this!
 
 == Copyright
 
-Copyright (c) 2010 Christoph Olszowka. See LICENSE for details.
+Copyright (c) 2010-2011 Christoph Olszowka. See LICENSE for details.

data/Rakefile

@@ -1,25 +1,5 @@
-require 'rubygems'
-require 'rake'
-
-begin
-  require 'jeweler'
-  Jeweler::Tasks.new do |gem|
-    gem.name = "simplecov"
-    gem.summary = %Q{Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites}
-    gem.description = %Q{Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites}
-    gem.email = "christoph at olszowka de"
-    gem.homepage = "http://github.com/colszowka/simplecov"
-    gem.authors = ["Christoph Olszowka"]
-    gem.add_dependency 'simplecov-html', ">= 0.3.7"
-    gem.add_development_dependency "shoulda", "2.10.3"
-    gem.add_development_dependency "rspec", "~> 2.0.0"
-    gem.add_development_dependency "jeweler", "1.4.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 'bundler'
+Bundler::GemHelper.install_tasks
 
 require 'rake/testtask'
 Rake::TestTask.new(:test) do |test|
@@ -28,16 +8,24 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
-task :test => :check_dependencies
-
 task :default => :test
 
 require 'rake/rdoctask'
 Rake::RDocTask.new do |rdoc|
-  version = File.exist?('VERSION') ? File.read('VERSION') : ""
-
   rdoc.rdoc_dir = 'rdoc'
-  rdoc.title = "simplecov #{version}"
   rdoc.rdoc_files.include('README*')
   rdoc.rdoc_files.include('lib/**/*.rb')
 end
+
+TestedRubyVersions = %w(1.9.2 1.8.7 1.8.6)
+
+desc "Perorms bundle install on all rvm-tested ruby versions (#{TestedRubyVersions.join(', ')})"
+task :"multitest:bundle" do
+  system "rvm #{TestedRubyVersions.join(',')} exec bundle install"
+end
+
+desc "Runs tests using rvm for: #{TestedRubyVersions.join(', ')}"
+task :multitest do
+  system "rvm #{TestedRubyVersions.join(',')} rake test"
+end
+

data/lib/simplecov.rb

@@ -5,9 +5,6 @@ module SimpleCov
   # Indicates invalid coverage data
   class CoverageDataError < StandardError; end;
   
-  # The version of the simplecov gem
-  VERSION = File.read(File.join(File.dirname(__FILE__), '../VERSION'))
-  
   class << self
     attr_accessor :running#, :result # TODO: Remove result?
     
@@ -29,10 +26,8 @@ module SimpleCov
     # Please check out the RDoc for SimpleCov::Configuration to find about available config options
     #
     def start(adapter=nil, &block)
-      unless "1.9".respond_to?(:encoding)
-        warn "WARNING: SimpleCov is activated, but you're not running Ruby 1.9 - no coverage analysis will happen"
-        return false
-      end
+      return false unless SimpleCov.usable?
+      
       require 'coverage'
       load_adapter(adapter) unless adapter.nil?
       Coverage.start
@@ -93,6 +88,17 @@ module SimpleCov
       adapters.load(name)
     end
     
+    #
+    # Checks whether we're on a proper version of ruby (1.9+) and returns false if this is not the case,
+    # also printing an appropriate warning
+    #
+    def usable?
+      unless "1.9".respond_to?(:encoding)
+        warn "WARNING: SimpleCov is activated, but you're not running Ruby 1.9+ - no coverage analysis will happen"
+        return false
+      end
+      true
+    end
   end
 end
 
@@ -107,6 +113,9 @@ require 'simplecov/formatter'
 require 'simplecov/merge_helpers'
 require 'simplecov/result_merger'
 require 'simplecov/command_guesser'
+require 'simplecov/version'
+
+# Load formatter gem
 require 'simplecov-html'
 
 # Default configuration

data/lib/simplecov/configuration.rb

@@ -99,6 +99,7 @@ module SimpleCov::Configuration
   # options at once.
   #
   def configure(&block)
+    return false unless SimpleCov.usable?
     instance_exec(&block)
   end
   

data/lib/simplecov/result.rb

@@ -6,7 +6,7 @@ module SimpleCov
   # A simplecov code coverage result, initialized from the Hash Ruby 1.9's built-in coverage
   # library generates (Coverage.result).
   #
-  class Result    
+  class Result
     # Returns the original Coverage.result used for this instance of SimpleCov::Result
     attr_reader :original_result
     # Returns all files that are applicable to this result (sans filters!) as instances of SimpleCov::SourceFile. Aliased as :source_files

data/lib/simplecov/version.rb

@@ -0,0 +1,3 @@
+module SimpleCov
+  VERSION = "0.3.9"
+end

data/simplecov.gemspec

@@ -1,106 +1,25 @@
-# Generated by jeweler
-# DO NOT EDIT THIS FILE DIRECTLY
-# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
 # -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "simplecov/version"
 
 Gem::Specification.new do |s|
-  s.name = %q{simplecov}
-  s.version = "0.3.7"
+  s.name        = "simplecov"
+  s.version     = SimpleCov::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Christoph Olszowka"]
+  s.email       = ["christoph at olszowka de"]
+  s.homepage    = "http://github.com/colszowka/simplecov"
+  s.summary     = %Q{Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites}
+  s.description = %Q{Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites}
 
-  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Christoph Olszowka"]
-  s.date = %q{2010-11-06}
-  s.description = %q{Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites}
-  s.email = %q{christoph at olszowka de}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     ".rvmrc",
-     "Gemfile",
-     "Gemfile.lock",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/simplecov.rb",
-     "lib/simplecov/adapters.rb",
-     "lib/simplecov/command_guesser.rb",
-     "lib/simplecov/configuration.rb",
-     "lib/simplecov/filter.rb",
-     "lib/simplecov/formatter.rb",
-     "lib/simplecov/formatter/simple_formatter.rb",
-     "lib/simplecov/merge_helpers.rb",
-     "lib/simplecov/result.rb",
-     "lib/simplecov/result_merger.rb",
-     "lib/simplecov/source_file.rb",
-     "simplecov.gemspec",
-     "test/fixtures/app/controllers/sample_controller.rb",
-     "test/fixtures/app/models/user.rb",
-     "test/fixtures/frameworks/rspec_bad.rb",
-     "test/fixtures/frameworks/rspec_good.rb",
-     "test/fixtures/frameworks/testunit_bad.rb",
-     "test/fixtures/frameworks/testunit_good.rb",
-     "test/fixtures/resultset1.rb",
-     "test/fixtures/resultset2.rb",
-     "test/fixtures/sample.rb",
-     "test/helper.rb",
-     "test/test_command_guesser.rb",
-     "test/test_filters.rb",
-     "test/test_merge_helpers.rb",
-     "test/test_result.rb",
-     "test/test_return_codes.rb",
-     "test/test_source_file.rb",
-     "test/test_source_file_line.rb"
-  ]
-  s.homepage = %q{http://github.com/colszowka/simplecov}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites}
-  s.test_files = [
-    "test/fixtures/app/controllers/sample_controller.rb",
-     "test/fixtures/app/models/user.rb",
-     "test/fixtures/frameworks/rspec_bad.rb",
-     "test/fixtures/frameworks/rspec_good.rb",
-     "test/fixtures/frameworks/testunit_bad.rb",
-     "test/fixtures/frameworks/testunit_good.rb",
-     "test/fixtures/resultset1.rb",
-     "test/fixtures/resultset2.rb",
-     "test/fixtures/sample.rb",
-     "test/helper.rb",
-     "test/test_command_guesser.rb",
-     "test/test_filters.rb",
-     "test/test_merge_helpers.rb",
-     "test/test_result.rb",
-     "test/test_return_codes.rb",
-     "test/test_source_file.rb",
-     "test/test_source_file_line.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-html>, [">= 0.3.7"])
-      s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
-      s.add_development_dependency(%q<rspec>, ["~> 2.0.0"])
-      s.add_development_dependency(%q<jeweler>, ["= 1.4.0"])
-    else
-      s.add_dependency(%q<simplecov-html>, [">= 0.3.7"])
-      s.add_dependency(%q<shoulda>, ["= 2.10.3"])
-      s.add_dependency(%q<rspec>, ["~> 2.0.0"])
-      s.add_dependency(%q<jeweler>, ["= 1.4.0"])
-    end
-  else
-    s.add_dependency(%q<simplecov-html>, [">= 0.3.7"])
-    s.add_dependency(%q<shoulda>, ["= 2.10.3"])
-    s.add_dependency(%q<rspec>, ["~> 2.0.0"])
-    s.add_dependency(%q<jeweler>, ["= 1.4.0"])
-  end
-end
+  s.rubyforge_project = "simplecov"
+  
+  s.add_dependency 'simplecov-html', ">= 0.3.7"
+  s.add_development_dependency "shoulda", "2.10.3"
+  s.add_development_dependency "rspec", "~> 2.0.0"
 
+  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/helper.rb

@@ -1,16 +1,21 @@
 require 'rubygems'
-require 'bundler'
-Bundler.setup(:default, :development)
+require 'bundler/setup'
+require 'simplecov'
+
 require 'test/unit'
 require 'shoulda'
 
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-require 'simplecov'
 SimpleCov.coverage_dir('tmp/coverage')
 
 class Test::Unit::TestCase
   def source_fixture(filename)
     File.expand_path(File.join(File.dirname(__FILE__), 'fixtures', filename))
   end
+  
+  # Keep 1.8-rubies from complaining about missing tests in each file that covers only 1.9 functionality
+  def default_test
+  end
 end
+
+require 'shoulda_macros'
+Test::Unit::TestCase.send :extend, ShouldaMacros

data/test/shoulda_macros.rb

@@ -0,0 +1,11 @@
+module ShouldaMacros
+  #
+  # Simple block helper for running certain tests only on specific ruby versions.
+  # The given strings will be regexp-matched against RUBY_VERSION
+  # 
+  def on_ruby(*ruby_versions)
+    context "On Ruby #{RUBY_VERSION}" do
+      yield
+    end if ruby_versions.any? {|v| RUBY_VERSION =~ /#{v}/ }
+  end
+end