cucumber-rails 1.4.0 → 2.1.0

data/README.md

@@ -1,18 +1,23 @@
 # Cucumber-Rails
 
-[![Build Status](https://secure.travis-ci.org/cucumber/cucumber-rails.png?branch=master)](http://travis-ci.org/cucumber/cucumber-rails)
+[![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)
+[![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 3.x and 4.x. 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 4.2, 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:
 
@@ -35,15 +40,24 @@ With Rake:
 Without Rake:
 
     [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'
+```
 
-    # features/support/env.rb
-    # ...
-    Cucumber::Rails::Database.autorun_database_cleaner = false
-    
 ## Upgrading from a previous version
 
 When upgrading from a previous version it is recommended that you rerun:
@@ -52,44 +66,59 @@ 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
 
-I strongly recommend rvm and ruby 1.9.3. 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
 
 With all dependencies installed, all specs and features should pass:
 
-    rake
-
-One of the features uses MongoDB, which needs to be running in order to make features/mongoid.feature to pass.
+    [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:
 
-    rake gemfiles:install
-    rake test:all
+    [bundle exec] appraisal install
+    [bundle exec] appraisal rake test
 
 To run the suite against a named gemfile, use the following:
 
-    rake test:gemfile[rails_3_0]
+    [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:
+
+    [bundle exec] appraisal update
 
-To remove and rebuild the different gemfiles (for example, to update a rails version or its dependencies), use the following:
+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:
 
-    rake gemfiles:rebuild
+    [bundle exec] rake clean
 
 ### Adding dependencies
 
@@ -97,6 +126,21 @@ 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.
+
+[the helper]: https://github.com/cucumber/cucumber-rails/blob/5e37c530560ae1c1a79521c38a54bae0be94242b/features/step_definitions/cucumber_rails_steps.rb#L15
+
+### NOTE
+
+If you get an error while trying to run the tests locally, similar to the one below:
+
+    Could not find a JavaScript runtime. See https://github.com/sstephenson/execjs for a list of available runtimes. (ExecJS::RuntimeUnavailable)
+    
+You need to install a javascript runtime.
+
+You can do that in ubuntu by using:
 
-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.
+    sudo apt-get install nodejs

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 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_3_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_4_2]'"
     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.24.0/geckodriver-v0.24.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

@@ -5,11 +5,13 @@ path = if failing_scenarios.empty?
   'features'
 else
   puts "Running failed scenarios"
-  failing_scenarios
+  failing_scenarios.gsub /\s/, ' '
 end
 opts = [
   "--format #{path == 'features' ? 'progress' : 'pretty'}",
   "--format rerun -o #{rerun_file}"
-].join(' ')
+]
+rails_version = `bundle exec rails --version`.match(/[\d.]+$/).to_s
+optlist = opts.join(' ')
 %>
-default: <%= path %> <%= opts %> --tags ~@broken
+default: <%= path %> <%= optlist %> --tags 'not @broken'

data/cucumber-rails.gemspec

@@ -1,39 +1,51 @@
-# -*- encoding: utf-8 -*-
-$LOAD_PATH.unshift File.expand_path("../lib", __FILE__)
+# frozen_string_literal: true
+
+$LOAD_PATH.unshift File.expand_path('lib', __dir__)
 
 Gem::Specification.new do |s|
   s.name        = 'cucumber-rails'
-  s.version     = '1.4.0'
-  s.authors     = ["Aslak Hellesøy", "Dennis Blöte", "Rob Holland"]
-  s.description = "Cucumber Generator and Runtime for Rails"
+  s.version     = '2.1.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.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('cucumber', '>= 1.2.0')
-  s.add_runtime_dependency('nokogiri', '>= 1.5.0')
-  s.add_runtime_dependency('capybara', '>= 1.1.2')
-  s.add_runtime_dependency('rails', '>= 3.0.0')
+  s.add_runtime_dependency('capybara', ['>= 2.12', '< 4'])
+  s.add_runtime_dependency('cucumber', ['>= 3.0.2', '< 5'])
+  s.add_runtime_dependency('mime-types', ['>= 2.0', '< 4'])
+  s.add_runtime_dependency('nokogiri', '~> 1.8')
+  s.add_runtime_dependency('rails', ['>= 4.2', '< 7'])
 
   # Main development dependencies
-  s.add_development_dependency('rake', '>= 0.9.2.2')
-  s.add_development_dependency('bundler', '~> 1.3.5')
-  s.add_development_dependency('aruba', '>= 0.4.11')
-  s.add_development_dependency('rspec', '>= 2.2')
-  s.add_development_dependency('ammeter', '>= 0.2.9')
-  s.add_development_dependency('factory_girl', '>= 3.2.0')
-  s.add_development_dependency('database_cleaner', '>= 0.7.2')
-  s.add_development_dependency('appraisal', '~> 0.5.1')
+  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.85.0')
+  s.add_development_dependency('rubocop-performance', '~> 1.6.1')
+  s.add_development_dependency('rubocop-rspec', '~> 1.39.0')
+  s.add_development_dependency('sqlite3', '~> 1.3')
 
   # For Documentation:
-  s.add_development_dependency('yard', '~> 0.8.5.2')
-  s.add_development_dependency('rdoc', '~> 3.12.2')
-  s.add_development_dependency('rdiscount', '~> 2.0.7')
-  s.add_development_dependency('bcat', '~> 0.6.2')
+  s.add_development_dependency('rdoc', '>= 6.0')
+  s.add_development_dependency('yard', '~> 0.9.10')
 
-  s.rubygems_version = ">= 1.6.1"
+  s.required_ruby_version = '>= 2.4.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.require_path     = 'lib'
 end

data/dev_tasks/cucumber.rake

@@ -1,5 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/rake/task'
 
-Cucumber::Rake::Task.new do |t|
-  t.rcov = false
-end
+Cucumber::Rake::Task.new

data/dev_tasks/rspec.rake

@@ -1,8 +1,5 @@
+# frozen_string_literal: true
+
 require 'rspec/core/rake_task'
 
-desc "Run RSpec"
-RSpec::Core::RakeTask.new do |t|
-  t.rcov = ENV['RCOV']
-  t.rcov_opts = %w{--exclude osx\/objc,gems\/,spec\/}
-  t.verbose = true
-end
+RSpec::Core::RakeTask.new

data/dev_tasks/yard/default/layout/html/footer.erb

@@ -1,5 +1,5 @@
 <div id="footer">
-  Generated on <%= Time.now.strftime("%c") %> by 
+  Generated on <%= Time.now.strftime("%c") %> by
   <a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
   <%= YARD::VERSION %> (ruby-<%= RUBY_VERSION %>).
 </div>

data/dev_tasks/yard/default/layout/html/layout.erb

@@ -8,18 +8,18 @@
     <script type="text/javascript" charset="utf-8">
       if (window.top.frames.main) document.body.className = 'frames';
     </script>
-    
+
     <div id="header">
       <%= erb(:logo) %>
       <%= erb(:breadcrumb) %>
       <%= erb(:search) %>
       <div class="clear"></div>
     </div>
-    
+
     <iframe id="search_frame"></iframe>
-    
+
     <div id="content"><%= yieldall %></div>
-    
+
     <%= erb(:footer) %>
   </body>
-</html>
+</html>

data/dev_tasks/yard/default/layout/html/logo.erb

@@ -1 +1 @@
-<h3><img src="<%= url_for('images/bubble_32x32.png') %>"></img> Cucumber-Rails <%= CUCUMBER_RAILS_VERSION %></h3>
+<h3><img src="<%= url_for('images/bubble_32x32.png') %>"></img> Cucumber-Rails <%= CUCUMBER_RAILS_VERSION %></h3>

data/dev_tasks/yard/default/layout/html/setup.rb

@@ -1,4 +1,9 @@
+# frozen_string_literal: true
+
 def init
   super
-  options[:serializer].serialize('/images/bubble_32x32.png', IO.read(File.dirname(__FILE__) + '/bubble_32x32.png'))
+  options[:serializer].serialize(
+    '/images/bubble_32x32.png',
+    IO.read(File.dirname(__FILE__) + '/bubble_32x32.png')
+  )
 end

data/dev_tasks/yard.rake

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'yard'
 require 'yard/rake/yardoc_task'
 
@@ -6,9 +8,8 @@ API_DIR = File.join(SITE_DIR, 'api', 'cucumber-rails', 'ruby', 'yardoc')
 
 namespace :api do
   file :dir do
-    unless File.directory?(SITE_DIR)
-      raise "You need to git clone git@github.com:cucumber/cucumber.github.com.git #{SITE_DIR}"
-    end
+    raise "You need to git clone git@github.com:cucumber/cucumber.github.com.git #{SITE_DIR}" unless File.directory?(SITE_DIR)
+
     sh('git pull origin master')
     mkdir_p API_DIR
   end
@@ -18,18 +19,10 @@ namespace :api do
   YARD::Rake::YardocTask.new(:yard) do |yard|
     dir = API_DIR
     mkdir_p dir
-    yard.options = ["--out", dir]
-  end
-  task :yard => :dir
-
-  task :release do
-    Dir.chdir(SITE_DIR) do
-      sh('git add .')
-      sh("git commit -m 'Update API docs for cucumber-rails v#{cucumber-rails::VERSION}'")
-      sh('git push origin master')
-    end
+    yard.options = ['--out', dir]
   end
+  task yard: :dir
 
   desc "Generate YARD docs for Cucumber-Rails' API"
-  task :doc => [:yard, :release]
+  task doc: :yard
 end

data/features/allow_rescue.feature

@@ -1,54 +1,59 @@
 Feature: Allow Cucumber to rescue exceptions
 
   Background: A controller that raises an exception
-    Given I have created a new Rails app "rails-3-app" and installed cucumber-rails
-    And I write to "app/controllers/posts_controller.rb" with:
+    Given I have created a new Rails app and installed cucumber-rails
+    When I write to "app/controllers/posts_controller.rb" with:
       """
       class PostsController < ApplicationController
         def index
-          raise "There is an error in index"
+          raise 'There is an error in index'
         end
       end
       """
     And I write to "config/routes.rb" with:
       """
-      Rails3App::Application.routes.draw do
+      TestApp::Application.routes.draw do
         resources :posts
       end
       """
 
   Scenario: Allow rescue
-    Given I write to "features/posts.feature" with:
+    When I write to "features/posts.feature" with:
       """
-      Feature: posts
+      Feature: Posts
         @allow-rescue
         Scenario: See posts
           When I look at the posts
+          Then I should see the public error page
       """
     And I write to "features/step_definitions/posts_steps.rb" with:
       """
-      When /^I look at the posts$/ do
+      When('I look at the posts') do
         visit '/posts'
       end
+
+      Then('I should see the public error page') do
+        expect(page).to have_content "We're sorry, but something went wrong."
+      end
       """
     And I run `bundle exec rake db:migrate`
     And I run `bundle exec cucumber`
-    Then it should pass with:
+    Then the feature run should pass with:
       """
       1 scenario (1 passed)
-      1 step (1 passed)
+      2 steps (2 passed)
       """
 
   Scenario: Don't allow rescue
-    Given I write to "features/posts.feature" with:
+    When I write to "features/posts.feature" with:
       """
-      Feature: posts
+      Feature: Posts
         Scenario: See them
           When I look at the posts
       """
     And I write to "features/step_definitions/posts_steps.rb" with:
       """
-      When /^I look at the posts$/ do
+      When('I look at the posts') do
         visit '/posts'
       end
       """

data/features/annotations.feature

@@ -0,0 +1,20 @@
+Feature: Annotations
+
+  In order to track my development progress
+  As a developer
+  I should be able to list annotations in my features
+
+  Scenario: See annotations in feature file
+    Given I have created a new Rails app with no database and installed cucumber-rails
+    When I write to "features/products.feature" with:
+      """
+      Feature: Products
+        Scenario: Test a Product
+          # TODO: When I go to the products page
+      """
+    When I run `bundle exec rake notes`
+    Then it should pass with:
+      """
+      features/products.feature:
+        * [3] [TODO] When I go to the products page
+      """