capybara 3.3.1 → 3.4.0

data/lib/capybara/selector/selector.rb

@@ -19,7 +19,7 @@ module Capybara
   #     * Locator: The id of the element to match
   #
   #   * **:field** - Select field elements (input [not of type submit, image, or hidden], textarea, select)
-  #     * Locator: Matches against the id, name, or placeholder
+  #     * Locator: Matches against the id, Capybara.test_id attribute, name, or placeholder
   #     * Filters:
   #       * :id (String) — Matches the id attribute
   #       * :name (String) — Matches the name attribute
@@ -50,7 +50,7 @@ module Capybara
   #       * :href (String, Regexp, nil) — Matches the normalized href of the link, if nil will find <a> elements with no href attribute
   #
   #   * **:button** - Find buttons ( input [of type submit, reset, image, button] or button elements )
-  #     * Locator: Matches the id, 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
+  #     * 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) — Matches the id attribute
   #       * :title (String) — Matches the title attribute
@@ -62,7 +62,7 @@ module Capybara
   #     * Locator: See :link and :button selectors
   #
   #   * **:fillable_field** - Find text fillable fields ( textarea, input [not of type submit, image, radio, checkbox, hidden, file] )
-  #     * Locator: Matches against the id, name, or placeholder
+  #     * Locator: Matches against the id, Capybara.test_id attribute, name, or placeholder
   #     * Filters:
   #       * :id (String) — Matches the id attribute
   #       * :name (String) — Matches the name attribute
@@ -74,7 +74,7 @@ module Capybara
   #       * :multiple (Boolean) — Match fields that accept multiple values
   #
   #   * **:radio_button** - Find radio buttons
-  #     * Locator: Match id, name, or associated label text
+  #     * Locator: Match id, Capybara.test_id attribute, name, or associated label text
   #     * Filters:
   #       * :id (String) — Matches the id attribute
   #       * :name (String) — Matches the name attribute
@@ -85,7 +85,7 @@ module Capybara
   #       * :option (String) — Match the value
   #
   #   * **:checkbox** - Find checkboxes
-  #     * Locator: Match id, name, or associated label text
+  #     * Locator: Match id, Capybara.test_id attribute, name, or associated label text
   #     * Filters:
   #       * *:id (String) — Matches the id attribute
   #       * *:name (String) — Matches the name attribute
@@ -96,7 +96,7 @@ module Capybara
   #       * *:option (String) — Match the value
   #
   #   * **:select** - Find select elements
-  #     * Locator: Match id, name, placeholder, or associated label text
+  #     * Locator: Match id, Capybara.test_id attribute, name, placeholder, or associated label text
   #     * Filters:
   #       * :id (String) — Matches the id attribute
   #       * :name (String) — Matches the name attribute
@@ -126,7 +126,7 @@ module Capybara
   #     * Locator:
   #
   #   * **:file_field** - Find file input elements
-  #     * Locator: Match id, name, or associated label text
+  #     * Locator: Match id, Capybara.test_id attribute, name, or associated label text
   #     * Filters:
   #       * :id (String) — Matches the id attribute
   #       * :name (String) — Matches the name attribute
@@ -190,6 +190,10 @@ module Capybara
       @expression = nil
       @expression_filters = {}
       @default_visibility = nil
+      @config = {
+        enable_aria_label: false,
+        test_id: nil
+      }
       instance_eval(&block)
     end
 
@@ -287,11 +291,12 @@ module Capybara
     #   @return [String]                 Description of the selector when used with the options passed
     def_delegator :@filter_set, :description
 
-    def call(locator, **options)
+    def call(locator, selector_config: {}, **options)
+      @config.merge! selector_config
       if format
         @expression.call(locator, options)
       else
-        warn "Selector has no format"
+        warn 'Selector has no format'
       end
     end
 
@@ -349,15 +354,25 @@ module Capybara
     def_delegators :@filter_set, :node_filter, :expression_filter, :filter
 
     def filter_set(name, filters_to_use = nil)
-      f_set = FilterSet.all[name]
-      filter_selector = filters_to_use.nil? ? ->(*) { true } : ->(n, _) { filters_to_use.include? n }
-      @filter_set.expression_filters.merge!(f_set.expression_filters.select(&filter_selector))
-      @filter_set.node_filters.merge!(f_set.node_filters.select(&filter_selector))
-      f_set.descriptions.each { |desc| @filter_set.describe(&desc) }
+      @filter_set.import(name, filters_to_use)
     end
 
     def_delegator :@filter_set, :describe
 
+    def describe_expression_filters(&block)
+      if block_given?
+        describe(:expression_filters, &block)
+      else
+        describe(:expression_filters) do |**options|
+          describe_all_expression_filters(options)
+        end
+      end
+    end
+
+    def describe_node_filters(&block)
+      describe(:node_filters, &block)
+    end
+
     ##
     #
     # Set the default visibility mode that shouble be used if no visibile option is passed when using the selector.
@@ -378,7 +393,15 @@ module Capybara
 
   private
 
-    def locate_field(xpath, locator, enable_aria_label: false, **_options)
+    def enable_aria_label
+      @config[:enable_aria_label]
+    end
+
+    def test_id
+      @config[:test_id]
+    end
+
+    def locate_field(xpath, locator, **_options)
       return xpath if locator.nil?
       locate_xpath = xpath # Need to save original xpath for the label wrap
       locator = locator.to_s
@@ -387,6 +410,7 @@ module Capybara
                        XPath.attr(:placeholder) == locator,
                        XPath.attr(:id) == XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for)].reduce(:|)
       attr_matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label
+      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)

data/lib/capybara/selenium/driver.rb

@@ -14,7 +14,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   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')
+    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 if e.message !~ /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."
@@ -99,7 +99,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def evaluate_script(script, *args)
-    result = execute_script("return #{script}", *args)
+    result = execute_script("return #{script.strip}", *args)
     unwrap_script_result(result)
   end
 
@@ -135,12 +135,12 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
           # to about:blank, so we rescue this error and do nothing
           # instead.
         end
-        @browser.navigate.to("about:blank")
+        @browser.navigate.to('about:blank')
       end
       navigated = true
 
       # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload
-      until find_xpath("/html/body/*").empty?
+      until find_xpath('/html/body/*').empty?
         raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?
         sleep 0.05
       end
@@ -153,11 +153,11 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
         sleep 0.25 # allow time for the modal to be handled
       rescue modal_error
         # The alert is now gone
-        if current_url != "about:blank"
+        if current_url != 'about:blank'
           begin
             # If navigation has not occurred attempt again and accept alert
             # since FF may have dismissed the alert at first attempt
-            @browser.navigate.to("about:blank")
+            @browser.navigate.to('about:blank')
             sleep 0.1 # slight wait for alert
             @browser.switch_to.alert.accept
           rescue modal_error # rubocop:disable Metrics/BlockNesting, Lint/HandleExceptions
@@ -219,7 +219,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def close_window(handle)
-    raise ArgumentError, "Not allowed to close the primary window" if handle == window_handles.first
+    raise ArgumentError, 'Not allowed to close the primary window' if handle == window_handles.first
     within_given_window(handle) do
       browser.close
     end
@@ -328,15 +328,15 @@ private
       if @browser.respond_to? :session_storage
         @browser.session_storage.clear
       else
-        warn "sessionStorage clear requested but is not available for this driver"
+        warn 'sessionStorage clear requested but is not available for this driver'
       end
     end
 
-    if options[:clear_local_storage]
+    if options[:clear_local_storage] # rubocop:disable Style/GuardClause
       if @browser.respond_to? :local_storage
         @browser.local_storage.clear
       else
-        warn "localStorage clear requested but is not available for this driver"
+        warn 'localStorage clear requested but is not available for this driver'
       end
     end
   end

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

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'capybara/selenium/nodes/chrome_node'
+
 module Capybara::Selenium::Driver::ChromeDriver
   def fullscreen_window(handle)
     within_given_window(handle) do
@@ -32,4 +34,10 @@ module Capybara::Selenium::Driver::ChromeDriver
     window_handles.slice(1..-1).each { |win| close_window(win) }
     super
   end
+
+private
+
+  def build_node(native_node)
+    ::Capybara::Selenium::ChromeNode.new(self, native_node)
+  end
 end

data/lib/capybara/selenium/node.rb

@@ -6,11 +6,11 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def all_text
-    text = driver.execute_script("return arguments[0].textContent", self)
+    text = driver.execute_script('return arguments[0].textContent', self)
     text.gsub(/[\u200b\u200e\u200f]/, '')
         .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
-        .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
-        .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+        .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
+        .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
         .tr("\u00a0", ' ')
   end
 
@@ -21,8 +21,8 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def value
-    if tag_name == "select" && multiple?
-      native.find_elements(:css, "option:checked").map { |n| n[:value] || n.text }
+    if tag_name == 'select' && multiple?
+      native.find_elements(:css, 'option:checked').map { |n| n[:value] || n.text }
     else
       native[:value]
     end
@@ -78,7 +78,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def unselect_option
-    raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box." unless select_node.multiple?
+    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?
     native.click if selected?
   end
 
@@ -142,8 +142,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   def disabled?
     return true unless native.enabled?
     # WebDriver only defines `disabled?` for form controls but fieldset makes sense too
-    return boolean_attr(self[:disabled]) if tag_name == 'fieldset'
-    false
+    tag_name == 'fieldset' && find_xpath('ancestor-or-self::fieldset[@disabled]').any?
   end
 
   def content_editable?
@@ -192,7 +191,7 @@ private
   end
 
   def boolean_attr(val)
-    val && (val != "false")
+    val && (val != 'false')
   end
 
   # a reference to the select node if this is an option node
@@ -206,7 +205,7 @@ private
     elsif clear == :backspace
       # Clear field by sending the correct number of backspace keys.
       backspaces = [:backspace] * self.value.to_s.length
-      native.send_keys(*(backspaces + [value.to_s]))
+      native.send_keys(*([:end] + backspaces + [value.to_s]))
     elsif clear == :none
       native.send_keys(value.to_s)
     elsif clear.is_a? Array

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

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
+  def set_file(value) # rubocop:disable Naming/AccessorMethodName
+    super(value)
+  rescue ::Selenium::WebDriver::Error::ExpectedError => e
+    if e.message =~ /File not found : .+\n.+/m
+      raise ArgumentError, "Selenium with remote Chrome doesn't currently support multiple file upload"
+    end
+    raise
+  end
+
+private
+
+  def bridge
+    driver.browser.send(:bridge)
+  end
+end

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

@@ -4,28 +4,53 @@ class Capybara::Selenium::MarionetteNode < Capybara::Selenium::Node
   def click(keys = [], **options)
     super
   rescue ::Selenium::WebDriver::Error::ElementNotInteractableError
-    if tag_name == "tr"
-      warn "You are attempting to click a table row which has issues in geckodriver/marionette - see https://github.com/mozilla/geckodriver/issues/1228. " \
-           "Your test should probably be clicking on a table cell like a user would. Clicking the first cell in the row instead."
+    if tag_name == 'tr'
+      warn 'You are attempting to click a table row which has issues in geckodriver/marionette - see https://github.com/mozilla/geckodriver/issues/1228. ' \
+           'Your test should probably be clicking on a table cell like a user would. Clicking the first cell in the row instead.'
       return find_css('th:first-child,td:first-child')[0].click
     end
     raise
   end
 
   def disabled?
-    return true if super
+    # Not sure exactly what version of FF fixed the below issue, but it is definitely fixed in 61+
+    return super unless driver.browser.capabilities[:browser_version].to_f < 61.0
 
+    return true if super
     # workaround for selenium-webdriver/geckodriver reporting elements as enabled when they are nested in disabling elements
     if %w[option optgroup].include? tag_name
-      find_xpath("parent::*[self::optgroup or self::select]")[0].disabled?
+      find_xpath('parent::*[self::optgroup or self::select]')[0].disabled?
     else
-      !find_xpath("parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]").empty?
+      !find_xpath('parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]').empty?
     end
   end
 
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
     path_names = value.to_s.empty? ? [] : value
     native.clear
-    Array(path_names).each { |p| native.send_keys(p) }
+    Array(path_names).each do |path|
+      unless driver.browser.respond_to?(:upload)
+        if (fd = bridge.file_detector)
+          local_file = fd.call([path])
+          path = upload(local_file) if local_file
+        end
+      end
+      native.send_keys(path)
+    end
+  end
+
+private
+
+  def bridge
+    driver.browser.send(:bridge)
+  end
+
+  def upload(local_file)
+    unless File.file?(local_file)
+      raise Error::WebDriverError, "you may only upload files: #{local_file.inspect}"
+    end
+
+    result = bridge.http.call(:post, "session/#{bridge.session_id}/file", file: Selenium::WebDriver::Zipper.zip_file(local_file))
+    result['value']
   end
 end

data/lib/capybara/server.rb

@@ -18,7 +18,7 @@ module Capybara
     attr_reader :app, :port, :host
 
     def initialize(app, *deprecated_options, port: Capybara.server_port, host: Capybara.server_host, reportable_errors: Capybara.server_errors, extra_middleware: [])
-      warn "Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments" unless deprecated_options.empty?
+      warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments' unless deprecated_options.empty?
       @app = app
       @extra_middleware = extra_middleware
       @server_thread = nil # suppress warnings
@@ -56,7 +56,7 @@ module Capybara
     def wait_for_pending_requests
       timer = Capybara::Helpers.timer(expire_in: 60)
       while pending_requests?
-        raise "Requests did not finish in 60 seconds" if timer.expired?
+        raise 'Requests did not finish in 60 seconds' if timer.expired?
         sleep 0.01
       end
     end
@@ -71,7 +71,7 @@ module Capybara
 
         timer = Capybara::Helpers.timer(expire_in: 60)
         until responsive?
-          raise "Rack application timed out during boot" if timer.expired?
+          raise 'Rack application timed out during boot' if timer.expired?
           @server_thread.join(0.1)
         end
       end

data/lib/capybara/server/animation_disabler.rb

@@ -21,7 +21,7 @@ module Capybara
     private
 
       def html_content?
-        !!(@headers["Content-Type"] =~ /html/)
+        !!(@headers['Content-Type'] =~ /html/)
       end
 
       def insert_disable(html)

data/lib/capybara/server/middleware.rb

@@ -36,7 +36,7 @@ module Capybara
       end
 
       def call(env)
-        if env["PATH_INFO"] == "/__identify__"
+        if env['PATH_INFO'] == '/__identify__'
           [200, {}, [@app.object_id.to_s]]
         else
           @counter.increment

data/lib/capybara/session.rb

@@ -75,12 +75,12 @@ module Capybara
     attr_accessor :synchronized
 
     def initialize(mode, app = nil)
-      raise TypeError, "The second parameter to Session::new should be a rack app if passed." if app && !app.respond_to?(:call)
+      raise TypeError, 'The second parameter to Session::new should be a rack app if passed.' if app && !app.respond_to?(:call)
       @@instance_created = true
       @mode = mode
       @app = app
       if block_given?
-        raise "A configuration block is only accepted when Capybara.threadsafe == true" unless Capybara.threadsafe
+        raise 'A configuration block is only accepted when Capybara.threadsafe == true' unless Capybara.threadsafe
         yield config
       end
       @server = if config.run_server && @app && driver.needs_server?
@@ -141,7 +141,7 @@ module Capybara
       # Force an explanation for the error being raised as the exception cause
       begin
         if config.raise_server_errors
-          raise CapybaraError, "Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true"
+          raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'
         end
       rescue CapybaraError
         # needed to get the cause set correctly in JRuby -- otherwise we could just do raise @server.error
@@ -190,7 +190,7 @@ module Capybara
       uri = ::Addressable::URI.parse(current_url)
 
       # Addressable doesn't support opaque URIs - we want nil here
-      return nil if uri&.scheme == "about"
+      return nil if uri&.scheme == 'about'
 
       path = uri&.path
       path unless path&.empty?
@@ -383,7 +383,7 @@ module Capybara
       when :parent
         if scopes.last != :frame
           raise Capybara::ScopeError, "`switch_to_frame(:parent)` cannot be called from inside a descendant frame's "\
-                                      "`within` block."
+                                      '`within` block.'
         end
         scopes.pop
         driver.switch_to_frame(:parent)
@@ -392,11 +392,13 @@ module Capybara
         if idx
           if scopes.slice(idx..-1).any? { |scope| ![:frame, nil].include?(scope) }
             raise Capybara::ScopeError, "`switch_to_frame(:top)` cannot be called from inside a descendant frame's "\
-                                        "`within` block."
+                                        '`within` block.'
           end
           scopes.slice!(idx..-1)
           driver.switch_to_frame(:top)
         end
+      else
+        raise ArgumentError, 'You must provide a frame element, :parent, or :top when calling switch_to_frame'
       end
     end
 
@@ -408,7 +410,7 @@ module Capybara
     # @overload within_frame(element)
     #   @param [Capybara::Node::Element]  frame element
     # @overload within_frame([kind = :frame], locator, **options)
-    #   @param [Symbol] kind      Optional selector type (:css, :xpath, :field, etc.) - Defaults to :frame
+    #   @param [Symbol] kind      Optional selector type (:frame, :css, :xpath, etc.) - Defaults to :frame
     #   @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)
@@ -471,11 +473,11 @@ module Capybara
     # @raise [ArgumentError]               if both or neither arguments were provided
     #
     def switch_to_window(window = nil, **options, &window_locator)
-      raise ArgumentError, "`switch_to_window` can take either a block or a window, not both" if window && block_given?
-      raise ArgumentError, "`switch_to_window`: either window or block should be provided" if !window && !block_given?
+      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && block_given?
+      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !block_given?
       unless scopes.last.nil?
-        raise Capybara::ScopeError, "`switch_to_window` is not supposed to be invoked from "\
-                                    "`within` or `within_frame` blocks."
+        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from '\
+                                    '`within` or `within_frame` blocks.'
       end
 
       _switch_to_window(window, options, &window_locator)
@@ -512,7 +514,7 @@ module Capybara
         when Proc
           _switch_to_window { window_or_proc.call }
         else
-          raise ArgumentError("`#within_window` requires a `Capybara::Window` instance or a lambda")
+          raise ArgumentError('`#within_window` requires a `Capybara::Window` instance or a lambda')
         end
 
         begin
@@ -546,7 +548,7 @@ module Capybara
       document.synchronize(wait_time, errors: [Capybara::WindowError]) do
         opened_handles = (driver.window_handles - old_handles)
         if opened_handles.size != 1
-          raise Capybara::WindowError, "block passed to #window_opened_by "\
+          raise Capybara::WindowError, 'block passed to #window_opened_by '\
                                        "opened #{opened_handles.size} windows instead of 1"
         end
         Window.new(self, opened_handles.first)
@@ -774,7 +776,7 @@ module Capybara
     #  if set at initialization time, so look at the configuration block that can be passed to the initializer too
     #
     def configure
-      raise "Session configuration is only supported when Capybara.threadsafe == true" unless Capybara.threadsafe
+      raise 'Session configuration is only supported when Capybara.threadsafe == true' unless Capybara.threadsafe
       yield config
     end
 
@@ -813,7 +815,7 @@ module Capybara
     end
 
     def open_file(path)
-      require "launchy"
+      require 'launchy'
       Launchy.open(path)
     rescue LoadError
       warn "File saved to #{path}.\nPlease install the launchy gem to open the file automatically."
@@ -824,7 +826,7 @@ module Capybara
     end
 
     def default_fn(extension)
-      timestamp = Time.new.strftime("%Y%m%d%H%M%S")
+      timestamp = Time.new.strftime('%Y%m%d%H%M%S')
       "capybara-#{timestamp}#{rand(10**10)}.#{extension}"
     end
 
@@ -846,6 +848,8 @@ module Capybara
     end
 
     def _find_frame(*args)
+      return find(:frame) if args.length.zero?
+
       case args[0]
       when Capybara::Node::Element
         args[0]
@@ -862,8 +866,8 @@ module Capybara
     end
 
     def _switch_to_window(window = nil, **options)
-      raise Capybara::ScopeError, "Window cannot be switched inside a `within_frame` block" if scopes.include?(:frame)
-      raise Capybara::ScopeError, "Window cannot be switch inside a `within` block" unless scopes.last.nil?
+      raise Capybara::ScopeError, 'Window cannot be switched inside a `within_frame` block' if scopes.include?(:frame)
+      raise Capybara::ScopeError, 'Window cannot be switch inside a `within` block' unless scopes.last.nil?
 
       if window
         driver.switch_to_window(window.handle)
@@ -882,7 +886,7 @@ module Capybara
             raise e
           else
             driver.switch_to_window(original_window_handle)
-            raise Capybara::WindowError, "Could not find a window matching block/lambda"
+            raise Capybara::WindowError, 'Could not find a window matching block/lambda'
           end
         end
       end