cucumber-rails 1.6.0 → 2.2.0

data/gemfiles/rails_6_0.gemfile

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

data/lib/cucumber/rails.rb

@@ -1,31 +1,37 @@
-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.include? '/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_ROOT'] ||= File.expand_path("#{env_caller}/../..")
+  require File.expand_path("#{ENV['RAILS_ROOT']}/config/environment")
+  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'
   require 'cucumber/rails/hooks'
   require 'cucumber/rails/capybara'
+  require 'cucumber/rails/database/strategy'
+  require 'cucumber/rails/database/deletion_strategy'
+  require 'cucumber/rails/database/shared_connection_strategy'
+  require 'cucumber/rails/database/truncation_strategy'
   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/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.rb

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

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Rails
     module Capybara
@@ -11,7 +13,9 @@ module Cucumber
 
         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,58 +48,62 @@ 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
-          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
+          # 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)
 
           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('not @no-js-emulation') do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Rails
     module Capybara
@@ -9,7 +11,7 @@ module Cucumber
           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
 

data/lib/cucumber/rails/database.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 module Cucumber
   module Rails
     module Database
-      CUSTOM_STRATEGY_INTERFACE = %w{ before_js before_non_js }
+      CUSTOM_STRATEGY_INTERFACE = %w[before_js before_non_js].freeze
 
       class InvalidStrategy < ArgumentError; end
 
@@ -13,16 +15,21 @@ 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
 
+        def default_strategy!
+          self.javascript_strategy = :truncation
+          self.autorun_database_cleaner = true
+        end
+
         def before_js
           @strategy.before_js
         end
@@ -35,7 +42,7 @@ module Cucumber
           @strategy.after
         end
 
-      private
+        private
 
         def map
           {
@@ -46,68 +53,29 @@ module Cucumber
           }
         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
-        end
-      end
-
-      class Strategy
-        def initialize(options = {})
-          @options = options
-        end
-
-        def before_js(strategy)
-          @original_strategy = DatabaseCleaner.connections.first.strategy # that feels like a nasty hack
-          DatabaseCleaner.strategy = strategy, @options
-        end
-
-        def before_non_js
-          # no-op
-        end
-
-        def after
-          return unless @original_strategy
-          DatabaseCleaner.strategy = @original_strategy
-          @original_strategy = nil
+        def throw_invalid_strategy_error(strategy)
+          raise(InvalidStrategy, "The strategy '#{strategy}' is not understood. Please use one of #{mapped_keys}")
         end
-      end
 
-      class TruncationStrategy < Strategy
-        def before_js
-          super :truncation
+        def mapped_keys
+          map.keys.join(', ')
         end
-      end
 
-      class DeletionStrategy < Strategy
-        def before_js
-          super :deletion
-        end
-      end
+        def validate_interface!
+          return if CUSTOM_STRATEGY_INTERFACE.all? { |m| @strategy.respond_to?(m) }
 
-      class SharedConnectionStrategy < Strategy
-        def before_js
-          # Forces all threads to share a connection on a per-model basis,
-          # as connections may vary per model as per establish_connection. This works
-          # on Capybara because it starts the web server in a thread.
-          ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection
-          ActiveRecord::Base.descendants.each do |model|
-            model.shared_connection = model.connection
-          end
+          throw_invalid_strategy_interface_error
         end
 
-        def before_non_js
-          # Do not use a shared connection unless we're in a @javascript scenario
-          ActiveRecord::Base.shared_connection = nil
-          ActiveRecord::Base.descendants.each do |model|
-            model.shared_connection = nil
-          end
+        def throw_invalid_strategy_interface_error
+          raise(
+            ArgumentError,
+            "Strategy must respond to all of: #{CUSTOM_STRATEGY_INTERFACE.map { |method| "##{method}" } * '  '} !"
+          )
         end
       end
 
-      Database.javascript_strategy = :truncation
-      Database.autorun_database_cleaner = true
+      default_strategy!
     end
   end
 end

data/lib/cucumber/rails/database/deletion_strategy.rb

@@ -0,0 +1,11 @@
+module Cucumber
+  module Rails
+    module Database
+      class DeletionStrategy < Strategy
+        def before_js
+          super :deletion
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/rails/database/shared_connection_strategy.rb

@@ -0,0 +1,25 @@
+module Cucumber
+  module Rails
+    module Database
+      class SharedConnectionStrategy < Strategy
+        def before_js
+          # Forces all threads to share a connection on a per-model basis,
+          # as connections may vary per model as per establish_connection. This works
+          # on Capybara because it starts the web server in a thread.
+          ActiveRecord::Base.shared_connection = ActiveRecord::Base.connection
+          ActiveRecord::Base.descendants.each do |model|
+            model.shared_connection = model.connection
+          end
+        end
+
+        def before_non_js
+          # Do not use a shared connection unless we're in a @javascript scenario
+          ActiveRecord::Base.shared_connection = nil
+          ActiveRecord::Base.descendants.each do |model|
+            model.shared_connection = nil
+          end
+        end
+      end
+    end
+  end
+end

data/lib/cucumber/rails/database/strategy.rb

@@ -0,0 +1,31 @@
+module Cucumber
+  module Rails
+    module Database
+      class Strategy
+        def initialize(options = {})
+          @options = options
+        end
+
+        def before_js(strategy)
+          @original_strategy = if defined?(DatabaseCleaner::VERSION) && 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
+
+        def before_non_js
+          # no-op
+        end
+
+        def after
+          return unless @original_strategy
+
+          DatabaseCleaner.strategy = @original_strategy
+          @original_strategy = nil
+        end
+      end
+    end
+  end
+end