Rspec Usecases

Rspec Usecases helps to write self-documenting code usage examples that execute as normal unit tests while outputting documentation in varied formats

Installation

Add this line to your application's Gemfile:

gem 'rspec-usecases'

And then execute:

bundle install

Or install it yourself as:

gem install rspec-usecases

Stories

Main Story

As a Ruby Developer, I want to document code usage examples, so that people can get going quickly with implementation

See all stories

Usage

See all usage examples

Basic Example

Basic example

Description for a basic example to be featured in the main README.MD file

class SomeRuby; end

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.

rspec-usecases is setup with Guard, run guard, this will watch development file changes and run tests automatically, if successful, it will then run rubocop for style quality.

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 tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/klueless-io/rspec-usecases. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

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

Code of Conduct

Everyone interacting in the Rspec Usecases project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.

Copyright (c) David Cruwys. See MIT License for further details.