simplecov 0.5.3 → 0.5.4

data/.travis.yml

@@ -5,5 +5,5 @@ rvm:
   - 1.9.2
   - 1.9.3
   - ree
-  - rbx
-#  - jruby
+#  - rbx # Fails currently because of broken gemspec in Cucumber
+#  - jruby # Has trouble installing on travis-ci right now

data/CHANGELOG.md

@@ -1,3 +1,16 @@
+v0.5.4 (2011-10-12)
+===================
+
+  * Do not give exit code 0 when there are exceptions prior to tests 
+    (see https://github.com/colszowka/simplecov/issues/41, thanks @nbogie)
+  * The API for building custom filter classes is now more obvious, using #matches? instead of #passes? too. 
+    (see https://github.com/colszowka/simplecov/issues/85, thanks @robinroestenburg)
+  * Mailers are now part of the Rails adapter as their own group (see 
+    https://github.com/colszowka/simplecov/issues/79, thanks @geetarista)
+  * Removed fix for JRuby 1.6 RC1 float bug because it's been fixed 
+    (see https://github.com/colszowka/simplecov/issues/86)
+  * Readme formatted in Markdown :)
+
 v0.5.3 (2011-09-13)
 ===================
 

data/README.md

@@ -0,0 +1,414 @@
+SimpleCov [![Build Status](https://secure.travis-ci.org/colszowka/simplecov.png)][Continuous Integration]
+=========
+*Code coverage for Ruby 1.9*
+
+  * [Source Code]
+  * [API documentation]
+  * [Changelog]
+  * [Rubygem]
+  * [Continuous Integration]
+
+[Coverage]: http://www.ruby-doc.org/ruby-1.9/classes/Coverage.html "API doc for Ruby 1.9's Coverage library"
+[Source Code]: https://github.com/colszowka/simplecov "Source Code @ GitHub"
+[API documentation]: http://rubydoc.info/gems/simplecov/frames "RDoc API Documentation at Rubydoc.info"
+[Configuration]: http://rubydoc.info/gems/simplecov/SimpleCov/Configuration "Configuration options API documentation"
+[Changelog]: https://github.com/colszowka/simplecov/blob/master/CHANGELOG.md "Project Changelog"
+[Rubygem]: http://rubygems.org/gems/simplecov "SimpleCov @ rubygems.org"
+[Continuous Integration]: http://travis-ci.org/colszowka/simplecov "SimpleCov is built around the clock by travis-ci.org"
+[simplecov-html]: https://github.com/colszowka/simplecov-html "SimpleCov HTML Formatter Source Code @ GitHub"
+
+
+SimpleCov is a code coverage analysis tool for Ruby 1.9. It uses [1.9's built-in Coverage][Coverage] library to gather code
+coverage data, but makes processing its 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 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
+report actually includes 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] but will be installed and configured
+automatically when you launch SimpleCov. If you're curious, you can find it [on Github, too][simplecov-html].
+
+
+
+Getting started
+---------------
+
+1. Add SimpleCov to your `Gemfile` and `bundle install`:
+      
+        gem 'simplecov', :require => false, :group => :test
+
+2. Load and launch SimpleCov **at the very top** of your `test/test_helper.rb` (*or `spec_helper.rb`, cucumber `env.rb`, or whatever
+   your preferred test framework uses*):
+
+        require 'simplecov'
+        SimpleCov.start
+
+        # Previous content of test helper now starts here
+        
+      **Note:** If SimpleCov starts after your application code is already loaded (via `require`), it won't be able to track your files and their coverage!       
+      The `SimpleCov.start` **must** be issued **before any of your application code is required!**
+
+3. Run your tests, open up `coverage/index.html` in your browser and check out what you've missed so far. 
+
+If you're making a Rails application, SimpleCov comes with a built-in adapter (see below for more information on what adapters are)
+which will get you started with groups for your Controllers, Views, Models and Helpers. To use it, the first two lines of 
+your test_helper should be like this:
+
+    require 'simplecov'
+    SimpleCov.start 'rails'
+
+
+
+## Example output
+
+**Coverage results report, fully browsable locally with sorting and much more:**
+
+![SimpleCov coverage report](http://colszowka.github.com/simplecov/devise_result-0.5.3.png)
+
+
+**Source file coverage details view:**
+
+![SimpleCov source file detail view](http://colszowka.github.com/simplecov/devise_source_file-0.5.3.png)
+
+
+
+## Use it with any 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.
+
+Add the setup code to the **top** of `features/support/env.rb` (for Cucumber) or `spec/spec_helper.rb` (for RSpec).
+Other test frameworks should work accordingly, whatever their setup file may be:
+
+    require 'simplecov'
+    SimpleCov.start 'rails'
+
+You could even track what kind of code your UI testers are touching if you want to go overboard with things. SimpleCov does not
+care what kind of framework it is running in, it just looks at what code is being executed and generates a report about it.
+
+
+
+## Configuring SimpleCov
+
+[Configuration] settings can be applied in three formats, which are completely equivalent:
+
+* The most common way is to configure it directly in your start block:
+
+        SimpleCov.start do
+          some_config_option 'foo'
+        end
+
+* You can also set all configuration options directly:
+
+        SimpleCov.some_config_option 'foo'
+
+* If you do not want to start coverage immediately after launch or want to add additional configuration later on in a concise way, use:
+
+        SimpleCov.configure do
+          some_config_option 'foo'
+        end
+        
+Please check out the [Configuration] API documentation to find out what you can customize.
+
+
+## Using .simplecov for centralized config
+
+If you use SimpleCov to merge multiple test suite results (i.e. Test/Unit and Cucumber) into a single report, you'd normally have to
+set up all your config options twice, once in `test_helper.rb` and once in `env.rb`.
+
+To avoid this, you can place a file called `.simplecov` in your project root. You can then just leave the `require 'simplecov'` in each
+test setup helper and move the `SimpleCov.start` code with all your custom config options into `.simplecov`:
+
+    # test/test_helper.rb
+    require 'simplecov'
+    
+    # features/support/env.rb
+    require 'simplecov'
+    
+    # .simplecov
+    SimpleCov.start 'rails' do
+      # any custom configs like groups and filters can be here at a central place
+    end
+
+
+## Filters
+
+Filters can be used to remove selected files from your coverage data. By default, a filter is applied that removes all files
+OUTSIDE of your project's root directory - otherwise you'd end up with a billion of coverage reports for source files in the
+gems you are using.
+
+Of course you can define your own to remove things like configuration files, tests or whatever you don't need in your coverage
+report.
+
+### Defining custom filters
+
+You can currently define a filter using either a String (that will then be Regexp-matched against each source file's path),
+a block or by passing in your own Filter class.
+
+#### String filter
+
+    SimpleCov.start do
+      add_filter "/test/"
+    end
+
+This simple string filter will remove all files that match "/test/" in their path.
+
+#### Block filter
+
+    SimpleCov.start do
+      add_filter do |source_file|
+        source_file.lines.count < 5
+      end
+    end
+
+Block filters receive a SimpleCov::SourceFile instance and expect your block to return either true (if the file is to be removed
+from the result) or false (if the result should be kept). Please check out the RDoc for SimpleCov::SourceFile to learn about the
+methods available to you. In the above example, the filter will remove all files that have less then 5 lines of code.
+
+#### Custom filter class
+
+    class LineFilter < SimpleCov::Filter
+      def matches?(source_file)
+        source_file.lines.count < filter_argument
+      end
+    end
+
+    SimpleCov.add_filter LineFilter.new(5)
+
+Defining your own filters is pretty easy: Just inherit from SimpleCov::Filter and define a method 'matches?(source_file)'. When running
+the filter, a true return value from this method will result in the removal of the given source_file. The filter_argument method
+is being set in the SimpleCov::Filter initialize method and thus is set to 5 in this example.
+
+
+## Groups
+
+You can separate your source files into groups. For example, in a rails app, you'll want to have separate listings for
+Models, Controllers, Helpers, Libs and Plugins. Group definition works similar to Filters (and indeed also accepts custom
+filter classes), but source files end up in a group when the filter passes (returns true), as opposed to filtering results,
+which exclude files from results when the filter results in a true value.
+
+Add your groups with:
+
+    SimpleCov.start do
+      add_group "Models", "app/models"
+      add_group "Controllers", "app/controllers"
+      add_group "Long files" do |src_file|
+        src_file.lines.count > 100
+      end
+      add_group "Short files", LineFilter.new(5) # Using the LineFilter class defined in Filters section above
+    end
+
+## Merging results
+
+Normally, you want to have your coverage analyzed across ALL of your test suites, right?
+
+Simplecov automatically caches coverage results in your (coverage_path)/resultset.yml. Those results will then
+be automatically merged when generating the result, so when coverage is set up properly for cucumber and your
+unit / functional / integration tests, all of those test suites will be taken into account when building the
+coverage report.
+
+There are two things to note here though:
+
+### Test suite names
+
+Simplecov tries to guess the name of the currently running test suite based upon the shell command the tests are running
+on. 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.
+
+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, 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 'test:units'
+
+    # test/functionals/some_controller_test.rb
+    SimpleCov.command_name "test:functionals"
+
+    # test/integration/some_integration_test.rb
+    SimpleCov.command_name "test:integration"
+
+    # features/support/env.rb
+    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.
+
+[simplecov-html] prints the used test suites in the footer of the generated coverage report.
+
+### Timeout for merge
+
+Of course, your cached coverage data is likely to become invalid at some point. Thus, result sets that are older than
+SimpleCov.merge_timeout will not be used any more. By default, the timeout is 600 seconds (10 minutes), and you can
+raise (or lower) it by specifying `SimpleCov.merge_timeout 3600` (1 hour), or, inside a configure/start block, with
+just "merge_timeout 3600".
+
+You can deactivate merging altogether with `SimpleCov.use_merging false`.
+
+
+## Running coverage only on demand
+
+The Ruby STDLIB Coverage library that SimpleCov builds upon is *very* fast (i.e. on a ~10 min Rails test suite, the speed drop was
+only a couple seconds for me), and therefore it's SimpleCov's policy to just generate coverage every time you run your tests because
+it doesn't do your test speed any harm and you're always equipped with the latest and greatest coverage results.
+
+Because of this, SimpleCov has no explicit built-in mechanism to run coverage only on demand.
+
+However, you can still accomplish this very easily by introducing a ENV variable conditional into your SimpleCov setup block, like this:
+
+    SimpleCov.start if ENV["COVERAGE"]
+
+Then, SimpleCov will only run if you execute your tests like this:
+
+    $ COVERAGE=true rake test
+
+
+## Adapters
+
+By default, Simplecov's only config assumption is that you only want coverage reports for files inside your project
+root. To save you from repetitive configuration, you can use predefined blocks of configuration, called 'adapters',
+or define your own.
+
+You can then pass the name of the adapter to be used as the first argument to SimpleCov.start. For example, simplecov
+comes bundled with a 'rails' adapter. It looks somewhat like this:
+
+    SimpleCov.adapters.define 'rails' do
+      add_filter '/test/'
+      add_filter '/config/'
+
+      add_group 'Controllers', 'app/controllers'
+      add_group 'Models', 'app/models'
+      add_group 'Helpers', 'app/helpers'
+      add_group 'Libraries', 'lib'
+      add_group 'Plugins', 'vendor/plugins'
+    end
+
+As you can see, it's just a glorified SimpleCov.configure block. In your test_helper.rb, launch simplecov with:
+
+    SimpleCov.start 'rails'
+
+**OR**
+
+    SimpleCov.start 'rails' do
+      # additional config here
+    end
+
+### Custom adapters
+
+You can load additional adapters with the SimpleCov.load_adapter('xyz') method. This allows you to build upon an existing
+adapter and customize it so you can reuse it in unit tests and cucumber features, for example.
+
+    # lib/simplecov_custom_adapter.rb
+    require 'simplecov'
+    SimpleCov.adapters.define 'myadapter' do
+      load_adapter 'rails'
+      add_filter 'vendor' # Don't include vendored stuff
+    end
+
+    # features/support/env.rb
+    require 'simplecov_custom_adapter'
+    SimpleCov.start 'myadapter'
+
+    # test/test_helper.rb
+    require 'simplecov_custom_adapter'
+    SimpleCov.start 'myadapter'
+
+
+
+## Customizing exit behaviour
+
+You can define what simplecov should do when your test suite finishes by customizing the at_exit hook:
+
+    SimpleCov.at_exit do
+      SimpleCov.result.format!
+    end
+
+Above is the default behaviour. Do whatever you like instead!
+
+
+## Using your own formatter
+
+You can use your own formatter with:
+
+    SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
+
+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], there are other formatters
+available:
+
+### [simplecov-rcov](https://github.com/fguillen/simplecov-rcov)
+*by Fernando Guillen*
+
+"The target of this formatter is to cheat on Hudson so I can use the Ruby metrics plugin with SimpleCov."
+
+#### [simplecov-csv](https://github.com/fguillen/simplecov-csv)
+*by Fernando Guillen*
+
+CSV formatter for SimpleCov code coverage tool for ruby 1.9+
+
+
+
+## Ruby version compatibility
+
+[![Build Status](https://secure.travis-ci.org/colszowka/simplecov.png)](http://travis-ci.org/colszowka/simplecov)
+
+Only Ruby 1.9+ ships with the coverage library that SimpleCov depends upon. SimpleCov is built against various other Rubies,
+including Rubinius and JRuby, in [Continuous Integration], but this happens only to ensure that SimpleCov does not make your 
+test suite crash right now. Whether SimpleCov will support JRuby/Rubinius in the future depends solely on whether those Ruby 
+interpreters add the coverage library.
+
+SimpleCov is built in [Continuous Integration] on 1.8.7, ree, 1.9.2, 1.9.3.
+
+
+
+## Contributions
+
+To fetch & test the library for development, do:
+
+    $ git clone https://github.com/colszowka/simplecov
+    $ cd simplecov
+    $ bundle
+    $ bundle exec rake test && bundle exec cucumber features
+
+If you wont to contribute, please:
+
+  * 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.
+  * Send me a pull request on Github.
+
+## Kudos
+
+Thanks to Aaron Patterson (http://engineering.attinteractive.com/2010/08/code-coverage-in-ruby-1-9/) for the original idea
+for this!
+    
+
+## Copyright
+
+Copyright (c) 2010-2011 Christoph Olszowka. See LICENSE for details.

data/features/rspec_fails_on_initialization.feature

@@ -0,0 +1,14 @@
+@rspec
+Feature:
+
+  Running specs with a failing rspec setup
+
+  Scenario: Fail if rspec fails before starting its tests
+    Given a file named "spec/spec_helper.rb" with:
+      """
+      require 'simplecov'
+      SimpleCov.start
+      raise "some exception in the class loading before the tests start"
+      """
+    When I run `bundle exec rspec spec`
+    Then the exit status should not be 0

data/features/rspec_groups_using_filter_class.feature

@@ -0,0 +1,40 @@
+@rspec
+Feature: Grouping on RSpec using a custom filter class
+
+  Next to passing a block or a string to define a group, you can also pass
+  a filter class. The filter class inherits from SimpleCov::Filter and 
+  must implement the matches? method, which is used to determine whether 
+  or not a file should be added to the group. 
+
+  Scenario:
+    Given SimpleCov for RSpec is configured with:
+      """
+      require 'simplecov'
+      class CoverageFilter < SimpleCov::Filter
+        def matches?(source_file)
+          source_file.covered_percent < filter_argument
+        end
+      end
+      SimpleCov.start do
+        add_group 'By filter class', CoverageFilter.new(90)
+        add_group 'By string', 'project/meta_magic'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rspec spec`
+    Then I should see the groups:
+      | name             | coverage | files |
+      | All Files        | 90.74%   | 6     |
+      | By filter class  | 78.26%   | 2     |
+      | By string        | 100.0%   | 1     |
+      | Ungrouped        | 100.0%   | 3     |
+
+    And I should see the source files:
+      | name                                    | coverage |
+      | lib/faked_project/framework_specific.rb | 75.0 %   | 
+      | lib/faked_project/some_class.rb         | 80.0 %   |
+      | lib/faked_project.rb                    | 100.0 %  |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |
+      | spec/meta_magic_spec.rb                 | 100.0 %  |
+      | spec/some_class_spec.rb                 | 100.0 %  |
+

data/features/test_unit_groups_using_filter_class.feature

@@ -0,0 +1,40 @@
+@test_unit
+Feature: Grouping on Test/Unit using a custom filter class
+
+  Next to passing a block or a string to define a group, you can also pass
+  a filter class. The filter class inherits from SimpleCov::Filter and 
+  must implement the matches? method, which is used to determine whether 
+  or not a file should be added to the group. 
+
+  Scenario:
+    Given SimpleCov for Test/Unit is configured with:
+      """
+      require 'simplecov'
+      class CoverageFilter < SimpleCov::Filter
+        def matches?(source_file)
+          source_file.covered_percent < filter_argument
+        end
+      end
+      SimpleCov.start do
+        add_group 'By filter class', CoverageFilter.new(90)
+        add_group 'By string', 'project/meta_magic'
+      end
+      """
+
+    When I open the coverage report generated with `bundle exec rake test`
+    Then I should see the groups:
+      | name             | coverage | files |
+      | All Files        | 91.38%   | 6     |
+      | By filter class  | 78.26%   | 2     |
+      | By string        | 100.0%   | 1     |
+      | Ungrouped        | 100.0%   | 3     |
+
+    And I should see the source files:
+      | name                                    | coverage |
+      | lib/faked_project/framework_specific.rb | 75.0 %   | 
+      | lib/faked_project/some_class.rb         | 80.0 %   |
+      | lib/faked_project.rb                    | 100.0 %  |
+      | lib/faked_project/meta_magic.rb         | 100.0 %  |
+      | test/meta_magic_test.rb                 | 100.0 %  |
+      | test/some_class_test.rb                 | 100.0 %  |
+

data/lib/simplecov.rb

@@ -60,7 +60,7 @@ module SimpleCov
     def filtered(files)
       result = files.clone
       filters.each do |filter|
-        result = result.select {|source_file| filter.passes?(source_file) }
+        result = result.reject {|source_file| filter.matches?(source_file) }
       end
       SimpleCov::FileList.new result
     end
@@ -72,7 +72,7 @@ module SimpleCov
       grouped = {}
       grouped_files = []
       groups.each do |name, filter|
-        grouped[name] = SimpleCov::FileList.new(files.select {|source_file| !filter.passes?(source_file)})
+        grouped[name] = SimpleCov::FileList.new(files.select {|source_file| filter.matches?(source_file)})
         grouped_files += grouped[name]
       end
       if groups.length > 0 and (other_files = files.reject {|source_file| grouped_files.include?(source_file)}).length > 0
@@ -103,7 +103,6 @@ module SimpleCov
 end
 
 $LOAD_PATH.unshift(File.join(File.dirname(__FILE__)))
-require 'simplecov/jruby_float_fix'
 require 'simplecov/configuration'
 SimpleCov.send :extend, SimpleCov::Configuration
 require 'simplecov/adapters'

data/lib/simplecov/defaults.rb

@@ -24,6 +24,7 @@ SimpleCov.adapters.define 'rails' do
 
   add_group 'Controllers', 'app/controllers'
   add_group 'Models', 'app/models'
+  add_group 'Mailers', 'app/mailers'
   add_group 'Helpers', 'app/helpers'
   add_group 'Libraries', 'lib'
   add_group 'Plugins', 'vendor/plugins'
@@ -35,14 +36,18 @@ SimpleCov.configure do
   # Exclude files outside of SimpleCov.root
   load_adapter 'root_filter'
 end
-
 at_exit do
   # Store the exit status of the test run since it goes away after calling the at_exit proc...
-  @exit_status = $!.status if $!.is_a?(SystemExit)
+  if $! #was an exception thrown?
+    #if it was a SystemExit, use the accompanying status
+    #otherwise set a non-zero status representing termination by some other exception
+    #(see github issue 41)
+    @exit_status = $!.is_a?(SystemExit) ? $!.status : 1
+  end
   SimpleCov.at_exit.call
   exit @exit_status if @exit_status # Force exit with stored status (see github issue #5)
 end
 
 # Autoload config from .simplecov if present
 config_path = File.join(SimpleCov.root, '.simplecov')
-load config_path if File.exist?(config_path)
+load config_path if File.exist?(config_path)

data/lib/simplecov/filter.rb

@@ -16,24 +16,29 @@ module SimpleCov
       @filter_argument = filter_argument
     end
 
-    def passes?(source_file)
+    def matches?(source_file)
       raise "The base filter class is not intended for direct use"
     end
+    
+    def passes?(source_file)
+      warn "DEPRECATION: SimpleCov::Filter#passes?(x) has been renamed to #matches?. Please update your custom filters accordingly!"
+      matches?(source_file)
+    end
   end
 
   class StringFilter < SimpleCov::Filter
     # Returns true when the given source file's filename matches the
     # string configured when initializing this Filter with StringFilter.new('somestring)
-    def passes?(source_file)
-      !(source_file.filename =~ /#{filter_argument}/)
+    def matches?(source_file)
+      (source_file.filename =~ /#{filter_argument}/)
     end
   end
 
   class BlockFilter < SimpleCov::Filter
     # Returns true if the block given when initializing this filter with BlockFilter.new {|src_file| ... }
     # returns true for the given source file.
-    def passes?(source_file)
-      !filter_argument.call(source_file)
+    def matches?(source_file)
+      filter_argument.call(source_file)
     end
   end
 end

data/lib/simplecov/version.rb

@@ -1,3 +1,3 @@
 module SimpleCov
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

data/simplecov.gemspec

@@ -16,7 +16,7 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'simplecov-html', '~> 0.5.3'
   gem.add_development_dependency 'aruba', '~> 0.4'
   gem.add_development_dependency 'capybara', '~> 1.0'
-  gem.add_development_dependency 'cucumber', '~> 1.0'
+  gem.add_development_dependency 'cucumber', '~> 1.0.5'
   gem.add_development_dependency 'rake', '~> 0.8'
   gem.add_development_dependency 'rspec', '~> 2.6'
   gem.add_development_dependency 'shoulda', '~> 2.10'

data/test/test_filters.rb

@@ -7,32 +7,32 @@ class TestFilters < Test::Unit::TestCase
         @source_file = SimpleCov::SourceFile.new(source_fixture('sample.rb'), [nil, 1, 1, 1, nil, nil, 1, 0, nil, nil])
       end
 
-      should "pass a new SimpleCov::StringFilter 'foobar'" do
-        assert SimpleCov::StringFilter.new('foobar').passes?(@source_file)
+      should "not match a new SimpleCov::StringFilter 'foobar'" do
+        assert !SimpleCov::StringFilter.new('foobar').matches?(@source_file)
       end
 
-      should "pass a new SimpleCov::StringFilter 'some/path'" do
-        assert SimpleCov::StringFilter.new('some/path').passes?(@source_file)
+      should "not match a new SimpleCov::StringFilter 'some/path'" do
+        assert !SimpleCov::StringFilter.new('some/path').matches?(@source_file)
       end
 
-      should "not pass a new SimpleCov::StringFilter 'test/fixtures'" do
-        assert !SimpleCov::StringFilter.new('test/fixtures').passes?(@source_file)
+      should "match a new SimpleCov::StringFilter 'test/fixtures'" do
+        assert SimpleCov::StringFilter.new('test/fixtures').matches?(@source_file)
       end
 
-      should "not pass a new SimpleCov::StringFilter 'test/fixtures/sample.rb'" do
-        assert !SimpleCov::StringFilter.new('test/fixtures/sample.rb').passes?(@source_file)
+      should "match a new SimpleCov::StringFilter 'test/fixtures/sample.rb'" do
+        assert SimpleCov::StringFilter.new('test/fixtures/sample.rb').matches?(@source_file)
       end
 
-      should "not pass a new SimpleCov::StringFilter 'sample.rb'" do
-        assert !SimpleCov::StringFilter.new('sample.rb').passes?(@source_file)
+      should "match a new SimpleCov::StringFilter 'sample.rb'" do
+        assert SimpleCov::StringFilter.new('sample.rb').matches?(@source_file)
       end
 
-      should "pass a new SimpleCov::BlockFilter that is not applicable" do
-        assert SimpleCov::BlockFilter.new(Proc.new {|s| File.basename(s.filename) == 'foo.rb'}).passes?(@source_file)
+      should "not match a new SimpleCov::BlockFilter that is not applicable" do
+        assert !SimpleCov::BlockFilter.new(Proc.new {|s| File.basename(s.filename) == 'foo.rb'}).matches?(@source_file)
       end
 
-      should "not pass a new SimpleCov::BlockFilter that is applicable" do
-        assert !SimpleCov::BlockFilter.new(Proc.new {|s| File.basename(s.filename) == 'sample.rb'}).passes?(@source_file)
+      should "match a new SimpleCov::BlockFilter that is applicable" do
+        assert SimpleCov::BlockFilter.new(Proc.new {|s| File.basename(s.filename) == 'sample.rb'}).matches?(@source_file)
       end
     end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: simplecov
 version: !ruby/object:Gem::Version
-  version: 0.5.3
+  version: 0.5.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,12 +9,12 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-13 00:00:00.000000000 +02:00
+date: 2011-10-12 00:00:00.000000000 +02:00
 default_executable: 
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multi_json
-  requirement: &70323468142820 !ruby/object:Gem::Requirement
+  requirement: &70223996324480 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -22,10 +22,10 @@ dependencies:
         version: 1.0.3
   type: :runtime
   prerelease: false
-  version_requirements: *70323468142820
+  version_requirements: *70223996324480
 - !ruby/object:Gem::Dependency
   name: simplecov-html
-  requirement: &70323468142320 !ruby/object:Gem::Requirement
+  requirement: &70223996323980 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -33,10 +33,10 @@ dependencies:
         version: 0.5.3
   type: :runtime
   prerelease: false
-  version_requirements: *70323468142320
+  version_requirements: *70223996323980
 - !ruby/object:Gem::Dependency
   name: aruba
-  requirement: &70323468141860 !ruby/object:Gem::Requirement
+  requirement: &70223996323380 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -44,10 +44,10 @@ dependencies:
         version: '0.4'
   type: :development
   prerelease: false
-  version_requirements: *70323468141860
+  version_requirements: *70223996323380
 - !ruby/object:Gem::Dependency
   name: capybara
-  requirement: &70323468141400 !ruby/object:Gem::Requirement
+  requirement: &70223996322760 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -55,21 +55,21 @@ dependencies:
         version: '1.0'
   type: :development
   prerelease: false
-  version_requirements: *70323468141400
+  version_requirements: *70223996322760
 - !ruby/object:Gem::Dependency
   name: cucumber
-  requirement: &70323468140940 !ruby/object:Gem::Requirement
+  requirement: &70223996322160 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: '1.0'
+        version: 1.0.5
   type: :development
   prerelease: false
-  version_requirements: *70323468140940
+  version_requirements: *70223996322160
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &70323468140480 !ruby/object:Gem::Requirement
+  requirement: &70223996321600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -77,10 +77,10 @@ dependencies:
         version: '0.8'
   type: :development
   prerelease: false
-  version_requirements: *70323468140480
+  version_requirements: *70223996321600
 - !ruby/object:Gem::Dependency
   name: rspec
-  requirement: &70323468140020 !ruby/object:Gem::Requirement
+  requirement: &70223996321120 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -88,10 +88,10 @@ dependencies:
         version: '2.6'
   type: :development
   prerelease: false
-  version_requirements: *70323468140020
+  version_requirements: *70223996321120
 - !ruby/object:Gem::Dependency
   name: shoulda
-  requirement: &70323468139560 !ruby/object:Gem::Requirement
+  requirement: &70223996320600 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -99,7 +99,7 @@ dependencies:
         version: '2.10'
   type: :development
   prerelease: false
-  version_requirements: *70323468139560
+  version_requirements: *70223996320600
 description: Code coverage for Ruby 1.9 with a powerful configuration library and
   automatic merging of coverage across test suites
 email:
@@ -114,7 +114,7 @@ files:
 - CHANGELOG.md
 - Gemfile
 - LICENSE
-- README.rdoc
+- README.md
 - Rakefile
 - cucumber.yml
 - features/config_adapters.feature
@@ -129,8 +129,10 @@ files:
 - features/cucumber_basic.feature
 - features/merging_test_unit_and_rspec.feature
 - features/rspec_basic.feature
+- features/rspec_fails_on_initialization.feature
 - features/rspec_groups_and_filters_basic.feature
 - features/rspec_groups_and_filters_complex.feature
+- features/rspec_groups_using_filter_class.feature
 - features/rspec_without_simplecov.feature
 - features/skipping_code_blocks_manually.feature
 - features/step_definitions/html_steps.rb
@@ -141,6 +143,7 @@ files:
 - features/test_unit_basic.feature
 - features/test_unit_groups_and_filters_basic.feature
 - features/test_unit_groups_and_filters_complex.feature
+- features/test_unit_groups_using_filter_class.feature
 - features/test_unit_without_simplecov.feature
 - features/unicode_compatiblity.feature
 - lib/simplecov.rb
@@ -152,7 +155,6 @@ files:
 - lib/simplecov/filter.rb
 - lib/simplecov/formatter.rb
 - lib/simplecov/formatter/simple_formatter.rb
-- lib/simplecov/jruby_float_fix.rb
 - lib/simplecov/merge_helpers.rb
 - lib/simplecov/result.rb
 - lib/simplecov/result_merger.rb
@@ -238,8 +240,10 @@ test_files:
 - features/cucumber_basic.feature
 - features/merging_test_unit_and_rspec.feature
 - features/rspec_basic.feature
+- features/rspec_fails_on_initialization.feature
 - features/rspec_groups_and_filters_basic.feature
 - features/rspec_groups_and_filters_complex.feature
+- features/rspec_groups_using_filter_class.feature
 - features/rspec_without_simplecov.feature
 - features/skipping_code_blocks_manually.feature
 - features/step_definitions/html_steps.rb
@@ -250,6 +254,7 @@ test_files:
 - features/test_unit_basic.feature
 - features/test_unit_groups_and_filters_basic.feature
 - features/test_unit_groups_and_filters_complex.feature
+- features/test_unit_groups_using_filter_class.feature
 - features/test_unit_without_simplecov.feature
 - features/unicode_compatiblity.feature
 - test/faked_project/Gemfile

data/README.rdoc

@@ -1,359 +0,0 @@
-= SimpleCov http://travis-ci.org/colszowka/simplecov.png
-
-* Source code: https://github.com/colszowka/simplecov
-* API documentation: http://rubydoc.info/gems/simplecov/frames
-* Changelog: https://github.com/colszowka/simplecov/blob/master/CHANGELOG.md
-* Rubygems: http://rubygems.org/gems/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 its 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 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
-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 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:
-
-  gem 'simplecov', '>= 0.5.3', :require => false, :group => :test
-
-Then, add the following to your test/test_helper.rb (right at the top, line 00) or spec_helper.rb or cucumber env.rb or whatever
-test framework you prefer, really - just make sure simplecov is loaded and started BEFORE your app code is loaded:
-
-  require 'simplecov'
-  SimpleCov.start
-
-Now, when running tests you'll get a coverage/ folder inside your app's root where you can browse your code coverage.
-
-If you're making a Rails application, SimpleCov comes with a built-in adapter (see below for more information on what adapters are)
-for it which will give you handy tabs in the output webpage for your Controllers, Views, Models, etc. To use it, the first two lines of your test_helper should be like this:
-
-  require 'simplecov'
-  SimpleCov.start 'rails'
-
-== Example output
-
-<b>Coverage results report, fully browsable locally with sorting and much more:</b>
-http://colszowka.github.com/simplecov/devise_result-0.5.3.png
-
-<b>Source file coverage details view:</b>
-http://colszowka.github.com/simplecov/devise_source_file-0.5.3.png
-
-== Use it with any 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.
-
-Add the setup code to the <b>top</b> of +features/support/env.rb+ (for Cucumber) or +spec/spec_helper.rb+ (for RSpec).
-Other test frameworks should work accordingly, whatever their setup file may be:
-
-  require 'simplecov'
-  SimpleCov.start 'rails'
-
-You could even track what kind of code your UI testers are touching if you want to go overboard with things. SimpleCov does not
-care what kind of framework it is running in, it just looks at what code is being executed and generates a report about it.
-
-== Configuration
-
-Configuration settings can be applied in three formats.
-
-The 'direct' way:
-
-  SimpleCov.some_config_option 'foo'
-
-Using a block:
-
-  SimpleCov.configure do
-    some_config_option 'foo'
-  end
-
-Using a block and automatically starting the coverage:
-
-  SimpleCov.start do
-    some_config_option 'foo'
-  end
-
-Most times, you'll want to use the latter, so loading and setting up simplecov is in one place at the top of your test helper.
-
-== Running coverage only on demand
-
-The Ruby STDLIB Coverage library that SimpleCov builds upon is *very* fast (i.e. on a ~10 min Rails test suite, the speed drop was
-only a couple seconds for me), and therefore it's SimpleCov's policy to just generate coverage every time you run your tests because
-it doesn't do your test speed any harm and you're always equipped with the latest and greatest coverage results.
-
-Because of this, SimpleCov has no explicit built-in mechanism to run coverage only on demand.
-
-However, you can still accomplish this very easily by introducing a ENV variable conditional into your SimpleCov setup block, like this:
-
-  SimpleCov.start if ENV["COVERAGE"]
-
-Then, SimpleCov will only run if you execute your tests like this:
-
-  $ COVERAGE=true rake test
-
-== Filters
-
-Filters can be used to remove selected files from your coverage data. By default, a filter is applied that removes all files
-OUTSIDE of your project's root directory - otherwise you'd end up with a billion of coverage reports for source files in the
-gems you are using.
-
-Of course you can define your own to remove things like configuration files, tests or whatever you don't need in your coverage
-report.
-
-=== Defining custom filters
-
-You can currently define a filter using either a String (that will then be Regexp-matched against each source file's path),
-a block or by passing in your own Filter class.
-
-==== String filter
-
-  SimpleCov.start do
-    add_filter "/test/"
-  end
-
-This simple string filter will remove all files that match "/test/" in their path.
-
-==== Block filter
-
-  SimpleCov.start do
-    add_filter do |source_file|
-      source_file.lines.count < 5
-    end
-  end
-
-Block filters receive a SimpleCov::SourceFile instance and expect your block to return either true (if the file is to be removed
-from the result) or false (if the result should be kept). Please check out the RDoc for SimpleCov::SourceFile to learn about the
-methods available to you. In the above example, the filter will remove all files that have less then 5 lines of code.
-
-==== Custom filter class
-
-  class LineFilter < SimpleCov::Filter
-    def passes?(source_file)
-      source_file.lines.count < filter_argument
-    end
-  end
-
-  SimpleCov.add_filter LineFilter.new(5)
-
-Defining your own filters is pretty easy: Just inherit from SimpleCov::Filter and define a method 'passes?(source_file)'. When running
-the filter, a true return value from this method will result in the removal of the given source_file. The filter_argument method
-is being set in the SimpleCov::Filter initialize method and thus is set to 5 in this example.
-
-== Groups
-
-You can separate your source files into groups. For example, in a rails app, you'll want to have separate listings for
-Models, Controllers, Helpers, Libs and Plugins. Group definition works similar to Filters (and indeed also accepts custom
-filter classes), but source files end up in a group when the filter passes (returns true), as opposed to filtering results,
-which exclude files from results when the filter results in a true value.
-
-Add your groups with:
-
-  SimpleCov.start do
-    add_group "Models", "app/models"
-    add_group "Controllers", "app/controllers"
-    add_group "Long files" do |src_file|
-      src_file.lines.count > 100
-    end
-    add_group "Short files", LineFilter.new(5) # Using the LineFilter class defined in Filters section above
-  end
-
-== Merging results
-
-Normally, you want to have your coverage analyzed across ALL of your test suites, right?
-
-Simplecov automatically caches coverage results in your (coverage_path)/resultset.yml. Those results will then
-be automatically merged when generating the result, so when coverage is set up properly for cucumber and your
-unit / functional / integration tests, all of those test suites will be taken into account when building the
-coverage report.
-
-There are two things to note here though:
-
-=== Test suite names
-
-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.
-
-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, 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 'test:units'
-
-  # test/functionals/some_controller_test.rb
-  SimpleCov.command_name "test:functionals"
-
-  # test/integration/some_integration_test.rb
-  SimpleCov.command_name "test:integration"
-
-  # features/steps/web_steps.rb
-  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.
-
-simplecov-html prints the used test suites in the footer of the generated coverage report.
-
-=== Timeout for merge
-
-Of course, your cached coverage data is likely to become invalid at some point. Thus, result sets that are older than
-SimpleCov.merge_timeout will not be used any more. By default, the timeout is 600 seconds (10 minutes), and you can
-raise (or lower) it by specifying SimpleCov.merge_timeout 3600 (1 hour), or, inside a configure/start block, with
-just "merge_timeout 3600".
-
-You can deactivate merging altogether with "SimpleCov.use_merging false".
-
-== Adapters
-
-By default, Simplecov's only config assumption is that you only want coverage reports for files inside your project
-root. To save you from repetitive configuration, you can use predefined blocks of configuration, called 'adapters',
-or define your own.
-
-You can then pass the name of the adapter to be used as the first argument to SimpleCov.start. For example, simplecov
-comes bundled with a 'rails' adapter. It looks somewhat like this:
-
-  SimpleCov.adapters.define 'rails' do
-    add_filter '/test/'
-    add_filter '/config/'
-
-    add_group 'Controllers', 'app/controllers'
-    add_group 'Models', 'app/models'
-    add_group 'Helpers', 'app/helpers'
-    add_group 'Libraries', 'lib'
-    add_group 'Plugins', 'vendor/plugins'
-  end
-
-As you can see, it's just a glorified SimpleCov.configure block. In your test_helper.rb, launch simplecov with:
-
-  SimpleCov.start 'rails'
-
-    OR
-
-  SimpleCov.start 'rails' do
-    # additional config here
-  end
-
-=== Custom adapters
-
-You can load additional adapters with the SimpleCov.load_adapter('xyz') method. This allows you to build upon an existing
-adapter and customize it so you can reuse it in unit tests and cucumber features, for example.
-
-  # lib/simplecov_custom_adapter.rb
-  require 'simplecov'
-  SimpleCov.adapters.define 'myadapter' do
-    load_adapter 'rails'
-    add_filter 'vendor' # Don't include vendored stuff
-  end
-
-  # features/support/env.rb
-  require 'simplecov_custom_adapter'
-  SimpleCov.start 'myadapter'
-
-  # test/test_helper.rb
-  require 'simplecov_custom_adapter'
-  SimpleCov.start 'myadapter'
-
-== Customizing exit behaviour
-
-You can define what simplecov should do when your test suite finishes by customizing the at_exit hook:
-
-  SimpleCov.at_exit do
-    SimpleCov.result.format!
-  end
-
-Above is the default behaviour. Do whatever you like instead!
-
-== Using your own formatter
-
-You can use your own formatter with:
-
-  SimpleCov.formatter = SimpleCov::Formatter::HTMLFormatter
-
-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
-
-Please have a look at our documentation[http://rubydoc.info/gems/simplecov/frames], specifically the Configuration class.
-
-== Kudos
-
-Thanks to Aaron Patterson (http://engineering.attinteractive.com/2010/08/code-coverage-in-ruby-1-9/) for the original idea
-for this!
-
-== Ruby version compatibility
-
-http://travis-ci.org/colszowka/simplecov.png
-
-Only Ruby 1.9+ ships with the coverage library that SimpleCov depends upon. SimpleCov is built against various other Rubies,
-including Rubinius and JRuby, in {continuous integration}[http://travis-ci.org/colszowka/simplecov], but this happens only to
-ensure that SimpleCov does not make your test suite crash right now. Whether SimpleCov will support JRuby/Rubinius in the future
-depends solely on whether those Ruby interpreters add the coverage library.
-
-SimpleCov is built in {continuous integration}[http://travis-ci.org/colszowka/simplecov] on 1.8.6, 1.8.7, 1.9.2, ree, ruby-head,
-rbx and jruby.
-
-== Contributions
-
-To fetch & test the library for development, do:
-
-  $ git clone https://github.com/colszowka/simplecov
-  $ cd simplecov
-  $ bundle
-  $ bundle exec rake test && bundle exec cucumber features
-
-If you wont to contribute, please:
-
-  * 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.
-  * Send me a pull request on Github.
-
-== Copyright
-
-Copyright (c) 2010-2011 Christoph Olszowka. See LICENSE for details.

data/lib/simplecov/jruby_float_fix.rb

@@ -1,14 +0,0 @@
-# Temporary fix for JRuby 1.6.0 RC1 wrong round method
-if defined?(RUBY_ENGINE) and RUBY_ENGINE == 'jruby' and RUBY_VERSION == '1.9.2'
-  class Float
-    alias_method :precisionless_round, :round
-    def round(precision = nil)
-      if precision
-        magnitude = 10.0 ** precision
-        (self * magnitude).round / magnitude
-      else
-        precisionless_round
-      end
-    end
-  end
-end