README.md in ndd-rspec-1.1.2 vs README.md in ndd-rspec-1.2.0

- old
+ new

@@ -2,48 +2,70 @@ [![Build Status](https://secure.travis-ci.org/ddidier/ndd-rspec.png)](http://travis-ci.org/ddidier/ndd-rspec) [![Dependency Status](https://gemnasium.com/ddidier/ndd-rspec.png)](https://gemnasium.com/ddidier/ndd-rspec) [![Code Climate](https://codeclimate.com/github/ddidier/ndd-rspec/badges/gpa.svg)](https://codeclimate.com/github/ddidier/ndd-rspec) [![Test Coverage](https://codeclimate.com/github/ddidier/ndd-rspec/badges/coverage.svg)](https://codeclimate.com/github/ddidier/ndd-rspec) -[![Documentation Coverage](https://inch-ci.org/github/ddidier/ndd-rspec.svg)](https://inch-ci.org/github/ddidier/ndd-rspec) [![Yard Documentation](http://img.shields.io/badge/yard-docs-blue.svg)](http://www.rubydoc.info/github/ddidier/ndd-rspec) +[![Documentation Coverage](https://inch-ci.org/github/ddidier/ndd-rspec.svg)](https://inch-ci.org/github/ddidier/ndd-rspec) RSpec utilities. The API documentation can be find at [RubyDoc](http://www.rubydoc.info/github/ddidier/ndd-rspec). ## Prerequisites -This gem requires RSpec 3.1 and is tested with: +This gem requires: -- Ruby 1.9.3 -- Ruby 2.0.0 -- Ruby 2.1.x +- `rspec >= 3.0` -## Matchers +And is tested with: -### be\_sorted\_by +- `Ruby 2.4` +- `Ruby 2.3` +- `Ruby 2.2` -```ruby -expect([1, 2, 3]).to be_sorted_by(:to_i) # => success -expect([1, 3, 2]).to be_sorted_by(:to_i) # => failure +## Installation -Duck = Struct.new(:color) -expect([Duck.new('Grey'), Duck.new('White')]).to be_sorted_by(:color) } # => success -expect([Duck.new('White'), Duck.new('Grey')]).to be_sorted_by(:color) } # => failure +Add this line to your application's Gemfile: + +```ruby +gem 'ndd-rspec-rails' ``` -### be\_reverse\_sorted\_by +And then execute `bundle` +Or install it yourself with `gem install ndd-rspec-rails` + +## Matchers + +### be_sorted_by + ```ruby -expect([3, 2, 1]).to be_reverse_sorted_by(:to_i) # => true -expect([1, 3, 2]).to be_reverse_sorted_by(:to_i) # => false +expect(%w[1 2 3]).to be_sorted_by(:to_i) # => success +expect(%w[1 3 2]).to be_sorted_by(:to_i) # => failure +``` -Duck = Struct.new(:color) -expect([Duck.new('White'), Duck.new('Grey')]).to be_reverse_sorted_by(:color) } # => success -expect([Duck.new('Grey'), Duck.new('White')]).to be_reverse_sorted_by(:color) } # => failure +### be_reverse_sorted_by + +```ruby +expect(%w[3 2 1]).to be_reverse_sorted_by(:to_i) # => true +expect(%w[1 3 2]).to be_reverse_sorted_by(:to_i) # => false ``` -## Copyright +## Development -Copyright (c) 2014 David DIDIER. -See `LICENSE.txt` for further details. +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](https://rubygems.org). + +## Contributing + +Bug reports and pull requests are welcome on GitHub at https://github.com/ddidier/ndd-rspec. This project is +intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the +[Contributor Covenant](http://contributor-covenant.org) code of conduct. + +## License + +The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).