README.md in cucumber-rails-1.5.0 vs README.md in cucumber-rails-1.6.0
- old
+ new
@@ -2,20 +2,20 @@
[](http://badge.fury.io/rb/cucumber-rails)
[](http://travis-ci.org/cucumber/cucumber-rails)
[](https://codeclimate.com/github/cucumber/cucumber-rails)
[](https://gemnasium.com/Kosmas/cucumber-rails)
-[](https://www.pullreview.com/github/cucumber/cucumber-rails/reviews/master)
+[](https://www.codetriage.com/cucumber/cucumber-rails)
Cucumber-Rails brings Cucumber to Rails 4.x and 5.x. For Rails 3.x support, use version 1.4.5. For Rails 2.3.x support, see the [rails-2.3.x branch](https://github.com/cucumber/cucumber-rails/tree/rails-2.3.x).
## Installation
Before you can use the generator, add the gem to your project's Gemfile as follows:
group :test do
- gem 'cucumber-rails', :require => false
+ gem 'cucumber-rails', require: false
# database_cleaner is not required, but highly recommended
gem 'database_cleaner'
end
Then install it by running:
@@ -65,34 +65,40 @@
If you know how to fix the bug yourself, make a second commit (after committing the failing feature) before you send the pull request.
### Setting up your environment
-I strongly recommend rvm and ruby 1.9.3. When you have that, cd into your cucumber-rails repository and:
+We strongly recommend that you use `rvm` or `rbenv` and ruby `2.2.0`. When you have that, cd into your cucumber-rails repository and:
gem install bundler
bundle install
### Running all tests
With all dependencies installed, all specs and features should pass:
- rake
+ [bundle exec] rake
### Running Appraisal suite
In order to test against multiple versions of key dependencies, the [Appraisal](https://github.com/thoughtbot/appraisal) is used to generate multiple gemfiles, stored in the `gemfiles/` directory. Normally these will only run on Travis; however, if you want to run the full test suite against all gemfiles, run the following commands:
- appraisal install
- appraisal rake test
+ [bundle exec] appraisal install
+ [bundle exec] appraisal rake test
To run the suite against a named gemfile, use the following:
- appraisal rails_4_1 rake test
+ [bundle exec] appraisal rails_4_1 rake test
To remove and rebuild the different gemfiles (for example, to update a rails version or its dependencies), use the following:
- appraisal install
+ [bundle exec] appraisal install
+
+If you've changed versions of the dependencies, you may find it helpful to forcefully clean each appraisal's gem lock file in `gemfiles/`. You can do this using:
+
+ [bundle exec] rake clean
+
+
### Adding dependencies
To support the multiple-gemfile testing, when adding a new dependency the following rules apply: