cucumber-rails 1.6.0 → 2.2.0

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
@@ -24,15 +25,15 @@ Feature: Rerun profile
       """
     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
+      Given('broken') do
         raise "I'm broken"
       end
 
-      Given /passing/ do
+      Given('passing') do
         puts "I've always been passing"
       end
       """

data/features/rest_api.feature

@@ -1,8 +1,8 @@
 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
@@ -12,7 +12,7 @@ Feature: REST API
       """
     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 the feature run should pass with:
-       """
-       1 scenario (1 passed)
-       2 steps (2 passed)
-       """
+      """
+      1 scenario (1 passed)
+      2 steps (2 passed)
+      """

data/features/step_definitions/cucumber_rails_steps.rb

@@ -1,137 +1,80 @@
-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'
-
-    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
-    end
-
-    gem 'geckodriver-helper', group: :test
-    gem 'rspec-rails', group: :test
-    gem 'database_cleaner', group: :test unless options.include?(:no_database_cleaner)
-    gem 'factory_bot', group: :test unless options.include?(:no_factory_bot)
-    # 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
+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 and installed cucumber\-rails$/ do
+Given('I have created a new Rails app and installed cucumber-rails with database_cleaner-active_record') do
   rails_new
-  install_cucumber_rails
-  create_web_steps
-  prepare_aruba_report
+  install_cucumber_rails :no_database_cleaner, :database_cleaner_active_record
 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_bot
+Given('I have created a new Rails app and installed cucumber-rails without database_cleaner') do
+  rails_new
+  install_cucumber_rails :no_database_cleaner
   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'
+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 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 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
+Given('I force selenium to run Firefox in headless mode') do
   selenium_config = %{
     Capybara.register_driver :selenium do |app|
-      browser_options = ::Selenium::WebDriver::Firefox::Options.new()
+      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)
+      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'
   step 'the output should contain:', string
 end
-
-Given("I remove the {string} gem from the Gemfile") do |gem_name|
-  run 'pwd'
-  app_path = last_command_started.output.strip
-  gemfile_path = File.join(app_path, 'Gemfile')
-
-  content = File.open(gemfile_path, 'r').readlines
-  new_content = []
-
-  content.each do |line|
-    next if line =~ /gem ["|']#{gem_name}["|'].*/
-    
-    new_content << line
-  end
-
-  overwrite_file(gemfile_path, new_content.join("\r\n"))
-end

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,86 @@
+# 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 'database_cleaner-active_record', '>= 2.0.0.beta2', group: :test if options.include?(:database_cleaner_active_record)
+    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,40 +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
-
-        # include
-        children = children.select do |child|
-          File.directory?(child) ||
-          (@aruba_report_start && File.stat(child).mtime > @aruba_report_start)
-        end
+# frozen_string_literal: true
 
-        # exclude
-        children = children.reject do |child|
-          child =~ /Gemfile/ ||
-          child =~ /\.log$/
-        end
+$LOAD_PATH.unshift("#{File.dirname(__FILE__)}/../../lib")
 
-        children
-      end
-    end
-  end
-end
-
-After do |scenario|
-  if scenario.failed?
-    puts last_command_stopped.stdout
-    puts last_command_stopped.stderr
-  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_5_0.gemfile

@@ -2,17 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.0.0"
-gem "railties", "~> 5.0.0"
-gem "capybara", "~> 2.7.1"
-gem "selenium-webdriver", "~> 3.9.0"
-gem "geckodriver-helper", "~> 0.0.5"
-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"
+gem "cucumber", "< 4"
+gem "rails", "~> 5.0.7"
+gem "sqlite3", "~> 1.3.13"
 
 gemspec path: "../"

data/gemfiles/rails_5_1.gemfile

@@ -2,16 +2,9 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.1.0"
-gem "railties", "~> 5.1.0"
-gem "capybara", "~> 2.7.1"
-gem "selenium-webdriver", "~> 3.9.0"
-gem "geckodriver-helper", "~> 0.0.5"
-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.15"
+gem "cucumber", "< 5"
+gem "rails", "~> 5.1.7"
 gem "sqlite3", "~> 1.3.13"
-gem "database_cleaner", ">= 1.1.0"
 
 gemspec path: "../"

data/gemfiles/rails_5_2.gemfile

@@ -2,16 +2,8 @@
 
 source "https://rubygems.org"
 
-gem "rails", "~> 5.2"
-gem "railties", "~> 5.2"
-gem "capybara", "~> 3.0"
-gem "selenium-webdriver", "~> 3.11"
-gem "geckodriver-helper", "~> 0.0.5"
-gem "rspec-rails", "~> 3.7"
-gem "sass-rails", "~> 5.0"
-gem "coffee-rails", "~> 4.2"
-gem "uglifier", "~> 4.1"
+gem "capybara", "< 3.33"
+gem "rails", "~> 5.2.4"
 gem "sqlite3", "~> 1.3.13"
-gem "database_cleaner", ">= 1.6.2"
 
 gemspec path: "../"