capybara 3.29.0 → 3.31.0

data/lib/capybara/selector/definition/fillable_field.rb

@@ -6,7 +6,7 @@ Capybara.add_selector(:fillable_field, locator_type: [String, Symbol]) do
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input, :textarea)[
       !XPath.attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')
     ]
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   expression_filter(:type) do |expr, type|

data/lib/capybara/selector/definition/label.rb

@@ -2,7 +2,7 @@
 
 Capybara.add_selector(:label, locator_type: [String, Symbol]) do
   label 'label'
-  xpath(:for) do |locator, options|
+  xpath(:for) do |locator, **options|
     xpath = XPath.descendant(:label)
     unless locator.nil?
       locator_matchers = XPath.string.n.is(locator.to_s) | (XPath.attr(:id) == locator.to_s)
@@ -10,7 +10,9 @@ Capybara.add_selector(:label, locator_type: [String, Symbol]) do
       xpath = xpath[locator_matchers]
     end
     if options.key?(:for)
-      if (for_option = options[:for].is_a?(Capybara::Node::Element) ? options[:for][:id] : options[:for])
+      for_option = options[:for]
+      for_option = for_option[:id] if for_option.is_a?(Capybara::Node::Element)
+      if for_option && (for_option != '')
         with_attr = builder(XPath.self).add_attribute_conditions(for: for_option)
         wrapped = !XPath.attr(:for) &
                   builder(XPath.self.descendant(*labelable_elements)).add_attribute_conditions(id: for_option)

data/lib/capybara/selector/definition/radio_button.rb

@@ -6,7 +6,7 @@ Capybara.add_selector(:radio_button, locator_type: [String, Symbol]) do
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input)[
       XPath.attr(:type) == 'radio'
     ]
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   filter_set(:_field, %i[checked unchecked disabled name])
@@ -21,7 +21,7 @@ Capybara.add_selector(:radio_button, locator_type: [String, Symbol]) do
   describe_node_filters do |option: nil, with: nil, **|
     desc = +''
     desc << " with value #{option.inspect}" if option
-    desc << " with value #{with.inspec}" if with
+    desc << " with value #{with.inspect}" if with
     desc
   end
 end

data/lib/capybara/selector/definition/select.rb

@@ -5,22 +5,32 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
 
   xpath do |locator, **options|
     xpath = XPath.descendant(:select)
-    locate_field(xpath, locator, options)
+    locate_field(xpath, locator, **options)
   end
 
   filter_set(:_field, %i[disabled multiple name placeholder])
 
   node_filter(:options) do |node, options|
-    actual = if node.visible?
-      node.all(:xpath, './/option', wait: false).map(&:text)
-    else
-      node.all(:xpath, './/option', visible: false, wait: false).map { |option| option.text(:all) }
-    end
+    actual = options_text(node)
     (options.sort == actual.sort).tap do |res|
       add_error("Expected options #{options.inspect} found #{actual.inspect}") unless res
     end
   end
 
+  node_filter(:enabled_options) do |node, options|
+    actual = options_text(node) { |o| !o.disabled? }
+    (options.sort == actual.sort).tap do |res|
+      add_error("Expected enabled options #{options.inspect} found #{actual.inspect}") unless res
+    end
+  end
+
+  node_filter(:disabled_options) do |node, options|
+    actual = options_text(node, &:disabled?)
+    (options.sort == actual.sort).tap do |res|
+      add_error("Expected disabled options #{options.inspect} found #{actual.inspect}") unless res
+    end
+  end
+
   expression_filter(:with_options) do |expr, options|
     options.inject(expr) do |xpath, option|
       xpath[expression_for(:option, option)]
@@ -28,18 +38,14 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
   end
 
   node_filter(:selected) do |node, selected|
-    actual = node.all(:xpath, './/option', visible: false, wait: false)
-                 .select(&:selected?)
-                 .map { |option| option.text(:all) }
+    actual = options_text(node, visible: false, &:selected?)
     (Array(selected).sort == actual.sort).tap do |res|
       add_error("Expected #{selected.inspect} to be selected found #{actual.inspect}") unless res
     end
   end
 
   node_filter(:with_selected) do |node, selected|
-    actual = node.all(:xpath, './/option', visible: false, wait: false)
-                 .select(&:selected?)
-                 .map { |option| option.text(:all) }
+    actual = options_text(node, visible: false, &:selected?)
     (Array(selected) - actual).empty?.tap do |res|
       add_error("Expected at least #{selected.inspect} to be selected found #{actual.inspect}") unless res
     end
@@ -51,12 +57,25 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
     desc
   end
 
-  describe_node_filters do |options: nil, selected: nil, with_selected: nil, disabled: nil, **|
+  describe_node_filters do |
+    options: nil, disabled_options: nil, enabled_options: nil,
+    selected: nil, with_selected: nil,
+    disabled: nil, **|
     desc = +''
     desc << " with options #{options.inspect}" if options
+    desc << " with disabled options #{disabled_options.inspect}}" if disabled_options
+    desc << " with enabled options #{enabled_options.inspect}" if enabled_options
     desc << " with #{selected.inspect} selected" if selected
     desc << " with at least #{with_selected.inspect} selected" if with_selected
     desc << ' which is disabled' if disabled
     desc
   end
+
+  def options_text(node, **opts, &filter_block)
+    opts[:wait] = false
+    opts[:visible] = false unless node.visible?
+    node.all(:xpath, './/option', **opts, &filter_block).map do |o|
+      o.text((:all if opts[:visible] == false))
+    end
+  end
 end

data/lib/capybara/selector/definition/table.rb

@@ -19,7 +19,10 @@ Capybara.add_selector(:table, locator_type: [String, Symbol]) do
           header = XPath.descendant(:th)[XPath.string.n.is(header)]
           td = XPath.descendant(:tr)[header].descendant(:td)
           cell_condition = XPath.string.n.is(cell_str)
-          cell_condition &= prev_col_position?(XPath.ancestor(:table)[1].join(xp)) if xp
+          if xp
+            prev_cell = XPath.ancestor(:table)[1].join(xp)
+            cell_condition &= (prev_cell & prev_col_position?(prev_cell))
+          end
           td[cell_condition]
         end
       else
@@ -28,7 +31,7 @@ Capybara.add_selector(:table, locator_type: [String, Symbol]) do
 
           if prev_cell
             prev_cell = XPath.ancestor(:tr)[1].preceding_sibling(:tr).join(prev_cell)
-            cell_condition &= prev_col_position?(prev_cell)
+            cell_condition &= (prev_cell & prev_col_position?(prev_cell))
           end
 
           XPath.descendant(:td)[cell_condition]

data/lib/capybara/selector/filter_set.rb

@@ -15,15 +15,15 @@ module Capybara
         instance_eval(&block)
       end
 
-      def node_filter(names, *types_and_options, &block)
+      def node_filter(names, *types, **options, &block)
         Array(names).each do |name|
-          add_filter(name, Filters::NodeFilter, *types_and_options, &block)
+          add_filter(name, Filters::NodeFilter, *types, **options, &block)
         end
       end
       alias_method :filter, :node_filter
 
-      def expression_filter(name, *types_and_options, &block)
-        add_filter(name, Filters::ExpressionFilter, *types_and_options, &block)
+      def expression_filter(name, *types, **options, &block)
+        add_filter(name, Filters::ExpressionFilter, *types, **options, &block)
       end
 
       def describe(what = nil, &block)
@@ -42,9 +42,9 @@ module Capybara
       def description(node_filters: true, expression_filters: true, **options)
         opts = options_with_defaults(options)
         description = +''
-        description << undeclared_descriptions.map { |desc| desc.call(opts).to_s }.join
-        description << expression_filter_descriptions.map { |desc| desc.call(opts).to_s }.join if expression_filters
-        description << node_filter_descriptions.map { |desc| desc.call(opts).to_s }.join if node_filters
+        description << undeclared_descriptions.map { |desc| desc.call(**opts).to_s }.join
+        description << expression_filter_descriptions.map { |desc| desc.call(**opts).to_s }.join if expression_filters
+        description << node_filter_descriptions.map { |desc| desc.call(**opts).to_s }.join if node_filters
         description
       end
 
@@ -112,9 +112,11 @@ module Capybara
 
       def add_filter(name, filter_class, *types, matcher: nil, **options, &block)
         types.each { |type| options[type] = true }
-        raise 'ArgumentError', ':default option is not supported for filters with a :matcher option' if matcher && options[:default]
+        if matcher && options[:default]
+          raise 'ArgumentError', ':default option is not supported for filters with a :matcher option'
+        end
 
-        filter = filter_class.new(name, matcher, block, options)
+        filter = filter_class.new(name, matcher, block, **options)
         (filter_class <= Filters::ExpressionFilter ? @expression_filters : @node_filters)[name] = filter
       end
     end

data/lib/capybara/selector/filters/base.rb

@@ -48,7 +48,12 @@ module Capybara
 
         def apply(subject, name, value, skip_value, ctx)
           return skip_value if skip?(value)
-          raise ArgumentError, "Invalid value #{value.inspect} passed to #{self.class.name.split('::').last} #{name}#{" : #{@name}" if @name.is_a?(Regexp)}" unless valid_value?(value)
+
+          unless valid_value?(value)
+            raise ArgumentError,
+                  "Invalid value #{value.inspect} passed to #{self.class.name.split('::').last} #{name}" \
+                  "#{" : #{name}" if @name.is_a?(Regexp)}"
+          end
 
           if @block.arity == 2
             filter_context(ctx).instance_exec(subject, value, &@block)

data/lib/capybara/selector/filters/locator_filter.rb

@@ -7,7 +7,7 @@ module Capybara
     module Filters
       class LocatorFilter < NodeFilter
         def initialize(block, **options)
-          super(nil, nil, block, options)
+          super(nil, nil, block, **options)
         end
 
         def matches?(node, value, context = nil, exact:)

data/lib/capybara/selector/selector.rb

@@ -56,12 +56,14 @@ module Capybara
       if format
         raise ArgumentError, "Selector #{@name} does not support #{format}" unless expressions.key?(format)
 
-        instance_exec(locator, options, &expressions[format])
+        instance_exec(locator, **options, &expressions[format])
       else
         warn 'Selector has no format'
       end
     ensure
-      warn "Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. This will raise an error in a future version of Capybara." unless locator_valid?(locator)
+      unless locator_valid?(locator)
+        warn "Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. This will raise an error in a future version of Capybara."
+      end
     end
 
     def add_error(error_msg)

data/lib/capybara/selenium/driver.rb

@@ -20,7 +20,9 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       require 'capybara/selenium/logger_suppressor'
       require 'capybara/selenium/patches/atoms'
       require 'capybara/selenium/patches/is_displayed'
-      warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade." if Gem.loaded_specs['selenium-webdriver'].version < Gem::Version.new('3.5.0')
+      if Gem.loaded_specs['selenium-webdriver'].version < Gem::Version.new('3.5.0')
+        warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade."
+      end
     rescue LoadError => e
       raise e unless e.message.match?(/selenium-webdriver/)
 
@@ -143,7 +145,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
     switch_to_frame(:parent)
     begin
-      return frame.base.obscured?(x: x, y: y)
+      frame.base.obscured?(x: x, y: y)
     ensure
       switch_to_frame(frame)
     end
@@ -219,7 +221,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def accept_modal(_type, **options)
     yield if block_given?
-    modal = find_modal(options)
+    modal = find_modal(**options)
 
     modal.send_keys options[:with] if options[:with]
 
@@ -230,7 +232,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def dismiss_modal(_type, **options)
     yield if block_given?
-    modal = find_modal(options)
+    modal = find_modal(**options)
     message = modal.text
     modal.dismiss
     message
@@ -238,7 +240,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def quit
     @browser&.quit
-  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED # rubocop:disable Lint/HandleExceptions
+  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED # rubocop:disable Lint/SuppressedException
     # Browser must have already gone
   rescue Selenium::WebDriver::Error::UnknownError => e
     unless silenced_unknown_error_message?(e.message) # Most likely already gone
@@ -290,7 +292,7 @@ private
   def clear_browser_state
     delete_all_cookies
     clear_storage
-  rescue *clear_browser_state_errors # rubocop:disable Lint/HandleExceptions
+  rescue *clear_browser_state_errors # rubocop:disable Lint/SuppressedException
     # delete_all_cookies fails when we've previously gone
     # to about:blank, so we rescue this error and do nothing
     # instead.
@@ -314,7 +316,7 @@ private
   def clear_storage
     clear_session_storage unless options[:clear_session_storage] == false
     clear_local_storage unless options[:clear_local_storage] == false
-  rescue Selenium::WebDriver::Error::JavascriptError # rubocop:disable Lint/HandleExceptions
+  rescue Selenium::WebDriver::Error::JavascriptError # rubocop:disable Lint/SuppressedException
     # session/local storage may not be available if on non-http pages (e.g. about:blank)
   end
 
@@ -325,7 +327,9 @@ private
       begin
         @browser&.execute_script('window.sessionStorage.clear()')
       rescue # rubocop:disable Style/RescueStandardError
-        warn 'sessionStorage clear requested but is not supported by this driver' unless options[:clear_session_storage].nil?
+        unless options[:clear_session_storage].nil?
+          warn 'sessionStorage clear requested but is not supported by this driver'
+        end
       end
     end
   end
@@ -337,7 +341,9 @@ private
       begin
         @browser&.execute_script('window.localStorage.clear()')
       rescue # rubocop:disable Style/RescueStandardError
-        warn 'localStorage clear requested but is not supported by this driver' unless options[:clear_local_storage].nil?
+        unless options[:clear_local_storage].nil?
+          warn 'localStorage clear requested but is not supported by this driver'
+        end
       end
     end
   end
@@ -346,7 +352,7 @@ private
     @browser.navigate.to(url)
     sleep 0.1 # slight wait for alert
     @browser.switch_to.alert.accept
-  rescue modal_error # rubocop:disable Lint/HandleExceptions
+  rescue modal_error # rubocop:disable Lint/SuppressedException
     # alert now gone, should mean navigation happened
   end
 
@@ -378,7 +384,9 @@ private
         alert = @browser.switch_to.alert
         regexp = text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(text.to_s))
         matched = alert.text.match?(regexp)
-        raise Capybara::ModalNotFound, "Unable to find modal dialog with #{text} - found '#{alert.text}' instead." unless matched
+        unless matched
+          raise Capybara::ModalNotFound, "Unable to find modal dialog with #{text} - found '#{alert.text}' instead."
+        end
 
         alert
       end

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/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/HandleExceptions
+      rescue Selenium::WebDriver::Error::NoSuchAlertError # rubocop:disable Lint/SuppressedException
         # 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/HandleExceptions
+  rescue Capybara::ModalNotFound # rubocop:disable Lint/SuppressedException
     # No modal was opened - page has refreshed - ignore
   end
 

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);
@@ -166,17 +181,18 @@ class Capybara::Selenium::Node
         var dragOverOpts = Object.assign({clientX: targetCenter.x, clientY: targetCenter.y}, opts);
         var dragOverEvent = new DragEvent('dragover', dragOverOpts);
         target.dispatchEvent(dragOverEvent);
-        window.setTimeout(dragLeave, step_delay, dragOverEvent.defaultPrevented);
+        window.setTimeout(dragLeave, step_delay, dragOverEvent.defaultPrevented, dragOverOpts);
       }
 
-      function dragLeave(drop) {
-        var dragLeaveEvent = new DragEvent('dragleave', opts);
+      function dragLeave(drop, dragOverOpts) {
+        var dragLeaveOptions = Object.assign({}, opts, dragOverOpts);
+        var dragLeaveEvent = new DragEvent('dragleave', dragLeaveOptions);
         target.dispatchEvent(dragLeaveEvent);
         if (drop) {
-          var dropEvent = new DragEvent('drop', opts);
+          var dropEvent = new DragEvent('drop', dragLeaveOptions);
           target.dispatchEvent(dropEvent);
         }
-        var dragEndEvent = new DragEvent('dragend', opts);
+        var dragEndEvent = new DragEvent('dragend', dragLeaveOptions);
         source.dispatchEvent(dragEndEvent);
         callback.call(true);
       }
@@ -184,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 };