Skip to content

Commit

Permalink
Merge pull request #442 from cucumber/refactor/rails_ver_tidy
Browse files Browse the repository at this point in the history
Rails Version Tidy
  • Loading branch information
luke-hill authored Sep 3, 2019
2 parents 03ea1d8 + 8130201 commit faaf217
Show file tree
Hide file tree
Showing 5 changed files with 30 additions and 17 deletions.
8 changes: 4 additions & 4 deletions Appraisals
Original file line number Diff line number Diff line change
Expand Up @@ -17,19 +17,19 @@ end
appraise 'rails_5_1' do
gem 'capybara', '< 3.16.0', platform: :mri_23
gem 'nokogiri', '< 1.9.1', platform: :mri_23
gem 'railties', '~> 5.1.0'
gem 'railties', '~> 5.1.7'
gem 'sqlite3', '~> 1.3.13'
end

appraise 'rails_5_2' do
gem 'capybara', '< 3.16.0', platform: :mri_23
gem 'nokogiri', '< 1.9.1', platform: :mri_23
gem 'railties', '~> 5.2.3'
gem 'railties', '~> 5.2.0'
gem 'sqlite3', '~> 1.3.13'
end

appraise 'rails_6_0' do
gem 'railties', '~> 6.0.0.rc2'
gem 'rails', '~> 6.0.0.rc2'
gem 'railties', '~> 6.0.0'
gem 'rails', '~> 6.0.0'
gem 'sqlite3', '~> 1.4'
end
31 changes: 22 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
[![Code Climate](https://codeclimate.com/github/cucumber/cucumber-rails.svg)](https://codeclimate.com/github/cucumber/cucumber-rails)
[![Open Source Helpers](https://www.codetriage.com/cucumber/cucumber-rails/badges/users.svg)](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

Expand Down Expand Up @@ -43,7 +43,8 @@ Without Rake:

## 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
Expand All @@ -59,14 +60,20 @@ When upgrading from a previous version it is recommended that you rerun:

## 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

Expand All @@ -85,7 +92,10 @@ With all dependencies installed, all specs and features should pass:

### 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
Expand All @@ -94,11 +104,13 @@ 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

Expand All @@ -108,7 +120,8 @@ To support the multiple-gemfile testing, when adding a new dependency the follow

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.

Expand Down
2 changes: 1 addition & 1 deletion gemfiles/rails_5_1.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ source "https://rubygems.org"

gem "capybara", "< 3.16.0", platform: :mri_23
gem "nokogiri", "< 1.9.1", platform: :mri_23
gem "railties", "~> 5.1.0"
gem "railties", "~> 5.1.7"
gem "sqlite3", "~> 1.3.13"

gemspec path: "../"
2 changes: 1 addition & 1 deletion gemfiles/rails_5_2.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ source "https://rubygems.org"

gem "capybara", "< 3.16.0", platform: :mri_23
gem "nokogiri", "< 1.9.1", platform: :mri_23
gem "railties", "~> 5.2.3"
gem "railties", "~> 5.2.0"
gem "sqlite3", "~> 1.3.13"

gemspec path: "../"
4 changes: 2 additions & 2 deletions gemfiles/rails_6_0.gemfile
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

source "https://rubygems.org"

gem "railties", "~> 6.0.0.rc2"
gem "rails", "~> 6.0.0.rc2"
gem "railties", "~> 6.0.0"
gem "rails", "~> 6.0.0"
gem "sqlite3", "~> 1.4"

gemspec path: "../"

0 comments on commit faaf217

Please sign in to comment.