cucumber-rails 1.6.0 → 2.2.0

data/CONTRIBUTING.md

@@ -13,29 +13,44 @@ We appreciate that. But before you do, please learn our basic rules:
 
 # Contributing to cucumber-rails
 
-This document is a guide for those maintaining cucumber-Rails, and others who would like to submit patches.
+This document is a guide for those maintaining Cucumber-Rails, and others who would like to submit patches.
 
 ## Note on Patches/Pull Requests
 
 * Fork the project. Make a branch for your change.
 * Make your feature addition or bug fix.
-* Make sure your patch is well covered by tests. We don't accept changes to cucumber-rails that aren't tested.
-* Please do not change the Rakefile, version, or history.
-  (if you want to have your own version, that is fine but
-  bump version in a commit by itself so we can ignore when we merge your change)
+* Make sure your patch is well covered by tests. We don't accept changes to `cucumber-rails` that aren't tested.
+* Please do not change the Rakefile, version, or CHANGELOG.
 * Send us a pull request.
 
 ## Running tests
 
     gem install bundler
     bundle install
-    bundle exec rake
+    bin/install_geckodriver.sh
+    bin/install_webpacker.sh
+    # Then to run tests on one version-specific Gemfile (e.g. gemfiles/rails_6_0.gemfile), run
+    bundle exec appraisal rails_6_0 rake test
+    # Or run tests across the full supported stack. Note that because we support many versions. This takes 5-10 minutes
+    bundle exec rake appraisal
+
+## Updating Appraisal gems / dependencies of cucumber-rails
+
+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:
+
+    [bundle exec] rake clean
+    
 ## Release Process
 
-* Make sure `History.md` is updated with the upcoming version number, and has entries for all fixes.
-* No need to add a `History.md` header at this point - this should be done when a new change is made, later.
-* Make sure you have up-to-date and clean copy of cucumber/cucumber.github.com.git at the same level as cucumber repo.
+* Make sure `CHANGELOG.md` is updated with the upcoming version number, and has entries for all fixes.
+* No need to add a new version header at this point - this should be done when a new release is made, later.
+* Make sure you have up-to-date and clean copy of `cucumber/cucumber.github.com.git` at the same level as cucumber repo.
 
 Now release it
 
@@ -44,29 +59,17 @@ Now release it
     git commit -m "Release X.Y.Z"
     rake release
 
-### NOTE:
-
-If after running the rake release task you get an error similar to this:
-
-    rake aborted!
-    Couldn't git push. `git push  2>&1' failed with the following output:
-
-    To git@github.com:cucumber/cucumber-rails.git
-    ! [rejected]        rails-2.3.x -> rails-2.3.x (non-fast-forward)
-    error: failed to push some refs to 'git@github.com:cucumber/cucumber-rails.git'
-
-make sure that you have pulled all the recent changes from both the master and the rails-2.3.x branch
-
 ## Gaining Release Karma
 
-To become a release manager, create a pull request adding your name to the list below, and include your Rubygems email address in the ticket. One of the existing Release managers will then add you.
+To become a release manager, create a pull request adding your name to the list below, including
+your Rubygems email address in the ticket. One of the existing Release managers will then add you.
 
 Current release managers:
   * Kosmas Chatzimichalis
   * Matt Wynne
   * Mathieu Jobin
+  * Andrew Walter
 
 To grant release karma, issue the following command:
 
     gem owner cucumber-rails --add <NEW OWNER RUBYGEMS EMAIL>
-

data/Gemfile

@@ -1,7 +1,5 @@
-source "https://rubygems.org"
+# frozen_string_literal: true
 
-# Test dependencies for Rails in the default test task, as test-generated
-# apps do not run bundler for speed reasons. Kept here so they can be
-# excluded from Appraisal-generated gemfiles.
+source 'https://rubygems.org'
 
 gemspec

data/LICENSE

@@ -1,6 +1,6 @@
 The MIT License
 
-Copyright (c) 2008,2009,2010,2011,2012,2013 Aslak Hellesøy and the Cucumber Team.
+Copyright (c) 2008-2020 Aslak Hellesøy and the Cucumber Team.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -3,20 +3,21 @@
 [![Gem Version](https://badge.fury.io/rb/cucumber-rails.svg)](http://badge.fury.io/rb/cucumber-rails)
 [![Build Status](https://secure.travis-ci.org/cucumber/cucumber-rails.svg?branch=master)](http://travis-ci.org/cucumber/cucumber-rails)
 [![Code Climate](https://codeclimate.com/github/cucumber/cucumber-rails.svg)](https://codeclimate.com/github/cucumber/cucumber-rails)
-[![Dependency Status](https://gemnasium.com/Kosmas/cucumber-rails.svg)](https://gemnasium.com/Kosmas/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.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).
+Cucumber-Rails brings Cucumber to Rails 5.x and 6.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
-      # database_cleaner is not required, but highly recommended
-      gem 'database_cleaner'
-    end
+```ruby
+group :test do
+  gem 'cucumber-rails', require: false
+  # database_cleaner is not required, but highly recommended
+  gem 'database_cleaner'
+end
+```
 
 Then install it by running:
 
@@ -42,11 +43,20 @@ 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:
 
-    # features/support/env.rb
-    # ...
-    Cucumber::Rails::Database.autorun_database_cleaner = false
+```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
 
@@ -56,21 +66,29 @@ 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 bug-install-generator
+    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
 
-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:
+Make sure you have a supported ruby installed, cd into your cucumber-rails repository and:
 
     gem install bundler
     bundle install
+    bin/install_geckodriver.sh
+    bin/install_webpacker.sh
 
 ### Running all tests
 
@@ -80,24 +98,17 @@ 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
 
 To run the suite against a named gemfile, use the following:
 
-    [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:
-
-    [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
-
-
+    [bundle exec] appraisal rails_6_0 rake test
 
 ### Adding dependencies
 
@@ -105,9 +116,12 @@ 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 Gemfile (for local test runs) and each appraisal section (if necessary).
+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.
 
-For example, rspec is a primary development dependency, so it lives in the gemspec. By contrast, coffee-rails is a dependency of apps generated with rails 3.1 and 3.2, so lives in the main Gemfile and the rails 3.1 and 3.2 appraisal sections.
+[the helper]: https://github.com/cucumber/cucumber-rails/blob/5e37c530560ae1c1a79521c38a54bae0be94242b/features/step_definitions/cucumber_rails_steps.rb#L15
 
 ### NOTE
 
@@ -115,7 +129,7 @@ If you get an error while trying to run the tests locally, similar to the one be
 
     Could not find a JavaScript runtime. See https://github.com/sstephenson/execjs for a list of available runtimes. (ExecJS::RuntimeUnavailable)
     
-you would need to install a javascript runtime.
+You need to install a javascript runtime.
 
 You can do that in ubuntu by using:
 

data/Rakefile

@@ -1,5 +1,7 @@
-# encoding: utf-8
-CUCUMBER_RAILS_VERSION = Gem::Specification.load(File.dirname(__FILE__) + '/cucumber-rails.gemspec').version.version
+# frozen_string_literal: true
+
+CUCUMBER_RAILS_VERSION =
+  Gem::Specification.load("#{File.dirname(__FILE__)}/cucumber-rails.gemspec").version.version
 require 'rubygems'
 require 'bundler'
 require 'bundler/setup'
@@ -9,41 +11,43 @@ require 'rake/clean'
 require 'pathname'
 Bundler::GemHelper.install_tasks
 
-$:.unshift(File.dirname(__FILE__) + '/lib')
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/lib")
 Dir["#{File.dirname(__FILE__)}/dev_tasks/*.rake"].sort.each { |ext| load ext }
 
 CLEAN.include('doc', 'tmp')
 
 task default: :test
 
-task test: [:spec, :cucumber]
+task test: %i[spec cucumber]
 
 namespace :test do
-  desc "Run tests against all gemfiles"
+  desc 'Run tests against all gemfiles'
   task :all do
     Rake::Task['appraisal'].invoke('test')
   end
 
-  desc "Run tests against specified gemfile, e.g. rake test:gemfile[rails_3_0]"
-  task :gemfile, :name do |task, args|
+  desc 'Run tests against specified gemfile, e.g. rake test:gemfile[rails_6_0]'
+  task :gemfile, :name do |_task, args|
     unless args.name && Pathname.new("gemfiles/#{args.name}.gemfile").exist?
-      raise ArgumentError "You must provide the name of an existing Appraisal gemfile, e.g. 'rake test:gemfile[rails_3_2]'"
+      raise ArgumentError, "You must provide the name of an existing Appraisal gemfile,
+        e.g. 'rake test:gemfile[rails_6_0]'"
     end
+
     Rake::Task["appraisal:#{args.name}"].invoke('test')
   end
 end
 
 namespace :gemfiles do
-  desc "Install dependencies for all gemfiles"
+  desc 'Install dependencies for all gemfiles'
   task :install do
-    ENV['BUNDLE_GEMFILE'] = "Gemfile.appraisal"
+    ENV['BUNDLE_GEMFILE'] = 'Gemfile.appraisal'
     Rake::Task['appraisal:install'].invoke
   end
 
   task :clean do
-    FileUtils.rm_rf("gemfiles/*")
+    FileUtils.rm_rf('gemfiles/*')
   end
 
-  desc "Rebuild generated gemfiles and install dependencies"
-  task rebuild: [:clean, :install]
+  desc 'Rebuild generated gemfiles and install dependencies'
+  task rebuild: %i[clean install]
 end

data/bin/install_geckodriver.sh

@@ -0,0 +1,19 @@
+#!/bin/bash
+
+set -xeuo pipefail
+
+curl --silent \
+     --show-error \
+     --location \
+     --fail \
+     --retry 3 \
+     --output /tmp/geckodriver_linux64.tar.gz \
+     https://github.com/mozilla/geckodriver/releases/download/v0.27.0/geckodriver-v0.27.0-linux64.tar.gz
+
+sudo tar -C /usr/local/bin -xvzf /tmp/geckodriver_linux64.tar.gz geckodriver
+
+rm /tmp/geckodriver_linux64.tar.gz
+
+geckodriver --version
+
+set +x

data/bin/install_webpacker.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+set -xeuo pipefail
+
+curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
+echo 'deb https://dl.yarnpkg.com/debian/ stable main' | sudo tee /etc/apt/sources.list.d/yarn.list
+sudo apt update && sudo apt install --yes yarn
+
+set +x

data/config/cucumber.yml

@@ -12,9 +12,6 @@ opts = [
   "--format rerun -o #{rerun_file}"
 ]
 rails_version = `bundle exec rails --version`.match(/[\d.]+$/).to_s
-if Gem::Version.new(rails_version) < Gem::Version.new('4.2')
-  opts << "--tags 'not @requires-rails-version-42'"
-end
 optlist = opts.join(' ')
 %>
 default: <%= path %> <%= optlist %> --tags 'not @broken'

data/cucumber-rails.gemspec

@@ -1,46 +1,53 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+require 'rake/file_list'
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'cucumber-rails'
-  s.version     = '1.6.0'
-  s.authors     = ["Aslak Hellesøy", "Dennis Blöte", "Rob Holland"]
-  s.description = "Cucumber Generator and Runtime for Rails"
+  s.version     = '2.2.0'
+  s.authors     = ['Aslak Hellesøy', 'Dennis Blöte', 'Rob Holland']
+  s.description = 'Cucumber Generator and Runtime for Rails'
   s.summary     = "#{s.name}-#{s.version}"
   s.email       = 'cukes@googlegroups.com'
-  s.homepage    = "http://cukes.info"
+  s.homepage    = 'https://cucumber.io'
 
   s.license = 'MIT'
 
-  s.add_runtime_dependency('capybara', ['>= 1.1.2', '< 4'])
-  s.add_runtime_dependency('cucumber', ['>= 3.0.2', '< 4'])
-  s.add_runtime_dependency('nokogiri', '~> 1.8')
-  s.add_runtime_dependency('railties', ['>= 4', '< 6'])
-  s.add_runtime_dependency('mime-types', ['>= 1.17', '< 4'])
+  s.metadata = {
+    'bug_tracker_uri' => 'https://github.com/cucumber/cucumber-rails/issues',
+    'changelog_uri' => "https://github.com/cucumber/cucumber-rails/blob/v#{s.version}/CHANGELOG.md",
+    'documentation_uri' => 'https://cucumber.io/docs',
+    'mailing_list_uri' => 'https://groups.google.com/forum/#!forum/cukes',
+    'source_code_uri' => "https://github.com/cucumber/cucumber-rails/tree/v#{s.version}"
+  }
+
+  s.add_runtime_dependency('capybara', ['>= 2.18', '< 4']) # We support legacy capybara (But only the last 2.x)
+  s.add_runtime_dependency('cucumber', ['>= 3.0.2', '< 6']) # Support cucumber in the 3.x / 4.x / 5.x revisions
+  s.add_runtime_dependency('mime-types', ['~> 3.2']) # Only support the latest major (3+ years old)
+  s.add_runtime_dependency('nokogiri', '~> 1.8') # Only support the latest major (3+ years old)
+  s.add_runtime_dependency('rails', ['>= 5.0', '< 7']) # We support any version of Rails in the 5.x and 6.x series
 
   # Main development dependencies
-  s.add_development_dependency('ammeter', ['>= 1.0.0', '!= 1.1.3'])
-  s.add_development_dependency('appraisal', '>= 0.5.1')
-  s.add_development_dependency('aruba', '~> 0.14.2')
-  s.add_development_dependency('builder', ['>= 3.1.0', '< 4'])
-  s.add_development_dependency('bundler', '>= 1.3.5')
-  s.add_development_dependency('selenium-webdriver', '>= 3.4.1')
-  s.add_development_dependency('database_cleaner', '>= 1.0.0')
-  s.add_development_dependency('factory_bot', '>= 3.2')
-  s.add_development_dependency('rake', '>= 0.9.2.2')
-  s.add_development_dependency('rspec', '~> 3.0')
-  s.add_development_dependency('rails')
-  s.add_development_dependency('sqlite3')
+  s.add_development_dependency('ammeter', '>= 1.1.4')
+  s.add_development_dependency('appraisal', '~> 2.2')
+  s.add_development_dependency('aruba', '~> 1.0')
+  s.add_development_dependency('bundler', '>= 1.17')
+  s.add_development_dependency('rake', '>= 12.0')
+  s.add_development_dependency('rspec', '~> 3.6')
+  s.add_development_dependency('rubocop', '~> 0.89.0')
+  s.add_development_dependency('rubocop-packaging', '~> 0.3.0')
+  s.add_development_dependency('rubocop-performance', '~> 1.7.1')
+  s.add_development_dependency('rubocop-rspec', '~> 1.42.0')
+  s.add_development_dependency('sqlite3', '~> 1.3')
 
   # For Documentation:
-  s.add_development_dependency('rdiscount', '>= 2.0.7')
-  s.add_development_dependency('rdoc', '>= 3.4')
-  s.add_development_dependency('yard', '>= 0.8.7')
-
-  s.required_ruby_version = '>= 2.2.0'
-  s.rubygems_version = ">= 1.6.1"
-  s.files            = `git ls-files`.split("\n")
-  s.test_files       = `git ls-files -- {spec,features}/*`.split("\n")
-  s.executables      = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_path     = "lib"
+  s.add_development_dependency('rdoc', '>= 6.0')
+  s.add_development_dependency('yard', '~> 0.9.10')
+
+  s.required_ruby_version = '>= 2.4.0'
+  s.rubygems_version = '>= 1.6.1'
+  s.files            = Rake::FileList['**/*'].exclude(*File.read('.gitignore').split)
+  s.test_files       = Dir['{spec,features}/**/*']
+  s.require_path     = 'lib'
 end

data/dev_tasks/cucumber.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/rake/task'
 
 Cucumber::Rake::Task.new

data/dev_tasks/rspec.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new