README.md in cucumber-rails-1.8.0 vs README.md in cucumber-rails-2.0.0
- old
+ new
@@ -3,11 +3,11 @@
[](http://badge.fury.io/rb/cucumber-rails)
[](http://travis-ci.org/cucumber/cucumber-rails)
[](https://codeclimate.com/github/cucumber/cucumber-rails)
[](https://www.codetriage.com/cucumber/cucumber-rails)
-Cucumber-Rails brings Cucumber to Rails 4.2, Rails 5.x and Rails 6.0.
+Cucumber-Rails brings Cucumber to Rails 4.2, 5.x and 6.x.
## Installation
Before you can use the generator, add the gem to your project's Gemfile as follows:
@@ -41,34 +41,47 @@
[bundle exec] cucumber
## Configuration options
-By default, cucumber-rails runs `DatabaseCleaner.start` and `DatabaseCleaner.clean` before and after your scenarios. You can disable this behaviour like so:
+By default, cucumber-rails runs `DatabaseCleaner.start` and `DatabaseCleaner.clean`
+before and after your scenarios. You can disable this behaviour like so:
```ruby
# features/support/env.rb
# ...
Cucumber::Rails::Database.autorun_database_cleaner = false
```
+By default, cucumber-rails will auto mix-in the helpers from `Rack::Test` into your default Cucumber World instance. You can prevent this behaviour like so:
+```ruby
+# features/support/env.rb
+ENV['CR_REMOVE_RACK_TEST_HELPERS'] = 'true'
+```
+
## Upgrading from a previous version
When upgrading from a previous version it is recommended that you rerun:
rails generate cucumber:install
## Bugs and feature requests
-The *only* way to have a bug fixed or a new feature accepted is to describe it with a Cucumber feature. Let's say you think you have found a bug in the cucumber:install generator. Fork this project, clone it to your workstation and check out a branch with a descriptive name:
+The *only* way to have a bug fixed or a new feature accepted is to describe it with a
+Cucumber feature. Let's say you think you have found a bug in the cucumber:install generator.
+Fork this project, clone it to your workstation and check out a branch with a descriptive name:
git clone git@github.com:you/cucumber-rails.git
git checkout -b bugfix/generator-fails-on-ruby-25
-Start by making sure you can run the existing features. Now, create a feature that demonstrates what's wrong. See the existing features for examples. When you have a failing feature that reproduces the bug, commit, push and send a pull request. Someone from the Cucumber-Rails team will review it and hopefully create a fix.
+Start by making sure you can run the existing features. Now, create a feature that demonstrates
+what's wrong. See the existing features for examples. When you have a failing feature that
+reproduces the bug, commit, push and send a pull request. Someone from the Cucumber-Rails team
+will review it and hopefully create a fix.
-If you know how to fix the bug yourself, make a second commit (after committing the failing feature) before you send the pull request.
+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
Make sure you have a supported ruby installed, cd into your cucumber-rails repository and:
@@ -83,33 +96,39 @@
[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:
+In order to test against multiple versions of key dependencies, the [Appraisal](https://github.com/thoughtbot/appraisal)
+gem 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:
[bundle exec] appraisal install
[bundle exec] appraisal rake test
To run the suite against a named gemfile, use the following:
[bundle exec] appraisal rails_4_2 rake test
-To remove and rebuild the different gemfiles (for example, to update a rails version or its dependencies), use the following:
+To remove and rebuild the different gemfiles (for example, to update a rails version or its
+dependencies), use the following:
[bundle exec] appraisal update
-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:
+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:
1. If it's a runtime dependency of the gem, add it to the gemspec
2. If it's a primary development dependency, add it to the gemspec
-3. If it's a dependency of a generated rails app in a test, add it to [the helper] that modifies that Gemfile.
+3. If it's a dependency of a generated rails app in a test, add it to [the helper] that
+modifies the `Gemfile`.
For example, rspec is a primary development dependency, so it lives in the gemspec.
[the helper]: https://github.com/cucumber/cucumber-rails/blob/5e37c530560ae1c1a79521c38a54bae0be94242b/features/step_definitions/cucumber_rails_steps.rb#L15