Contents

[![Gem Version](https://badge.fury.io/rb/rspec_pretty_html_reporter.svg)](https://badge.fury.io/rb/rspec_pretty_html_reporter)

# RSpec Pretty HTML Reporter

Produce pretty [RSpec](http://rspec.info/) reports.

This is a custom reporter for RSpec which generates pretty HTML reports showing the results of rspec tests. It has
features to embed images and videos into the report providing better debugging information when a test fails.

<img src="https://github.com/TheSpartan1980/rspec_pretty_html_reporter/blob/master/images/group_overview_report.png" width="80%"/>

## Setup

Add this to your Gemfile:

```rb
gem 'rspec-pretty-html-reporter'
```

## Generating the report

Either add the below into your `.rspec` file

```rb
--format RspecPrettyHtmlReporter
```

or run RSpec with `--format RspecPrettyHtmlReporter` like below:

```bash
REPORT_PATH=reports/$(date +%s) bundle exec rspec --format RspecPrettyHtmlReporter spec
```

This will create the reports in the `reports` directory.

## Usage

Images and videos can be embed by adding their path into example's metadata. For an example of how to do this, please
check out this [Sample Test](./spec/embed_graphics_spec.rb).

## Credits

This library is forked from [vbanthia/rspec_html_reporter](https://github.com/vbanthia/rspec_html_reporter). The
original credit goes to *[kingsleyh](https://github.com/kingsleyh)*
for [kingsleyh/rspec_reports_formatter](https://github.com/kingsleyh/rspec_reports_formatter)

Version data entries

2 entries across 2 versions & 1 rubygems

Version	Path
rspec_pretty_html_reporter-1.1.2	README.md
rspec_pretty_html_reporter-1.1.1	README.md