capybara 3.36.0 → 3.39.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fd7f81974b21d47d35c99dff02f878607128c99c80b18b1fef54680797978898
-  data.tar.gz: ee6659925b7ddaaa0220ad0af81ae65a34e96094583308c160902470e7019128
+  metadata.gz: '0945d8fedaab75fa31a90d12105de7318d78c20a46955a1b78ae88dc791f6a5a'
+  data.tar.gz: 9a59ca68ff9d44ef28597603ed275ebef28c79c8b6fb76ffdc26daaee68ab383
 SHA512:
-  metadata.gz: ad7d2ea4d2612770e801443e61b23a45c0b9936fa4387170ffbbf051706dbc8aee5111b8eefb2d6fabb3042b479dc19d26248923d84da3e78d12dc090aca1e2d
-  data.tar.gz: 8868469dc6ddcb6c802f4a7b76df9455ff561d00ad78e3cab75e5f02e1b71b74402700c081864368d446304acb6fac2fed5cb79df117d309d4a0a278c95e35d8
+  metadata.gz: dbb58a338e2408140ce5e6a44bc141fc44833952c10f611996f5a217c9a0ad00f8d6344a1c16b0bf53000801f9e1d45ef3848cb0fa886dabe68c6d766a42372a
+  data.tar.gz: db985c0c947ff348c80008fd4c90232a0ad4dcd38dbe8694b157ecfb512c099d6e9bc08177d8a115e1db17cca35c68903e10662da0fdd14c4f1a2ab671932b16

data/History.md

@@ -1,3 +1,93 @@
+# Version 3.39.2
+Release date: 2023-06-10
+
+### Fixed
+
+* Fix Selenium version comparison [aki77]
+
+# Version 3.39.1
+Release date: 2023-05-12
+
+### Fixed
+
+* Fix usage of Selenium logger
+
+# Version 3.39.0
+Release date: 2023-04-02
+
+### Added
+
+* Support `:target` filter option on `:link` selector [Yudai Takada]
+* Experimental Rack 3 support
+* Text normalization performance improvements [Brandon Weaver]
+
+### Fixed
+
+* MS Edge button click [Brian J. Bayer]
+* Options/Capabilities choosing based on Selenium versions
+* Support for base versions [Matijs van Zuijlen]
+* ExpectedError not defined in Selenium 4+
+* Filter block forwarding to a number of matchers [Christophe Bliard]
+###  Changed
+
+* Dropped support for rack 1.x
+
+# Version 3.38.0
+Release date: 2022-11-03
+
+### Changed
+
+* Capybara.w3c_click_offset now defaults to true. If you need click offsets to be from the elements top left corner set it to false in your config
+
+### Added
+
+* Support Selenium 4.3 changes to click offset calculations
+* `click`, `double_click`, `right_click` can now be called on the session to click the currently scoped element (or document)
+* `Session#within` now passes the scoped element to the block
+* Support rack-test 2+
+* Retry interval is now configurable [Masahiro NOMOTO]
+* Support Puma 6 - Issue #2590
+* Selenium: DetachedShadowRootError is treated as an invalid element error [Perryn Fowler]
+* Selenium: When inspected shadow roots will have a tag name of "ShadowRoot"
+* `evaluate_async_script` added to Session::DSL_METHODS [Henry Blyth]
+
+### Fixed
+
+* Use higher precision clock in Capybara::Helpers::Timer if available
+* rack-test driver behavior with \r\n - Issue #2547 [Stefan Hoffmann]
+* Updated for deprecation of positional parameters in Selenium::WebDriver::ActionBuilder#pause
+* Explicitly set cause on server raised errors
+* Options no longer duplicated in have_xxx invalid option error message [Yudai Takada]
+* Animation disabler is now threadsafe [Daniel Sheppard]
+* Server connection count tracking [Oleksandr K.]
+* Ensure scopes are reset when session is [Henry Blyth]
+
+# Version 3.37.1
+Release date: 2022-05-09
+
+### Fixed
+
+* Regression in rack-test visit - Issue #2548
+
+# Version 3.37.0
+Release date: 2022-05-07
+
+### Changed
+
+* Ruby 2.7.0+ is now required
+
+### Added
+
+* [Beta] CSP nonces inserted into animation disabler additions - Issue #2542
+* Support `<base>` element in rack-test driver - ISsue #2544
+* [Beta] `Element#shadow_root` support. Requires selenium-webdriver 4.1+. Only currently supported with Chrome when using the selenium driver. Note: only CSS can be used to find elements from the shadow root. Therefore you won't be able to use most Capybara helper methods (`fill_in`, `click_link`, `find_field`, etc) directly from the shadow root since those locators are built using XPath. If you first locate a descendant from the shadow root using CSS then you should be able to use all the Capybara methods from there.
+* Regexp now supported for `exact_text` finder option
+
+### Fixed
+
+* Fragments in referer headers in rack-test driver - Issue #2525
+* Selenium v4.1 deprecation notice
+
 # Version 3.36.0
 Release date: 2021-10-24
 
@@ -10,7 +100,7 @@ Release date: 2021-10-24
 
 * Support for selenium-webdriver 4.x
 * `allow_label_click` accepts click options to be used when clicking an associated label
-* Deprecated `allow_gumbo=` in favor of `use_html5_parsing=` to enable use of Nokogiri::HTL5 when available
+* Deprecated `allow_gumbo=` in favor of `use_html5_parsing=` to enable use of Nokogiri::HTML5 when available
 * `Session#active_element` returns the element with focus - Not supported by the `RackTest` driver [Sean Doyle]
 * Support `focused:` filter for finding interactive elements - Not supported by the `RackTest` driver [Sean Doyle]
 
@@ -784,7 +874,7 @@ Release date: 2018-03-23
 
 ### Changed
 
-* Visibile text whitespace is no longer fully normalized in favor of being more in line with the WebDriver spec for visible text
+* Visible text whitespace is no longer fully normalized in favor of being more in line with the WebDriver spec for visible text
 * Drivers are expected to close extra windows when resetting the session
 * Selenium driver supports Date/Time when filling in date/time/datetime-local inputs
 * `current_url` returns the url for the top level browsing context
@@ -1190,7 +1280,7 @@ Release date: 2016-01-27
 
 # Version 2.6.0
 
-Relase date: 2016-01-17
+Release date: 2016-01-17
 
 ### Fixed
 
@@ -1254,7 +1344,7 @@ Release date: 2014-10-13
 
 # Version 2.4.3
 
-Relase date: 2014-09-21
+Release date: 2014-09-21
 
 ### Fixed
 

data/README.md

@@ -74,7 +74,7 @@ GitHub): http://groups.google.com/group/ruby-capybara
 
 ## <a name="setup"></a>Setup
 
-Capybara requires Ruby 2.6.0 or later. To install, add this line to your
+Capybara requires Ruby 2.7.0 or later. To install, add this line to your
 `Gemfile` and run `bundle install`:
 
 ```ruby
@@ -161,7 +161,7 @@ You can now write your specs like so:
 ```ruby
 describe "the signin process", type: :feature do
   before :each do
-    User.make(email: 'user@example.com', password: 'password')
+    User.create(email: 'user@example.com', password: 'password')
   end
 
   it "signs me in" do
@@ -192,7 +192,7 @@ Capybara also comes with a built in DSL for creating descriptive acceptance test
 ```ruby
 feature "Signing in" do
   background do
-    User.make(email: 'user@example.com', password: 'caplin')
+    User.create(email: 'user@example.com', password: 'caplin')
   end
 
   scenario "Signing in with correct credentials" do
@@ -205,7 +205,7 @@ feature "Signing in" do
     expect(page).to have_content 'Success'
   end
 
-  given(:other_user) { User.make(email: 'other@example.com', password: 'rous') }
+  given(:other_user) { User.create(email: 'other@example.com', password: 'rous') }
 
   scenario "Signing in as another user" do
     visit '/sessions/new'
@@ -336,7 +336,7 @@ By default, Capybara uses the `:rack_test` driver, which is fast but limited: it
 does not support JavaScript, nor is it able to access HTTP resources outside of
 your Rack application, such as remote APIs and OAuth services. To get around
 these limitations, you can set up a different default driver for your features.
-For example if you'd prefer to run everything in Selenium, you could do:
+For example, if you'd prefer to run everything in Selenium, you could do:
 
 ```ruby
 Capybara.default_driver = :selenium # :selenium_chrome and :selenium_chrome_headless are also registered
@@ -630,7 +630,7 @@ JS
 
 ### <a name="modals"></a>Modals
 
-In drivers which support it, you can accept, dismiss and respond to alerts, confirms and prompts.
+In drivers which support it, you can accept, dismiss and respond to alerts, confirms, and prompts.
 
 You can accept or dismiss alert messages by wrapping the code that produces an alert in a block:
 
@@ -781,7 +781,7 @@ expect(page).to have_content('baz')
 If clicking on the *foo* link triggers an asynchronous process, such as
 an Ajax request, which, when complete will add the *bar* link to the page,
 clicking on the *bar* link would be expected to fail, since that link doesn't
-exist yet. However Capybara is smart enough to retry finding the link for a
+exist yet. However, Capybara is smart enough to retry finding the link for a
 brief period of time before giving up and throwing an error. The same is true of
 the next line, which looks for the content *baz* on the page; it will retry
 looking for that content for a brief time. You can adjust how long this period
@@ -795,13 +795,25 @@ Be aware that because of this behaviour, the following two statements are **not*
 equivalent, and you should **always** use the latter!
 
 ```ruby
-!page.has_xpath?('a')
-page.has_no_xpath?('a')
+# Given use of a driver where the page is loaded when visit returns
+# and that Capybara.predicates_wait is `true`
+# consider a page where the `a` tag is removed through AJAX after 1s
+visit(some_path)
+!page.has_xpath?('a')  # is false
+page.has_no_xpath?('a')  # is true
 ```
 
-The former would immediately fail because the content has not yet been removed.
-Only the latter would wait for the asynchronous process to remove the content
-from the page.
+First expression:
+- `has_xpath?('a')` is called right after `visit` returns. It is `true` because the link has not yet been removed
+- Capybara does not wait upon successful predicates/assertions, therefore **has_xpath? returns `true` immediately**
+- The expression returns `false` (because it is negated with the leading `!`)
+
+Second expression:
+- `has_no_xpath?('a')` is called right after `visit` returns. It is `false` because the link has not yet been removed.
+- Capybara waits upon failed predicates/assertions, therefore **has_no_xpath? does not return `false` immediately**
+- Capybara will periodically re-check the predicate/assertion up to the `default_max_wait_time` defined
+- after 1s, the predicate becomes `true` (because the link has been removed)
+- The expression returns `true`
 
 Capybara's RSpec matchers, however, are smart enough to handle either form.
 The two following statements are functionally equivalent:

data/lib/capybara/driver/node.rb

@@ -125,6 +125,10 @@ module Capybara
         raise NotSupportedByDriverError, 'Capybara::Driver::Node#trigger'
       end
 
+      def shadow_root
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#shadow_root'
+      end
+
       def inspect
         %(#<#{self.class} tag="#{tag_name}" path="#{path}">)
       rescue NotSupportedByDriverError

data/lib/capybara/dsl.rb

@@ -47,17 +47,11 @@ module Capybara
     end
 
     Session::DSL_METHODS.each do |method|
-      if RUBY_VERSION >= '2.7'
-        class_eval <<~METHOD, __FILE__, __LINE__ + 1
-          def #{method}(...)
-            page.method("#{method}").call(...)
-          end
-        METHOD
-      else
-        define_method method do |*args, &block|
-          page.send method, *args, &block
+      class_eval <<~METHOD, __FILE__, __LINE__ + 1
+        def #{method}(...)
+          page.method("#{method}").call(...)
         end
-      end
+      METHOD
     end
   end
 

data/lib/capybara/helpers.rb

@@ -73,7 +73,7 @@ module Capybara
     def filter_backtrace(trace)
       return 'No backtrace' unless trace
 
-      filter = %r{lib/capybara/|lib/rspec/|lib/minitest/}
+      filter = %r{lib/capybara/|lib/rspec/|lib/minitest/|delegate.rb}
       new_trace = trace.take_while { |line| line !~ filter }
       new_trace = trace.grep_v(filter) if new_trace.empty?
       new_trace = trace.dup if new_trace.empty?
@@ -85,7 +85,11 @@ module Capybara
       Kernel.warn(message, uplevel: uplevel)
     end
 
-    if defined?(Process::CLOCK_MONOTONIC)
+    if defined?(Process::CLOCK_MONOTONIC_RAW)
+      def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC_RAW; end
+    elsif defined?(Process::CLOCK_MONOTONIC_PRECISE)
+      def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC_PRECISE; end
+    elsif defined?(Process::CLOCK_MONOTONIC)
       def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC; end
     else
       def monotonic_time; Time.now.to_f; end

data/lib/capybara/minitest/spec.rb

@@ -246,9 +246,9 @@ module Capybara
 
       ##
       # @deprecated
-      def must_have_style(*args, **kw_args, &block)
+      def must_have_style(...)
         warn 'must_have_style is deprecated, please use must_match_style'
-        must_match_style(*args, **kw_args, &block)
+        must_match_style(...)
       end
     end
   end

data/lib/capybara/node/actions.rb

@@ -383,7 +383,7 @@ module Capybara
         end
       end
 
-      UPDATE_STYLE_SCRIPT = <<~'JS'
+      UPDATE_STYLE_SCRIPT = <<~JS
         this.capybara_style_cache = this.style.cssText;
         var css = arguments[0];
         for (var prop in css){
@@ -393,20 +393,20 @@ module Capybara
         }
       JS
 
-      RESET_STYLE_SCRIPT = <<~'JS'
+      RESET_STYLE_SCRIPT = <<~JS
         if (this.hasOwnProperty('capybara_style_cache')) {
           this.style.cssText = this.capybara_style_cache;
           delete this.capybara_style_cache;
         }
       JS
 
-      DATALIST_OPTIONS_SCRIPT = <<~'JS'
+      DATALIST_OPTIONS_SCRIPT = <<~JS
         Array.prototype.slice.call((this.list||{}).options || []).
           filter(function(el){ return !el.disabled }).
           map(function(el){ return { "value": el.value, "label": el.label} })
       JS
 
-      CAPTURE_FILE_ELEMENT_SCRIPT = <<~'JS'
+      CAPTURE_FILE_ELEMENT_SCRIPT = <<~JS
         document.addEventListener('click', function file_catcher(e){
           if (e.target.matches("input[type='file']")) {
             window._capybara_clicked_file_input = e.target;

data/lib/capybara/node/base.rb

@@ -77,6 +77,7 @@ module Capybara
         return yield if session.synchronized
 
         seconds = session_options.default_max_wait_time if [nil, true].include? seconds
+        interval = session_options.default_retry_interval
         session.synchronized = true
         timer = Capybara::Helpers.timer(expire_in: seconds)
         begin
@@ -88,7 +89,7 @@ module Capybara
           if driver.wait?
             raise e if timer.expired?
 
-            sleep(0.01)
+            sleep interval
             reload if session_options.automatic_reload
           else
             old_base = @base

data/lib/capybara/node/element.rb

@@ -115,7 +115,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element
       def set(value, **options)
-        if ENV['CAPYBARA_THOROUGH'] && readonly?
+        if ENV.fetch('CAPYBARA_THOROUGH', nil) && readonly?
           raise Capybara::ReadOnlyElementError, "Attempt to set readonly element with value: #{value}"
         end
 
@@ -472,6 +472,17 @@ module Capybara
         self
       end
 
+      ##
+      #
+      # Return the shadow_root for the current element
+      #
+      # @return [Capybara::Node::Element]  The shadow root
+
+      def shadow_root
+        root = synchronize { base.shadow_root }
+        root && Capybara::Node::Element.new(session, root, nil, nil)
+      end
+
       ##
       #
       # Execute the given JS in the context of the element not returning a result. This is useful for scripts that return

data/lib/capybara/node/finders.rb

@@ -18,7 +18,7 @@ module Capybara
       #
       # @!macro system_filters
       #   @option options [String, Regexp] text      Only find elements which contain this text or match this regexp
-      #   @option options [String, Boolean] exact_text
+      #   @option options [String, Regexp, String] exact_text
       #     When String the elements contained text must match exactly, when Boolean controls whether the `text` option must match exactly.
       #     Defaults to {Capybara.configure exact_text}.
       #   @option options [Boolean] normalize_ws
@@ -50,6 +50,13 @@ module Capybara
       #
       def find(*args, **options, &optional_filter_block)
         options[:session_options] = session_options
+        count_options = options.slice(*Capybara::Queries::BaseQuery::COUNT_KEYS)
+        unless count_options.empty?
+          Capybara::Helpers.warn(
+            "'find' does not support count options (#{count_options}) ignoring. " \
+            "Called from: #{Capybara::Helpers.filter_backtrace(caller)}"
+          )
+        end
         synced_resolve Capybara::Queries::SelectorQuery.new(*args, **options, &optional_filter_block)
       end
 
@@ -142,6 +149,8 @@ module Capybara
       #   @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, Boolean] download  Match links with the download provided
+      #   @option options [String] target             Match links with the target provided
       #   @option options [String, Array<String>, Regexp] class    Match links that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #

data/lib/capybara/node/whitespace_normalizer.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Node
+    ##
+    #
+    # {Capybara::Node::WhitespaceNormalizer} provides methods that
+    # help to normalize the spacing of text content inside of
+    # {Capybara::Node::Element}s by removing various unicode
+    # spacing and directional markings.
+    #
+    module WhitespaceNormalizer
+      # Unicode for NBSP, or  
+      NON_BREAKING_SPACE = "\u00a0"
+      LINE_SEPERATOR = "\u2028"
+      PARAGRAPH_SEPERATOR = "\u2029"
+
+      # All spaces except for NBSP
+      BREAKING_SPACES = "[[:space:]&&[^#{NON_BREAKING_SPACE}]]"
+
+      # Whitespace we want to substitute with plain spaces
+      SQUEEZED_SPACES = " \n\f\t\v#{LINE_SEPERATOR}#{PARAGRAPH_SEPERATOR}"
+
+      # Any whitespace at the front of text
+      LEADING_SPACES = /\A#{BREAKING_SPACES}+/.freeze
+
+      # Any whitespace at the end of text
+      TRAILING_SPACES = /#{BREAKING_SPACES}+\z/.freeze
+
+      # "Invisible" space character
+      ZERO_WIDTH_SPACE = "\u200b"
+
+      # Signifies text is read left to right
+      LEFT_TO_RIGHT_MARK = "\u200e"
+
+      # Signifies text is read right to left
+      RIGHT_TO_LEFT_MARK = "\u200f"
+
+      # Characters we want to truncate from text
+      REMOVED_CHARACTERS = [ZERO_WIDTH_SPACE, LEFT_TO_RIGHT_MARK, RIGHT_TO_LEFT_MARK].join
+
+      # Matches multiple empty lines
+      EMPTY_LINES = /[\ \n]*\n[\ \n]*/.freeze
+
+      ##
+      #
+      # Normalizes the spacing of a node's text to be similar to
+      # what matchers might expect.
+      #
+      # @param text [String]
+      # @return [String]
+      #
+      def normalize_spacing(text)
+        text
+          .delete(REMOVED_CHARACTERS)
+          .tr(SQUEEZED_SPACES, ' ')
+          .squeeze(' ')
+          .sub(LEADING_SPACES, '')
+          .sub(TRAILING_SPACES, '')
+          .tr(NON_BREAKING_SPACE, ' ')
+      end
+
+      ##
+      #
+      # Variant on {Capybara::Node::Normalizer#normalize_spacing} that
+      # targets the whitespace of visible elements only.
+      #
+      # @param text [String]
+      # @return [String]
+      #
+      def normalize_visible_spacing(text)
+        text
+          .squeeze(' ')
+          .gsub(EMPTY_LINES, "\n")
+          .sub(LEADING_SPACES, '')
+          .sub(TRAILING_SPACES, '')
+          .tr(NON_BREAKING_SPACE, ' ')
+      end
+    end
+  end
+end

data/lib/capybara/queries/base_query.rb

@@ -79,8 +79,8 @@ module Capybara
         if count
           message << " #{occurrences count}"
         elsif between
-          message << " between #{between.begin ? between.first : 1} and" \
-                     " #{between.end ? between.last : 'infinite'} times"
+          message << " between #{between.begin ? between.first : 1} and " \
+                     "#{between.end ? between.last : 'infinite'} times"
         elsif maximum
           message << " at most #{occurrences maximum}"
         elsif minimum

data/lib/capybara/queries/selector_query.rb

@@ -27,6 +27,12 @@ module Capybara
         @order = order
         @filter_cache = Hash.new { |hsh, key| hsh[key] = {} }
 
+        if @options[:text].is_a?(Regexp) && [true, false].include?(@options[:exact_text])
+          Capybara::Helpers.warn(
+            "Boolean 'exact_text' option is not supported when 'text' option is a Regexp - ignoring"
+          )
+        end
+
         super(@options)
         self.session_options = session_options
 
@@ -266,7 +272,7 @@ module Capybara
       end
 
       def valid_keys
-        VALID_KEYS + custom_keys
+        (VALID_KEYS + custom_keys).uniq
       end
 
       def matches_node_filters?(node, errors)
@@ -541,16 +547,19 @@ module Capybara
       def matches_text_filter?(node)
         value = options[:text]
         return true unless value
-        return matches_text_exactly?(node, value) if exact_text == true
+        return matches_text_exactly?(node, value) if exact_text == true && !value.is_a?(Regexp)
 
         regexp = value.is_a?(Regexp) ? value : Regexp.escape(value.to_s)
         matches_text_regexp?(node, regexp)
       end
 
       def matches_exact_text_filter?(node)
-        return true unless exact_text.is_a?(String)
-
-        matches_text_exactly?(node, exact_text)
+        case exact_text
+        when String, Regexp
+          matches_text_exactly?(node, exact_text)
+        else
+          true
+        end
       end
 
       def matches_visibility_filters?(node)
@@ -561,7 +570,9 @@ module Capybara
         when :visible
           node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)
         when :hidden
-          (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)
+          # TODO: check why the 'visbile' cache spelling mistake wasn't caught in a test
+          # (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)
+          (node.initial_cache[:visible] == false) || (node.initial_cache[:visible].nil? && !node.visible?)
         else
           true
         end
@@ -578,17 +589,21 @@ module Capybara
 
       def matches_text_exactly?(node, value)
         regexp = value.is_a?(Regexp) ? value : /\A#{Regexp.escape(value.to_s)}\z/
-        matches_text_regexp?(node, regexp)
+        matches_text_regexp(node, regexp).then { |m| m&.pre_match == '' && m&.post_match == '' }
       end
 
       def normalize_ws
         options.fetch(:normalize_ws, session_options.default_normalize_ws)
       end
 
-      def matches_text_regexp?(node, regexp)
+      def matches_text_regexp(node, regexp)
         text_visible = visible
         text_visible = :all if text_visible == :hidden
-        node.text(text_visible, normalize_ws: normalize_ws).match?(regexp)
+        node.text(text_visible, normalize_ws: normalize_ws).match(regexp)
+      end
+
+      def matches_text_regexp?(node, regexp)
+        !matches_text_regexp(node, regexp).nil?
       end
 
       def default_visibility

data/lib/capybara/queries/text_query.rb

@@ -13,7 +13,7 @@ module Capybara
         self.session_options = session_options
 
         if expected_text.nil? && !exact?
-          warn 'Checking for expected text of nil is confusing and/or pointless since it will always match. '\
+          warn 'Checking for expected text of nil is confusing and/or pointless since it will always match. ' \
                "Please specify a string or regexp instead. #{Capybara::Helpers.filter_backtrace(caller)}"
         end