capybara 3.35.3 → 3.37.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 516861530f59d3d9713daba7379838146575b920f787ac2c3f5c4bbffc6bf44d
-  data.tar.gz: 85b3fb81bf05e43122c2eef320a7a2dbd500033723ebbc04ebc414b0a42d0881
+  metadata.gz: c7283f19c4364fa2c19379e8da670105ebf59754937fc80117d975cd89959b87
+  data.tar.gz: b4fe7210ee210667602e9ec0a9882a1a34d8a64ceddae4df888aba0dd6974940
 SHA512:
-  metadata.gz: 7f745dac92b73afa56f43a2a509052c7fc5d1efa458863b0b3f05507c664847d6f67720a2c2a680e21126888e63a6eaf6a0e9be7d1a4df9d6aaa9ec61d832e29
-  data.tar.gz: 53532156dd31631879a0a8fda93126f259a5cd856a6cec82e6283f9f96e1cc2d98b788e4414ffee5756024d14819450d358529aa90d4c948618e82b878342ebd
+  metadata.gz: 71de08c12fdd479453fa743e0a7ef858e72ca96d9a32d2ecb0b1721b365a1f1e494309432b52536dcac5669af78fe50e60b1a9f886f0b08a2ac2fd378abfc52e
+  data.tar.gz: 91a2e75a15768ef02e8c9b9f1400c4ee1dd2e1e2562b4733dc520afddc4c71be962fcd5c0379481fa65938d0776cfe5434c75f5faf0e512246abca48b06b0c00

data/History.md

@@ -1,7 +1,64 @@
+# Version 3.37.1
+Relesae 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
+
+### Changed
+
+* Ruby 2.6.0+ is now required
+* Minimum selenium-webdriver supported is now 3.142.7
+
+### Added
+
+* 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::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]
+
+### Fixed
+
+* Sibling and ancestor queries now work with Simple::Node - Issue #2452
+* rack_test correctly ignores readonly attribute on specific input element types
+* `Node#all_text` always returns a string - Issue #2477
+* `have_any_of_selectors` negated match - Issue #2473
+* `Document#scroll_to` fixed for standards behavior - pass quirks: true if you need the older behavior [Eric Anderson]
+* Use capture on attach file event listener for better React compatibility [Jeff Way]
+* Animation disabler produces valid HTML [Javi Martin]
+
+### Removed
+
+* References to non-w3c mode in drivers/tests. Non-w3c mode is obsolete and no one should be using it anymore. Capybara hasn't been testing/supporting it in a while
+
 # Version 3.35.3
 Release date: 2021-01-29
 
 ### Fixed
+
 * Just a release to have the correct dates in the History.md in released gem
 
 # Version 3.35.2
@@ -1898,4 +1955,3 @@ too many users, please read the release notes carefully!
 * clicking links where the image's alt attribute contains the text is now possible
 * within_fieldset and within_table work when the default selector is CSS
 * boolean attributes work the same across drivers (return true/false)
-

data/README.md

@@ -74,7 +74,7 @@ GitHub): http://groups.google.com/group/ruby-capybara
 
 ## <a name="setup"></a>Setup
 
-Capybara requires Ruby 2.5.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
@@ -151,6 +151,8 @@ RSpec](https://relishapp.com/rspec/rspec-rails/v/4-0/docs/directory-structure))
 and if you have your Capybara specs in a different directory, then tag the
 example groups with `type: :feature` or `type: :system` depending on which type of test you're writing.
 
+If you are using Rails system specs please see [their documentation](https://relishapp.com/rspec/rspec-rails/docs/system-specs/system-spec#system-specs-driven-by-selenium-chrome-headless) for selecting the driver you wish to use.
+
 If you are not using Rails, tag all the example groups in which you want to use
 Capybara with `type: :feature`.
 
@@ -258,6 +260,8 @@ end
 
 ## <a name="using-capybara-with-minitest"></a>Using Capybara with Minitest
 
+* If you are using Rails system tests please see their documentation for information on selecting the driver you wish to use.
+
 * If you are using Rails, but not using Rails system tests, add the following code in your `test_helper.rb`
     file to make Capybara available in all test cases deriving from
     `ActionDispatch::IntegrationTest`:

data/lib/capybara/config.rb

@@ -7,10 +7,12 @@ module Capybara
   class Config
     extend Forwardable
 
-    OPTIONS = %i[app reuse_server threadsafe server default_driver javascript_driver allow_gumbo].freeze
+    OPTIONS = %i[
+      app reuse_server threadsafe server default_driver javascript_driver use_html5_parsing allow_gumbo
+    ].freeze
 
-    attr_accessor :app, :allow_gumbo
-    attr_reader :reuse_server, :threadsafe, :session_options
+    attr_accessor :app, :use_html5_parsing
+    attr_reader :reuse_server, :threadsafe, :session_options # rubocop:disable Style/BisectedAttrAccessor
     attr_writer :default_driver, :javascript_driver
 
     SessionConfig::OPTIONS.each do |method|
@@ -22,7 +24,7 @@ module Capybara
       @javascript_driver = nil
     end
 
-    attr_writer :reuse_server
+    attr_writer :reuse_server # rubocop:disable Style/BisectedAttrAccessor
 
     def threadsafe=(bool)
       if (bool != threadsafe) && Session.instance_created?
@@ -88,5 +90,15 @@ module Capybara
       end
       @deprecation_notified[method] = true
     end
+
+    def allow_gumbo=(val)
+      deprecate('allow_gumbo=', 'use_html5_parsing=')
+      self.use_html5_parsing = val
+    end
+
+    def allow_gumbo
+      deprecate('allow_gumbo', 'use_html5_parsing')
+      use_html5_parsing
+    end
   end
 end

data/lib/capybara/driver/base.rb

@@ -63,6 +63,10 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#send_keys'
   end
 
+  def active_element
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#active_element'
+  end
+
   ##
   #
   # @param frame [Capybara::Node::Element, :parent, :top]  The iframe element to switch to

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
@@ -132,7 +136,7 @@ module Capybara
       end
 
       def ==(other)
-        raise NotSupportedByDriverError, 'Capybara::Driver::Node#=='
+        eql?(other) || (other.respond_to?(:native) && native == other.native)
       end
     end
   end

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,25 +73,16 @@ 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.reject { |line| line =~ filter } if new_trace.empty?
+      new_trace = trace.grep_v(filter) if new_trace.empty?
       new_trace = trace.dup if new_trace.empty?
 
       new_trace.first.split(/:in /, 2).first
     end
 
     def warn(message, uplevel: 1)
-      return Kernel.warn(message, uplevel: uplevel) if RUBY_VERSION >= '2.6'
-
-      # TODO: Remove when we drop support for Ruby 2.5
-      # Workaround for emulating `warn '...', uplevel: n` in Ruby 2.5 or lower.
-      if (match = /^(?<file>.+?):(?<line>\d+)(?::in `.*')?/.match(caller[uplevel]))
-        location = [match[:file], match[:line]].join(':')
-        Kernel.warn "#{location}: #{message}"
-      else
-        Kernel.warn message
-      end
+      Kernel.warn(message, uplevel: uplevel)
     end
 
     if defined?(Process::CLOCK_MONOTONIC)

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

@@ -92,8 +92,9 @@ module Capybara
       end
 
       # @!macro label_click
-      #   @option options [Boolean] allow_label_click
+      #   @option options [Boolean, Hash] allow_label_click
       #     Attempt to click the label to toggle state if element is non-visible. Defaults to {Capybara.configure automatic_label_click}.
+      #     If set to a Hash it is passed as options to the `click` on the label
 
       ##
       #
@@ -277,7 +278,7 @@ module Capybara
       # @return [Capybara::Node::Element]  The file field element
       def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments
         if locator && block_given?
-          raise ArgumentError, '``#attach_file` does not support passing both a locator and a block'
+          raise ArgumentError, '`#attach_file` does not support passing both a locator and a block'
         end
 
         Array(paths).each do |path|
@@ -314,7 +315,7 @@ module Capybara
 
           begin
             find(:datalist_input, from, **options)
-          rescue Capybara::ElementNotFound => dlinput_error # rubocop:disable Naming/RescuedExceptionsVariableName
+          rescue Capybara::ElementNotFound => dlinput_error
             raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
           end
         end
@@ -371,7 +372,11 @@ module Capybara
 
           begin
             el ||= find(selector, locator, **options.merge(visible: :all))
-            el.session.find(:label, for: el, visible: true, match: :first).click unless el.checked? == checked
+            unless el.checked? == checked
+              el.session
+                .find(:label, for: el, visible: true, match: :first)
+                .click(**(Hash.try_convert(allow_label_click) || {}))
+            end
           rescue StandardError # swallow extra errors - raise original
             raise e
           end
@@ -408,7 +413,7 @@ module Capybara
             this.removeEventListener('click', file_catcher);
             e.preventDefault();
           }
-        })
+        }, {capture: true})
       JS
     end
   end

data/lib/capybara/node/document.rb

@@ -40,8 +40,8 @@ module Capybara
         find(:xpath, '/html').evaluate_script(*args)
       end
 
-      def scroll_to(*args, **options)
-        find(:xpath, '//body').scroll_to(*args, **options)
+      def scroll_to(*args, quirks: false, **options)
+        find(:xpath, quirks ? '//body' : '/html').scroll_to(*args, **options)
       end
     end
   end

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
@@ -550,7 +561,7 @@ module Capybara
         return self unless @allow_reload
 
         begin
-          reloaded = @query.resolve_for(query_scope.reload)[@query_idx.to_i]
+          reloaded = @query.resolve_for(query_scope ? query_scope.reload : session)[@query_idx.to_i]
           @base = reloaded.base if reloaded
         rescue StandardError => e
           raise e unless catch_error?(e)

data/lib/capybara/node/finders.rb

@@ -18,11 +18,11 @@ 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
-      #     Whether the `text`/`exact_text` options are compared against elment text with whitespace normalized or as returned by the driver.
+      #     Whether the `text`/`exact_text` options are compared against element text with whitespace normalized or as returned by the driver.
       #     Defaults to {Capybara.configure default_normalize_ws}.
       #   @option options [Boolean, Symbol] visible
       #     Only find elements with the specified visibility. Defaults to behavior indicated by {Capybara.configure ignore_hidden_elements}.
@@ -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
 

data/lib/capybara/node/simple.rb

@@ -110,7 +110,7 @@ module Capybara
           # No need for an xpath if only checking the current element
           !(native.key?('hidden') ||
             /display:\s?none/.match?(native[:style] || '') ||
-            %w[script head].include?(tag_name))
+            %w[script head style].include?(tag_name))
         end
       end
 
@@ -191,6 +191,10 @@ module Capybara
         {}
       end
 
+      def ==(other)
+        eql?(other) || (other.respond_to?(:native) && native == other.native)
+      end
+
     private
 
       def option_value(option)

data/lib/capybara/queries/active_element_query.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Capybara
+  # @api private
+  module Queries
+    class ActiveElementQuery < BaseQuery
+      def initialize(**options)
+        @options = options
+        super(@options)
+      end
+
+      def resolve_for(session)
+        node = session.driver.active_element
+        [Capybara::Node::Element.new(session, node, nil, self)]
+      end
+    end
+  end
+end

data/lib/capybara/queries/ancestor_query.rb

@@ -8,7 +8,8 @@ module Capybara
         @child_node = node
 
         node.synchronize do
-          match_results = super(node.session.current_scope, exact)
+          scope = node.respond_to?(:session) ? node.session.current_scope : node.find(:xpath, '/*')
+          match_results = super(scope, exact)
           ancestors = node.find_xpath(XPath.ancestor.to_s)
                           .map(&method(:to_element))
                           .select { |el| match_results.include?(el) }

data/lib/capybara/queries/current_path_query.rb

@@ -19,7 +19,7 @@ module Capybara
 
       def resolves_for?(session)
         uri = ::Addressable::URI.parse(session.current_url)
-        @actual_path = (options[:ignore_query] ? uri&.omit(:query) : uri).yield_self do |u|
+        @actual_path = (options[:ignore_query] ? uri&.omit(:query) : uri).then do |u|
           options[:url] ? u&.to_s : u&.request_uri
         end
 

data/lib/capybara/queries/selector_query.rb

@@ -9,7 +9,7 @@ module Capybara
 
       SPATIAL_KEYS = %i[above below left_of right_of near].freeze
       VALID_KEYS = SPATIAL_KEYS + COUNT_KEYS +
-                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set]
+                   %i[text id class style visible obscured exact exact_text normalize_ws match wait filter_set focused]
       VALID_MATCH = %i[first smart prefer_exact one].freeze
 
       def initialize(*args,
@@ -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
 
@@ -73,6 +79,8 @@ module Capybara
 
         desc << " with id #{options[:id]}" if options[:id]
         desc << " with classes [#{Array(options[:class]).join(',')}]" if options[:class]
+        desc << ' that is focused' if options[:focused]
+        desc << ' that is not focused' if options[:focused] == false
 
         desc << case options[:style]
         when String
@@ -371,6 +379,10 @@ module Capybara
         options.key?(:style) && !custom_keys.include?(:style)
       end
 
+      def use_default_focused_filter?
+        options.key?(:focused) && !custom_keys.include?(:focused)
+      end
+
       def use_spatial_filter?
         options.values_at(*SPATIAL_KEYS).compact.any?
       end
@@ -435,6 +447,7 @@ module Capybara
           matches_id_filter?(node) &&
           matches_class_filter?(node) &&
           matches_style_filter?(node) &&
+          matches_focused_filter?(node) &&
           matches_text_filter?(node) &&
           matches_exact_text_filter?(node)
       end
@@ -494,6 +507,12 @@ module Capybara
         end
       end
 
+      def matches_focused_filter?(node)
+        return true unless use_default_focused_filter?
+
+        (node == node.session.active_element) == options[:focused]
+      end
+
       def need_to_process_classes?
         case options[:class]
         when Regexp then true
@@ -528,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)
@@ -565,17 +587,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/sibling_query.rb

@@ -7,7 +7,8 @@ module Capybara
       def resolve_for(node, exact = nil)
         @sibling_node = node
         node.synchronize do
-          match_results = super(node.session.current_scope, exact)
+          scope = node.respond_to?(:session) ? node.session.current_scope : node.find(:xpath, '/*')
+          match_results = super(scope, exact)
           siblings = node.find_xpath((XPath.preceding_sibling + XPath.following_sibling).to_s)
                          .map(&method(:to_element))
                          .select { |el| match_results.include?(el) }