capybara 3.6.0 → 3.7.0

data/lib/capybara/selenium/driver_specializations/chrome_driver.rb

@@ -7,8 +7,8 @@ module Capybara::Selenium::Driver::ChromeDriver
     within_given_window(handle) do
       begin
         super
-      rescue NoMethodError => e
-        raise unless e.message =~ /full_screen_window/
+      rescue NoMethodError => err
+        raise unless err.message =~ /full_screen_window/
         bridge = browser.send(:bridge)
         result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
         result['value']
@@ -18,8 +18,8 @@ module Capybara::Selenium::Driver::ChromeDriver
 
   def resize_window_to(handle, width, height)
     super
-  rescue Selenium::WebDriver::Error::UnknownError => e
-    raise unless e.message =~ /failed to change window state/
+  rescue Selenium::WebDriver::Error::UnknownError => err
+    raise unless err.message =~ /failed to change window state/
     # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen
     # and raises unnecessary error. Wait a bit and try again.
     sleep 0.5

data/lib/capybara/selenium/driver_specializations/marionette_driver.rb

@@ -23,6 +23,15 @@ module Capybara::Selenium::Driver::MarionetteDriver
     super
   end
 
+  def refresh
+    # Accept any "will repost content" confirmation that occurs
+    accept_modal :confirm, wait: 0.1 do
+      super
+    end
+  rescue Capybara::ModalNotFound # rubocop:disable Lint/HandleExceptions
+    # No modal was opened - page has refreshed - ignore
+  end
+
 private
 
   def build_node(native_node)

data/lib/capybara/selenium/node.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# Selenium specific implementation of the Capybara::Driver::Node API
 class Capybara::Selenium::Node < Capybara::Driver::Node
   def visible_text
     native.text
@@ -22,7 +23,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
 
   def value
     if tag_name == 'select' && multiple?
-      native.find_elements(:css, 'option:checked').map { |n| n[:value] || n.text }
+      native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }
     else
       native[:value]
     end
@@ -73,46 +74,38 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def select_option
-    native.click unless selected? || disabled?
+    click unless selected? || disabled?
   end
 
   def unselect_option
     raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?
-    native.click if selected?
+    click if selected?
   end
 
   def click(keys = [], **options)
-    if keys.empty? && !coords?(options)
-      native.click
-    else
-      scroll_if_needed do
-        action_with_modifiers(keys, options) do |a|
-          coords?(options) ? a.click : a.click(native)
-        end
-      end
-    end
-  rescue StandardError => e
-    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
-       e.message =~ /Other element would receive the click/
+    click_options = ClickOptions.new(keys, options)
+    return native.click if click_options.empty?
+    click_with_options(click_options)
+  rescue StandardError => err
+    if err.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
+       err.message =~ /Other element would receive the click/
       scroll_to_center
     end
 
-    raise e
+    raise err
   end
 
   def right_click(keys = [], **options)
-    scroll_if_needed do
-      action_with_modifiers(keys, options) do |a|
-        coords?(options) ? a.context_click : a.context_click(native)
-      end
+    click_options = ClickOptions.new(keys, options)
+    click_with_options(click_options) do |action|
+      click_options.coords? ? action.context_click : action.context_click(native)
     end
   end
 
   def double_click(keys = [], **options)
-    scroll_if_needed do
-      action_with_modifiers(keys, options) do |a|
-        coords?(options) ? a.double_click : a.double_click(native)
-      end
+    click_options = ClickOptions.new(keys, options)
+    click_with_options(click_options) do |action|
+      click_options.coords? ? action.double_click : action.double_click(native)
     end
   end
 
@@ -121,11 +114,14 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def hover
-    scroll_if_needed { driver.browser.action.move_to(native).perform }
+    scroll_if_needed { browser_action.move_to(native).perform }
   end
 
   def drag_to(element)
-    scroll_if_needed { driver.browser.action.drag_and_drop(native, element.native).perform }
+    # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary
+    # which means Seleniums `drag_and_drop` is now broken - do it manually
+    scroll_if_needed { browser_action.click_and_hold(native).perform }
+    element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
   end
 
   def tag_name
@@ -149,11 +145,11 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def find_xpath(locator)
-    native.find_elements(:xpath, locator).map { |n| self.class.new(driver, n) }
+    native.find_elements(:xpath, locator).map { |el| self.class.new(driver, el) }
   end
 
   def find_css(locator)
-    native.find_elements(:css, locator).map { |n| self.class.new(driver, n) }
+    native.find_elements(:css, locator).map { |el| self.class.new(driver, el) }
   end
 
   def ==(other)
@@ -190,12 +186,17 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     '/' + result.reverse.join('/')
   end
 
-private
+protected
 
-  def coords?(options)
-    options[:x] && options[:y]
+  def scroll_if_needed
+    yield
+  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
+    scroll_to_center
+    yield
   end
 
+private
+
   def boolean_attr(val)
     val && (val != 'false')
   end
@@ -206,30 +207,34 @@ private
   end
 
   def set_text(value, clear: nil, **_unused)
-    if value.to_s.empty? && clear.nil?
+    value = value.to_s
+    if value.empty? && clear.nil?
       native.clear
     elsif clear == :backspace
       # Clear field by sending the correct number of backspace keys.
       backspaces = [:backspace] * self.value.to_s.length
-      send_keys(*([:end] + backspaces + [value.to_s]))
-    elsif clear == :none
-      send_keys(value.to_s)
+      send_keys(*([:end] + backspaces + [value]))
     elsif clear.is_a? Array
-      send_keys(*clear, value.to_s)
+      send_keys(*clear, value)
     else
       # Clear field by JavaScript assignment of the value property.
       # Script can change a readonly element which user input cannot, so
       # don't execute if readonly.
-      driver.execute_script "arguments[0].value = ''", self
-      send_keys(value.to_s)
+      driver.execute_script "arguments[0].value = ''", self unless clear == :none
+      send_keys(value)
     end
   end
 
-  def scroll_if_needed
-    yield
-  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
-    scroll_to_center
-    yield
+  def click_with_options(click_options)
+    scroll_if_needed do
+      action_with_modifiers(click_options) do |action|
+        if block_given?
+          yield action
+        else
+          click_options.coords? ? action.click : action.click(native)
+        end
+      end
+    end
   end
 
   def scroll_to_center
@@ -248,21 +253,24 @@ private
   end
 
   def set_date(value) # rubocop:disable Naming/AccessorMethodName
-    return set_text(value) if value.is_a?(String) || !value.respond_to?(:to_date)
+    value = SettableValue.new(value)
+    return set_text(value) unless value.dateable?
     # TODO: this would be better if locale can be detected and correct keystrokes sent
-    update_value_js(value.to_date.strftime('%Y-%m-%d'))
+    update_value_js(value.to_date_str)
   end
 
   def set_time(value) # rubocop:disable Naming/AccessorMethodName
-    return set_text(value) if value.is_a?(String) || !value.respond_to?(:to_time)
+    value = SettableValue.new(value)
+    return set_text(value) unless value.timeable?
     # TODO: this would be better if locale can be detected and correct keystrokes sent
-    update_value_js(value.to_time.strftime('%H:%M'))
+    update_value_js(value.to_time_str)
   end
 
   def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName
-    return set_text(value) if value.is_a?(String) || !value.respond_to?(:to_time)
+    value = SettableValue.new(value)
+    return set_text(value) unless value.timeable?
     # TODO: this would be better if locale can be detected and correct keystrokes sent
-    update_value_js(value.to_time.strftime('%Y-%m-%dT%H:%M'))
+    update_value_js(value.to_datetime_str)
   end
 
   def update_value_js(value)
@@ -301,34 +309,33 @@ private
     # if we use the faster direct send_keys.  For now just send_keys to the element
     # we've already focused.
     # native.send_keys(value.to_s)
-    driver.browser.action.send_keys(value.to_s).perform
+    browser_action.send_keys(value.to_s).perform
   end
 
-  def action_with_modifiers(keys, x: nil, y: nil)
-    actions = driver.browser.action
-    actions.move_to(native, x, y)
-    modifiers_down(actions, keys)
+  def action_with_modifiers(click_options)
+    actions = browser_action.move_to(native, *click_options.coords)
+    modifiers_down(actions, click_options.keys)
     yield actions
-    modifiers_up(actions, keys)
+    modifiers_up(actions, click_options.keys)
     actions.perform
   ensure
-    a = driver.browser.action
-    a.release_actions if a.respond_to?(:release_actions)
+    act = browser_action
+    act.release_actions if act.respond_to?(:release_actions)
   end
 
   def modifiers_down(actions, keys)
-    keys.each do |key|
-      key = case key
-      when :ctrl then :control
-      when :command, :cmd then :meta
-      else
-        key
-      end
-      actions.key_down(key)
-    end
+    each_key(keys) { |key| actions.key_down(key) }
   end
 
   def modifiers_up(actions, keys)
+    each_key(keys) { |key| actions.key_up(key) }
+  end
+
+  def browser_action
+    driver.browser.action
+  end
+
+  def each_key(keys)
     keys.each do |key|
       key = case key
       when :ctrl then :control
@@ -336,7 +343,60 @@ private
       else
         key
       end
-      actions.key_up(key)
+      yield key
+    end
+  end
+
+  # SettableValue encapsulates time/date field formatting
+  class SettableValue
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def dateable?
+      !value.is_a?(String) && value.respond_to?(:to_date)
+    end
+
+    def to_date_str
+      value.to_date.strftime('%Y-%m-%d')
+    end
+
+    def timeable?
+      !value.is_a?(String) && value.respond_to?(:to_time)
+    end
+
+    def to_time_str
+      value.to_time.strftime('%H:%M')
+    end
+
+    def to_datetime_str
+      value.to_time.strftime('%Y-%m-%dT%H:%M')
+    end
+  end
+  private_constant :SettableValue
+
+  # ClickOptions encapsulates click option logic
+  class ClickOptions
+    attr_reader :keys, :options
+
+    def initialize(keys, options)
+      @keys = keys
+      @options = options
+    end
+
+    def coords?
+      options[:x] && options[:y]
+    end
+
+    def coords
+      [options[:x], options[:y]]
+    end
+
+    def empty?
+      keys.empty? && !coords?
     end
   end
+  private_constant :ClickOptions
 end

data/lib/capybara/selenium/nodes/chrome_node.rb

@@ -3,8 +3,8 @@
 class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
     super(value)
-  rescue ::Selenium::WebDriver::Error::ExpectedError => e
-    if e.message =~ /File not found : .+\n.+/m
+  rescue ::Selenium::WebDriver::Error::ExpectedError => err
+    if err.message =~ /File not found : .+\n.+/m
       raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload"
     end
     raise
@@ -13,7 +13,7 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
   def drag_to(element)
     return super unless self[:draggable] == 'true'
 
-    scroll_if_needed { driver.browser.action.click_and_hold(native).perform }
+    scroll_if_needed { browser_action.click_and_hold(native).perform }
     driver.execute_script HTML5_DRAG_DROP_SCRIPT, self, element
   end
 

data/lib/capybara/selenium/nodes/marionette_node.rb

@@ -7,7 +7,7 @@ class Capybara::Selenium::MarionetteNode < Capybara::Selenium::Node
     if tag_name == 'tr'
       warn 'You are attempting to click a table row which has issues in geckodriver/marionette - see https://github.com/mozilla/geckodriver/issues/1228. ' \
            'Your test should probably be clicking on a table cell like a user would. Clicking the first cell in the row instead.'
-      return find_css('th:first-child,td:first-child')[0].click
+      return find_css('th:first-child,td:first-child')[0].click(keys, options)
     end
     raise
   end
@@ -26,7 +26,8 @@ class Capybara::Selenium::MarionetteNode < Capybara::Selenium::Node
   end
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
-    native.clear # By default files are appended so we have to clear here
+    # By default files are appended so we have to clear here if its multiple and already set
+    native.clear if multiple? && driver.evaluate_script('arguments[0].files', self).any?
     return super if browser_version >= 62.0
 
     # Workaround lack of support for multiple upload by uploading one at a time
@@ -44,25 +45,30 @@ class Capybara::Selenium::MarionetteNode < Capybara::Selenium::Node
 
   def send_keys(*args)
     # https://github.com/mozilla/geckodriver/issues/846
-    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none? { |s| s.is_a? Array }
+    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none? { |arg| arg.is_a? Array }
 
     native.click
-    actions = driver.browser.action
-    args.each do |keys|
+    args.each_with_object(browser_action) do |keys, actions|
       _send_keys(keys, actions)
-    end
-    actions.perform
+    end.perform
   end
 
   def drag_to(element)
     return super unless (browser_version >= 62.0) && (self[:draggable] == 'true')
 
-    scroll_if_needed { driver.browser.action.click_and_hold(native).perform }
+    scroll_if_needed { browser_action.click_and_hold(native).perform }
     driver.execute_script HTML5_DRAG_DROP_SCRIPT, self, element
   end
 
 private
 
+  def click_with_options(click_options)
+    # Firefox/marionette has an issue clicking with offset near viewport edge
+    # scroll element to middle just in case
+    scroll_to_center if click_options.coords?
+    super
+  end
+
   def _send_keys(keys, actions, down_keys = nil)
     case keys
     when String

data/lib/capybara/server.rb

@@ -31,7 +31,7 @@ module Capybara
     end
 
     def reset_error!
-      middleware.error = nil
+      middleware.clear_error
     end
 
     def error
@@ -49,7 +49,7 @@ module Capybara
       if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
         return res.body == app.object_id.to_s
       end
-    rescue SystemCallError
+    rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError
       false
     end
 

data/lib/capybara/server/animation_disabler.rb

@@ -3,8 +3,20 @@
 module Capybara
   class Server
     class AnimationDisabler
+      def self.selector_for(css_or_bool)
+        case css_or_bool
+        when String
+          css_or_bool
+        when true
+          '*'
+        else
+          raise CapybaraError, 'Capybara.disable_animation supports either a String (the css selector to disable) or a boolean'
+        end
+      end
+
       def initialize(app)
         @app = app
+        @disable_markup = DISABLE_MARKUP_TEMPLATE % AnimationDisabler.selector_for(Capybara.disable_animation)
       end
 
       def call(env)
@@ -20,18 +32,20 @@ module Capybara
 
     private
 
+      attr_reader :disable_markup
+
       def html_content?
         !!(@headers['Content-Type'] =~ /html/)
       end
 
       def insert_disable(html)
-        html.sub(%r{(</head>)}, DISABLE_MARKUP + '\\1')
+        html.sub(%r{(</head>)}, disable_markup + '\\1')
       end
 
-      DISABLE_MARKUP = <<~HTML
+      DISABLE_MARKUP_TEMPLATE = <<~HTML
         <script defer>(typeof jQuery !== 'undefined') && (jQuery.fx.off = true);</script>
         <style>
-          * {
+           %s {
              transition: none !important;
              animation-duration: 0s !important;
              animation-delay: 0s !important;