capybara 3.31.0 → 3.34.0

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

@@ -7,27 +7,25 @@ module Capybara::Selenium::Driver::ChromeDriver
   def self.extended(base)
     bridge = base.send(:bridge)
     bridge.extend Capybara::Selenium::ChromeLogs unless bridge.respond_to?(:log)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
     base.options[:native_displayed] = false if base.options[:native_displayed].nil?
   end
 
   def fullscreen_window(handle)
     within_given_window(handle) do
-      begin
-        super
-      rescue NoMethodError => e
-        raise unless e.message.match?(/full_screen_window/)
-
-        result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
-        result['value']
-      end
+      super
+    rescue NoMethodError => e
+      raise unless e.message.include?('full_screen_window')
+
+      result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
+      result['value']
     end
   end
 
   def resize_window_to(handle, width, height)
     super
   rescue Selenium::WebDriver::Error::UnknownError => e
-    raise unless e.message.match?(/failed to change window state/)
+    raise unless e.message.include?('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.
@@ -65,7 +63,7 @@ private
   end
 
   def clear_all_storage?
-    storage_clears.none? { |s| s == false }
+    storage_clears.none? false
   end
 
   def uniform_storage_clear?

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

@@ -5,7 +5,7 @@ require 'capybara/selenium/nodes/edge_node'
 module Capybara::Selenium::Driver::EdgeDriver
   def self.extended(base)
     bridge = base.send(:bridge)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
     base.options[:native_displayed] = false if base.options[:native_displayed].nil?
   end
 
@@ -13,21 +13,19 @@ module Capybara::Selenium::Driver::EdgeDriver
     return super if edgedriver_version < 75
 
     within_given_window(handle) do
-      begin
-        super
-      rescue NoMethodError => e
-        raise unless e.message.match?(/full_screen_window/)
-
-        result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
-        result['value']
-      end
+      super
+    rescue NoMethodError => e
+      raise unless e.message.include?('full_screen_window')
+
+      result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
+      result['value']
     end
   end
 
   def resize_window_to(handle, width, height)
     super
   rescue Selenium::WebDriver::Error::UnknownError => e
-    raise unless e.message.match?(/failed to change window state/)
+    raise unless e.message.include?('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.
@@ -74,7 +72,7 @@ private
   end
 
   def clear_all_storage?
-    storage_clears.none? { |s| s == false }
+    storage_clears.none? false
   end
 
   def uniform_storage_clear?

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

@@ -6,7 +6,7 @@ module Capybara::Selenium::Driver::FirefoxDriver
   def self.extended(driver)
     driver.extend Capybara::Selenium::Driver::W3CFirefoxDriver if w3c?(driver)
     bridge = driver.send(:bridge)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
   end
 
   def self.w3c?(driver)
@@ -46,7 +46,7 @@ module Capybara::Selenium::Driver::W3CFirefoxDriver
       begin
         # Firefox 68 hangs if we try to switch windows while a modal is visible
         browser.switch_to.alert&.dismiss
-      rescue Selenium::WebDriver::Error::NoSuchAlertError # rubocop:disable Lint/SuppressedException
+      rescue Selenium::WebDriver::Error::NoSuchAlertError
         # Swallow
       end
     end
@@ -61,7 +61,7 @@ module Capybara::Selenium::Driver::W3CFirefoxDriver
     accept_modal :confirm, wait: 0.1 do
       super
     end
-  rescue Capybara::ModalNotFound # rubocop:disable Lint/SuppressedException
+  rescue Capybara::ModalNotFound
     # No modal was opened - page has refreshed - ignore
   end
 

data/lib/capybara/selenium/extensions/find.rb

@@ -100,9 +100,9 @@ module Capybara
       def is_displayed_atom # rubocop:disable Naming/PredicateName
         @@is_displayed_atom ||= begin # rubocop:disable Style/ClassVars
           browser.send(:bridge).send(:read_atom, 'isDisplayed')
-                                rescue StandardError
-                                  # If the atom doesn't exist or other error
-                                  ''
+        rescue StandardError
+          # If the atom doesn't exist or other error
+          ''
         end
       end
     end

data/lib/capybara/selenium/extensions/scroll.rb

@@ -45,20 +45,18 @@ module Capybara
         JS
       end
 
+      SCROLL_POSITIONS = {
+        top: '0',
+        bottom: 'arguments[0].scrollHeight',
+        center: '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'
+      }.freeze
+
       def scroll_to_location(location)
-        scroll_y = case location
-        when :top
-          '0'
-        when :bottom
-          'arguments[0].scrollHeight'
-        when :center
-          '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'
-        end
         driver.execute_script <<~JS, self
           if (arguments[0].scrollTo){
-            arguments[0].scrollTo(0, #{scroll_y});
+            arguments[0].scrollTo(0, #{SCROLL_POSITIONS[location]});
           } else {
-            arguments[0].scrollTop = #{scroll_y};
+            arguments[0].scrollTop = #{SCROLL_POSITIONS[location]};
           }
         JS
       end

data/lib/capybara/selenium/node.rb

@@ -104,10 +104,23 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     click_options = ClickOptions.new(keys, options)
     return native.click if click_options.empty?
 
-    click_with_options(click_options)
+    perform_with_options(click_options) do |action|
+      target = click_options.coords? ? nil : native
+      if click_options.delay.zero?
+        action.click(target)
+      else
+        action.click_and_hold(target)
+        if w3c?
+          action.pause(action.pointer_inputs.first, click_options.delay)
+        else
+          action.pause(click_options.delay)
+        end
+        action.release
+      end
+    end
   rescue StandardError => e
     if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
-       e.message.match?(/Other element would receive the click/)
+       e.message.include?('Other element would receive the click')
       scroll_to_center
     end
 
@@ -116,14 +129,26 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
 
   def right_click(keys = [], **options)
     click_options = ClickOptions.new(keys, options)
-    click_with_options(click_options) do |action|
-      click_options.coords? ? action.context_click : action.context_click(native)
+    perform_with_options(click_options) do |action|
+      target = click_options.coords? ? nil : native
+      if click_options.delay.zero?
+        action.context_click(target)
+      elsif w3c?
+        action.move_to(target) if target
+        action.pointer_down(:right)
+              .pause(action.pointer_inputs.first, click_options.delay)
+              .pointer_up(:right)
+      else
+        raise ArgumentError, 'Delay is not supported when right clicking with legacy (non-w3c) selenium driver'
+      end
     end
   end
 
   def double_click(keys = [], **options)
     click_options = ClickOptions.new(keys, options)
-    click_with_options(click_options) do |action|
+    raise ArgumentError, "double_click doesn't support a delay option" unless click_options.delay.zero?
+
+    perform_with_options(click_options) do |action|
       click_options.coords? ? action.double_click : action.double_click(native)
     end
   end
@@ -212,7 +237,7 @@ protected
     JS
     begin
       driver.execute_script(script, self)
-    rescue StandardError # rubocop:disable Lint/SuppressedException
+    rescue StandardError
       # Swallow error if scrollIntoView with options isn't supported
     end
   end
@@ -242,7 +267,7 @@ private
     find_xpath(XPath.ancestor(:select)[1]).first
   end
 
-  def set_text(value, clear: nil, **_unused)
+  def set_text(value, clear: nil, rapid: nil, **_unused)
     value = value.to_s
     if value.empty? && clear.nil?
       native.clear
@@ -254,11 +279,23 @@ private
       send_keys(*clear, value)
     else
       driver.execute_script 'arguments[0].select()', self unless clear == :none
-      send_keys(value)
+      if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false)
+        send_keys(value[0..3])
+        driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3]
+        send_keys(value[-3..-1])
+      else
+        send_keys(value)
+      end
     end
   end
 
-  def click_with_options(click_options)
+  def auto_rapid_set_length
+    30
+  end
+
+  def perform_with_options(click_options, &block)
+    raise ArgumentError, 'A block must be provided' unless block
+
     scroll_if_needed do
       action_with_modifiers(click_options) do |action|
         if block_given?
@@ -407,6 +444,15 @@ private
     browser.action
   end
 
+  def capabilities
+    browser.capabilities
+  end
+
+  def w3c?
+    (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
+      capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+  end
+
   def normalize_keys(keys)
     keys.map do |key|
       case key
@@ -418,8 +464,8 @@ private
     end
   end
 
-  def each_key(keys)
-    normalize_keys(keys).each { |key| yield(key) }
+  def each_key(keys, &block)
+    normalize_keys(keys).each(&block)
   end
 
   def find_context
@@ -447,6 +493,9 @@ private
       var xpath = '';
     	var pos, tempitem2;
 
+      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {
+        return "(: Shadow DOM element - no XPath :)";
+      };
       while(el !== xml.documentElement) {
         pos = 0;
         tempitem2 = el;
@@ -488,6 +537,16 @@ private
     })(arguments[0], arguments[1], arguments[2])
   JS
 
+  RAPID_APPEND_TEXT = <<~'JS'
+    (function(el, value) {
+      value = el.value + value;
+      if (el.maxLength && el.maxLength != -1){
+        value = value.slice(0, el.maxLength);
+      }
+      el.value = value;
+    })(arguments[0], arguments[1])
+  JS
+
   # SettableValue encapsulates time/date field formatting
   class SettableValue
     attr_reader :value
@@ -544,7 +603,11 @@ private
     end
 
     def empty?
-      keys.empty? && !coords?
+      keys.empty? && !coords? && delay.zero?
+    end
+
+    def delay
+      options[:delay] || 0
     end
   end
   private_constant :ClickOptions

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

@@ -42,7 +42,7 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     raise
   rescue ::Selenium::WebDriver::Error::WebDriverError => e
     # chromedriver 74 (at least on mac) raises the wrong error for this
-    if e.message.match?(/element click intercepted/)
+    if e.message.include?('element click intercepted')
       raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message
     end
 
@@ -73,6 +73,24 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     end
   end
 
+  def send_keys(*args)
+    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\p{Emoji Presentation}/) }
+        .each do |contains_emoji, inputs|
+      if contains_emoji
+        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\p{Emoji Presentation}/) }
+              .each do |emoji, clusters|
+          if emoji
+            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)
+          else
+            super(clusters.join)
+          end
+        end
+      else
+        super(*inputs)
+      end
+    end
+  end
+
 private
 
   def perform_legacy_drag(element, drop_modifiers)
@@ -92,12 +110,7 @@ private
     end
   end
 
-  def w3c?
-    (defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)) ||
-      capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
-  end
-
-  def browser_version(to_float = true)
+  def browser_version(to_float: true)
     caps = capabilities
     ver = (caps[:browser_version] || caps[:version])
     ver = ver.to_f if to_float
@@ -116,10 +129,6 @@ private
     capabilities['chrome']['chromedriverVersion'].split(' ')[0]
   end
 
-  def capabilities
-    driver.browser.capabilities
-  end
-
   def native_displayed?
     (driver.options[:native_displayed] != false) &&
       (w3c? && chromedriver_supports_displayed_endpoint?) &&

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

@@ -42,7 +42,7 @@ class Capybara::Selenium::FirefoxNode < 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? { |arg| arg.is_a? Array }
+    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none?(Array)
 
     native.click
     _send_keys(args).perform
@@ -85,7 +85,7 @@ private
     (driver.options[:native_displayed] != false) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']
   end
 
-  def click_with_options(click_options)
+  def perform_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?

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

@@ -43,7 +43,7 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
     return '' unless visible?
 
     vis_text = driver.execute_script('return arguments[0].innerText', self)
-    vis_text.gsub(/\ +/, ' ')
+    vis_text.squeeze(' ')
             .gsub(/[\ \n]*\n[\ \n]*/, "\n")
             .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
             .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')

data/lib/capybara/selenium/patches/action_pauser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActionPauser
+  def initialize(mouse, keyboard)
+    super
+    @devices[:pauser] = Pauser.new
+  end
+
+  def pause(duration)
+    @actions << [:pauser, :pause, [duration]]
+    self
+  end
+
+  class Pauser
+    def pause(duration)
+      sleep duration
+    end
+  end
+
+  private_constant :Pauser
+end
+
+if defined?(::Selenium::WebDriver::VERSION) && (::Selenium::WebDriver::VERSION.to_f < 4) &&
+   defined?(::Selenium::WebDriver::ActionBuilder)
+  ::Selenium::WebDriver::ActionBuilder.prepend(ActionPauser)
+end

data/lib/capybara/selenium/patches/atoms.rb

@@ -6,10 +6,10 @@ private
   def read_atom(function)
     @atoms ||= Hash.new do |hash, key|
       hash[key] = begin
-                    File.read(File.expand_path("../../atoms/#{key}.min.js", __FILE__))
-                  rescue Errno::ENOENT
-                    super
-                  end
+        File.read(File.expand_path("../../atoms/#{key}.min.js", __FILE__))
+      rescue Errno::ENOENT
+        super
+      end
     end
     @atoms[function]
   end