capybara 3.31.0 → 3.32.1

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

@@ -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/node.rb

@@ -104,7 +104,20 @@ 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/)
@@ -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_SET_TEXT, self, value[0...-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
@@ -488,6 +534,15 @@ private
     })(arguments[0], arguments[1], arguments[2])
   JS
 
+  RAPID_SET_TEXT = <<~'JS'
+    (function(el, 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 +599,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

@@ -92,11 +92,6 @@ 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)
     caps = capabilities
     ver = (caps[:browser_version] || caps[:version])
@@ -116,10 +111,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

@@ -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/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/spec/public/test.js

@@ -153,6 +153,7 @@ $(function() {
   });
   $('#click-test').on({
     click: function(e) {
+      window.click_delay = ((new Date().getTime()) - window.mouse_down_time)/1000.0;
       var desc = "";
       if (e.altKey) desc += 'alt ';
       if (e.ctrlKey) desc += 'control ';
@@ -179,6 +180,16 @@ $(function() {
       if (e.shiftKey) desc += 'shift ';
       var pos = this.getBoundingClientRect();
       $(this).after('<a id="has-been-right-clicked" href="#">Has been ' + desc + 'right clicked at ' + (e.clientX - pos.left) + ',' + (e.clientY - pos.top) + '</a>');
+    },
+    mousedown: function(e) {
+      window.click_delay = undefined;
+      window.right_click_delay = undefined;
+      window.mouse_down_time = new Date().getTime();
+    },
+    mouseup: function(e) {
+      if (e.button == 2){
+        window.right_click_delay = ((new Date().getTime()) - window.mouse_down_time)/1000.0;
+      }
     }
   });
   $('#open-alert').click(function() {

data/lib/capybara/spec/session/fill_in_spec.rb

@@ -47,6 +47,15 @@ Capybara::SpecHelper.spec '#fill_in' do
     expect(extract_results(@session)['description']).to eq('Texty text')
   end
 
+  it 'should fill in a textarea in a reasonable time by default' do
+    textarea = @session.find(:fillable_field, 'form[description]')
+    value = 'a' * 4000
+    start = Time.now
+    textarea.fill_in(with: value)
+    expect(Time.now.to_f).to be_within(0.25).of start.to_f
+    expect(textarea.value).to eq value
+  end
+
   it 'should fill in a password field by id' do
     @session.fill_in('form_password', with: 'supasikrit')
     @session.click_button('awesome')

data/lib/capybara/spec/session/find_spec.rb

@@ -451,32 +451,35 @@ Capybara::SpecHelper.spec '#find' do
   context 'with spatial filters', requires: [:spatial] do
     before do
       @session.visit('/spatial')
-      @center = @session.find(:css, 'div.center')
+    end
+
+    let :center do
+      @session.find(:css, 'div.center')
     end
 
     it 'should find an element above another element' do
-      expect(@session.find(:css, 'div:not(.corner)', above: @center).text).to eq('2')
+      expect(@session.find(:css, 'div:not(.corner)', above: center).text).to eq('2')
     end
 
     it 'should find an element below another element' do
-      expect(@session.find(:css, 'div:not(.corner):not(.footer)', below: @center).text).to eq('8')
+      expect(@session.find(:css, 'div:not(.corner):not(.footer)', below: center).text).to eq('8')
     end
 
     it 'should find an element left of another element' do
-      expect(@session.find(:css, 'div:not(.corner)', left_of: @center).text).to eq('4')
+      expect(@session.find(:css, 'div:not(.corner)', left_of: center).text).to eq('4')
     end
 
     it 'should find an element right of another element' do
-      expect(@session.find(:css, 'div:not(.corner)', right_of: @center).text).to eq('6')
+      expect(@session.find(:css, 'div:not(.corner)', right_of: center).text).to eq('6')
     end
 
     it 'should combine spatial filters' do
-      expect(@session.find(:css, 'div', left_of: @center, above: @center).text).to eq('1')
-      expect(@session.find(:css, 'div', right_of: @center, below: @center).text).to eq('9')
+      expect(@session.find(:css, 'div', left_of: center, above: center).text).to eq('1')
+      expect(@session.find(:css, 'div', right_of: center, below: center).text).to eq('9')
     end
 
     it 'should find an element "near" another element' do
-      expect(@session.find(:css, 'div.distance', near: @center).text).to eq('2')
+      expect(@session.find(:css, 'div.distance', near: center).text).to eq('2')
     end
   end
 

data/lib/capybara/spec/session/has_css_spec.rb

@@ -234,18 +234,21 @@ Capybara::SpecHelper.spec '#has_css?' do
   context 'with spatial requirements', requires: [:spatial] do
     before do
       @session.visit('/spatial')
-      @center = @session.find(:css, '.center')
+    end
+
+    let :center do
+      @session.find(:css, '.center')
     end
 
     it 'accepts spatial options' do
-      expect(@session).to have_css('div', above: @center).thrice
-      expect(@session).to have_css('div', above: @center, right_of: @center).once
+      expect(@session).to have_css('div', above: center).thrice
+      expect(@session).to have_css('div', above: center, right_of: center).once
     end
 
     it 'supports spatial sugar' do
-      expect(@session).to have_css('div').left_of(@center).thrice
-      expect(@session).to have_css('div').below(@center).right_of(@center).once
-      expect(@session).to have_css('div').near(@center).exactly(8).times
+      expect(@session).to have_css('div').left_of(center).thrice
+      expect(@session).to have_css('div').below(center).right_of(center).once
+      expect(@session).to have_css('div').near(center).exactly(8).times
     end
   end
 

data/lib/capybara/spec/session/node_spec.rb

@@ -808,7 +808,10 @@ Capybara::SpecHelper.spec 'node' do
     context 'offset', requires: [:js] do
       before do
         @session.visit('/offset')
-        @clicker = @session.find(:id, 'clicker')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
       end
 
       context 'when w3c_click_offset is false' do
@@ -817,17 +820,17 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from top left of element' do
-          @clicker.click(x: 10, y: 5)
+          clicker.click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 110,105/)
         end
 
         it 'should offset outside the element' do
-          @clicker.click(x: -15, y: -10)
+          clicker.click(x: -15, y: -10)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.click
+          clicker.click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
@@ -838,21 +841,30 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from center of element' do
-          @clicker.click(x: 10, y: 5)
+          clicker.click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 160,155/)
         end
 
         it 'should offset outside from center of element' do
-          @clicker.click(x: -65, y: -60)
+          clicker.click(x: -65, y: -60)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.click
+          clicker.click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
     end
+
+    context 'delay', requires: [:js] do
+      it 'should delay the mouse up' do
+        @session.visit('with_js')
+        @session.find(:css, '#click-test').click(delay: 2)
+        delay = @session.evaluate_script('window.click_delay')
+        expect(delay).to be >= 2
+      end
+    end
   end
 
   describe '#double_click', requires: [:js] do
@@ -891,7 +903,10 @@ Capybara::SpecHelper.spec 'node' do
     context 'offset', requires: [:js] do
       before do
         @session.visit('/offset')
-        @clicker = @session.find(:id, 'clicker')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
       end
 
       context 'when w3c_click_offset is false' do
@@ -900,17 +915,17 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from top left of element' do
-          @clicker.double_click(x: 10, y: 5)
+          clicker.double_click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 110,105/)
         end
 
         it 'should offset outside the element' do
-          @clicker.double_click(x: -15, y: -10)
+          clicker.double_click(x: -15, y: -10)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.double_click
+          clicker.double_click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
@@ -921,17 +936,17 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from center of element' do
-          @clicker.double_click(x: 10, y: 5)
+          clicker.double_click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 160,155/)
         end
 
         it 'should offset outside from center of element' do
-          @clicker.double_click(x: -65, y: -60)
+          clicker.double_click(x: -65, y: -60)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.double_click
+          clicker.double_click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
@@ -974,7 +989,10 @@ Capybara::SpecHelper.spec 'node' do
     context 'offset', requires: [:js] do
       before do
         @session.visit('/offset')
-        @clicker = @session.find(:id, 'clicker')
+      end
+
+      let :clicker do
+        @session.find(:id, 'clicker')
       end
 
       context 'when w3c_click_offset is false' do
@@ -983,17 +1001,17 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from top left of element' do
-          @clicker.right_click(x: 10, y: 5)
+          clicker.right_click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 110,105/)
         end
 
         it 'should offset outside the element' do
-          @clicker.right_click(x: -15, y: -10)
+          clicker.right_click(x: -15, y: -10)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.right_click
+          clicker.right_click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
@@ -1004,21 +1022,30 @@ Capybara::SpecHelper.spec 'node' do
         end
 
         it 'should offset from center of element' do
-          @clicker.right_click(x: 10, y: 5)
+          clicker.right_click(x: 10, y: 5)
           expect(@session).to have_text(/clicked at 160,155/)
         end
 
         it 'should offset outside from center of element' do
-          @clicker.right_click(x: -65, y: -60)
+          clicker.right_click(x: -65, y: -60)
           expect(@session).to have_text(/clicked at 85,90/)
         end
 
         it 'should default to click the middle' do
-          @clicker.right_click
+          clicker.right_click
           expect(@session).to have_text(/clicked at 150,150/)
         end
       end
     end
+
+    context 'delay', requires: [:js] do
+      it 'should delay the mouse up' do
+        @session.visit('with_js')
+        @session.find(:css, '#click-test').right_click(delay: 2)
+        delay = @session.evaluate_script('window.right_click_delay')
+        expect(delay).to be >= 2
+      end
+    end
   end
 
   describe '#send_keys', requires: [:send_keys] do