README.md
UmtsCustomMatchers
==================
Custom RSpec Rails-related matchers, used for UMass Transit's internal Rails
development process.
Much of the inspiration for these solutions came from inspection of the
rspec-rails source code, so thanks to the rspec-rails team for making their
source code public.
[![Build Status][travis-badge]][travis-link]
[![Test Coverage][cc-coverage-badge]][cc-coverage-link]
[![Code Climate][cc-badge]][cc-link]
[![Issue Count][cc-issue-badge]][cc-issue-link]
Installation
------------
Add this line to your application's Gemfile:
```ruby
gem 'umts-custom-matchers'
```
And then execute:
```
$ bundle
```
Or install it yourself as:
```
$ gem install umts-custom-matchers
```
Usage
-----
Require the matchers in your RSpec configuration file:
```ruby
require 'umts_custom_matchers'
```
And include them:
```ruby
RSpec.configure do |config|
# ...
config.include UmtsCustomMatchers
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.
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][rg].
Contributing
------------
Bug reports and pull requests are welcome on GitHub at
https://github.com/umts/custom-matchers.
License
-------
The gem is available as open source under the terms of the [MIT License][lic].
[travis-badge]: https://travis-ci.org/umts/custom-matchers.svg?branch=master
[travis-link]: https://travis-ci.org/umts/custom-matchers
[cc-coverage-badge]: https://codeclimate.com/github/umts/custom-matchers/badges/coverage.svg
[cc-coverage-link]: https://codeclimate.com/github/umts/custom-matchers/coverage
[cc-badge]: https://codeclimate.com/github/umts/custom-matchers/badges/gpa.svg
[cc-link]: https://codeclimate.com/github/umts/custom-matchers
[cc-issue-badge]: https://codeclimate.com/github/umts/custom-matchers/badges/issue_count.svg
[cc-issue-link]: https://codeclimate.com/github/umts/custom-matchers
[rg]: https://rubygems.org
[lic]: http://opensource.org/licenses/MIT