capybara 3.32.0 → 3.35.0

data/lib/capybara/selector/builders/xpath_builder.rb

@@ -15,6 +15,8 @@ module Capybara
       def add_attribute_conditions(**conditions)
         @expression = conditions.inject(expression) do |xp, (name, value)|
           conditions = name == :class ? class_conditions(value) : attribute_conditions(name => value)
+          return xp if conditions.nil?
+
           if xp.is_a? XPath::Expression
             xp[conditions]
           else
@@ -47,7 +49,7 @@ module Capybara
         when XPath::Expression, Regexp
           attribute_conditions(class: classes)
         else
-          Array(classes).map do |klass|
+          Array(classes).reject { |c| c.is_a? Regexp }.map do |klass|
             if klass.match?(/^!(?!!!)/)
               !XPath.attr(:class).contains_word(klass.slice(1..-1))
             else

data/lib/capybara/selector/definition.rb

@@ -10,11 +10,12 @@ module Capybara
   class Selector
     class Definition
       attr_reader :name, :expressions
+
       extend Forwardable
 
       def initialize(name, locator_type: nil, raw_locator: false, supports_exact: nil, &block)
         @name = name
-        @filter_set = Capybara::Selector::FilterSet.add(name) {}
+        @filter_set = Capybara::Selector::FilterSet.add(name)
         @match = nil
         @label = nil
         @failure_message = nil
@@ -82,7 +83,7 @@ module Capybara
       # Automatic selector detection
       #
       # @yield [locator]                   This block takes the passed in locator string and returns whether or not it matches the selector
-      # @yieldparam [String], locator      The locator string used to determin if it matches the selector
+      # @yieldparam [String], locator      The locator string used to determine if it matches the selector
       # @yieldreturn [Boolean]             Whether this selector matches the locator string
       # @return [#call]                    The block that will be used to detect selector match
       #
@@ -177,7 +178,7 @@ module Capybara
       def_delegator :@filter_set, :describe
 
       def describe_expression_filters(&block)
-        if block_given?
+        if block
           describe(:expression_filters, &block)
         else
           describe(:expression_filters) do |**options|
@@ -189,7 +190,7 @@ module Capybara
       def describe_all_expression_filters(**opts)
         expression_filters.map do |ef_name, ef|
           if ef.matcher?
-            handled_custom_keys(ef, opts.keys).map { |key| " with #{ef_name}[#{key} => #{opts[key]}]" }.join
+            handled_custom_options(ef, opts).map { |option, value| " with #{ef_name}[#{option} => #{value}]" }.join
           elsif opts.key?(ef_name)
             " with #{ef_name} #{opts[ef_name]}"
           end
@@ -214,7 +215,7 @@ module Capybara
       end
 
       def default_visibility(fallback = Capybara.ignore_hidden_elements, options = {})
-        vis = if @default_visibility&.respond_to?(:call)
+        vis = if @default_visibility.respond_to?(:call)
           @default_visibility.call(options)
         else
           @default_visibility
@@ -251,14 +252,15 @@ module Capybara
 
     private
 
-      def handled_custom_keys(filter, keys)
-        keys.select do |key|
-          filter.handles_option?(key) && !::Capybara::Queries::SelectorQuery::VALID_KEYS.include?(key)
+      def handled_custom_options(filter, options)
+        options.select do |option, _|
+          filter.handles_option?(option) && !::Capybara::Queries::SelectorQuery::VALID_KEYS.include?(option)
         end
       end
 
       def parameter_names(block)
-        block.parameters.select { |(type, _name)| %i[key keyreq].include? type }.map { |(_type, name)| name }
+        key_types = %i[key keyreq]
+        block.parameters.select { |(type, _name)| key_types.include? type }.map { |(_type, name)| name }
       end
 
       def expression(type, allowed_filters, &block)

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

@@ -4,30 +4,30 @@ Capybara.add_selector(:button, locator_type: [String, Symbol]) do
   xpath(:value, :title, :type, :name) do |locator, **options|
     input_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')]
     btn_xpath = XPath.descendant(:button)
+    aria_btn_xpath = XPath.descendant[XPath.attr(:role).equals('button')]
     image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type) == 'image']
 
     unless locator.nil?
       locator = locator.to_s
-      locator_matchers = XPath.attr(:id).equals(locator) |
-                         XPath.attr(:name).equals(locator) |
-                         XPath.attr(:value).is(locator) |
-                         XPath.attr(:title).is(locator)
-      locator_matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label
-      locator_matchers |= XPath.attr(test_id) == locator if test_id
+      locator_matchers = combine_locators(locator, config: self)
+      btn_matchers = locator_matchers |
+                     XPath.string.n.is(locator) |
+                     XPath.descendant(:img)[XPath.attr(:alt).is(locator)]
 
-      input_btn_xpath = input_btn_xpath[locator_matchers]
-
-      btn_xpath = btn_xpath[locator_matchers |
-                            XPath.string.n.is(locator) |
-                            XPath.descendant(:img)[XPath.attr(:alt).is(locator)]]
+      input_btn_xpath = input_btn_xpath[locator_matchers] + locate_label(locator).descendant(input_btn_xpath)
+      btn_xpath = btn_xpath[btn_matchers] + locate_label(locator).descendant(btn_xpath)
+      aria_btn_xpath = aria_btn_xpath[btn_matchers]
 
       alt_matches = XPath.attr(:alt).is(locator)
       alt_matches |= XPath.attr(:'aria-label').is(locator) if enable_aria_label
-      image_btn_xpath = image_btn_xpath[alt_matches]
+      image_btn_xpath = image_btn_xpath[alt_matches] + locate_label(locator).descendant(image_btn_xpath)
     end
 
-    %i[value title type].inject(input_btn_xpath.union(btn_xpath).union(image_btn_xpath)) do |memo, ef|
-      memo[find_by_attr(ef, options[ef])]
+    btn_xpaths = [input_btn_xpath, btn_xpath, image_btn_xpath]
+    btn_xpaths << aria_btn_xpath if enable_aria_role
+
+    %i[value title type].inject(btn_xpaths.inject(&:union)) do |memo, ef|
+      memo.where(find_by_attr(ef, options[ef]))
     end
   end
 
@@ -48,4 +48,16 @@ Capybara.add_selector(:button, locator_type: [String, Symbol]) do
   describe_node_filters do |disabled: nil, **|
     ' that is disabled' if disabled == true
   end
+
+  def combine_locators(locator, config:)
+    [
+      XPath.attr(:id).equals(locator),
+      XPath.attr(:name).equals(locator),
+      XPath.attr(:value).is(locator),
+      XPath.attr(:title).is(locator),
+      (XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)),
+      (XPath.attr(:'aria-label').is(locator) if config.enable_aria_label),
+      (XPath.attr(test_id) == locator if config.test_id)
+    ].compact.inject(&:|)
+  end
 end

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

@@ -3,7 +3,7 @@
 Capybara.add_selector(:css, locator_type: [String, Symbol], raw_locator: true) do
   css do |css|
     if css.is_a? Symbol
-      warn "DEPRECATED: Passing a symbol (#{css.inspect}) as the CSS locator is deprecated - please pass a string instead."
+      Capybara::Helpers.warn "DEPRECATED: Passing a symbol (#{css.inspect}) as the CSS locator is deprecated - please pass a string instead : #{Capybara::Helpers.filter_backtrace(caller)}"
     end
     css
   end

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

@@ -19,7 +19,7 @@ Capybara.add_selector(:datalist_input, locator_type: [String, Symbol]) do
 
   expression_filter(:with_options) do |expr, options|
     options.inject(expr) do |xpath, option|
-      xpath[XPath.attr(:list) == XPath.anywhere(:datalist)[expression_for(:datalist_option, option)].attr(:id)]
+      xpath.where(XPath.attr(:list) == XPath.anywhere(:datalist)[expression_for(:datalist_option, option)].attr(:id))
     end
   end
 

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

@@ -18,7 +18,8 @@ Capybara.add_selector(:element, locator_type: [String, Symbol]) do
   end
 
   describe_expression_filters do |**options|
-    booleans, values = options.partition { |_k, v| [true, false].include? v }.map(&:to_h)
+    boolean_values = [true, false]
+    booleans, values = options.partition { |_k, v| boolean_values.include? v }.map(&:to_h)
     desc = describe_all_expression_filters(**values)
     desc + booleans.map do |k, v|
       v ? " with #{k} attribute" : "without #{k} attribute"

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

@@ -18,7 +18,7 @@ Capybara.add_selector(:fillable_field, locator_type: [String, Symbol]) do
     end
   end
 
-  filter_set(:_field, %i[disabled multiple name placeholder valid])
+  filter_set(:_field, %i[disabled multiple name placeholder valid validation_message])
 
   node_filter(:with) do |node, with|
     val = node.value

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

@@ -53,7 +53,7 @@ Capybara.add_selector(:label, locator_type: [String, Symbol]) do
     end
   end
   describe_node_filters do |**options|
-    " for element #{options[:for]}" if options[:for]&.is_a?(Capybara::Node::Element)
+    " for element #{options[:for]}" if options[:for].is_a?(Capybara::Node::Element)
   end
 
   def labelable_elements

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

@@ -5,6 +5,13 @@ Capybara.add_selector(:link, locator_type: [String, Symbol]) do
     xpath = XPath.descendant(:a)
     xpath = builder(xpath).add_attribute_conditions(href: href) unless href == false
 
+    if enable_aria_role
+      role_path = XPath.descendant[XPath.attr(:role).equals('link')]
+      role_path = builder(role_path).add_attribute_conditions(href: href) unless [true, false].include? href
+
+      xpath += role_path
+    end
+
     unless locator.nil?
       locator = locator.to_s
       matchers = [XPath.attr(:id) == locator,
@@ -18,6 +25,7 @@ Capybara.add_selector(:link, locator_type: [String, Symbol]) do
 
     xpath = xpath[find_by_attr(:title, title)]
     xpath = xpath[XPath.descendant(:img)[XPath.attr(:alt) == alt]] if alt
+
     xpath
   end
 

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

@@ -33,7 +33,7 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
 
   expression_filter(:with_options) do |expr, options|
     options.inject(expr) do |xpath, option|
-      xpath[expression_for(:option, option)]
+      xpath.where(expression_for(:option, option))
     end
   end
 

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

@@ -43,7 +43,7 @@ Capybara.add_selector(:table, locator_type: [String, Symbol]) do
   end
 
   expression_filter(:cols, valid_values: [Array]) do |xpath, cols|
-    raise ArgumentError, ':cols must be an Array of Arrays' unless cols.all? { |col| col.is_a? Array }
+    raise ArgumentError, ':cols must be an Array of Arrays' unless cols.all?(Array)
 
     rows = cols.transpose
     col_conditions = rows.map { |row| match_row(row, match_size: true) }.reduce(:&)

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

@@ -9,12 +9,12 @@ Capybara.add_selector(:table_row, locator_type: [Array, Hash]) do
         cell_xp = XPath.descendant(:td)[
           XPath.string.n.is(cell) & XPath.position.equals(header_xp.preceding_sibling.count.plus(1))
         ]
-        xp[cell_xp]
+        xp.where(cell_xp)
       end
     else
       initial_td = XPath.descendant(:td)[XPath.string.n.is(locator.shift)]
       tds = locator.reverse.map { |cell| XPath.following_sibling(:td)[XPath.string.n.is(cell)] }
-                   .reduce { |xp, cell| xp[cell] }
+                   .reduce { |xp, cell| xp.where(cell) }
       xpath[initial_td[tds]]
     end
   end

data/lib/capybara/selector/filter_set.rb

@@ -12,7 +12,7 @@ module Capybara
         @node_filters = {}
         @expression_filters = {}
         @descriptions = Hash.new { |hsh, key| hsh[key] = [] }
-        instance_eval(&block)
+        instance_eval(&block) if block
       end
 
       def node_filter(names, *types, **options, &block)
@@ -49,7 +49,7 @@ module Capybara
       end
 
       def descriptions
-        warn 'DEPRECATED: FilterSet#descriptions is deprecated without replacement'
+        Capybara::Helpers.warn 'DEPRECATED: FilterSet#descriptions is deprecated without replacement'
         [undeclared_descriptions, node_filter_descriptions, expression_filter_descriptions].flatten
       end
 

data/lib/capybara/selector/selector.rb

@@ -48,6 +48,10 @@ module Capybara
       @config[:enable_aria_label]
     end
 
+    def enable_aria_role
+      @config[:enable_aria_role]
+    end
+
     def test_id
       @config[:test_id]
     end
@@ -128,7 +132,11 @@ module Capybara
       attr_matchers |= XPath.attr(test_id) == locator if test_id
 
       locate_xpath = locate_xpath[attr_matchers]
-      locate_xpath + XPath.descendant(:label)[XPath.string.n.is(locator)].descendant(xpath)
+      locate_xpath + locate_label(locator).descendant(xpath)
+    end
+
+    def locate_label(locator)
+      XPath.descendant(:label)[XPath.string.n.is(locator)]
     end
 
     def find_by_attr(attribute, value)

data/lib/capybara/selenium/atoms/src/isDisplayed.js

@@ -158,7 +158,7 @@
       // the overflow style of the body, and the body is really overflow:visible.
       var overflowElem = e;
       if (htmlOverflowStyle == "visible") {
-        // Note: bodyElem will be null/undefined in SVG documents.
+        // NOTE: bodyElem will be null/undefined in SVG documents.
         if (e == htmlElem && bodyElem) {
           overflowElem = bodyElem;
         } else if (e == bodyElem) {

data/lib/capybara/selenium/driver.rb

@@ -12,20 +12,44 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     clear_session_storage: nil
   }.freeze
   SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout native_displayed].freeze
+  CAPS_VERSION = Gem::Requirement.new('~> 4.0.0.alpha6')
+
   attr_reader :app, :options
 
   class << self
+    attr_reader :selenium_webdriver_version
+
     def load_selenium
       require 'selenium-webdriver'
       require 'capybara/selenium/logger_suppressor'
       require 'capybara/selenium/patches/atoms'
       require 'capybara/selenium/patches/is_displayed'
       require 'capybara/selenium/patches/action_pauser'
-      if Gem.loaded_specs['selenium-webdriver'].version < Gem::Version.new('3.5.0')
+
+      # Look up the version of `selenium-webdriver` to
+      # see if it's a version we support.
+      #
+      # By default, we use Gem.loaded_specs to determine
+      # the version number. However, in some cases, such
+      # as when loading `selenium-webdriver` outside of
+      # Rubygems, we fall back to referencing
+      # Selenium::WebDriver::VERSION. Ideally we'd
+      # use the constant in all cases, but earlier versions
+      # of `selenium-webdriver` didn't provide the constant.
+      @selenium_webdriver_version =
+        if Gem.loaded_specs['selenium-webdriver']
+          Gem.loaded_specs['selenium-webdriver'].version
+        else
+          Gem::Version.new(Selenium::WebDriver::VERSION)
+        end
+
+      unless Gem::Requirement.new('>= 3.5.0').satisfied_by? @selenium_webdriver_version
         warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade."
       end
+
+      @selenium_webdriver_version
     rescue LoadError => e
-      raise e unless e.message.match?(/selenium-webdriver/)
+      raise e unless e.message.include?('selenium-webdriver')
 
       raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
     end
@@ -49,7 +73,15 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
         end
       end
       processed_options = options.reject { |key, _val| SPECIAL_OPTIONS.include?(key) }
-      @browser = Selenium::WebDriver.for(options[:browser], processed_options)
+
+      @browser = if options[:browser] == :firefox &&
+                    RUBY_VERSION >= '3.0' &&
+                    Capybara::Selenium::Driver.selenium_webdriver_version <= Gem::Version.new('4.0.0.alpha1')
+        # selenium-webdriver 3.x doesn't correctly pass options through for Firefox with Ruby 3 so workaround that
+        Selenium::WebDriver::Firefox::Driver.new(**processed_options)
+      else
+        Selenium::WebDriver.for(options[:browser], processed_options)
+      end
 
       specialize_driver
       setup_exit_handler
@@ -58,6 +90,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def initialize(app, **options)
+    super()
     self.class.load_selenium
     @app = app
     @browser = nil
@@ -85,6 +118,8 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def html
     browser.page_source
+  rescue Selenium::WebDriver::Error::JavascriptError => e
+    raise unless e.message.include?('documentElement is null')
   end
 
   def title
@@ -113,6 +148,10 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     unwrap_script_result(result)
   end
 
+  def send_keys(*args)
+    active_element.send_keys(*args)
+  end
+
   def save_screenshot(path, **_options)
     browser.save_screenshot(path)
   end
@@ -241,7 +280,8 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def quit
     @browser&.quit
-  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED # rubocop:disable Lint/SuppressedException
+  rescue Selenium::WebDriver::Error::SessionNotCreatedError, Errno::ECONNREFUSED,
+         Selenium::WebDriver::Error::InvalidSessionIdError
     # Browser must have already gone
   rescue Selenium::WebDriver::Error::UnknownError => e
     unless silenced_unknown_error_message?(e.message) # Most likely already gone
@@ -293,7 +333,7 @@ private
   def clear_browser_state
     delete_all_cookies
     clear_storage
-  rescue *clear_browser_state_errors # rubocop:disable Lint/SuppressedException
+  rescue *clear_browser_state_errors
     # delete_all_cookies fails when we've previously gone
     # to about:blank, so we rescue this error and do nothing
     # instead.
@@ -317,7 +357,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/SuppressedException
+  rescue Selenium::WebDriver::Error::JavascriptError
     # session/local storage may not be available if on non-http pages (e.g. about:blank)
   end
 
@@ -353,7 +393,7 @@ private
     @browser.navigate.to(url)
     sleep 0.1 # slight wait for alert
     @browser.switch_to.alert.accept
-  rescue modal_error # rubocop:disable Lint/SuppressedException
+  rescue modal_error
     # alert now gone, should mean navigation happened
   end
 
@@ -435,6 +475,10 @@ private
     browser
   end
 
+  def active_element
+    browser.switch_to.active_element
+  end
+
   def build_node(native_node, initial_cache = {})
     ::Capybara::Selenium::Node.new(self, native_node, initial_cache)
   end

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?