capybara 3.10.1 → 3.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab5799591629ab7839ce7bd05f651e7ca3215e300bd1e6622130e01e0431ad86
-  data.tar.gz: b848caed06658e44c604d490eb26b4a5d313a5879c4deb6fc3f8d3ba2b784644
+  metadata.gz: 6c349d493d1d6639b40265451f5b357aa7b5d29d279e1095284071fba9bc8a59
+  data.tar.gz: 23350dd400ffd3e11fdda081f12331ab7518b94061fb104355e30cfbee0d9935
 SHA512:
-  metadata.gz: b74973ebd8ca32addec5f7aeb005ef022d6b2e9e5633203b51ccafa4608378121ad582eed792bd7de44496e2d9b8692a49b648575fe3b8ee399f4ca6515e3b22
-  data.tar.gz: ebb6f2aeb95d168e23d515d6d97e1af702d244c030a39ba7474a2dbd3a6bd954b70e29bacf31e7def0e9f66e5db8e53ae255709751e99431b869d5c2c84b0041
+  metadata.gz: caa9124c0465dcc82b15109c4cbd841dbc8e214ff87fd928a712abd6896155c6c8b3be00d0ec09cb1fbbea9da8206773b799766da5fd08ac9bc0a9d36d81dd85
+  data.tar.gz: 18b0c515e7be809183bc26d6d2ce38692561e30760b96a26992d44b96027484ae942f7c25e48b803323ef0534ca616fd20c503ec2cfefbf1da47416eb30b2443

data/History.md

@@ -1,3 +1,16 @@
+# Version 3.11.0
+Release date: 2018-11-14
+
+### Added
+
+* Ability for node filters to set detailed error messages
+* `Capybara::HTML` Will use `nokogumbo` for HTML parsing if installed
+* `Selector#locator_filter` added to allow for dynamic locator in selectors
+
+### Fixed
+
+* Node filters are evaluated in the context of the Selector they are used in to ensure the correct options are used
+
 # Version 3.10.1
 Release date: 2018-11-03
 

data/README.md

@@ -6,8 +6,7 @@
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jnicklas/capybara?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=capybara&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=capybara&package-manager=bundler&version-scheme=semver)
 
-**Note** You are viewing the README for the development version of Capybara.  If you are using the current release version
-you can find the README at https://github.com/teamcapybara/capybara/blob/3.10_stable/README.md
+**Note** You are viewing the README for the 3.11.0 version of Capybara.
 
 
 Capybara helps you test web applications by simulating how a real user would
@@ -409,7 +408,7 @@ and test server, see "Transactions and database setup" below.
 
 ### <a name="capybara-webkit"></a>Capybara-webkit
 
-Note: `capybara-webkit` depends on QtWebkit which went EOL quite some time ago. There has been an attempt to revive the project but `capybara-webkit` is not yet (AFAIK) compatible with the revived version of QtWebKit (could be a good OSS project for someone) and as such is still limited to an old version of QtWebKit.  This means its support for modern JS and CSS is severely limited. Y
+Note: `capybara-webkit` depends on QtWebkit which went EOL quite some time ago. There has been an attempt to revive the project but `capybara-webkit` is not yet (AFAIK) compatible with the revived version of QtWebKit (could be a good OSS project for someone) and as such is still limited to an old version of QtWebKit.  This means its support for modern JS and CSS is severely limited.
 
 The [capybara-webkit driver](https://github.com/thoughtbot/capybara-webkit) is for true headless
 testing. It uses QtWebKit to start a rendering engine process. It can execute JavaScript as well.

data/lib/capybara.rb

@@ -366,9 +366,18 @@ module Capybara
     # @return [Nokogiri::HTML::Document]      HTML document
     #
     def HTML(html) # rubocop:disable Naming/MethodName
-      Nokogiri::HTML(html).tap do |document|
-        document.xpath('//textarea').each do |textarea|
-          textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/, '')
+      if Nokogiri.respond_to?(:HTML5) # Nokogumbo installed
+        Nokogiri::HTML5(html).tap do |document|
+          document.xpath('//textarea').each do |textarea|
+            # The Nokogumbo HTML5 parser already returns spec compliant contents
+            textarea['_capybara_raw_value'] = textarea.content
+          end
+        end
+      else
+        Nokogiri::HTML(html).tap do |document|
+          document.xpath('//textarea').each do |textarea|
+            textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/, '')
+          end
         end
       end
     end
@@ -460,7 +469,8 @@ end
 
 Capybara.register_server :webrick do |app, port, host, **options|
   require 'rack/handler/webrick'
-  Rack::Handler::WEBrick.run(app, { Host: host, Port: port, AccessLog: [], Logger: WEBrick::Log.new(nil, 0) }.merge(options))
+  options = { Host: host, Port: port, AccessLog: [], Logger: WEBrick::Log.new(nil, 0) }.merge(options)
+  Rack::Handler::WEBrick.run(app, options)
 end
 
 Capybara.register_server :puma do |app, port, host, **options|
@@ -476,8 +486,8 @@ Capybara.register_server :puma do |app, port, host, **options|
   # If we just run the Puma Rack handler it installs signal handlers which prevent us from being able to interrupt tests.
   # Therefore construct and run the Server instance ourselves.
   # Rack::Handler::Puma.run(app, { Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false }.merge(options))
-
-  conf = Rack::Handler::Puma.config(app, { Host: host, Port: port, Threads: '0:4', workers: 0, daemon: false }.merge(options))
+  options = { Host: host, Port: port, Threads: '0:4', workers: 0, daemon: false }.merge(options)
+  conf = Rack::Handler::Puma.config(app, options)
   events = conf.options[:Silent] ? ::Puma::Events.strings : ::Puma::Events.stdio
 
   events.log 'Capybara starting Puma...'

data/lib/capybara/minitest.rb

@@ -42,12 +42,12 @@ module Capybara
       # @!method assert_no_current_path
       #   see {Capybara::SessionMatchers#assert_no_current_path}
 
-      %w[assert_text assert_no_text assert_title assert_no_title assert_current_path assert_no_current_path].each do |assertion_name|
+      %w[text no_text title no_title current_path no_current_path].each do |assertion_name|
         class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def #{assertion_name} *args
+          def assert_#{assertion_name} *args
             self.assertions +=1
             subject, args = determine_subject(args)
-            subject.#{assertion_name}(*args)
+            subject.assert_#{assertion_name}(*args)
           rescue Capybara::ExpectationNotMet => e
             raise ::Minitest::Assertion, e.message
           end
@@ -86,15 +86,14 @@ module Capybara
       # @!method assert_style
       #   see {Capybara::Node::Matchers#assert_style}
 
-      %w[assert_selector assert_no_selector
-         assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors
-         assert_matches_selector assert_not_matches_selector
-         assert_style].each do |assertion_name|
+      %w[selector no_selector style
+         all_of_selectors none_of_selectors any_of_selectors
+         matches_selector not_matches_selector].each do |assertion_name|
         class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def #{assertion_name} *args, &optional_filter_block
+          def assert_#{assertion_name} *args, &optional_filter_block
             self.assertions +=1
             subject, args = determine_subject(args)
-            subject.#{assertion_name}(*args, &optional_filter_block)
+            subject.assert_#{assertion_name}(*args, &optional_filter_block)
           rescue Capybara::ExpectationNotMet => e
             raise ::Minitest::Assertion, e.message
           end

data/lib/capybara/node/actions.rb

@@ -3,19 +3,20 @@
 module Capybara
   module Node
     module Actions
-      ##
-      #
-      # Finds a button or link and clicks it.  See {Capybara::Node::Actions#click_button} and
-      # {Capybara::Node::Actions#click_link} for what locator will match against for each type of element
       # @!macro waiting_behavior
-      #   If the driver is capable of executing JavaScript, +$0+ will wait for a set amount of time
+      #   If the driver is capable of executing JavaScript, this method will wait for a set amount of time
       #   and continuously retry finding the element until either the element is found or the time
       #   expires. The length of time +find+ will wait is controlled through {Capybara.default_max_wait_time}
       #
       #   @option options [false, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
+
+      ##
       #
-      # @overload click_link_or_button([locator], options)
+      # Finds a button or link and clicks it.  See {Capybara::Node::Actions#click_button} and
+      # {Capybara::Node::Actions#click_link} for what locator will match against for each type of element
       #
+      # @overload click_link_or_button([locator], **options)
+      #   @macro waiting_behavior
       #   @param [String] locator      See {Capybara::Node::Actions#click_button} and {Capybara::Node::Actions#click_link}
       #
       # @return [Capybara::Node::Element]  The element clicked
@@ -30,9 +31,8 @@ module Capybara
       # Finds a link by id, Capybara.test_id attribute, text or title and clicks it. Also looks at image
       # alt text inside the link.
       #
-      # @macro waiting_behavior
-      #
-      # @overload click_link([locator], options)
+      # @overload click_link([locator], **options)
+      #   @macro waiting_behavior
       #   @param [String] locator         text, id, Capybara.test_id attribute, title or nested image's alt attribute
       #   @param options                  See {Capybara::Node::Finders#find_link}
       #
@@ -48,9 +48,8 @@ module Capybara
       # \<button> element. All buttons can be found by their id, Capybara.test_id attribute, value, or title. \<button> elements can also be found
       # by their text content, and image \<input> elements by their alt attribute
       #
-      # @macro waiting_behavior
-      #
       # @overload click_button([locator], **options)
+      #   @macro waiting_behavior
       #   @param [String] locator      Which button to find
       #   @param options     See {Capybara::Node::Finders#find_button}
       # @return [Capybara::Node::Element]  The element clicked
@@ -78,10 +77,10 @@ module Capybara
       #   @macro waiting_behavior
       #   @option options [String] currently_with The current value property of the field to fill in
       #   @option options [Boolean] multiple      Match fields that can have multiple values?
-      #   @option options [String] id             Match fields that match the id attribute
+      #   @option options [String, Regexp] id             Match fields that match the id attribute
       #   @option options [String] name           Match fields that match the name attribute
       #   @option options [String] placeholder    Match fields that match the placeholder attribute
-      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
+      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided
       #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from Capybara.default_set_options)
       #
       # @return [Capybara::Node::Element]  The element filled_in
@@ -110,9 +109,9 @@ module Capybara
       #   @param [String] locator           Which radio button to choose
       #
       #   @option options [String] option  Value of the radio_button to choose
-      #   @option options [String] id             Match fields that match the id attribute
+      #   @option options [String, Regexp] id             Match fields that match the id attribute
       #   @option options [String] name           Match fields that match the name attribute
-      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
+      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided
       #   @macro waiting_behavior
       #   @macro label_click
       #
@@ -138,9 +137,9 @@ module Capybara
       #   @param [String] locator           Which check box to check
       #
       #   @option options [String] option  Value of the checkbox to select
-      #   @option options [String] id       Match fields that match the id attribute
+      #   @option options [String, Regexp] id       Match fields that match the id attribute
       #   @option options [String] name     Match fields that match the name attribute
-      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
+      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided
       #   @macro label_click
       #   @macro waiting_behavior
       #
@@ -166,9 +165,9 @@ module Capybara
       #   @param [String] locator           Which check box to uncheck
       #
       #   @option options [String] option  Value of the checkbox to deselect
-      #   @option options [String] id       Match fields that match the id attribute
+      #   @option options [String, Regexp] id       Match fields that match the id attribute
       #   @option options [String] name     Match fields that match the name attribute
-      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
+      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided
       #   @macro label_click
       #   @macro waiting_behavior
       #
@@ -188,10 +187,11 @@ module Capybara
       #
       #     page.select 'March', from: 'Month'
       #
-      # @macro waiting_behavior
+      # @overload select(value = nil, from: nil, **options)
+      #   @macro waiting_behavior
       #
-      # @param value [String] Which option to select
-      # @param from [String]  The id, Capybara.test_id atrtribute, name or label of the select box
+      #   @param value [String] Which option to select
+      #   @param from [String]  The id, Capybara.test_id atrtribute, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element selected
       def select(value = nil, from: nil, **options)
@@ -212,10 +212,12 @@ module Capybara
       #
       #     page.unselect 'March', from: 'Month'
       #
-      # @macro waiting_behavior
+      # @overload unselect(value = nil, from: nil, **options)
+      #   @macro waiting_behavior
+      #
+      #   @param value [String]     Which option to unselect
+      #   @param from [String]      The id, Capybara.test_id attribute, name or label of the select box
       #
-      # @param value [String]     Which option to unselect
-      # @param from [String]      The id, Capybara.test_id attribute, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element unselected
       def unselect(value = nil, from: nil, **options)
@@ -246,9 +248,9 @@ module Capybara
       #   @option options [Symbol] match (Capybara.match)     The matching strategy to use (:one, :first, :prefer_exact, :smart).
       #   @option options [Boolean] exact (Capybara.exact)    Match the exact label name/contents or accept a partial match.
       #   @option options [Boolean] multiple Match field which allows multiple file selection
-      #   @option options [String] id             Match fields that match the id attribute
+      #   @option options [String, Regexp] id             Match fields that match the id attribute
       #   @option options [String] name           Match fields that match the name attribute
-      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
+      #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided
       #   @option options [true, Hash] make_visible   A Hash of CSS styles to change before attempting to attach the file, if `true` { opacity: 1, display: 'block', visibility: 'visible' } is used (may not be supported by all drivers)
       #
       #   @return [Capybara::Node::Element]  The file field element
@@ -320,7 +322,8 @@ module Capybara
       rescue StandardError # rubocop:disable Lint/HandleExceptions swallow extra errors
       end
 
-      def _check_with_label(selector, checked, locator, allow_label_click: session_options.automatic_label_click, **options)
+      def _check_with_label(selector, checked, locator,
+                            allow_label_click: session_options.automatic_label_click, **options)
         options[:allow_self] = true if locator.nil?
 
         synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do

data/lib/capybara/node/base.rb

@@ -73,9 +73,10 @@ module Capybara
       # @return [Object]                  The result of the given block
       # @raise  [Capybara::FrozenInTime]  If the return value of `Time.now` appears stuck
       #
-      def synchronize(seconds = session_options.default_max_wait_time, errors: nil)
+      def synchronize(seconds = nil, errors: nil)
         return yield if session.synchronized
 
+        seconds = session_options.default_max_wait_time if seconds.nil?
         session.synchronized = true
         timer = Capybara::Helpers.timer(expire_in: seconds)
         begin

data/lib/capybara/node/document_matchers.rb

@@ -17,7 +17,9 @@ module Capybara
       # @return [true]
       #
       def assert_title(title, **options)
-        _verify_title(title, options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
+        _verify_title(title, options) do |query|
+          raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
+        end
       end
 
       ##
@@ -28,7 +30,9 @@ module Capybara
       # @return [true]
       #
       def assert_no_title(title, **options)
-        _verify_title(title, options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
+        _verify_title(title, options) do |query|
+          raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self)
+        end
       end
 
       ##

data/lib/capybara/node/element.rb

@@ -125,9 +125,9 @@ module Capybara
       # Select this node if is an option element inside a select tag
       #
       # @return [Capybara::Node::Element]  The element
-      def select_option
+      def select_option(wait: nil)
         warn "Attempt to select disabled option: #{value || text}" if disabled?
-        synchronize { base.select_option }
+        synchronize(wait) { base.select_option }
         self
       end
 
@@ -136,8 +136,8 @@ module Capybara
       # Unselect this node if is an option element inside a multiple select tag
       #
       # @return [Capybara::Node::Element]  The element
-      def unselect_option
-        synchronize { base.unselect_option }
+      def unselect_option(wait: nil)
+        synchronize(wait) { base.unselect_option }
         self
       end
 
@@ -152,8 +152,8 @@ module Capybara
       #     @option offset [Integer] x  X coordinate to offset the click location from the top left corner of the element
       #     @option offset [Integer] y  Y coordinate to offset the click location from the top left corner of the element
       # @return [Capybara::Node::Element]  The element
-      def click(*keys, **offset)
-        synchronize { base.click(keys, offset) }
+      def click(*keys, wait: nil, **offset)
+        synchronize(wait) { base.click(keys, offset) }
         self
       end
 
@@ -163,8 +163,8 @@ module Capybara
       #
       # @macro click_modifiers
       # @return [Capybara::Node::Element]  The element
-      def right_click(*keys, **offset)
-        synchronize { base.right_click(keys, offset) }
+      def right_click(*keys, wait: nil, **offset)
+        synchronize(wait) { base.right_click(keys, offset) }
         self
       end
 
@@ -174,8 +174,8 @@ module Capybara
       #
       # @macro click_modifiers
       # @return [Capybara::Node::Element]  The element
-      def double_click(*keys, **offset)
-        synchronize { base.double_click(keys, offset) }
+      def double_click(*keys, wait: nil, **offset)
+        synchronize(wait) { base.double_click(keys, offset) }
         self
       end
 

data/lib/capybara/node/finders.rb

@@ -9,15 +9,15 @@ module Capybara
       # is not found.
       #
       # @!macro waiting_behavior
-      #   If the driver is capable of executing JavaScript, +$0+ will wait for a set amount of time
+      #   If the driver is capable of executing JavaScript, this method will wait for a set amount of time
       #   and continuously retry finding the element until either the element is found or the time
       #   expires. The length of time +find+ will wait is controlled through {Capybara.default_max_wait_time}
       #   and defaults to 2 seconds.
       #   @option options [false, Numeric] wait (Capybara.default_max_wait_time) Maximum time to wait for matching element to appear.
       #
-      #     page.find('#foo').find('.bar')
-      #     page.find(:xpath, './/div[contains(., "bar")]')
-      #     page.find('li', text: 'Quox').click_link('Delete')
+      #  page.find('#foo').find('.bar')
+      #  page.find(:xpath, './/div[contains(., "bar")]')
+      #  page.find('li', text: 'Quox').click_link('Delete')
       #
       # @param (see Capybara::Node::Finders#all)
       #
@@ -37,7 +37,6 @@ module Capybara
       #                                            + If you need to check for existence of a class name that starts with ! then prefix with !!
       #                                            + ```class:['a', '!b', '!!!c'] # limit to elements with class 'a' and '!c' but not class 'b'```
       #   @option options [Boolean] exact            Control whether `is` expressions in the given XPath match exactly or partially
-      #   @option options [Integer, false] wait (Capybara.default_max_wait_time)  The time to wait for matching elements to become available
       # @option options [Symbol] match        The matching strategy to use.
       #
       # @return [Capybara::Node::Element]      The found element
@@ -63,7 +62,7 @@ module Capybara
       #
       # @macro waiting_behavior
       #
-      # @option options [Boolean] match        The matching strategy to use.
+      # @option options [Symbol] match        The matching strategy to use.
       #
       # @return [Capybara::Node::Element]      The found element
       # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires
@@ -89,7 +88,7 @@ module Capybara
       #
       # @macro waiting_behavior
       #
-      # @option options [Boolean] match        The matching strategy to use.
+      # @option options [Symbol] match        The matching strategy to use.
       #
       # @return [Capybara::Node::Element]      The found element
       # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires
@@ -119,10 +118,10 @@ module Capybara
       #   @option options [String, Regexp] with   Value of field to match on
       #   @option options [String] type           Type of field to match on
       #   @option options [Boolean] multiple      Match fields that can have multiple values?
-      #   @option options [String] id             Match fields that match the id attribute
+      #   @option options [String, Regexp] id             Match fields that match the id attribute
       #   @option options [String] name           Match fields that match the name attribute
       #   @option options [String] placeholder    Match fields that match the placeholder attribute
-      #   @option options [String, Array<String>] Match fields that match the class(es) passed
+      #   @option options [String, Array<String>, Regexp] class Match fields that match the class(es) passed
       # @return [Capybara::Node::Element]   The found element
       #
 
@@ -140,10 +139,10 @@ module Capybara
       #   @macro waiting_behavior
       #
       #   @option options [String,Regexp,nil] href        Value to match against the links href, if nil finds link placeholders (<a> elements with no href attribute)
-      #   @option options [String] id                 Match links with the id provided
+      #   @option options [String, Regexp] id                 Match links with the id provided
       #   @option options [String] title              Match links with the title provided
       #   @option options [String] alt                Match links with a contained img element whose alt matches
-      #   @option options [String, Array<String>] class    Match links that match the class(es) provided
+      #   @option options [String, Array<String>, Regexp] class    Match links that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
       def find_link(locator = nil, **options, &optional_filter_block)
@@ -168,10 +167,10 @@ module Capybara
       #                                                       * true - only finds a disabled button
       #                                                       * false - only finds an enabled button
       #                                                       * :all - finds either an enabled or disabled button
-      #   @option options [String] id                 Match buttons with the id provided
+      #   @option options [String, Regexp] id                 Match buttons with the id provided
       #   @option options [String] title              Match buttons with the title provided
       #   @option options [String] value              Match buttons with the value provided
-      #   @option options [String, Array<String>] class    Match buttons that match the class(es) provided
+      #   @option options [String, Array<String>, Regexp] class    Match buttons that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
       def find_button(locator = nil, **options, &optional_filter_block)
@@ -276,7 +275,7 @@ module Capybara
       # element is found, or `nil` if the provided count options allow for empty results.
       #
       # @overload first([kind], locator, options)
-      #   @param [:css, :xpath] kind                 The type of selector
+      #   @param [Symbol] kind                       The type of selector
       #   @param [String] locator                    The selector
       #   @param [Hash] options                      Additional options; see {#all}
       # @return [Capybara::Node::Element]            The found element or nil