Repository files navigation

Cucumber-Rails brings Cucumber to Rails 6.1, 7.x, and 8.x.

Before you can use the generator, add the gem to your project's Gemfile as follows:

group:testdogem'cucumber-rails',require:false# database_cleaner is not required, but highly recommendedgem'database_cleaner'end

Then install it by running:

bundle install

Learn about the various options:

rails generate cucumber:install --help

Finally, bootstrap your Rails app, for example:

rails generate cucumber:install

[bundle exec] cucumber

By default, cucumber-rails runsDatabaseCleaner.start andDatabaseCleaner.cleanbefore and after your scenarios. You can disable this behaviour like so:

# features/support/env.rb# ...Cucumber::Rails::Database.autorun_database_cleaner=false

By default, cucumber-rails will auto mix-in the helpers fromRack::Test into your default Cucumber World instance.You can prevent this behaviour like so:

# features/support/env.rbENV['CR_REMOVE_RACK_TEST_HELPERS']='true'

When upgrading from a previous version it is recommended that you rerun:

rails generate cucumber:install

Theonly way to have a bug fixed or a new feature accepted is to describe it with aCucumber 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.gitgit checkout -b bugfix/generator-fails-on-bundle-exec

Start by making sure you can run the existing features. Now, create a feature that demonstrateswhat's wrong. See the existing features for examples. When you have a failing feature thatreproduces the bug, commit, push and send a pull request. Someone from the Cucumber-Rails teamwill review it and hopefully create a fix.

If you know how to fix the bug yourself, make a second commit (after committing the failingfeature) before you send the pull request.

Make sure you have a supported ruby installed, cd into yourcucumber-rails repository and run

gem install bundlerbundle installbin/install_geckodriver.shbin/install_webpacker.sh

With all dependencies installed, all specs and features should pass:

[bundle exec] rake

In order to test against multiple versions of key dependencies, theAppraisalgem is used to generate multiple gemfiles, stored in thegemfiles/ directory.Normally these will only run on GitHub via GitHub Actions; however if you want to run the full testsuite 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_8_0 rake test

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 tothe helper method that modifies theGemfile

For example, rspec is a primary development dependency, so it lives in the gemspec.