/turnip_documentation_formatter

RSpec documentation formatter for Turnip

Primary LanguageRubyMIT LicenseMIT

Turnip Documentation Formatter

This gem extends the default RSpec documentation formatter for Turnip to print each step on it's own line.

This makes it easier to see on exactly which step an error occured.

This project is still unstable. It's monkey patching turnip to get some things to work. It will be considered unstable until some patches have been integrated into Turnip.

Screenshot

Before example

Installation

Add this line to your application's Gemfile:

gem 'turnip_documentation_formatter'

And then execute:

$ bundle install

Or install it yourself as:

$ gem install turnip_documentation_formatter

Usage

Use the default documentation formatter when running RSpec (rspec --format documentation).

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/aramvisser/turnip-documentation-formatter.

License

The gem is available as open source under the terms of the MIT License.