simplecov 0.3.1 → 0.3.2

data/README.rdoc

@@ -8,24 +8,40 @@ In most cases, you'll want overall coverage results for your projects, including
 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.
 
-Though a very simple formatter for printing the coverage results comes bundled with the simplecov gem, this is more
-for explaining the basic usage of formatters if you want to build your own. To get a pretty HTML-page with your results, 
-you will want to use the simplecov-html gem (http://github.com/colszowka/simplecov-html).
+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
 
 == Basic usage
 
 Update your Gemfile with this and do a bundle install:
   group :test do
-    gem 'simplecov-html', '>= 0.3.0' # Will install simplecov as a dependency
+    gem 'simplecov', '>= 0.3.2' # 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):
 
-  require 'simplecov-html'
+  require 'simplecov'
   SimpleCov.start 'rails'
 
 Now, when running rake test you'll get a coverage/ folder inside your app's root where you can browse your code coverage.
 
+== Example output
+
+For the Devise Ruby gem (some tests were removed, they just have too awesome test coverage...)
+
+http://img.skitch.com/20100823-n9f52i3ty3qa7cqj33rafghrtc.png
+
+== Usage with Cucumber and RSpec (name your framework)
+
+Similarily to the usage with Test::Unit described above, the only thing you have to do is to add the simplecov
+config to the very top of your Cucumber/RSpec/whatever setup file.
+
+Just add the setup snippet at the very(!) top of features/support/env.rb (for Cucumber) or spec/spec_helper.rb (for RSpec).
+Other test frameworks should work accordingly.
+
+  require 'simplecov'
+  SimpleCov.start 'rails'
+
 == Configuration
 
 Configuration settings can be applied in three formats.
@@ -127,28 +143,29 @@ There are two things to note here though:
 
 === Test suite names
 
-First, simplecov by itself does not really know about "test suites" and thus makes a guess based upon the command
-line arguments it is currently running on. This works fine, though the test suites used for your coverage report
-won't be easy to recognize. 
+Simplecov tries to guess the name of the currently running test suite based upon the shell command the tests are running
+on (from v0.3.2+). This should work fine for Unit Tests, RSpec and Cucumber. If it fails, it will use the shell command
+that invoked the test suite as a command name.
 
-Thus, if you want nicely labeled test suites, you have to give Simplecov a cue what the name of the currently running
-test suite is. You can do so by specifying SimpleCov.command_name in one test file that is part of your specific suite.
+If you have some non-standard setup and still want nicely labeled test suites, you have to give Simplecov a cue what the 
+name of the currently running test suite is. You can do so by specifying SimpleCov.command_name in one test file that is 
+part of your specific suite.
 
-So, in order to get proper suite names in a Rails app (yeah, sorry for being Rails biased, but everyone knows what
-the structure of those projects is. You can apply this accordingly to the RSpecs for your Outlook-WebDAV-Calendar-Sync gem), 
+So, to customize the suite names on a Rails app (yeah, sorry for being Rails biased, but everyone knows what
+the structure of those projects is. You can apply this accordingly to the RSpecs in your Outlook-WebDAV-Calendar-Sync gem), 
 you could do something like this:
 
   # test/unit/some_test.rb
-  SimpleCov.command_name 'Unit Tests'
+  SimpleCov.command_name 'test:units'
   
   # test/functionals/some_controller_test.rb
-  SimpleCov.command_name "Functional Tests"
+  SimpleCov.command_name "test:functionals"
   
   # test/integration/some_integration_test.rb
-  SimpleCov.command_name "Integration Tests"
+  SimpleCov.command_name "test:integration"
   
   # features/steps/web_steps.rb
-  SimpleCov.command_name "Cucumber Features"
+  SimpleCov.command_name "features"
   
 Note that this has only to be invoked ONCE PER TEST SUITE, so even if you have 200 unit test files, specifying it in 
 some_test.rb is fair enough.

data/Rakefile

@@ -5,11 +5,12 @@ begin
   require 'jeweler'
   Jeweler::Tasks.new do |gem|
     gem.name = "simplecov"
-    gem.summary = %Q{Code coverage for Ruby 1.9}
-    gem.description = %Q{Code coverage for Ruby 1.9}
+    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.5"
     gem.add_development_dependency "shoulda", "= 2.10.3"
     # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
   end

data/VERSION

@@ -1 +1 @@
-0.3.1
+0.3.2

data/lib/simplecov.rb

@@ -105,10 +105,12 @@ require 'simplecov/filter'
 require 'simplecov/formatter'
 require 'simplecov/merge_helpers'
 require 'simplecov/result_merger'
+require 'simplecov/command_guesser'
+require 'simplecov-html'
 
 # Default configuration
 SimpleCov.configure do
-  formatter SimpleCov::Formatter::SimpleFormatter
+  formatter SimpleCov::Formatter::HTMLFormatter
   # Exclude files outside of SimpleCov.root
   load_adapter 'root_filter'
 end

data/lib/simplecov/adapters.rb

@@ -37,6 +37,8 @@ end
 
 SimpleCov.adapters.define 'rails' do
   add_filter '/test/'
+  add_filter '/features/'
+  add_filter '/spec/'
   add_filter '/config/'
   
   add_group 'Controllers', 'app/controllers'

data/lib/simplecov/command_guesser.rb

@@ -0,0 +1,21 @@
+#
+# Helper that tries to find out what test suite is running (for SimpleCov.command_name)
+#
+module SimpleCov::CommandGuesser
+  def self.guess(command)
+    case command
+      when /#{'test/functional/'}/
+        "Functional Tests"
+      when /#{'test/integration/'}/
+        "Integration Tests"
+      when /#{'test/'}/
+        "Unit Tests"
+      when /cucumber/, /features/
+        "Cucumber Features"
+      when /#{'spec/'}/
+        "RSpec"
+      else
+        return command
+    end
+  end
+end

data/lib/simplecov/configuration.rb

@@ -45,11 +45,19 @@ module SimpleCov::Configuration
     @filters ||= []
   end
   
-  # The name of the command currently running. It is used for result merging and defaults 
-  # to the command line arguments the current test suite is running on.
-  # You can specify it manually with SimpleCov.command_name("test:units")
+  # The name of the command (a.k.a. Test Suite) currently running. Used for result
+  # merging and caching. It first tries to make a guess based upon the command line
+  # arguments the current test suite is running on and should automatically detect
+  # unit tests, functional tests, integration tests, rpsec and cucumber and label
+  # them properly. If it fails to recognize the current command, the command name
+  # is set to the shell command that the current suite is running on.
+  #
+  # You can specify it manually with SimpleCov.command_name("test:units") - please
+  # also check out the corresponding section in README.rdoc
   def command_name(name=nil)
-    @name ||= (name.nil? ? ARGV.join(" ") : name)
+    @name = name unless name.nil?
+    @name ||= SimpleCov::CommandGuesser.guess("#{$0} #{ARGV.join(" ")}")
+    @name
   end
   
   #

data/simplecov.gemspec

@@ -5,12 +5,12 @@
 
 Gem::Specification.new do |s|
   s.name = %q{simplecov}
-  s.version = "0.3.1"
+  s.version = "0.3.2"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Christoph Olszowka"]
-  s.date = %q{2010-08-23}
-  s.description = %q{Code coverage for Ruby 1.9}
+  s.date = %q{2010-08-25}
+  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",
@@ -25,6 +25,7 @@ Gem::Specification.new do |s|
      "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",
@@ -33,7 +34,6 @@ Gem::Specification.new do |s|
      "lib/simplecov/result.rb",
      "lib/simplecov/result_merger.rb",
      "lib/simplecov/source_file.rb",
-     "simple_cov.gemspec",
      "simplecov.gemspec",
      "test/fixtures/app/controllers/sample_controller.rb",
      "test/fixtures/app/models/user.rb",
@@ -41,6 +41,7 @@ Gem::Specification.new do |s|
      "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",
@@ -51,7 +52,7 @@ Gem::Specification.new do |s|
   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}
+  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",
@@ -59,6 +60,7 @@ Gem::Specification.new do |s|
      "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",
@@ -71,11 +73,14 @@ Gem::Specification.new do |s|
     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.5"])
       s.add_development_dependency(%q<shoulda>, ["= 2.10.3"])
     else
+      s.add_dependency(%q<simplecov-html>, [">= 0.3.5"])
       s.add_dependency(%q<shoulda>, ["= 2.10.3"])
     end
   else
+    s.add_dependency(%q<simplecov-html>, [">= 0.3.5"])
     s.add_dependency(%q<shoulda>, ["= 2.10.3"])
   end
 end

data/test/test_command_guesser.rb

@@ -0,0 +1,18 @@
+require 'helper'
+
+class TestCommandGuesser < Test::Unit::TestCase
+  def self.should_guess_command_name(expectation, *argv)
+    argv.each do |args|
+      should "return '#{expectation}' for '#{args}'" do
+        assert_equal expectation, SimpleCov::CommandGuesser.guess(args)
+      end
+    end
+  end
+  
+  should_guess_command_name "Unit Tests", '/some/path/test/units/foo_bar_test.rb', 'test/units/foo.rb', 'test/foo.rb'
+  should_guess_command_name "Functional Tests", '/some/path/test/functional/foo_bar_controller_test.rb'
+  should_guess_command_name "Integration Tests", '/some/path/test/integration/foo_bar_controller_test.rb'  
+  should_guess_command_name "Cucumber Features", 'features', 'cucumber', 'cucumber features'
+  should_guess_command_name "RSpec", '/some/path/spec/foo.rb'
+  should_guess_command_name "some_arbitrary_command with arguments", 'some_arbitrary_command with arguments'
+end

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 3
-  - 1
-  version: 0.3.1
+  - 2
+  version: 0.3.2
 platform: ruby
 authors: 
 - Christoph Olszowka
@@ -14,13 +14,28 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-08-23 00:00:00 +02:00
+date: 2010-08-25 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: shoulda
+  name: simplecov-html
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 3
+        - 5
+        version: 0.3.5
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: shoulda
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - "="
@@ -31,8 +46,8 @@ dependencies:
         - 3
         version: 2.10.3
   type: :development
-  version_requirements: *id001
-description: Code coverage for Ruby 1.9
+  version_requirements: *id002
+description: Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites
 email: christoph at olszowka.de
 executables: []
 
@@ -50,6 +65,7 @@ files:
 - 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
@@ -58,7 +74,6 @@ files:
 - lib/simplecov/result.rb
 - lib/simplecov/result_merger.rb
 - lib/simplecov/source_file.rb
-- simple_cov.gemspec
 - simplecov.gemspec
 - test/fixtures/app/controllers/sample_controller.rb
 - test/fixtures/app/models/user.rb
@@ -66,6 +81,7 @@ files:
 - 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
@@ -102,7 +118,7 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: Code coverage for Ruby 1.9
+summary: Code coverage for Ruby 1.9 with a powerful configuration library and automatic merging of coverage across test suites
 test_files: 
 - test/fixtures/app/controllers/sample_controller.rb
 - test/fixtures/app/models/user.rb
@@ -110,6 +126,7 @@ test_files:
 - 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

data/simple_cov.gemspec

@@ -1,81 +0,0 @@
-# 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{simple_cov}
-  s.version = "0.2.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-20}
-  s.description = %q{Makes ruby 1.9's code coverage library's results more accessible in an object-oriented manner and adds some sugar on top}
-  s.email = %q{christoph at olszowka.de}
-  s.extra_rdoc_files = [
-    "LICENSE",
-     "README.rdoc"
-  ]
-  s.files = [
-    ".document",
-     ".gitignore",
-     "LICENSE",
-     "README.rdoc",
-     "Rakefile",
-     "VERSION",
-     "lib/simple_cov.rb",
-     "lib/simple_cov/adapters.rb",
-     "lib/simple_cov/configuration.rb",
-     "lib/simple_cov/filter.rb",
-     "lib/simple_cov/formatter.rb",
-     "lib/simple_cov/formatter/simple_formatter.rb",
-     "lib/simple_cov/merge_helpers.rb",
-     "lib/simple_cov/result.rb",
-     "lib/simple_cov/result_merger.rb",
-     "lib/simple_cov/source_file.rb",
-     "simple_cov.gemspec",
-     "test/fixtures/app/controllers/sample_controller.rb",
-     "test/fixtures/app/models/user.rb",
-     "test/fixtures/resultset1.rb",
-     "test/fixtures/resultset2.rb",
-     "test/fixtures/sample.rb",
-     "test/helper.rb",
-     "test/test_filters.rb",
-     "test/test_merge_helpers.rb",
-     "test/test_result.rb",
-     "test/test_source_file.rb",
-     "test/test_source_file_line.rb"
-  ]
-  s.homepage = %q{http://github.com/colszowka/simple_cov}
-  s.rdoc_options = ["--charset=UTF-8"]
-  s.require_paths = ["lib"]
-  s.rubygems_version = %q{1.3.7}
-  s.summary = %q{Makes ruby 1.9's code coverage library's results more accessible in an object-oriented manner and adds some sugar on top}
-  s.test_files = [
-    "test/fixtures/app/controllers/sample_controller.rb",
-     "test/fixtures/app/models/user.rb",
-     "test/fixtures/resultset1.rb",
-     "test/fixtures/resultset2.rb",
-     "test/fixtures/sample.rb",
-     "test/helper.rb",
-     "test/test_filters.rb",
-     "test/test_merge_helpers.rb",
-     "test/test_result.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_development_dependency(%q<shoulda>, ["= 2.10.3"])
-    else
-      s.add_dependency(%q<shoulda>, ["= 2.10.3"])
-    end
-  else
-    s.add_dependency(%q<shoulda>, ["= 2.10.3"])
-  end
-end
-