Publish pretty rspec reports

This is a ruby Rspec custom formatter which generates pretty html reports showing the results of rspec tests. This gem was build to use Rspec 2.x.x If you want to use it with newer versions of Rspec then you should use the rspec_reports_formatter 0.3.x (master) or use this 0.2.x version with the rspec legacy formatters - see below for instructions.

• For Rspec 2.x.x please use rspec_reports_formatter version starting with 0.2.x
• For Rspec 3.x.x please use the rspec_reports_formatter version starting with 0.3.x

Install

  gem install rspec_reports_formatter -v 0.2.2

ideally just add it to your bundler Gemfile as follows:

  gem 'rspec-legacy_formatters', '~> 0.2.2'

Use

When running your rspec tests with rspec 2.8.0 just use the custom formatter:

This should work:

 rspec -f RspecHtmlFormatter spec

If not you can explicitly add in a require as follows:

 rspec --require rspec_html_formatter.rb --format RspecHtmlFormatter spec

If you are using a more recent version of Rspec (3.0.0 onwards) but for some reason don't want to use the rspec_reports_formatter v 0.3.x then you must include the legacy formatter gem into your project by adding it to your Gemfile:

# Your gemfile
group :development do
  gem 'rspec','~> 3.0.0.rc1'
  gem 'bundler', '~> 1.0'
  gem 'rspec-legacy_formatters', '~> 0.2.1'
  gem 'rspec_html_formatter'
end

Then use it at the command line:

 rspec --require rspec/legacy_formatters -f RspecHtmlFormatter spec

It will probably throw out some deprecation warnings. Sorry. I will probably make a version of this reporting specifically for rspec 3.0.0 and onwards at some point.

If you want to provide some generated documentation for the tests you can put comments in the rspec tests like this:

  #-> Given I have ordered a vegetarian pizza
  #-> When I eat the pizza
  #-> Then my tummy is full

The #-> notation is picked up and passed through a Gherkin syntax highlighter. So it was designed to use with Given,When,Then. But in theory you can put other text there too.