cucumber-rails 1.4.0 → 2.1.0

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

@@ -1,19 +1,21 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Rails
     module Capybara
       # This module defines methods for selecting dates and times
       module SelectDatesAndTimes
-        # Select a Rails date. Options has must include :from => +label+
+        # Select a Rails date. Options hash must include from: +label+
         def select_date(date, options)
           date        = Date.parse(date)
           base_dom_id = get_base_dom_id_from_label_tag(options[:from])
 
           find(:xpath, ".//select[@id='#{base_dom_id}_1i']").select(date.year.to_s)
-          find(:xpath, ".//select[@id='#{base_dom_id}_2i']").select(I18n.l date, :format => '%B')
+          find(:xpath, ".//select[@id='#{base_dom_id}_2i']").select(I18n.l(date, format: '%B'))
           find(:xpath, ".//select[@id='#{base_dom_id}_3i']").select(date.day.to_s)
         end
-      
-        # Select a Rails time. Options has must include :from => +label+
+
+        # Select a Rails time. Options hash must include from: +label+
         def select_time(time, options)
           time        = Time.zone.parse(time)
           base_dom_id = get_base_dom_id_from_label_tag(options[:from])
@@ -21,8 +23,8 @@ module Cucumber
           find(:xpath, ".//select[@id='#{base_dom_id}_4i']").select(time.hour.to_s.rjust(2, '0'))
           find(:xpath, ".//select[@id='#{base_dom_id}_5i']").select(time.min.to_s.rjust(2,  '0'))
         end
-      
-        # Select a Rails datetime. Options has must include :from => +label+
+
+        # Select a Rails datetime. Options hash must include from: +label+
         def select_datetime(datetime, options)
           select_date(datetime, options)
           select_time(datetime, options)

data/lib/cucumber/rails/capybara.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'capybara'
 require 'capybara/rails'
 require 'capybara/cucumber'

data/lib/cucumber/rails/database.rb

@@ -1,13 +1,13 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Rails
     module Database
+      CUSTOM_STRATEGY_INTERFACE = %w[before_js before_non_js].freeze
 
-      CUSTOM_STRATEGY_INTERFACE = %w{ before_js before_non_js }
-
-      class InvalidStrategy < ArgumentError;end
+      class InvalidStrategy < ArgumentError; end
 
       class << self
-
         attr_accessor :autorun_database_cleaner
 
         def javascript_strategy=(args)
@@ -15,12 +15,12 @@ module Cucumber
           strategy_type =
             case strategy
             when Symbol
-              map[strategy] || raise(InvalidStrategy, "The strategy '#{strategy}' is not understood. Please use one of #{map.keys.join(',')}")
+              map[strategy] || throw_invalid_strategy_error(strategy)
             when Class
               strategy
             end
 
-          @strategy =  strategy_type.new(*strategy_opts)
+          @strategy = strategy_type.new(*strategy_opts)
 
           validate_interface!
         end
@@ -37,32 +37,50 @@ module Cucumber
           @strategy.after
         end
 
-      private
+        private
 
         def map
           {
-            :truncation => TruncationStrategy,
-            :shared_connection => SharedConnectionStrategy,
-            :transaction => SharedConnectionStrategy,
-            :deletion => DeletionStrategy
+            truncation: TruncationStrategy,
+            shared_connection: SharedConnectionStrategy,
+            transaction: SharedConnectionStrategy,
+            deletion: DeletionStrategy
           }
         end
 
+        def throw_invalid_strategy_error(strategy)
+          raise(InvalidStrategy, "The strategy '#{strategy}' is not understood. Please use one of #{mapped_keys}")
+        end
+
+        def mapped_keys
+          map.keys.join(', ')
+        end
+
         def validate_interface!
-          unless CUSTOM_STRATEGY_INTERFACE.all? {|m| @strategy.respond_to?(m) }
-            raise(ArgumentError, "Strategy must respond to all of: #{CUSTOM_STRATEGY_INTERFACE.map{|method| "##{method}" } * '  '} !")
-          end
+          return if CUSTOM_STRATEGY_INTERFACE.all? { |m| @strategy.respond_to?(m) }
+
+          throw_invalid_strategy_interface_error
         end
 
+        def throw_invalid_strategy_interface_error
+          raise(
+            ArgumentError,
+            "Strategy must respond to all of: #{CUSTOM_STRATEGY_INTERFACE.map { |method| "##{method}" } * '  '} !"
+          )
+        end
       end
 
       class Strategy
-        def initialize(options={})
-          @options=options
+        def initialize(options = {})
+          @options = options
         end
 
         def before_js(strategy)
-          @original_strategy = DatabaseCleaner.connections.first.strategy # that feels like a nasty hack
+          @original_strategy = if Gem::Version.new(DatabaseCleaner::VERSION) >= Gem::Version.new('1.8.0.beta')
+                                 DatabaseCleaner.cleaners.values.first.strategy # that feels like a nasty hack
+                               else
+                                 DatabaseCleaner.connections.first.strategy # that feels like a nasty hack
+                               end
           DatabaseCleaner.strategy = strategy, @options
         end
 
@@ -72,6 +90,7 @@ module Cucumber
 
         def after
           return unless @original_strategy
+
           DatabaseCleaner.strategy = @original_strategy
           @original_strategy = nil
         end

data/lib/cucumber/rails/hooks/active_record.rb

@@ -1,21 +1,23 @@
-if defined?(ActiveRecord::Base)
-  class ActiveRecord::Base
+# frozen_string_literal: true
+
+module ActiveRecord
+  class Base
     class_attribute :shared_connection
 
     def self.connection
-      self.shared_connection || retrieve_connection
+      shared_connection || retrieve_connection
     end
   end
+end
 
-  Before('@javascript') do
-    Cucumber::Rails::Database.before_js
-  end
+Before('@javascript') do
+  Cucumber::Rails::Database.before_js if Cucumber::Rails::Database.autorun_database_cleaner
+end
 
-  Before('~@javascript') do
-    Cucumber::Rails::Database.before_non_js
-  end
+Before('not @javascript') do
+  Cucumber::Rails::Database.before_non_js if Cucumber::Rails::Database.autorun_database_cleaner
+end
 
-  After do
-    Cucumber::Rails::Database.after
-  end
+After do
+  Cucumber::Rails::Database.after if Cucumber::Rails::Database.autorun_database_cleaner
 end

data/lib/cucumber/rails/hooks/allow_rescue.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 Before('@allow-rescue') do
   @__orig_allow_rescue = ActionController::Base.allow_rescue
   ActionController::Base.allow_rescue = true

data/lib/cucumber/rails/hooks/database_cleaner.rb

@@ -1,13 +1,15 @@
+# frozen_string_literal: true
+
 begin
   require 'database_cleaner'
 
-  Before('~@no-database-cleaner') do
+  Before('not @no-database-cleaner') do
     DatabaseCleaner.start if Cucumber::Rails::Database.autorun_database_cleaner
   end
 
-  After('~@no-database-cleaner') do
+  After('not @no-database-cleaner') do
     DatabaseCleaner.clean if Cucumber::Rails::Database.autorun_database_cleaner
   end
-
-rescue LoadError => ignore_if_database_cleaner_not_present
+rescue LoadError
+  Cucumber.logger.debug('database_cleaner gem not present.')
 end

data/lib/cucumber/rails/hooks/mail.rb

@@ -1,5 +1,5 @@
-if defined?(ActionMailer::Base)
-  Before do
-    ActionMailer::Base.deliveries = []
-  end
+# frozen_string_literal: true
+
+Before do
+  ActionMailer::Base.deliveries = []
 end

data/lib/cucumber/rails/hooks.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'cucumber/rails/hooks/active_record'
 require 'cucumber/rails/hooks/database_cleaner'
 require 'cucumber/rails/hooks/allow_rescue'

data/lib/cucumber/rails/rspec.rb

@@ -1,18 +1,20 @@
+# frozen_string_literal: true
+
 require 'cucumber/rails/world'
 
 begin
   require 'rspec/rails/matchers'
 
-  [Cucumber::Rails::World, ActionController::Integration::Session].each do |klass|
+  [Cucumber::Rails::World, ActionDispatch::Integration::Session].each do |klass|
     klass.class_eval do
       include RSpec::Matchers
     end
   end
-rescue LoadError => try_rspec_1
+rescue LoadError
   require 'spec/expectations'
   require 'spec/rails'
 
-  [Cucumber::Rails::World, ActionController::Integration::Session].each do |klass|
+  [Cucumber::Rails::World, ActionDispatch::Integration::Session].each do |klass|
     klass.class_eval do
       include Spec::Matchers
       include Spec::Rails::Matchers if defined?(Spec::Rails::Matchers)

data/lib/cucumber/rails/world.rb

@@ -1,21 +1,38 @@
+# frozen_string_literal: true
+
 begin
   # Try to load it so we can assign @_result below if needed.
   require 'test/unit/testresult'
-rescue LoadError => ignore
+rescue LoadError
+  Cucumber.logger.debug('Minitest not found.')
+end
+
+module Cucumber
+  module Rails
+    class << self
+      def include_rack_test_helpers?
+        # Using ActiveModel Boolean casting here will give false positives more often than not!
+        !ENV['CR_REMOVE_RACK_TEST_HELPERS']&.casecmp('true')&.zero?
+      end
+    end
+  end
 end
 
-module Cucumber #:nodoc:
-  module Rails #:nodoc:
-    class World < ActionDispatch::IntegrationTest #:nodoc:
-      include Rack::Test::Methods
-      include ActiveSupport::Testing::SetupAndTeardown if ActiveSupport::Testing.const_defined?("SetupAndTeardown")
+module Cucumber
+  module Rails
+    class World < ::ActionDispatch::IntegrationTest
+      include Rack::Test::Methods if Cucumber::Rails.include_rack_test_helpers?
+      include ActiveSupport::Testing::SetupAndTeardown if ActiveSupport::Testing.const_defined?('SetupAndTeardown')
 
-      def initialize #:nodoc:
+      def initialize
         @_result = Test::Unit::TestResult.new if defined?(Test::Unit::TestResult)
       end
 
-      if !defined?(ActiveRecord::Base)
-        def self.fixture_table_names; []; end # Workaround for projects that don't use ActiveRecord
+      unless defined?(ActiveRecord::Base)
+        # Workaround for projects that don't use ActiveRecord
+        def self.fixture_table_names
+          []
+        end
       end
     end
   end

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
+  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_dispatch'
+  require 'rails/test_help'
 
-  if !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.  For more information see https://rspec.lighthouseapp.com/projects/16211/tickets/165."
+  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'
@@ -23,8 +24,10 @@ if env_caller
   require 'cucumber/rails/capybara'
   require 'cucumber/rails/database'
 
+  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/generators/cucumber/{install/USAGE → USAGE}

@@ -1,9 +1,9 @@
 Description:
     Sets up Cucumber in your Rails project. After running this generator you will
     get a new rake task called cucumber.
-    
+
     This also generates the necessary files in the features directory.
-    
+
 Examples:
     `rails generate cucumber:install`
 

data/lib/generators/cucumber/{install/install_generator.rb → install_generator.rb}

@@ -1,13 +1,22 @@
+# frozen_string_literal: true
+
 require 'rbconfig'
 
 module Cucumber
   class InstallGenerator < ::Rails::Generators::Base
-    source_root File.expand_path("../templates", __FILE__)
+    source_root File.expand_path('templates', __dir__)
 
     DEFAULT_SHEBANG = File.join(RbConfig::CONFIG['bindir'], RbConfig::CONFIG['ruby_install_name'])
 
-    class_option :spork,         :type => :boolean, :desc => "Use Spork"
-    class_option :skip_database, :type => :boolean, :desc => "Skip modification of database.yml", :aliases => '-D', :default => false
+    class_option :spork,
+                 type: :boolean,
+                 desc: 'Use Spork'
+
+    class_option :skip_database,
+                 type: :boolean,
+                 desc: 'Skip modification of database.yml',
+                 aliases: '-D',
+                 default: false
 
     def create_templates
       template 'config/cucumber.yml.erb', 'config/cucumber.yml'
@@ -20,6 +29,7 @@ module Cucumber
 
     def create_step_definitions
       empty_directory 'features/step_definitions'
+      create_file 'features/step_definitions/.gitkeep'
     end
 
     def create_feature_support
@@ -38,13 +48,13 @@ module Cucumber
 
     def create_database
       return unless File.exist?('config/database.yml')
-      unless File.read('config/database.yml').include? 'cucumber:'
-        gsub_file 'config/database.yml', /^test:.*\n/, "test: &test\n"
-        gsub_file 'config/database.yml', /\z/, "\ncucumber:\n  <<: *test"
-        
-        # Since gsub_file doesn't ask the user, just inform user that the file was overwritten.
-        puts "       force  config/database.yml"
-      end
+      return unless File.read('config/database.yml').include? 'cucumber:'
+
+      gsub_file 'config/database.yml', /^test:.*\n/, "test: &test\n"
+      gsub_file 'config/database.yml', /\z/, "\ncucumber:\n  <<: *test\n"
+
+      # Since gsub_file doesn't ask the user, just inform user that the file was overwritten.
+      puts '       force  config/database.yml'
     end
 
     protected
@@ -53,14 +63,17 @@ module Cucumber
       options[:spork]
     end
 
-    def embed_file(source, indent='')
+    def embed_file(source, indent = '')
       IO.read(File.join(self.class.source_root, source)).gsub(/^/, indent)
     end
 
-    def embed_template(source, indent='')
+    def embed_template(source, indent = '')
       template = File.join(self.class.source_root, source)
-      ERB.new(IO.read(template), nil, '-').result(binding).gsub(/^/, indent)
+      if RUBY_VERSION >= '2.6'
+        ERB.new(IO.read(template), trim_mode: '-').result(binding).gsub(/^/, indent)
+      else
+        ERB.new(IO.read(template), nil, '-').result(binding).gsub(/^/, indent)
+      end
     end
-
   end
-end
+end

data/lib/generators/cucumber/{install/templates → templates}/config/cucumber.yml.erb

@@ -1,8 +1,9 @@
 <%%
 rerun = File.file?('rerun.txt') ? IO.read('rerun.txt') : ""
-rerun_opts = rerun.to_s.strip.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
-std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags ~@wip"
+rerun = rerun.strip.gsub /\s/, ' '
+rerun_opts = rerun.empty? ? "--format #{ENV['CUCUMBER_FORMAT'] || 'progress'} features" : "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} #{rerun}"
+std_opts = "--format #{ENV['CUCUMBER_FORMAT'] || 'pretty'} --strict --tags 'not @wip'"
 %>
 default: <%= spork? ? '--drb ' : '' %><%%= std_opts %> features
 wip: <%= spork? ? '--drb ' : '' %>--tags @wip:3 --wip features
-rerun: <%= spork? ? '--drb ' : '' %><%%= rerun_opts %> --format rerun --out rerun.txt --strict --tags ~@wip
+rerun: <%= spork? ? '--drb ' : '' %><%%= rerun_opts %> --format rerun --out rerun.txt --strict --tags 'not @wip'

data/lib/generators/cucumber/{install/templates → templates}/script/cucumber

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 vendored_cucumber_bin = Dir["#{File.dirname(__FILE__)}/../vendor/{gems,plugins}/cucumber*/bin/cucumber"].first
 if vendored_cucumber_bin

data/lib/generators/cucumber/{install/templates → templates}/support/_rails_each_run.rb.erb

@@ -1,6 +1,6 @@
 # By default, any exception happening in your Rails application will bubble up
-# to Cucumber so that your scenario will fail. This is a different from how 
-# your application behaves in the production environment, where an error page will 
+# to Cucumber so that your scenario will fail. This is a different from how
+# your application behaves in the production environment, where an error page will
 # be rendered instead.
 #
 # Sometimes we want to override this default behaviour and allow Rails to rescue
@@ -27,13 +27,13 @@ end
 # See the DatabaseCleaner documentation for details. Example:
 #
 #   Before('@no-txn,@selenium,@culerity,@celerity,@javascript') do
-#     # { :except => [:widgets] } may not do what you expect here
+#     # { except: [:widgets] } may not do what you expect here
 #     # as Cucumber::Rails::Database.javascript_strategy overrides
 #     # this setting.
 #     DatabaseCleaner.strategy = :truncation
 #   end
 #
-#   Before('~@no-txn', '~@selenium', '~@culerity', '~@celerity', '~@javascript') do
+#   Before('not @no-txn', 'not @selenium', 'not @culerity', 'not @celerity', 'not @javascript') do
 #     DatabaseCleaner.strategy = :transaction
 #   end
 #

data/lib/generators/cucumber/{install/templates → templates}/support/capybara.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # Capybara defaults to CSS3 selectors rather than XPath.
 # If you'd prefer to use XPath, just uncomment this line and adjust any
 # selectors in your step definitions to use the XPath syntax.

data/lib/generators/cucumber/{install/templates → templates}/support/rails_spork.rb.erb

@@ -1,13 +1,13 @@
 <%= embed_file('support/edit_warning.txt') %>
 require 'rubygems'
 require 'spork'
- 
+
 Spork.prefork do
 <%= embed_template('support/_rails_prefork.rb.erb', '  ') %>
 
 <%= embed_file("support/capybara.rb", '  ') %>
 end
- 
+
 Spork.each_run do
 <%= embed_template('support/_rails_each_run.rb.erb', '  ') %>
 end

data/lib/generators/cucumber/{install/templates → templates}/tasks/cucumber.rake.erb

@@ -9,39 +9,48 @@ begin
   require 'cucumber/rake/task'
 
   namespace :cucumber do
-    Cucumber::Rake::Task.new({:ok => 'test:prepare'}, 'Run features that should pass') do |t|
+    Cucumber::Rake::Task.new({ok: 'test:prepare'}, 'Run features that should pass') do |t|
       t.binary = vendored_cucumber_bin # If nil, the gem's binary is used.
       t.fork = true # You may get faster startup if you set this to false
       t.profile = 'default'
     end
 
-    Cucumber::Rake::Task.new({:wip => 'test:prepare'}, 'Run features that are being worked on') do |t|
+    Cucumber::Rake::Task.new({wip: 'test:prepare'}, 'Run features that are being worked on') do |t|
       t.binary = vendored_cucumber_bin
       t.fork = true # You may get faster startup if you set this to false
       t.profile = 'wip'
     end
 
-    Cucumber::Rake::Task.new({:rerun => 'test:prepare'}, 'Record failing features and run only them if any exist') do |t|
+    Cucumber::Rake::Task.new({rerun: 'test:prepare'}, 'Record failing features and run only them if any exist') do |t|
       t.binary = vendored_cucumber_bin
       t.fork = true # You may get faster startup if you set this to false
       t.profile = 'rerun'
     end
 
     desc 'Run all features'
-    task :all => [:ok, :wip]
+    task all: [:ok, :wip]
 
     task :statsetup do
       require 'rails/code_statistics'
       ::STATS_DIRECTORIES << %w(Cucumber\ features features) if File.exist?('features')
       ::CodeStatistics::TEST_TYPES << "Cucumber features" if File.exist?('features')
     end
+
+    task :annotations_setup do
+      Rails.application.configure do
+        if config.respond_to?(:annotations)
+          config.annotations.directories << 'features'
+          config.annotations.register_extensions('feature') { |tag| /#\s*(#{tag}):?\s*(.*)$/ }
+        end
+      end
+    end
   end
   desc 'Alias for cucumber:ok'
-  task :cucumber => 'cucumber:ok'
+  task cucumber: 'cucumber:ok'
 
-  task :default => :cucumber
+  task default: :cucumber
 
-  task :features => :cucumber do
+  task features: :cucumber do
     STDERR.puts "*** The 'features' task is deprecated. See rake -T cucumber ***"
   end
 
@@ -49,7 +58,9 @@ begin
   task 'test:prepare' do
   end
 
-  task :stats => 'cucumber:statsetup'
+  task stats: 'cucumber:statsetup'
+
+  task notes: 'cucumber:annotations_setup'
 rescue LoadError
   desc 'cucumber rake task not available (cucumber not installed)'
   task :cucumber do