cucumber-rails 1.4.0 → 2.1.0

data/features/raising_errors.feature

@@ -1,16 +1,22 @@
 Feature: Raise Errors
 
   Scenario: Raise error for undefined route
-    Given I have created a new Rails app "test-app" with no database and installed cucumber-rails
-    And I write to "features/tests.feature" with:
+    Given I have created a new Rails app with no database and installed cucumber-rails
+    When I write to "features/home.feature" with:
       """
       Feature: Tests
         Scenario: Tests
-          When I go to the products page
+          When I go to the home page
+      """
+    And I write to "features/home_steps.rb" with:
+      """
+      When('I go to the home page') do
+        visit('/')
+      end
       """
     And I run `bundle exec cucumber`
     Then it should fail with:
       """
       1 scenario (1 failed)
       1 step (1 failed)
-      """
+      """

data/features/rerun_profile.feature

@@ -1,4 +1,5 @@
 Feature: Rerun profile
+
   In order to concentrate on failing features
   As a Rails developer working with Cucumber
   I want to rerun only failing features
@@ -8,6 +9,7 @@ Feature: Rerun profile
     And a file named "rerun.txt" with:
       """
       features/rerun_test.feature:2
+      features/rerun_test.feature:5
       """
     And a file named "features/rerun_test.feature" with:
       """
@@ -15,23 +17,31 @@ Feature: Rerun profile
         Scenario: failing before
           Given fixed now
 
+        Scenario: still failing
+          Given broken
+
         Scenario: always passing
           Given passing
       """
     And a file named "features/step_definitions/rerun_steps.rb" with:
       """
-      Given /fixed now/ do
-        puts "All fixed now"
+      Given('fixed now') do
+        puts 'All fixed now'
+      end
+
+      Given('broken') do
+        raise "I'm broken"
       end
 
-      Given /passing/ do
+      Given('passing') do
         puts "I've always been passing"
       end
       """
-    When I successfully run `bundle exec cucumber -p rerun`
-    Then it should pass with:
+    When I run `bundle exec cucumber -p rerun`
+    Then it should fail with:
       """
-      1 scenario (1 passed)
-      1 step (1 passed)
+      2 scenarios (1 failed, 1 passed)
+      2 steps (1 failed, 1 passed)
       """
-    And the file "rerun.txt" should not contain "features/rerun_test.feature:2"    
+    And the file "rerun.txt" should not contain "features/rerun_test.feature:2"
+    And the file "rerun.txt" should contain "features/rerun_test.feature:5"

data/features/rest_api.feature

@@ -1,18 +1,18 @@
 Feature: REST API
 
   Scenario: Compare JSON
-    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
-          render :json => {'hello' => 'world'}.to_json
+          render json: {'hello' => 'world'}.to_json
         end
       end
       """
     And I write to "config/routes.rb" with:
       """
-      Rails3App::Application.routes.draw do
+      TestApp::Application.routes.draw do
         resources :posts
       end
       """
@@ -28,20 +28,20 @@ Feature: REST API
             }
             \"\"\"
       """
-    And I write to "features/step_definitions/rest_steps.rb" with:
+    And I write to "features/step_definitions/post_steps.rb" with:
       """
-      When /^the client requests GET (.*)$/ do |path|
+      When('the client requests GET /{word}') do |path|
         get(path)
       end
 
-      Then /^the response should be JSON:$/ do |json|
-        JSON.parse(last_response.body).should == JSON.parse(json)
+      Then('the response should be JSON:') do |json|
+        expect(JSON.parse(last_response.body)).to eq(JSON.parse(json))
       end
       """
     And I run `bundle exec rake db:migrate`
     And I run `bundle exec rake cucumber`
-    Then it should pass with:
-       """
-       1 scenario (1 passed)
-       2 steps (2 passed)
-       """
+    Then the feature run should pass with:
+      """
+      1 scenario (1 passed)
+      2 steps (2 passed)
+      """

data/features/step_definitions/cucumber_rails_steps.rb

@@ -1,83 +1,69 @@
-module CucumberRailsHelper
-  def rails_new(options={})
-    options[:name] ||= 'test_app'
-    run_simple "bundle exec rails new #{options[:name]} --skip-test-unit #{options[:args]}"
-    assert_passing_with('README')
-    cd options[:name]
-  end
+# frozen_string_literal: true
 
-  def install_cucumber_rails(*options)
-    if options.include?(:not_in_test_group)
-      gem "cucumber-rails", :path => "#{File.expand_path('.')}"
-    else
-      gem "cucumber-rails", :group => :test, :require => false, :path => "#{File.expand_path('.')}"
-    end
-    gem "capybara", :group => :test
-    gem "rspec-rails", :group => :test
-    gem "database_cleaner", :group => :test unless options.include?(:no_database_cleaner)
-    gem 'factory_girl', :group => :test unless options.include?(:no_factory_girl)
-    gem "selenium-webdriver", :group => :test
-    run_simple "bundle exec rails generate cucumber:install"
-  end
-  
-  def gem(name, options)
-    line = %{gem "#{name}", #{options.inspect}\n}
-    append_to_file('Gemfile', line)
-  end
-  
-  def prepare_aruba_report
-    if(ENV['ARUBA_REPORT_DIR'])
-      @aruba_report_start = Time.new
-      sleep(1)
-    end
-  end
-  
-  def fixture(path)
-    File.expand_path(File.dirname(__FILE__) + "./../support/fixtures/#{path}")
-  end
-end
-World(CucumberRailsHelper)
-
-Given /^I have created a new Rails app and installed cucumber\-rails, accidentally outside of the test group in my Gemfile$/ do
+Given('I have created a new Rails app and installed cucumber-rails, accidentally outside of the test group in my Gemfile') do
   rails_new
   install_cucumber_rails :not_in_test_group
-  create_web_steps
-  prepare_aruba_report
-end
-
-Given /^I have created a new Rails app "([^"]*)" and installed cucumber\-rails$/ do |app_name|
-  rails_new :name => app_name
-  install_cucumber_rails
-  create_web_steps
-  prepare_aruba_report
 end
 
-Given /^I have created a new Rails app and installed cucumber\-rails$/ do
+Given('I have created a new Rails app and installed cucumber-rails') do
   rails_new
   install_cucumber_rails
-  create_web_steps
-  prepare_aruba_report
 end
 
-Given /^I have created a new Rails app with no database and installed cucumber-rails$/ do
-  rails_new :args => '--skip-active-record'
-  install_cucumber_rails :no_database_cleaner, :no_factory_girl
+Given('I have created a new Rails app with no database and installed cucumber-rails') do
+  rails_new args: '--skip-active-record'
+  install_cucumber_rails :no_database_cleaner, :no_factory_bot
   overwrite_file('features/support/env.rb', "require 'cucumber/rails'\n")
-  create_web_steps
 end
 
-Given /^I have created a new Rails app "(.*?)" with no database and installed cucumber\-rails$/ do |app_name|
-  rails_new :name => app_name, :args => '--skip-active-record'
-  install_cucumber_rails :no_database_cleaner, :no_factory_girl
-  overwrite_file('features/support/env.rb', "require 'cucumber/rails'\n")
-  create_web_steps
+Given('I have a {string} ActiveRecord model object') do |name|
+  run_command_and_stop("bundle exec rails g model #{name}")
+  run_command_and_stop('bundle exec rake db:migrate RAILS_ENV=test')
+end
+
+Given('I remove the {string} gem from the Gemfile') do |gem_name|
+  content = File.open(expand_path('Gemfile'), 'r').readlines
+  new_content = []
+
+  content.each do |line|
+    next if /gem ["|']#{gem_name}["|'].*/.match?(line)
+
+    new_content << line
+  end
+
+  overwrite_file('Gemfile', new_content.join("\r\n"))
+end
+
+Given('I force selenium to run Firefox in headless mode') do
+  selenium_config = %{
+    Capybara.register_driver :selenium do |app|
+      http_client = Selenium::WebDriver::Remote::Http::Default.new
+      http_client.read_timeout = 180
+
+      browser_options = Selenium::WebDriver::Firefox::Options.new
+      browser_options.args << '--headless'
+      Capybara::Selenium::Driver.new(
+        app,
+        browser: :firefox,
+        options: browser_options,
+        http_client: http_client
+      )
+    end
+
+    Capybara.server = :webrick
+  }
+
+  step 'I append to "features/support/env.rb" with:', selenium_config
 end
 
-Given /^I have a "([^"]*)" ActiveRecord model object$/ do |name|
-  run_simple("bundle exec rails g model #{name}")
-  run_simple("bundle exec rake db:migrate RAILS_ENV=test")
+When('I run the cukes') do
+  run_command_and_stop('bundle exec cucumber')
 end
 
-When /^I run the cukes$/ do
-  run_simple('bundle exec cucumber')
+# Copied from Aruba
+Then('the feature run should pass with:') do |string|
+  step 'the output should not contain " failed)"'
+  step 'the output should not contain " undefined)"'
+  step 'the exit status should be 0'
+  step 'the output should contain:', string
 end

data/features/support/aruba.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Aruba.configure do |config|
+  config.exit_timeout = 360
+end

data/features/support/cucumber_rails_helper.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+module CucumberRailsHelper
+  def rails_new(options = {})
+    validate_rails_new_success(run_rails_new_command(options))
+    clear_bundle_env_vars(options[:name])
+  end
+
+  def install_cucumber_rails(*options)
+    add_conditional_gems(options)
+
+    add_gem 'capybara', group: :test
+    add_gem 'selenium-webdriver', '~> 3.11', group: :test
+    add_gem 'rspec-expectations', '~> 3.7', group: :test
+    add_gem 'database_cleaner', '>= 1.8.0', group: :test unless options.include?(:no_database_cleaner)
+    add_gem 'factory_bot', '>= 3.2', group: :test unless options.include?(:no_factory_bot)
+
+    run_command_and_stop 'bundle install'
+    run_command_and_stop 'bundle exec rails webpacker:install' if rails6?
+    run_command_and_stop 'bundle exec rails generate cucumber:install'
+  end
+
+  def add_gem(name, *args)
+    line = convert_gem_opts_to_string(name, *args)
+    gem_regexp = /gem ["']#{name}["'].*$/
+    gemfile_content = File.read(expand_path('Gemfile'))
+
+    if gemfile_content&.match?(gem_regexp)
+      updated_gemfile_content = gemfile_content.gsub(gem_regexp, line)
+      overwrite_file('Gemfile', updated_gemfile_content)
+    else
+      append_to_file('Gemfile', line)
+    end
+  end
+
+  private
+
+  def run_rails_new_command(options)
+    options[:name] ||= 'test_app'
+    flags = '--skip-bundle --skip-test-unit --skip-spring --skip-bootsnap'
+    flags += ' --skip-webpack-install' if rails6?
+    run_command "bundle exec rails new #{options[:name]} #{flags} #{options[:args]}"
+  end
+
+  def validate_rails_new_success(result)
+    expect(result).to have_output(/README/)
+    expect(last_command_started).to be_successfully_executed
+  end
+
+  def clear_bundle_env_vars(dir)
+    cd dir
+    delete_environment_variable 'RUBYOPT'
+    delete_environment_variable 'BUNDLE_BIN_PATH'
+    delete_environment_variable 'BUNDLE_GEMFILE'
+  end
+
+  def rails6?
+    `bundle exec rails -v`.start_with?('Rails 6')
+  end
+
+  def add_conditional_gems(options)
+    if options.include?(:not_in_test_group)
+      add_gem 'cucumber-rails', path: File.expand_path('.').to_s
+    else
+      add_gem 'cucumber-rails', group: :test, require: false, path: File.expand_path('.').to_s
+    end
+
+    if rails6?
+      add_gem 'sqlite3', '~> 1.4'
+    else
+      add_gem 'sqlite3', '~> 1.3.13'
+    end
+  end
+
+  def convert_gem_opts_to_string(name, *args)
+    options = args.last.is_a?(Hash) ? args.pop : {}
+    parts = ["'#{name}'"]
+    parts << args.map(&:inspect) if args.any?
+    parts << options.inspect[1..-2] if options.any?
+    new_parts = parts.flatten.map { |part| part.gsub(/:(\w+)=>/, '\1: ') }
+    "gem #{new_parts.join(', ')}\n"
+  end
+end
+
+World(CucumberRailsHelper)

data/features/support/env.rb

@@ -1,37 +1,6 @@
-$:.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'rubygems'
-require 'bundler/setup'
-require 'rspec/expectations'
-require 'aruba/cucumber'
-
-Before do
-  @aruba_timeout_seconds = 120 # A long time needed some times
-  unset_bundler_env_vars
-end
+# frozen_string_literal: true
 
-if(ENV['ARUBA_REPORT_DIR'])
-  # Override reporting behaviour so we don't document all files, only the ones
-  # that have been created after @aruba_report_start (a Time object). This is
-  # given a value after the Rails app is generated (see cucumber_rails_steps.rb)
-  module Aruba
-    module Reporting
-      def children(dir)
-        children = Dir["#{dir}/*"].sort
-        
-        # include
-        children = children.select do |child|
-          File.directory?(child) || 
-          (@aruba_report_start && File.stat(child).mtime > @aruba_report_start)
-        end
-        
-        # exclude
-        children = children.reject do |child|
-          child =~ /Gemfile/ || 
-          child =~ /\.log$/
-        end
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 
-        children
-      end
-    end
-  end
-end
+require 'rspec/expectations'
+require 'aruba/cucumber'

data/features/support/hooks.rb

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+After do |scenario|
+  if scenario.failed?
+    puts last_command_stopped.stdout
+    puts last_command_stopped.stderr
+  end
+end

data/gemfiles/rails_4_2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "capybara", "< 3.16.0", platform: :mri_23
+gem "nokogiri", "< 1.9.1", platform: :mri_23
+gem "railties", "~> 4.2.11"
+gem "sqlite3", "~> 1.3.13"
+
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "capybara", "< 3.16.0", platform: :mri_23
+gem "nokogiri", "< 1.9.1", platform: :mri_23
+gem "railties", "~> 5.0.7"
+gem "sqlite3", "~> 1.3.13"
+
+gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "capybara", "< 3.16.0", platform: :mri_23
+gem "nokogiri", "< 1.9.1", platform: :mri_23
+gem "railties", "~> 5.1.7"
+gem "sqlite3", "~> 1.3.13"
+
+gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -0,0 +1,10 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "capybara", "< 3.16.0", platform: :mri_23
+gem "nokogiri", "< 1.9.1", platform: :mri_23
+gem "railties", "~> 5.2.0"
+gem "sqlite3", "~> 1.3.13"
+
+gemspec path: "../"

data/gemfiles/rails_6_0.gemfile

@@ -0,0 +1,9 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "railties", "~> 6.0.0"
+gem "rails", "~> 6.0.0"
+gem "sqlite3", "~> 1.4"
+
+gemspec path: "../"

data/lib/cucumber/rails/action_dispatch.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+ActionController::Base.class_eval do
+  cattr_accessor :allow_rescue
+end
+
+module Cucumber
+  module Rails
+    module ActionDispatch
+      module ShowExceptions
+        def call(env)
+          env['action_dispatch.show_detailed_exceptions'] = !ActionController::Base.allow_rescue
+          env['action_dispatch.show_exceptions'] = !env['action_dispatch.show_detailed_exceptions']
+          super(env)
+        end
+      end
+    end
+  end
+end
+
+ActionDispatch::ShowExceptions.prepend(Cucumber::Rails::ActionDispatch::ShowExceptions)

data/lib/cucumber/rails/application.rb

@@ -1,17 +1,26 @@
+# frozen_string_literal: true
+
 require 'rails/application'
 
 # Make sure the ActionDispatch::ShowExceptions middleware is always enabled,
 # regardless of what is in config/environments/test.rb
 # Instead we are overriding ActionDispatch::ShowExceptions to be able to
 # toggle whether or not exceptions are raised.
-class Rails::Application
-  alias __cucumber_orig_initialize__ initialize!
-  
-  def initialize!
-    ad = config.action_dispatch
-    def ad.show_exceptions
-      true
+
+module Cucumber
+  module Rails
+    module Application
+      def initialize!
+        ad = config.action_dispatch
+
+        def ad.show_exceptions
+          true
+        end
+
+        super
+      end
     end
-    __cucumber_orig_initialize__
   end
 end
+
+Rails::Application.prepend(Cucumber::Rails::Application)

data/lib/cucumber/rails/capybara/javascript_emulation.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Rails
     module Capybara
@@ -8,10 +10,12 @@ module Cucumber
             alias_method :click, :click_with_javascript_emulation
           end
         end
-  
-        def click_with_javascript_emulation
+
+        def click_with_javascript_emulation(*)
           if link_with_non_get_http_method?
-            ::Capybara::RackTest::Form.new(driver, js_form(element_node.document, self[:href], emulated_method)).submit(self)
+            ::Capybara::RackTest::Form.new(
+              driver, js_form(element_node.document, self[:href], emulated_method)
+            ).submit(self)
           else
             click_without_javascript_emulation
           end
@@ -44,61 +48,65 @@ module Cucumber
           js_form['action'] = action
           js_form['method'] = method
 
-          if emulated_method and emulated_method.downcase != method.downcase
-            input = document.create_element('input')
-            input['type'] = 'hidden'
-            input['name'] = '_method'
-            input['value'] = emulated_method
-            js_form.add_child(input)
-          end
+          add_hidden_method_input(document, js_form) unless same?(emulated_method, method)
+
+          # rails will wipe the session if the CSRF token is not sent with non-GET requests
+          add_hidden_csrf_input(document, js_form) if csrf? && !get?(emulated_method)
 
-          # rails will wipe the session if the CSRF token is not sent
-          # with non-GET requests
-          if csrf? && emulated_method.downcase != "get"
-            input = document.create_element('input')
-            input['type'] = 'hidden'
-            input['name'] = csrf_param
-            input['value'] = csrf_token
-            js_form.add_child(input)
-          end
-        
           js_form
         end
 
+        def same?(emulated_method, method)
+          emulated_method.casecmp(method).zero?
+        end
+
+        def add_hidden_method_input(document, js_form)
+          input = document.create_element('input')
+          input['type'] = 'hidden'
+          input['name'] = '_method'
+          input['value'] = emulated_method
+          js_form.add_child(input)
+        end
+
+        def get?(emulated_method)
+          same?(emulated_method, 'get')
+        end
+
+        def add_hidden_csrf_input(document, js_form)
+          input = document.create_element('input')
+          input['type'] = 'hidden'
+          input['name'] = csrf_param
+          input['value'] = csrf_token
+          js_form.add_child(input)
+        end
+
         def link_with_non_get_http_method?
-          if ::Rails.version.to_f >= 3.0
-            tag_name == 'a' && element_node['data-method'] && element_node['data-method'] =~ /(?:delete|put|post)/
-          else
-            tag_name == 'a' && element_node['onclick'] && element_node['onclick'] =~ /var f = document\.createElement\('form'\); f\.style\.display = 'none';/
-          end
+          tag_name == 'a' &&
+            element_node['data-method'] &&
+            element_node['data-method'] =~ /(?:delete|put|post)/
         end
 
         def emulated_method
-          if ::Rails.version.to_f >= 3.0
-            element_node['data-method']
-          else
-            element_node['onclick'][/m\.setAttribute\('value', '([^']*)'\)/, 1]
-          end
+          element_node['data-method']
         end
 
         def element_node
-          if self.respond_to? :native
-            self.native
-          else
-            warn "DEPRECATED: cucumber-rails loves you, just not your version of Capybara. Please update Capybara to >= 0.4.0"
-            self.node
-          end
+          native
         end
       end
     end
   end
 end
 
-class Capybara::RackTest::Node
-  include ::Cucumber::Rails::Capybara::JavascriptEmulation
+module Capybara
+  module RackTest
+    class Node
+      include ::Cucumber::Rails::Capybara::JavascriptEmulation
+    end
+  end
 end
 
-Before('~@no-js-emulation') do
+Before('not @no-js-emulation') do
   # Enable javascript emulation
   ::Capybara::RackTest::Node.class_eval do
     alias_method :click, :click_with_javascript_emulation