cucumber-rails 1.5.0 → 2.1.0

data/features/step_definitions/cucumber_rails_steps.rb

@@ -1,111 +1,67 @@
-module CucumberRailsHelper
-  def rails_new(options = {})
-    options[:name] ||= 'test_app'
-    command = run "bundle exec rails new #{options[:name]} --skip-bundle --skip-test-unit --skip-spring #{options[:args]}"
-    expect(command).to have_output /README/
-    expect(last_command_started).to be_successfully_executed
-    cd options[:name]
-    delete_environment_variable 'RUBYOPT'
-    delete_environment_variable 'BUNDLE_BIN_PATH'
-    delete_environment_variable 'BUNDLE_GEMFILE'
-    # Force older version of nokogiri on older Rubies
-    gem 'nokogiri', '~> 1.6.8' if RUBY_VERSION < '2.1.0'
-    run_simple 'bundle install'
-  end
-
-  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
-    # From Rails 5.1 some gems are already part of the Gemfile
-    if Gem.loaded_specs['rails'].version < Gem::Version.new('5.1.0')
-      gem 'capybara', group: :test
-      gem 'selenium-webdriver', group: :test
-    else
-      # Make sure to restrict the selected selenium-webdriver version
-      # Since version 3 geckodriver is required to be installed
-      gemfile_text = File.read(expand_path('Gemfile'))
-      gemfile_text.gsub!("gem 'selenium-webdriver'", "gem 'selenium-webdriver', '~> 2.0'")
-      overwrite_file('Gemfile', gemfile_text)
-    end
-    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)
-    # Newer versions of rake remove a method used by RSpec older versions
-    # See https://stackoverflow.com/questions/35893584/nomethoderror-undefined-method-last-comment-after-upgrading-to-rake-11#35893625
-    if Gem::Version.new(RSpec::Support::Version::STRING) < Gem::Version.new('3.4.4')
-      gem 'rake', '< 11.0'
-      run_simple 'bundle update rake --local'
-    end
-    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)
+# frozen_string_literal: true
 
-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
+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
+  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 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')
+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
 
-When /^I run the cukes$/ do
-  run_simple('bundle exec cucumber')
+When('I run the cukes') do
+  run_command_and_stop('bundle exec cucumber')
 end
 
 # Copied from Aruba
-Then /^the feature run should pass with:$/ do |string|
+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'

data/features/support/aruba.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Aruba.configure do |config|
-  config.exit_timeout = 120
+  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,32 +1,6 @@
-$:.unshift(File.dirname(__FILE__) + '/../../lib')
-require 'rubygems'
-require 'bundler/setup'
-require 'rspec/expectations'
-require 'aruba/cucumber'
-
-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
+# frozen_string_literal: true
 
-        # include
-        children = children.select do |child|
-          File.directory?(child) ||
-          (@aruba_report_start && File.stat(child).mtime > @aruba_report_start)
-        end
+$LOAD_PATH.unshift(File.dirname(__FILE__) + '/../../lib')
 
-        # exclude
-        children = children.reject do |child|
-          child =~ /Gemfile/ ||
-          child =~ /\.log$/
-        end
-
-        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

@@ -2,17 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 4.2.1"
-gem "railties", "~> 4.2.1"
-gem "capybara", "~> 2.4.4"
-gem "selenium-webdriver", "~> 2.0"
-gem "rspec-rails", "~> 3.1.0"
-gem "sass-rails", "~> 5.0"
-gem "coffee-rails", "~> 4.1.0"
-gem "jquery-rails"
-gem "uglifier", "~> 2.1.0"
-gem "sqlite3", "~> 1.3.7"
-gem "database_cleaner", "~> 1.0.1"
-gem "rake", "< 11.0"
+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 => "../"
+gemspec path: "../"

data/gemfiles/rails_5_0.gemfile

@@ -2,16 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0.0"
-gem "railties", "~> 5.0.0"
-gem "capybara", "~> 2.7.1"
-gem "selenium-webdriver", "~> 2.0"
-gem "rspec-rails", "~> 3.5.0"
-gem "sass-rails", "~> 5.0"
-gem "coffee-rails", "~> 4.2.0"
-gem "jquery-rails"
-gem "uglifier", "~> 2.7.2"
-gem "sqlite3", "~> 1.3.7"
-gem "database_cleaner", ">= 1.1.0"
+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 => "../"
+gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -2,14 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.1.0"
-gem "railties", "~> 5.1.0"
-gem "selenium-webdriver", "~> 2.0"
-gem "rspec-rails", "~> 3.5.0"
-gem "sass-rails", "~> 5.0"
-gem "coffee-rails", "~> 4.2.0"
-gem "uglifier", "~> 3.2.0"
+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"
-gem "database_cleaner", ">= 1.1.0"
 
-gemspec :path => "../"
+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.rb

@@ -1,21 +1,22 @@
-env_caller = File.dirname(caller.detect{ |f| f =~ /\/env\.rb:/ }) if caller.detect{ |f| f =~ /\/env\.rb:/ }
-if env_caller
+# frozen_string_literal: true
+
+called_from_env_rb = caller.detect { |f| f =~ /\/env\.rb:/ }
+
+if called_from_env_rb
+  env_caller = File.dirname(called_from_env_rb)
+
   require 'rails'
   require 'cucumber/rails/application'
   ENV['RAILS_ENV'] ||= 'test'
   ENV['RAILS_ROOT'] ||= File.expand_path(env_caller + '/../..')
   require File.expand_path(ENV['RAILS_ROOT'] + '/config/environment')
-  require 'cucumber/rails/action_controller'
-
-  if defined?(ActiveRecord::Base)
-    require 'rails/test_help'
-  else
-    require 'action_dispatch/testing/test_process'
-    require 'action_dispatch/testing/integration'
-  end
+  require 'cucumber/rails/action_dispatch'
+  require 'rails/test_help'
 
-  unless Rails.application.config.cache_classes
-    warn "WARNING: You have set Rails' config.cache_classes to false (most likely in config/environments/cucumber.rb).  This setting is known to cause problems with database transactions. Set config.cache_classes to true if you want to use transactions."
+  unless Rails.application.config.cache_classes || defined?(Spring)
+    warn "WARNING: You have set Rails' config.cache_classes to false
+    (Spring needs cache_classes set to false). This is known to cause problems
+    with database transactions. Set config.cache_classes to true if you want to use transactions."
   end
 
   require 'cucumber/rails/world'
@@ -25,7 +26,8 @@ if env_caller
 
   MultiTest.disable_autorun
 else
-  warn "WARNING: Cucumber-rails required outside of env.rb.  The rest of loading is being deferred until env.rb is called.
-  To avoid this warning, move 'gem \'cucumber-rails\', :require => false' under only group :test in your Gemfile.
-  If already in the :test group, be sure you are specifying ':require => false'."
+  warn "WARNING: Cucumber-rails required outside of env.rb.  The rest of loading is being deferred
+  until env.rb is called. To avoid this warning, move 'gem \'cucumber-rails\', require: false'
+  under only group :test in your Gemfile. If already in the :test group, be sure you are
+  specifying 'require: false'."
 end

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)