capybara 3.16.2 → 3.17.0

data/lib/capybara/rspec/matchers/base.rb

@@ -41,8 +41,8 @@ module Capybara
       class WrappedElementMatcher < Base
         def matches?(actual)
           element_matches?(wrap(actual))
-        rescue Capybara::ExpectationNotMet => err
-          @failure_message = err.message
+        rescue Capybara::ExpectationNotMet => e
+          @failure_message = e.message
           false
         end
 

data/lib/capybara/selector.rb

@@ -7,20 +7,28 @@ Capybara::Selector::FilterSet.add(:_field) do
   node_filter(:checked, :boolean) { |node, value| !(value ^ node.checked?) }
   node_filter(:unchecked, :boolean) { |node, value| (value ^ node.checked?) }
   node_filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }
-  node_filter(:multiple, :boolean) { |node, value| !(value ^ node.multiple?) }
 
   expression_filter(:name) { |xpath, val| xpath[XPath.attr(:name) == val] }
   expression_filter(:placeholder) { |xpath, val| xpath[XPath.attr(:placeholder) == val] }
+  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
+  expression_filter(:multiple) { |xpath, val| xpath[val ? XPath.attr(:multiple) : ~XPath.attr(:multiple)] }
 
-  describe(:node_filters) do |checked: nil, unchecked: nil, disabled: nil, multiple: nil, **|
+  describe(:expression_filters) do |name: nil, placeholder: nil, disabled: nil, multiple: nil, **|
+    desc = +''
+    desc << ' that is not disabled' if disabled == false
+    desc << " with name #{name}" if name
+    desc << " with placeholder #{placeholder}" if placeholder
+    desc << ' with the multiple attribute' if multiple == true
+    desc << ' without the multiple attribute' if multiple == false
+    desc
+  end
+
+  describe(:node_filters) do |checked: nil, unchecked: nil, disabled: nil, **|
     desc, states = +'', []
     states << 'checked' if checked || (unchecked == false)
     states << 'not checked' if unchecked || (checked == false)
     states << 'disabled' if disabled == true
-    states << 'not disabled' if disabled == false
     desc << " that is #{states.join(' and ')}" unless states.empty?
-    desc << ' with the multiple attribute' if multiple == true
-    desc << ' without the multiple attribute' if multiple == false
     desc
   end
 end
@@ -37,7 +45,7 @@ end
 
 Capybara.add_selector(:id, locator_type: [String, Symbol, Regexp]) do
   xpath { |id| builder(XPath.descendant).add_attribute_conditions(id: id) }
-  locator_filter {  |node, id| id.is_a?(Regexp) ? node[:id] =~ id : true }
+  locator_filter {  |node, id| id.is_a?(Regexp) ? id.match?(node[:id]) : true }
 end
 
 Capybara.add_selector(:field, locator_type: [String, Symbol]) do
@@ -63,16 +71,13 @@ Capybara.add_selector(:field, locator_type: [String, Symbol]) do
   node_filter(:readonly, :boolean) { |node, value| !(value ^ node.readonly?) }
   node_filter(:with) do |node, with|
     val = node.value
-    (with.is_a?(Regexp) ? val =~ with : val == with.to_s).tap do |res|
+    (with.is_a?(Regexp) ? with.match?(val) : val == with.to_s).tap do |res|
       add_error("Expected value to be #{with.inspect} but was #{val.inspect}") unless res
     end
   end
 
-  describe_expression_filters do |type: nil, **options|
-    desc = +''
-    (expression_filters.keys & options.keys).each { |ef| desc << " with #{ef} #{options[ef]}" }
-    desc << " of type #{type.inspect}" if type
-    desc
+  describe_expression_filters do |type: nil, **|
+    " of type #{type.inspect}" if type
   end
 
   describe_node_filters do |**options|
@@ -90,6 +95,7 @@ Capybara.add_selector(:fieldset, locator_type: [String, Symbol]) do
   end
 
   node_filter(:disabled, :boolean) { |node, value| !(value ^ node.disabled?) }
+  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
 end
 
 Capybara.add_selector(:link, locator_type: [String, Symbol]) do
@@ -123,26 +129,28 @@ Capybara.add_selector(:link, locator_type: [String, Symbol]) do
     builder(expr).add_attribute_conditions(download: download)
   end
 
-  describe_expression_filters do |**options|
+  describe_expression_filters do |download: nil, **options|
     desc = +''
     if (href = options[:href])
       desc << " with href #{'matching ' if href.is_a? Regexp}#{href.inspect}"
     elsif options.key?(:href) # is nil/false specified?
       desc << ' with no href attribute'
     end
+    desc << " with download attribute#{" #{download}" if download.is_a? String}" if download
+    desc << ' without download attribute' if download == false
     desc
   end
 end
 
 Capybara.add_selector(:button, locator_type: [String, Symbol]) do
-  xpath(:value, :title, :type) do |locator, **options|
+  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)
     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(:value).is(locator) | XPath.attr(:title).is(locator)
+      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
 
@@ -155,14 +163,20 @@ Capybara.add_selector(:button, locator_type: [String, Symbol]) do
       image_btn_xpath = image_btn_xpath[alt_matches]
     end
 
-    %i[value title type].inject(input_btn_xpath.union(btn_xpath).union(image_btn_xpath)) do |memo, ef|
+    %i[value title type name].inject(input_btn_xpath.union(btn_xpath).union(image_btn_xpath)) do |memo, ef|
       memo[find_by_attr(ef, options[ef])]
     end
   end
 
   node_filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }
+  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
+
+  describe_expression_filters do |disabled: nil, **options|
+    desc = +''
+    desc << ' that is not disabled' if disabled == false
+    desc << describe_all_expression_filters(options)
+  end
 
-  describe_expression_filters
   describe_node_filters do |disabled: nil, **|
     ' that is disabled' if disabled == true
   end
@@ -176,7 +190,7 @@ Capybara.add_selector(:link_or_button, locator_type: [String, Symbol]) do
     end.reduce(:union)
   end
 
-  node_filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| node.tag_name == 'a' || !(value ^ node.disabled?) }
+  node_filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }
 
   describe_node_filters do |disabled: nil, **|
     ' that is disabled' if disabled == true
@@ -205,12 +219,11 @@ Capybara.add_selector(:fillable_field, locator_type: [String, Symbol]) do
 
   node_filter(:with) do |node, with|
     val = node.value
-    (with.is_a?(Regexp) ? val =~ with : val == with.to_s).tap do |res|
+    (with.is_a?(Regexp) ? with.match?(val) : val == with.to_s).tap do |res|
       add_error("Expected value to be #{with.inspect} but was #{val.inspect}") unless res
     end
   end
 
-  describe_expression_filters
   describe_node_filters do |**options|
     " with value #{options[:with].to_s.inspect}" if options.key?(:with)
   end
@@ -234,7 +247,6 @@ Capybara.add_selector(:radio_button, locator_type: [String, Symbol]) do
     end
   end
 
-  describe_expression_filters
   describe_node_filters do |option: nil, **|
     " with value #{option.inspect}" if option
   end
@@ -257,7 +269,6 @@ Capybara.add_selector(:checkbox, locator_type: [String, Symbol]) do
     end
   end
 
-  describe_expression_filters
   describe_node_filters do |option: nil, **|
     " with value #{option.inspect}" if option
   end
@@ -304,18 +315,18 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
     end
   end
 
-  describe_expression_filters do |with_options: nil, **opts|
+  describe_expression_filters do |with_options: nil, **|
     desc = +''
     desc << " with at least options #{with_options.inspect}" if with_options
-    desc << describe_all_expression_filters(opts)
     desc
   end
 
-  describe_node_filters do |options: nil, selected: nil, with_selected: nil, **|
+  describe_node_filters do |options: nil, selected: nil, with_selected: nil, disabled: nil, **|
     desc = +''
     desc << " with options #{options.inspect}" if 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
 end
@@ -343,10 +354,9 @@ Capybara.add_selector(:datalist_input, locator_type: [String, Symbol]) do
     end
   end
 
-  describe_expression_filters do |with_options: nil, **opts|
+  describe_expression_filters do |with_options: nil, **|
     desc = +''
     desc << " with at least options #{with_options.inspect}" if with_options
-    desc << describe_all_expression_filters(opts)
     desc
   end
 
@@ -363,11 +373,19 @@ Capybara.add_selector(:option, locator_type: [String, Symbol]) do
   end
 
   node_filter(:disabled, :boolean) { |node, value| !(value ^ node.disabled?) }
+  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
+
   node_filter(:selected, :boolean) { |node, value| !(value ^ node.selected?) }
 
+  describe_expression_filters do |disabled: nil, **options|
+    desc = +''
+    desc << ' that is not disabled' if disabled == false
+    (expression_filters.keys & options.keys).inject(desc) { |memo, ef| memo << " with #{ef} #{options[ef]}" }
+  end
+
   describe_node_filters do |**options|
     desc = +''
-    desc << " that is#{' not' unless options[:disabled]} disabled" if options.key?(:disabled)
+    desc << ' that is disabled' if options[:disabled]
     desc << " that is#{' not' unless options[:selected]} selected" if options.key?(:selected)
     desc
   end
@@ -384,9 +402,16 @@ Capybara.add_selector(:datalist_option, locator_type: [String, Symbol]) do
   end
 
   node_filter(:disabled, :boolean) { |node, value| !(value ^ node.disabled?) }
+  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
+
+  describe_expression_filters do |disabled: nil, **options|
+    desc = +''
+    desc << ' that is not disabled' if disabled == false
+    desc << describe_all_expression_filters(options)
+  end
 
   describe_node_filters do |**options|
-    " that is#{' not' unless options[:disabled]} disabled" if options.key?(:disabled)
+    ' that is disabled' if options[:disabled]
   end
 end
 
@@ -400,8 +425,6 @@ Capybara.add_selector(:file_field, locator_type: [String, Symbol]) do
   end
 
   filter_set(:_field, %i[disabled multiple name])
-
-  describe_expression_filters
 end
 
 Capybara.add_selector(:label, locator_type: [String, Symbol]) do
@@ -595,7 +618,7 @@ Capybara.add_selector(:element, locator_type: [String, Symbol]) do
   node_filter(:attributes, matcher: /.+/) do |node, name, val|
     next true unless val.is_a?(Regexp)
 
-    (node[name] =~ val).tap do |res|
+    (val.match? node[name]).tap do |res|
       add_error("Expected #{name} to match #{val.inspect} but it was #{node[name]}") unless res
     end
   end

data/lib/capybara/selector/css.rb

@@ -6,7 +6,7 @@ module Capybara
       def self.escape(str)
         value = str.dup
         out = +''
-        out << value.slice!(0...1) if value =~ /^[-_]/
+        out << value.slice!(0...1) if value.match?(/^[-_]/)
         out << (value[0].match?(NMSTART) ? value.slice!(0...1) : escape_char(value.slice!(0...1)))
         out << value.gsub(/[^a-zA-Z0-9_-]/) { |char| escape_char char }
         out

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

@@ -34,7 +34,7 @@ module Capybara
 
         def handles_option?(option_name)
           if matcher?
-            option_name =~ @matcher
+            @matcher.match? option_name
           else
             @name == option_name
           end

data/lib/capybara/selector/selector.rb

@@ -59,6 +59,7 @@ module Capybara
   #     * Locator: Matches the id, Capybara.test_id attribute, value, or title attributes, string content of a button, or the alt attribute of an image type button or of a descendant image of a button
   #     * Filters:
   #       * :id (String, Regexp, XPath::Expression) — Matches the id attribute
+  #       * :name (String) - Matches the name attribute
   #       * :title (String) — Matches the title attribute
   #       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
   #       * :value (String) — Matches the value of an input button

data/lib/capybara/selenium/driver.rb

@@ -14,17 +14,27 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   SPECIAL_OPTIONS = %i[browser clear_local_storage clear_session_storage timeout].freeze
   attr_reader :app, :options
 
-  def self.load_selenium
-    require 'selenium-webdriver'
-    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')
-  rescue LoadError => err
-    raise err if err.message !~ /selenium-webdriver/
+  class << self
+    def load_selenium
+      require 'selenium-webdriver'
+      require 'capybara/selenium/logger_suppressor'
+      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')
+    rescue LoadError => e
+      raise e unless e.message.match?(/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
+
+    attr_reader :specializations
 
-    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."
+    def register_specialization(browser_name, specialization)
+      @specializations ||= {}
+      @specializations[browser_name] = specialization
+    end
   end
 
   def browser
-    @browser ||= begin
+    unless @browser
       options[:http_client] ||= begin
         require 'capybara/selenium/patches/persistent_client'
         if options[:timeout]
@@ -34,10 +44,10 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
         end
       end
       processed_options = options.reject { |key, _val| SPECIAL_OPTIONS.include?(key) }
-      Selenium::WebDriver.for(options[:browser], processed_options).tap do |driver|
-        specialize_driver(driver)
-        setup_exit_handler
-      end
+      @browser = Selenium::WebDriver.for(options[:browser], processed_options)
+
+      specialize_driver
+      setup_exit_handler
     end
     @browser
   end
@@ -115,7 +125,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       navigated = true
       # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload
       wait_for_empty_page(timer)
-    rescue Selenium::WebDriver::Error::UnhandledAlertError, Selenium::WebDriver::Error::UnexpectedAlertOpenError
+    rescue *unhandled_alert_errors
       # This error is thrown if an unhandled alert is on the page
       # Firefox appears to automatically dismiss this alert, chrome does not
       # We'll try to accept it
@@ -226,19 +236,27 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def invalid_element_errors
-    [
-      ::Selenium::WebDriver::Error::StaleElementReferenceError,
-      ::Selenium::WebDriver::Error::UnhandledError,
-      ::Selenium::WebDriver::Error::ElementNotVisibleError,
-      ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around a chromedriver go_back/go_forward race condition
-      ::Selenium::WebDriver::Error::ElementNotInteractableError,
-      ::Selenium::WebDriver::Error::ElementClickInterceptedError,
-      ::Selenium::WebDriver::Error::InvalidElementStateError,
-      ::Selenium::WebDriver::Error::ElementNotSelectableError,
-      ::Selenium::WebDriver::Error::ElementNotSelectableError,
-      ::Selenium::WebDriver::Error::NoSuchElementError, # IE
-      ::Selenium::WebDriver::Error::InvalidArgumentError # IE
-    ]
+    @invalid_element_errors ||= begin
+      [
+        ::Selenium::WebDriver::Error::StaleElementReferenceError,
+        ::Selenium::WebDriver::Error::ElementNotInteractableError,
+        ::Selenium::WebDriver::Error::InvalidSelectorError, # Work around chromedriver go_back/go_forward race condition
+        ::Selenium::WebDriver::Error::ElementClickInterceptedError,
+        ::Selenium::WebDriver::Error::NoSuchElementError, # IE
+        ::Selenium::WebDriver::Error::InvalidArgumentError # IE
+      ].tap do |errors|
+        unless selenium_4?
+          ::Selenium::WebDriver.logger.suppress_deprecations do
+            errors.concat [
+              ::Selenium::WebDriver::Error::UnhandledError,
+              ::Selenium::WebDriver::Error::ElementNotVisibleError,
+              ::Selenium::WebDriver::Error::InvalidElementStateError,
+              ::Selenium::WebDriver::Error::ElementNotSelectableError
+            ]
+          end
+        end
+      end
+    end
   end
 
   def no_such_window_error
@@ -247,6 +265,10 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
 private
 
+  def selenium_4?
+    defined?(Selenium::WebDriver::VERSION) && (Selenium::WebDriver::VERSION.to_f >= 4)
+  end
+
   def native_args(args)
     args.map { |arg| arg.is_a?(Capybara::Selenium::Node) ? arg.native : arg }
   end
@@ -254,12 +276,32 @@ private
   def clear_browser_state
     delete_all_cookies
     clear_storage
-  rescue Selenium::WebDriver::Error::UnhandledError # rubocop:disable Lint/HandleExceptions
+  rescue *clear_browser_state_errors # rubocop:disable Lint/HandleExceptions
     # delete_all_cookies fails when we've previously gone
     # to about:blank, so we rescue this error and do nothing
     # instead.
   end
 
+  def clear_browser_state_errors
+    @clear_browser_state_errors ||= [Selenium::WebDriver::Error::UnknownError].tap do |errors|
+      unless selenium_4?
+        ::Selenium::WebDriver.logger.suppress_deprecations do
+          errors << Selenium::WebDriver::Error::UnhandledError
+        end
+      end
+    end
+  end
+
+  def unhandled_alert_errors
+    @unhandled_alert_errors ||= [Selenium::WebDriver::Error::UnexpectedAlertOpenError].tap do |errors|
+      unless selenium_4?
+        ::Selenium::WebDriver.logger.suppress_deprecations do
+          errors << Selenium::WebDriver::Error::UnhandledAlertError
+        end
+      end
+    end
+  end
+
   def delete_all_cookies
     @browser.manage.delete_all_cookies
   end
@@ -332,13 +374,23 @@ private
         regexp = text.is_a?(Regexp) ? text : Regexp.escape(text.to_s)
         alert.text.match?(regexp) ? alert : nil
       end
-    rescue Selenium::WebDriver::Error::TimeOutError
+    rescue *find_modal_errors
       raise Capybara::ModalNotFound, "Unable to find modal dialog#{" with #{text}" if text}"
     end
   end
 
+  def find_modal_errors
+    @find_modal_errors ||= [Selenium::WebDriver::Error::TimeoutError].tap do |errors|
+      unless selenium_4?
+        ::Selenium::WebDriver.logger.suppress_deprecations do
+          errors << Selenium::WebDriver::Error::TimeOutError
+        end
+      end
+    end
+  end
+
   def silenced_unknown_error_message?(msg)
-    silenced_unknown_error_messages.any? { |regex| msg =~ regex }
+    silenced_unknown_error_messages.any? { |regex| msg.match? regex }
   end
 
   def silenced_unknown_error_messages
@@ -366,24 +418,13 @@ private
     ::Capybara::Selenium::Node.new(self, native_node, initial_cache)
   end
 
-  def specialize_driver(sel_driver)
-    case sel_driver.browser
-    when :chrome
-      extend ChromeDriver
-    when :firefox
-      require 'capybara/selenium/patches/pause_duration_fix' if pause_broken?(sel_driver)
-      extend FirefoxDriver if sel_driver.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
-    when :ie, :internet_explorer
-      extend InternetExplorerDriver
-    when :safari, :Safari_Technology_Preview
-      extend SafariDriver
+  def specialize_driver
+    browser_type = browser.browser
+    self.class.specializations.select { |k, _v| k === browser_type }.each_value do |specialization| # rubocop:disable Style/CaseEquality
+      extend specialization
     end
   end
 
-  def pause_broken?(driver)
-    driver.capabilities['moz:geckodriverVersion']&.start_with?('0.22.')
-  end
-
   def setup_exit_handler
     main = Process.pid
     at_exit do