capybara 3.30.0 → 3.31.0

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

@@ -96,7 +96,7 @@ private
 
   def execute_cdp(cmd, params = {})
     if browser.respond_to? :execute_cdp
-      browser.execute_cdp(cmd, params)
+      browser.execute_cdp(cmd, **params)
     else
       args = { cmd: cmd, params: params }
       result = bridge.http.call(:post, "session/#{bridge.session_id}/goog/cdp/execute", args)

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

@@ -4,25 +4,32 @@ class Capybara::Selenium::Node
   module Html5Drag
     # Implement methods to emulate HTML5 drag and drop
 
-    def drag_to(element, html5: nil, delay: 0.05)
+    def drag_to(element, html5: nil, delay: 0.05, drop_modifiers: [])
+      drop_modifiers = Array(drop_modifiers)
+
       driver.execute_script MOUSEDOWN_TRACKER
       scroll_if_needed { browser_action.click_and_hold(native).perform }
       html5 = !driver.evaluate_script(LEGACY_DRAG_CHECK, self) if html5.nil?
       if html5
-        perform_html5_drag(element, delay)
+        perform_html5_drag(element, delay, drop_modifiers)
       else
-        perform_legacy_drag(element)
+        perform_legacy_drag(element, drop_modifiers)
       end
     end
 
   private
 
-    def perform_legacy_drag(element)
-      element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    def perform_legacy_drag(element, drop_modifiers)
+      element.scroll_if_needed do
+        # browser_action.move_to(element.native).release.perform
+        keys_down = modifiers_down(browser_action, drop_modifiers)
+        keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)
+        keys_up.perform
+      end
     end
 
-    def perform_html5_drag(element, delay)
-      driver.evaluate_async_script HTML5_DRAG_DROP_SCRIPT, self, element, delay * 1000
+    def perform_html5_drag(element, delay, drop_modifiers)
+      driver.evaluate_async_script HTML5_DRAG_DROP_SCRIPT, self, element, delay * 1000, normalize_keys(drop_modifiers)
       browser_action.release.perform
     end
 
@@ -153,6 +160,14 @@ class Capybara::Selenium::Node
         var targetRect = target.getBoundingClientRect();
         var sourceCenter = rectCenter(source.getBoundingClientRect());
 
+        for (var i = 0; i < drop_modifier_keys.length; i++) {
+          key = drop_modifier_keys[i];
+          if (key == "control"){
+            key = "ctrl"
+          }
+          opts[key + 'Key'] = true;
+        }
+
         // fire 2 dragover events to simulate dragging with a direction
         var entryPoint = pointOnRect(sourceCenter, targetRect)
         var dragOverOpts = Object.assign({clientX: entryPoint.x, clientY: entryPoint.y}, opts);
@@ -185,7 +200,8 @@ class Capybara::Selenium::Node
       var source = arguments[0],
           target = arguments[1],
           step_delay = arguments[2],
-          callback = arguments[3];
+          drop_modifier_keys = arguments[3],
+          callback = arguments[4];
 
       var dt = new DataTransfer();
       var opts = { cancelable: true, bubbles: true, dataTransfer: dt };

data/lib/capybara/selenium/node.rb

@@ -78,6 +78,8 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
         set_datetime_local(value)
       when 'color'
         set_color(value)
+      when 'range'
+        set_range(value)
       else
         set_text(value, **options)
       end
@@ -134,11 +136,17 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     scroll_if_needed { browser_action.move_to(native).perform }
   end
 
-  def drag_to(element, **)
+  def drag_to(element, drop_modifiers: [], **)
+    drop_modifiers = Array(drop_modifiers)
     # 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 }
+    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    element.scroll_if_needed do
+      keys_down = modifiers_down(browser_action, drop_modifiers)
+      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)
+      keys_up.perform
+    end
   end
 
   def drop(*_)
@@ -290,6 +298,10 @@ private
     update_value_js(value)
   end
 
+  def set_range(value) # rubocop:disable Naming/AccessorMethodName
+    update_value_js(value)
+  end
+
   def update_value_js(value)
     driver.execute_script(<<-JS, self, value)
       if (arguments[0].readOnly) { return };
@@ -375,10 +387,12 @@ private
 
   def modifiers_down(actions, keys)
     each_key(keys) { |key| actions.key_down(key) }
+    actions
   end
 
   def modifiers_up(actions, keys)
     each_key(keys) { |key| actions.key_up(key) }
+    actions
   end
 
   def browser
@@ -393,18 +407,21 @@ private
     browser.action
   end
 
-  def each_key(keys)
-    keys.each do |key|
-      key = case key
+  def normalize_keys(keys)
+    keys.map do |key|
+      case key
       when :ctrl then :control
       when :command, :cmd then :meta
       else
         key
       end
-      yield key
     end
   end
 
+  def each_key(keys)
+    normalize_keys(keys).each { |key| yield(key) }
+  end
+
   def find_context
     native
   end

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

@@ -18,7 +18,7 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set
     if browser_version >= 75.0
       driver.execute_script(<<~JS, self)
-        if (arguments[0].multiple && (arguments[0].files.length > 0)){
+        if (arguments[0].multiple && arguments[0].files.length){
           arguments[0].value = null;
         }
       JS
@@ -75,9 +75,11 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
 
 private
 
-  def perform_legacy_drag(element)
+  def perform_legacy_drag(element, drop_modifiers)
     return super if chromedriver_fixed_actions_key_state? || !w3c? || element.obscured?
 
+    raise ArgumentError, 'Modifier keys are not supported while dragging in this version of Chrome.' unless drop_modifiers.empty?
+
     # W3C Chrome/chromedriver < 77 doesn't maintain mouse button state across actions API performs
     # https://bugs.chromium.org/p/chromedriver/issues/detail?id=2981
     browser_action.release.perform

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

@@ -18,7 +18,7 @@ class Capybara::Selenium::EdgeNode < Capybara::Selenium::Node
     # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set
     if chrome_edge?
       driver.execute_script(<<~JS, self)
-        if (arguments[0].multiple && (arguments[0].files.length > 0)){
+        if (arguments[0].multiple && arguments[0].files.length){
           arguments[0].value = null;
         }
       JS

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

@@ -26,7 +26,7 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
     # By default files are appended so we have to clear here if its multiple and already set
     driver.execute_script(<<~JS, self)
-      if (arguments[0].multiple && (arguments[0].files.length > 0)){
+      if (arguments[0].multiple && arguments[0].files.length){
         arguments[0].value = null;
       }
     JS

data/lib/capybara/session.rb

@@ -338,8 +338,8 @@ module Capybara
     #
     # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires
     #
-    def within(*args)
-      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args)
+    def within(*args, **kw_args)
+      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)
       begin
         scopes.push(new_scope)
         yield if block_given?
@@ -423,8 +423,8 @@ module Capybara
     #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element
     # @overload within_frame(index)
     #   @param [Integer] index         index of a frame (0 based)
-    def within_frame(*args)
-      switch_to_frame(_find_frame(*args))
+    def within_frame(*args, **kw_args)
+      switch_to_frame(_find_frame(*args, **kw_args))
       begin
         yield if block_given?
       ensure
@@ -746,15 +746,32 @@ module Capybara
     end
 
     NODE_METHODS.each do |method|
-      define_method method do |*args, &block|
-        @touched = true
-        current_scope.send(method, *args, &block)
+      if RUBY_VERSION >= '2.7'
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          def #{method}(...)
+            @touched = true
+            current_scope.#{method}(...)
+          end
+        METHOD
+      else
+        define_method method do |*args, &block|
+          @touched = true
+          current_scope.send(method, *args, &block)
+        end
       end
     end
 
     DOCUMENT_METHODS.each do |method|
-      define_method method do |*args, &block|
-        document.send(method, *args, &block)
+      if RUBY_VERSION >= '2.7'
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          def #{method}(...)
+            document.#{method}(...)
+          end
+        METHOD
+      else
+        define_method method do |*args, &block|
+          document.send(method, *args, &block)
+        end
       end
     end
 
@@ -873,16 +890,14 @@ module Capybara
       uri.port ||= @server.port if @server && config.always_include_port
     end
 
-    def _find_frame(*args)
-      return find(:frame) if args.length.zero?
-
+    def _find_frame(*args, **kw_args)
       case args[0]
       when Capybara::Node::Element
         args[0]
-      when String, Hash
-        find(:frame, *args)
+      when String, nil
+        find(:frame, *args, **kw_args)
       when Symbol
-        find(*args)
+        find(*args, **kw_args)
       when Integer
         idx = args[0]
         all(:frame, minimum: idx + 1)[idx]

data/lib/capybara/spec/public/test.js

@@ -1,15 +1,40 @@
 var activeRequests = 0;
 $(function() {
   $('#change').text('I changed it');
-  $('#drag, #drag_scroll, #drag_link').draggable();
+  $('#drag, #drag_scroll, #drag_link').draggable({
+    start: function(event, ui){
+      $(document.body).append(
+        "<div class='drag_start'>Dragged!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "") +
+          "</div>"
+      );
+    }
+  });
   $('#drop, #drop_scroll').droppable({
     tolerance: 'touch',
     drop: function(event, ui) {
       ui.draggable.remove();
-      $(this).html('Dropped!');
+      $(this).html(
+        "Dropped!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "")
+      );
     }
   });
   $('#drag_html5, #drag_html5_scroll').on('dragstart', function(ev){
+    $(document.body).append(
+        "<div class='drag_start'>HTML5 Dragged!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "") +
+          "</div>"
+    );
     ev.originalEvent.dataTransfer.setData("text", ev.target.id);
   });
   $('#drag_html5, #drag_html5_scroll').on('dragend', function(ev){
@@ -38,10 +63,19 @@ $(function() {
           $(this).append('HTML5 Dropped file: ' + file.name);
         } else {
           var _this = this;
-          var callback = (function(type){
-            return function(s){
-              $(_this).append('HTML5 Dropped string: ' + type + ' ' + s)
-            }
+          var callback = (function(type) {
+            return function(s) {
+              $(_this).append(
+                "HTML5 Dropped string: " +
+                  type +
+                  " " +
+                  s +
+                  (ev.altKey ? "-alt" : "") +
+                  (ev.ctrlKey ? "-ctrl" : "") +
+                  (ev.metaKey ? "-meta" : "") +
+                  (ev.shiftKey ? "-shift" : "")
+              );
+            };
           })(item.type);
           item.getAsString(callback);
         }

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

@@ -47,6 +47,39 @@ Capybara::SpecHelper.spec '#all' do
     expect { @session.all('//p', schmoo: 'foo') }.to raise_error(ArgumentError)
   end
 
+  it 'should not reload by default', requires: [:driver] do
+    paras = @session.all(:css, 'p', minimum: 3)
+    expect { paras[0].text }.not_to raise_error
+    @session.refresh
+    expect { paras[0].text }.to raise_error do |err|
+      expect(err).to be_an_invalid_element_error(@session)
+    end
+  end
+
+  context 'with allow_reload' do
+    it 'should reload if true' do
+      paras = @session.all(:css, 'p', allow_reload: true, minimum: 3)
+      expect { paras[0].text }.not_to raise_error
+      @session.refresh
+      sleep 1 # Ensure page has started to reload
+      expect(paras[0]).to have_text('Lorem ipsum dolor')
+      expect(paras[1]).to have_text('Duis aute irure dolor')
+    end
+
+    it 'should not reload if false', requires: [:driver] do
+      paras = @session.all(:css, 'p', allow_reload: false, minimum: 3)
+      expect { paras[0].text }.not_to raise_error
+      @session.refresh
+      sleep 1 # Ensure page has started to reload
+      expect { paras[0].text }.to raise_error do |err|
+        expect(err).to be_an_invalid_element_error(@session)
+      end
+      expect { paras[2].text }.to raise_error do |err|
+        expect(err).to be_an_invalid_element_error(@session)
+      end
+    end
+  end
+
   context 'with css selectors' do
     it 'should find all elements using the given selector' do
       expect(@session.all(:css, 'h1').first.text).to eq('This is a test')
@@ -176,6 +209,13 @@ Capybara::SpecHelper.spec '#all' do
           expect { @session.all(:css, 'h1, p', between: 5..) }.to raise_error(Capybara::ExpectationNotMet)
         end
       TEST
+
+      eval <<~TEST, binding, __FILE__, __LINE__ + 1 if RUBY_VERSION.to_f > 2.6
+        it'treats a beginless range as maximum' do
+          expect { @session.all(:css, 'h1, p', between: ..7) }.not_to raise_error
+          expect { @session.all(:css, 'h1, p', between: ..3) }.to raise_error(Capybara::ExpectationNotMet)
+        end
+      TEST
     end
 
     context 'with multiple count filters' do
@@ -184,7 +224,7 @@ Capybara::SpecHelper.spec '#all' do
               minimum: 5,
               maximum: 0,
               between: 0..3 }
-        expect { @session.all(:css, 'h1, p', o) }.not_to raise_error
+        expect { @session.all(:css, 'h1, p', **o) }.not_to raise_error
       end
 
       context 'with no :count expectation' do
@@ -192,28 +232,28 @@ Capybara::SpecHelper.spec '#all' do
           o = { minimum: 5,
                 maximum: 4,
                 between: 2..7 }
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
 
         it 'fails if :maximum is not met' do
           o = { minimum: 0,
                 maximum: 0,
                 between: 2..7 }
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
 
         it 'fails if :between is not met' do
           o = { minimum: 0,
                 maximum: 4,
                 between: 0..3 }
-          expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
+          expect { @session.all(:css, 'h1, p', **o) }.to raise_error(Capybara::ExpectationNotMet)
         end
 
         it 'succeeds if all combineable expectations are met' do
           o = { minimum: 0,
                 maximum: 4,
                 between: 2..7 }
-          expect { @session.all(:css, 'h1, p', o) }.not_to raise_error
+          expect { @session.all(:css, 'h1, p', **o) }.not_to raise_error
         end
       end
     end

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

@@ -157,7 +157,7 @@ Capybara::SpecHelper.spec '#assert_text' do
             minimum: 6,
             maximum: 0,
             between: 0..4 }
-      expect { @session.assert_text('Header', o) }.not_to raise_error
+      expect { @session.assert_text('Header', **o) }.not_to raise_error
     end
 
     context 'with no :count expectation' do
@@ -165,28 +165,28 @@ Capybara::SpecHelper.spec '#assert_text' do
         o = { minimum: 6,
               maximum: 5,
               between: 2..7 }
-        expect { @session.assert_text('Header', o) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.assert_text('Header', **o) }.to raise_error(Capybara::ExpectationNotMet)
       end
 
       it 'fails if :maximum is not met' do
         o = { minimum: 0,
               maximum: 0,
               between: 2..7 }
-        expect { @session.assert_text('Header', o) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.assert_text('Header', **o) }.to raise_error(Capybara::ExpectationNotMet)
       end
 
       it 'fails if :between is not met' do
         o = { minimum: 0,
               maximum: 5,
               between: 0..4 }
-        expect { @session.assert_text('Header', o) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.assert_text('Header', **o) }.to raise_error(Capybara::ExpectationNotMet)
       end
 
       it 'succeeds if all combineable expectations are met' do
         o = { minimum: 0,
               maximum: 5,
               between: 2..7 }
-        expect { @session.assert_text('Header', o) }.not_to raise_error
+        expect { @session.assert_text('Header', **o) }.not_to raise_error
       end
     end
   end