README.md in puppetlabs_spec_helper-2.8.0 vs README.md in puppetlabs_spec_helper-2.9.0

- old
+ new

@@ -77,12 +77,11 @@ $ rake parallel_spec Issues ====== -Please file issues against this project at the [Puppet Labs Issue -Tracker](https://tickets.puppetlabs.com/browse/MODULES) +Please file issues against this project at the [Puppet Labs Issue Tracker](https://tickets.puppetlabs.com/browse/MODULES) The Long Version ---------------- Purpose of this Project @@ -362,56 +361,23 @@ This section describes how to add code coverage reports for Ruby files (types, providers, ...). See the documentation of [RSpec-Puppet](https://github.com/rodjek/rspec-puppet) for Puppet manifest coverage reports. Starting with Ruby 1.9, the *de facto* standard for Ruby code coverage is -[SimpleCov](https://github.com/colszowka/simplecov). -You can add it to your module like this: +[SimpleCov](https://github.com/colszowka/simplecov). It is implemented as a Rake task in this gem. -```Ruby -# First line of spec/spec_helper.rb -require 'simplecov' +To run code coverage: -SimpleCov.start do - add_filter '/spec/' - # Exclude bundled Gems in `/.vendor/` - add_filter '/.vendor/' -end + $ rake spec:simplecov -require 'puppetlabs_spec_helper/module_spec_helper' -# Further content -``` +Reports are written to `/coverage/`, which you should add to `.gitignore`. -The reports will then be generated every time you invoke RSpec, e.g. via `rake spec`, -and are written to `/coverage/`, which you should add to `.gitignore`. +The reports can be generated every time you invoke RSpec, e.g. via `rake spec`, +You can enable it, set the following environment variable:s -Remember to add `gem 'simplecov', require: false` to your `Gemfile`. +``SIMPLECOV=yes`` -Using Code Climate ------------------- - -You can also use [Code Climate](https://codeclimate.com/) together with SimpleCov: - -```Ruby -# First line of spec/spec_helper.rb -require 'codeclimate-test-reporter' - -SimpleCov.formatters = [ - SimpleCov::Formatter::HTMLFormatter, - CodeClimate::TestReporter::Formatter -] - -SimpleCov.start do - add_filter '/spec/' - # Exclude bundled Gems in `/.vendor/` - add_filter '/.vendor/' -end - -require 'puppetlabs_spec_helper/module_spec_helper' -# Further content -``` - -Remember to add `gem 'codeclimate-test-reporter', require: false` to your `Gemfile`. +Remember to add the simplecov-console and codecov gems to your `Gemfile`. Using Coveralls --------------- You can also use [Coveralls](https://coveralls.io/) together with SimpleCov: