capybara 3.1.1 → 3.2.0

data/lib/capybara/selenium/driver.rb

@@ -101,7 +101,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   def needs_server?; true; end
 
   def execute_script(script, *args)
-    browser.execute_script(script, *args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg })
+    browser.execute_script(script, *native_args(args))
   end
 
   def evaluate_script(script, *args)
@@ -111,7 +111,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def evaluate_async_script(script, *args)
     browser.manage.timeouts.script_timeout = Capybara.default_max_wait_time
-    result = browser.execute_async_script(script, *args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg })
+    result = browser.execute_async_script(script, *native_args(args))
     unwrap_script_result(result)
   end
 
@@ -137,7 +137,11 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
         begin
           @browser.manage.delete_all_cookies
           clear_storage
-        rescue Selenium::WebDriver::Error::UnhandledError
+        # rescue Selenium::WebDriver::Error::NoSuchAlertError
+        #   # Handle a bug in Firefox/Geckodriver where it thinks it needs an alert modal to exist
+        #   # for no good reason
+        #   retry
+        rescue Selenium::WebDriver::Error::UnhandledError # rubocop:disable Lint/HandleExceptions
           # delete_all_cookies fails when we've previously gone
           # to about:blank, so we rescue this error and do nothing
           # instead.
@@ -167,7 +171,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
             @browser.navigate.to("about:blank")
             sleep 0.1 # slight wait for alert
             @browser.switch_to.alert.accept
-          rescue modal_error # rubocop:disable Metrics/BlockNesting
+          rescue modal_error # rubocop:disable Metrics/BlockNesting, Lint/HandleExceptions
             # alert now gone, should mean navigation happened
           end
         end
@@ -263,8 +267,8 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def quit
-    @browser.quit if @browser
-  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED
+    @browser&.quit
+  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED # rubocop:disable Lint/HandleExceptions
     # Browser must have already gone
   rescue Selenium::WebDriver::Error::UnknownError => e
     unless silenced_unknown_error_message?(e.message) # Most likely already gone
@@ -327,6 +331,10 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
 private
 
+  def native_args(args)
+    args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }
+  end
+
   def clear_storage
     if options[:clear_session_storage]
       if @browser.respond_to? :session_storage
@@ -335,6 +343,7 @@ private
         warn "sessionStorage clear requested but is not available for this driver"
       end
     end
+
     if options[:clear_local_storage]
       if @browser.respond_to? :local_storage
         @browser.local_storage.clear
@@ -352,60 +361,6 @@ private
     end
   end
 
-  def insert_modal_handlers(accept, response_text)
-    prompt_response = if accept
-      if response_text.nil?
-        "default_text"
-      else
-        "'#{response_text.gsub('\\', '\\\\\\').gsub("'", "\\\\'")}'"
-      end
-    else
-      'null'
-    end
-
-    script = <<-JS
-      if (typeof window.capybara  === 'undefined') {
-        window.capybara = {
-          modal_handlers: [],
-          current_modal_status: function() {
-            return [this.modal_handlers[0].called, this.modal_handlers[0].modal_text];
-          },
-          add_handler: function(handler) {
-            this.modal_handlers.unshift(handler);
-          },
-          remove_handler: function(handler) {
-            window.alert = handler.alert;
-            window.confirm = handler.confirm;
-            window.prompt = handler.prompt;
-          },
-          handler_called: function(handler, str) {
-            handler.called = true;
-            handler.modal_text = str;
-            this.remove_handler(handler);
-          }
-        };
-      };
-
-      var modal_handler = {
-        prompt: window.prompt,
-        confirm: window.confirm,
-        alert: window.alert,
-        called: false
-      }
-      window.capybara.add_handler(modal_handler);
-
-      window.alert = window.confirm = function(str = "") {
-        window.capybara.handler_called(modal_handler, str.toString());
-        return #{accept ? 'true' : 'false'};
-      }
-      window.prompt = function(str = "", default_text = "") {
-        window.capybara.handler_called(modal_handler, str.toString());
-        return #{prompt_response};
-      }
-    JS
-    execute_script script
-  end
-
   def within_given_window(handle)
     original_handle = current_window_handle
     if handle == original_handle
@@ -436,34 +391,6 @@ private
     end
   end
 
-  def find_headless_modal(text: nil, **options)
-    # Selenium has its own built in wait (2 seconds)for a modal to show up, so this wait is really the minimum time
-    # Actual wait time may be longer than specified
-    wait = Selenium::WebDriver::Wait.new(
-      timeout: options.fetch(:wait, session_options.default_max_wait_time) || 0,
-      ignore: modal_error
-    )
-    begin
-      wait.until do
-        called, alert_text = evaluate_script('window.capybara && window.capybara.current_modal_status()')
-        if called
-          execute_script('window.capybara && window.capybara.modal_handlers.shift()')
-          regexp = text.is_a?(Regexp) ? text : Regexp.escape(text.to_s)
-          raise Capybara::ModalNotFound, "Unable to find modal dialog#{" with #{text}" if text}" unless alert_text.match(regexp)
-          alert_text
-        elsif called.nil?
-          # page changed so modal_handler data has gone away
-          warn "Can't verify modal text when page change occurs - ignoring" if options[:text]
-          ""
-        else
-          nil
-        end
-      end
-    rescue Selenium::WebDriver::Error::TimeOutError
-      raise Capybara::ModalNotFound, "Unable to find modal dialog#{" with #{options[:text]}" if options[:text]}"
-    end
-  end
-
   def silenced_unknown_error_message?(msg)
     silenced_unknown_error_messages.any? { |r| msg =~ r }
   end

data/lib/capybara/selenium/node.rb

@@ -21,7 +21,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def value
-    if tag_name == "select" and multiple?
+    if tag_name == "select" && multiple?
       native.find_elements(:css, "option:checked").map { |n| n[:value] || n.text }
     else
       native[:value]
@@ -76,51 +76,36 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     native.click if selected?
   end
 
-  def click(keys = [], options = {})
-    if keys.empty? && !(options[:x] && options[:y])
+  def click(keys = [], **options)
+    if keys.empty? && !coords?(options)
       native.click
     else
       scroll_if_needed do
         action_with_modifiers(keys, options) do |a|
-          if options[:x] && options[:y]
-            a.click
-          else
-            a.click(native)
-          end
+          coords?(options) ? a.click : a.click(native)
         end
       end
     end
-  rescue => e
+  rescue StandardError => e
     if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
        e.message =~ /Other element would receive the click/
-      begin
-        driver.execute_script("arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'})", self)
-      rescue # Swallow error if scrollIntoView with options isn't supported
-      end
+      scroll_to_center
     end
     raise e
   end
 
-  def right_click(keys = [], options = {})
+  def right_click(keys = [], **options)
     scroll_if_needed do
       action_with_modifiers(keys, options) do |a|
-        if options[:x] && options[:y]
-          a.context_click
-        else
-          a.context_click(native)
-        end
+        coords?(options) ? a.context_click : a.context_click(native)
       end
     end
   end
 
-  def double_click(keys = [], options = {})
+  def double_click(keys = [], **options)
     scroll_if_needed do
       action_with_modifiers(keys, options) do |a|
-        if options[:x] && options[:y]
-          a.double_click
-        else
-          a.double_click(native)
-        end
+        coords?(options) ? a.double_click : a.double_click(native)
       end
     end
   end
@@ -197,8 +182,12 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
 
 private
 
+  def coords?(options)
+    options[:x] && options[:y]
+  end
+
   def boolean_attr(val)
-    val and val != "false"
+    val && (val != "false")
   end
 
   # a reference to the select node if this is an option node
@@ -229,6 +218,11 @@ private
   def scroll_if_needed
     yield
   rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
+    scroll_to_center
+    yield
+  end
+
+  def scroll_to_center
     script = <<-'JS'
       try {
         arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
@@ -236,8 +230,11 @@ private
         arguments[0].scrollIntoView(true);
       }
     JS
-    driver.execute_script(script, self)
-    yield
+    begin
+      driver.execute_script(script, self)
+    rescue StandardError # rubocop:disable Lint/HandleExceptions
+      # Swallow error if scrollIntoView with options isn't supported
+    end
   end
 
   def set_date(value) # rubocop:disable Naming/AccessorMethodName

data/lib/capybara/server.rb

@@ -3,56 +3,11 @@
 require 'uri'
 require 'net/http'
 require 'rack'
+require 'capybara/server/middleware'
+require 'capybara/server/animation_disabler'
 
 module Capybara
   class Server
-    class Middleware
-      class Counter
-        attr_reader :value
-
-        def initialize
-          @value = 0
-          @mutex = Mutex.new
-        end
-
-        def increment
-          @mutex.synchronize { @value += 1 }
-        end
-
-        def decrement
-          @mutex.synchronize { @value -= 1 }
-        end
-      end
-
-      attr_accessor :error
-
-      def initialize(app, server_errors)
-        @app = app
-        @counter = Counter.new
-        @server_errors = server_errors
-      end
-
-      def pending_requests?
-        @counter.value > 0
-      end
-
-      def call(env)
-        if env["PATH_INFO"] == "/__identify__"
-          [200, {}, [@app.object_id.to_s]]
-        else
-          @counter.increment
-          begin
-            @app.call(env)
-          rescue *@server_errors => e
-            @error ||= e
-            raise e
-          ensure
-            @counter.decrement
-          end
-        end
-      end
-    end
-
     class << self
       def ports
         @ports ||= {}
@@ -61,9 +16,10 @@ module Capybara
 
     attr_reader :app, :port, :host
 
-    def initialize(app, *deprecated_options, port: Capybara.server_port, host: Capybara.server_host, reportable_errors: Capybara.server_errors)
+    def initialize(app, *deprecated_options, port: Capybara.server_port, host: Capybara.server_host, reportable_errors: Capybara.server_errors, extra_middleware: [])
       warn "Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments" unless deprecated_options.empty?
       @app = app
+      @extra_middleware = extra_middleware
       @server_thread = nil # suppress warnings
       @host = deprecated_options[1] || host
       @reportable_errors = deprecated_options[2] || reportable_errors
@@ -86,10 +42,10 @@ module Capybara
     end
 
     def responsive?
-      return false if @server_thread && @server_thread.join(0)
+      return false if @server_thread&.join(0)
 
       begin
-        res = if !@using_ssl
+        res = if !using_ssl?
           http_connect
         else
           https_connect
@@ -99,11 +55,11 @@ module Capybara
         @using_ssl = true
       end
 
-      if res.is_a?(Net::HTTPSuccess) or res.is_a?(Net::HTTPRedirection)
+      if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
         return res.body == app.object_id.to_s
       end
     rescue SystemCallError
-      return false
+      false
     end
 
     def wait_for_pending_requests
@@ -147,7 +103,7 @@ module Capybara
     end
 
     def middleware
-      @middleware ||= Middleware.new(app, @reportable_errors)
+      @middleware ||= Middleware.new(app, @reportable_errors, @extra_middleware)
     end
 
     def port_key
@@ -162,7 +118,7 @@ module Capybara
       server = TCPServer.new(host, 0)
       server.addr[1]
     ensure
-      server.close if server
+      server&.close
     end
   end
 end

data/lib/capybara/server/animation_disabler.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Capybara
+  class Server
+    class AnimationDisabler
+      def initialize(app)
+        @app = app
+      end
+
+      def call(env)
+        @status, @headers, @body = @app.call(env)
+        return [@status, @headers, @body] unless html_content?
+        response = Rack::Response.new([], @status, @headers)
+
+        @body.each { |html| response.write insert_disable(html) }
+        @body.close if @body.respond_to?(:close)
+
+        response.finish
+      end
+
+    private
+
+      def html_content?
+        !!(@headers["Content-Type"] =~ /html/)
+      end
+
+      def insert_disable(html)
+        html.sub(%r{(</head>)}, DISABLE_MARKUP + '\\1')
+      end
+
+      DISABLE_MARKUP = <<~HTML
+        <script defer>(typeof jQuery !== 'undefined') && (jQuery.fx.off = true);</script>
+        <style>
+          * {
+             transition: none !important;
+             animation-duration: 0s !important;
+             animation-delay: 0s !important;
+          }
+        </style>
+      HTML
+    end
+  end
+end

data/lib/capybara/server/middleware.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module Capybara
+  class Server
+    class Middleware
+      class Counter
+        attr_reader :value
+
+        def initialize
+          @value = 0
+          @mutex = Mutex.new
+        end
+
+        def increment
+          @mutex.synchronize { @value += 1 }
+        end
+
+        def decrement
+          @mutex.synchronize { @value -= 1 }
+        end
+      end
+
+      attr_accessor :error
+
+      def initialize(app, server_errors, extra_middleware = [])
+        @app = app
+        @extended_app = extra_middleware.inject(@app) do |ex_app, klass|
+          klass.new(ex_app)
+        end
+        @counter = Counter.new
+        @server_errors = server_errors
+      end
+
+      def pending_requests?
+        @counter.value.positive?
+      end
+
+      def call(env)
+        if env["PATH_INFO"] == "/__identify__"
+          [200, {}, [@app.object_id.to_s]]
+        else
+          @counter.increment
+          begin
+            @extended_app.call(env)
+          rescue *@server_errors => e
+            @error ||= e
+            raise e
+          ensure
+            @counter.decrement
+          end
+        end
+      end
+    end
+  end
+end