capybara 3.29.0 → 3.37.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5f11a887ca6aed51d064d9c8eb797e0db4605a3d013082a11f4f4b1013b27bef
-  data.tar.gz: 714e834fdb1c2f0e692f547a1d032113dd888d6905eddecc60f05503720bcd8e
+  metadata.gz: c7283f19c4364fa2c19379e8da670105ebf59754937fc80117d975cd89959b87
+  data.tar.gz: b4fe7210ee210667602e9ec0a9882a1a34d8a64ceddae4df888aba0dd6974940
 SHA512:
-  metadata.gz: 82c37d1b9c8d1c7f9d858f8d7aebebfc2ecee4c5e35d35f9a3c949d978e4e97d48f78b9d5f93079e209fc779ab31e5707ecce8ac0d2a4ce8108fc3be2437e1bc
-  data.tar.gz: '06886b335dd0ef5f93f59a09026877bc460e6430b2d2f1902cd31a3179b1bd52b9418a1b43ab558dcf18e92b198506023c3549a065949bb33f881538ec9e018d'
+  metadata.gz: 71de08c12fdd479453fa743e0a7ef858e72ca96d9a32d2ecb0b1721b365a1f1e494309432b52536dcac5669af78fe50e60b1a9f886f0b08a2ac2fd378abfc52e
+  data.tar.gz: 91a2e75a15768ef02e8c9b9f1400c4ee1dd2e1e2562b4733dc520afddc4c71be962fcd5c0379481fa65938d0776cfe5434c75f5faf0e512246abca48b06b0c00

data/History.md

@@ -1,5 +1,220 @@
+# 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
+Release date: 2021-01-29
+
+### Fixed
+
+* Selenium deprecation suppressor with Selenium 3.x
+
+# Version 3.35.1
+Release date: 2021-01-26
+
+### Fixed
+
+* Default chrome driver registrations use chrome - Issue #2442 [Yuriy Alekseyev]
+* 'Capybara.test_id' usage with the :button selector - Issue #2443
+
+# Version 3.35.0
+Release date: 2021-01-25
+
+### Added
+
+* Support Regexp matching for individual class names in :class filter passed an Array
+* Animation disabler now supports JQuery animation disabling when JQuery loaded from body [Chien-Wei Huang]
+
+### Fixed
+
+* :button selector type use with `enable_aria_role` [Sean Doyle]
+* <label> elements don't associate with aria-role buttons
+* Ignore Selenium::WebDriver::Error::InvalidSessionIdError when quitting driver [Robin Daugherty]
+* Firefox: Don't click input when sending keys if already focused
+* Miscellaneous issues with selenium-webdriver 4.0.0.alphas
+* Nil return error in node details optimizations
+* Animation disabler now inserts XHTML compliant content [Dale Morgan]
+
+# Version 3.34.0
+Release date: 2020-11-26
+
+### Added
+
+* Ability to fill in with emoji when using Chrome with selenium driver (Firefox already worked)
+* Current path assertions/expectations accept optional filter block
+* Animation disabler now specifies `scroll-behavior: auto;` [Nathan Broadbent]
+* :button selector can now find elements by label text [Sean Doyle]
+* `Session#send_keys` to send keys to the current element with focus in drivers that support the
+  concept of a current element [Sean Doyle]
+
+### Changed
+
+* Text query validates the type parameter to prevent undefined behavior
+
+### Fixed
+
+* racktest driver better handles fragments and redirection to urls that include fragments
+* Don't error when attempting to get XPath location of a shadow element
+* Missing `readonly?` added to Node::Simple
+* Selenium version detection when loaded via alternate method [Joel Hawksley]
+* Connection count issue if REQUEST_URI value changed by app [Blake Williams]
+* Maintain URI fragment when redirecting in rack-test driver
+* Text query error message [Wojciech Wnętrzak]
+* Checking a checkbox/radio button with `allow_label_click` now works if there are multiple labels (Issue #2421)
+* `drop` with `Pathname` (Issue #2424)[Máximo Mussini]
+
+# Version 3.33.0
+Release date: 2020-06-21
+
+### Added
+
+* Block passed to `within_session` now receives the new and old session
+* Support for aria-role button when enabled [Seiei Miyagi]
+* Support for aria-role link when enabled
+* Support for `validation_message` filter with :field and :fillable_field selectors
+* Deprecation warnings show source location [Koichi ITO]
+
+### Changed
+
+* Ruby 2.5.0+ is now required
+* Deprecated direct manipulation of the driver and server registries
+
+### Fixed
+
+* Ruby 2.7 warning in minitest `assert_text` [Eileen M. Uchitelle]
+
+
+# Version 3.32.2
+Release date: 2020-05-16
+
+### Fixed
+
+* Don't use lazy enumerator with JRuby due to leaking threads
+* Ruby 2.7 deprecation warning when registering Webrick [Jon Zeppieri]
+* `have_text` description [Juan Pablo Rinaldi]
+
+# Version 3.32.1
+Release date: 2020-04-05
+
+### Fixed
+
+* Rapid set now respects field maxlength (Issue #2332)
+* Only patch pause into legacy actions in Selenium < 4 (Issue #2334)
+
+# Version 3.32.0
+Release date: 2020-03-29
+
+### Added
+
+* Support `delay` setting on click with Selenium
+* Implement rapid set for values longer than 30 characters in text fields with Selenium
+
+### Fixed
+
+* Result#[] and negative max on ranges (Issue #2302/2303) [Jeremy Evans]
+* RackTest form submission rewrites query string when using GET method
+* Ruby 2.7 deprecation warnings in RSpec matcher proxies
+
+# Version 3.31.0
+Release date: 2020-01-26
+
+### Added
+
+* Support setting range inputs with the selenium driver [Andrew White]
+* Support setting range inputs with the rack driver
+* Support drop modifier keys in drag & drop [Elliot Crosby-McCullough]
+* `enabled_options` and `disabled options` filters for select selector
+* Support beginless ranges
+* Optionally allow `all` results to be reloaded when stable - Beta feature - may be removed in
+  future version if problems occur
+
+### Fixed
+
+* Fix Ruby 2.7 deprecation notices around keyword arguments. I have tried to do this without
+  any breaking changes, but due to the nature of the 2.7 changes and some selector types accepting
+  Hashes as locators there are a lot of edge cases. If you find any broken cases please report
+  them and I'll see if they're fixable.
+* Clicking on details/summary element behavior in rack_test driver_
+
+# Version 3.30.0
+Release date: 2019-12-24
+
+### Added
+
+* Display pending requests when they don't complete in time [Juan Carlos Medina]
+* :order option in selector queries - set to :reverse to for reverse document order results
+* Support regexp for :name and :placeholder options in selectors that import filters from
+  _field filter set
+
+### Fixed
+
+* Issue around automatic port assignment - Issue #2245
+* Label selector when label has no id - Issue #2260
+* Preserve clientX/clientY in Selenium HTML5 drag emulation [Nicolò G.]
+* table selector using :with_cols option if last specified column matched but others didn't - Issue #2287
+* Some tests updated for Ruby 2.7 behavior change around keyword args
+
 # Version 3.29.0
-Release date: Unreleased
+Release date: 2019-09-02
 
 ### Added
 
@@ -72,8 +287,8 @@ Release date: 2019-06-27
 
 ### Fixed
 
-* Woraround issue with chromedriver 76/77 in W3C mode losing mouse state during legacy drag. Only fixed if
-  both source and target are simultaenously inside the viewport - Issue #2223
+* Work around issue with chromedriver 76/77 in W3C mode losing mouse state during legacy drag. Only fixed if
+  both source and target are simultaneously inside the viewport - Issue #2223
 * Negative ancestor expectations/predicates were incorrectly checking siblings rather than ancestors
 
 # Version 3.24.0
@@ -352,7 +567,7 @@ Release date: 2018-10-23
 
 ### Fixed
 
-* Selector `css` expression definiton declared filters now work again
+* Selector `css` expression definition declared filters now work again
 * Cleaned up warnings [Yuji Yaginuma]
 * Workaround installation of rspec matcher proxies under jruby by reverting to the old solution not using prepend, so jruby bugs are not hit - Issue #2115
 
@@ -469,7 +684,7 @@ Release date: 2018-07-19
 
 ### Fixed
 
-* Make selenium driver :backspace clear stategy work even if caret location is in middle of field content [Champier Cyril]
+* Make selenium driver :backspace clear strategy work even if caret location is in middle of field content [Champier Cyril]
 * Selenium issue with fieldset nested in disabled fieldset not being considered disabled
 * `Session#evaluate_script` and `Element#evaluate_script` now strip leading/trailing whitespace from scripts [Ian Lesperance]
 
@@ -568,7 +783,7 @@ Release date: 2018-04-13
 ### Fixes
 
 * Fix expression filter descriptions in some selector failure messages
-* Fix compounding of negated matechers - Issue #2010
+* Fix compounding of negated matchers - Issue #2010
 
 # Version 3.0.1
 Release date: 2018-04-06
@@ -842,7 +1057,7 @@ Release date: 2016-12-05
 * Options for clearing session/local storage on reset added to the Selenium driver
 * Window size changes wait for the size to stabilize
 * Defined return value for most actions
-* Ignore specific error when qutting selenium driver instance - Issue #1773 [Dylan Reichstadt, Thomas Walpole]
+* Ignore specific error when quitting selenium driver instance - Issue #1773 [Dylan Reichstadt, Thomas Walpole]
 * Warn on selenium unknown errors rather than raising when quitting driver [Adam Pohorecki, Thomas Walpole]
 * Capybara::Result#each now returns an `Enumerator` when called without a block - Issue #1777 [Thomas Walpole]
 
@@ -904,7 +1119,7 @@ Release date: 2016-09-19
 
 ### Fixed
 
-* Issue with rack-test driver and obselete mime-types when using `#attach_file` - Issue #1756 [Thomas Walpole]
+* Issue with rack-test driver and obsolete mime-types when using `#attach_file` - Issue #1756 [Thomas Walpole]
 
 ### Added
 
@@ -971,7 +1186,7 @@ Release date: 2016-04-07
 
 ### Added
 
-* Capybara now waits for requests to Capybaras server to complete while restting the session [John Hawthorn, Thomas Walpole]
+* Capybara now waits for requests to Capybaras server to complete while resetting the session [John Hawthorn, Thomas Walpole]
 * Capybara.reuse_server option to allow disabling of sharing server instance between sessions [Thomas Walpole]
 * :multiple filter added to relevant selectors [Thomas Walpole]
 * Provided server registrations for :webrick and :puma. Capybara.server = :puma for testing with Rails 5 [Thomas Walpole]
@@ -985,7 +1200,7 @@ Release date: 2016-04-07
 
 # Version 2.6.2
 
-Relase date: 2016-01-27
+Release date: 2016-01-27
 
 ### Fixed
 
@@ -1531,8 +1746,8 @@ Release date: 2011-06-14
 * Rack::Test driver honours maxlength on input fields [Guilherme Carvalho]
 * Rack::Test now works as expected with domains and subdomains [Jonas Nicklas]
 * Session is reset more thoroughly between tests. [Jonas Nicklas]
-* Raise error when uploading non-existant file [Jonas Nicklas]
-* Rack reponse body should respond to #each [Piotr Sarnacki]
+* Raise error when uploading non-existent file [Jonas Nicklas]
+* Rack response body should respond to #each [Piotr Sarnacki]
 * Deprecation warnings with selenium webdriver 0.2.0 [Aaron Gibraltar]
 * Selenium Chrome no longer YELLS tagname [Carl Jackson & David W. Frank]
 * Capybara no longer strips encoding before sending to Rack [Jonas Nicklas]
@@ -1674,7 +1889,7 @@ Release date: 2010-05-12
 
 Release date: 2010-04-09
 
-This is a drop in compatible maintainance release. It's mostly
+This is a drop in compatible maintenance release. It's mostly
 important for driver authors.
 
 ### Added
@@ -1693,7 +1908,7 @@ important for driver authors.
 
 Release date: 2010-03-22
 
-This is a maintainance release with minor bug fixes, should be
+This is a maintenance release with minor bug fixes, should be
 drop in compatible.
 
 ### Added
@@ -1740,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

@@ -7,8 +7,6 @@
 [![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 3.29.x version of Capybara.
-
 Capybara helps you test web applications by simulating how a real user would
 interact with your app. It is agnostic about the driver running your tests and
 comes with Rack::Test and Selenium support built in. WebKit is supported
@@ -76,7 +74,7 @@ GitHub): http://groups.google.com/group/ruby-capybara
 
 ## <a name="setup"></a>Setup
 
-Capybara requires Ruby 2.4.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
@@ -149,10 +147,12 @@ require 'capybara/rspec'
 
 If you are using Rails, put your Capybara specs in `spec/features` or `spec/system` (only works
 if [you have it configured in
-RSpec](https://www.relishapp.com/rspec/rspec-rails/docs/upgrade#file-type-inference-disabled))
+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`.
 
@@ -260,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`:
@@ -1055,6 +1057,13 @@ additional info about how the underlying driver can be configured.
   are testing for specific server errors and using multiple sessions make sure to test for the
   errors using the initial session (usually :default)
 
+* If WebMock is enabled, you may encounter a "Too many open files"
+  error. A simple `page.find` call may cause thousands of HTTP requests
+  until the timeout occurs. By default, WebMock will cause each of these
+  requests to spawn a new connection. To work around this problem, you
+  may need to [enable WebMock's `net_http_connect_on_start: true`
+  parameter](https://github.com/bblimke/webmock/blob/master/README.md#connecting-on-nethttpstart).
+
 ## <a name="threadsafe"></a>"Threadsafe" mode
 
 In normal mode most of Capybara's configuration options are global settings which can cause issues

data/lib/capybara/config.rb

@@ -7,13 +7,13 @@ 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
-    attr_reader :reuse_server, :threadsafe
-    attr_reader :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
-    attr_accessor :allow_gumbo
 
     SessionConfig::OPTIONS.each do |method|
       def_delegators :session_options, method, "#{method}="
@@ -24,10 +24,12 @@ module Capybara
       @javascript_driver = nil
     end
 
-    attr_writer :reuse_server
+    attr_writer :reuse_server # rubocop:disable Style/BisectedAttrAccessor
 
     def threadsafe=(bool)
-      raise 'Threadsafe setting cannot be changed once a session is created' if (bool != threadsafe) && Session.instance_created?
+      if (bool != threadsafe) && Session.instance_created?
+        raise 'Threadsafe setting cannot be changed once a session is created'
+      end
 
       @threadsafe = bool
     end
@@ -59,7 +61,7 @@ module Capybara
       @server = if name.respond_to? :call
         name
       elsif options
-        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, options) }
+        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, **options) }
       else
         Capybara.servers[name.to_sym]
       end
@@ -81,10 +83,22 @@ module Capybara
       @javascript_driver || :selenium
     end
 
-    def deprecate(method, alternate_method, once = false)
+    def deprecate(method, alternate_method, once: false)
       @deprecation_notified ||= {}
-      warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once && @deprecation_notified[method]
+      unless once && @deprecation_notified[method]
+        Capybara::Helpers.warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead: #{Capybara::Helpers.filter_backtrace(caller)}"
+      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/cucumber.rb

@@ -22,6 +22,6 @@ end
 Before do |scenario|
   scenario.source_tag_names.each do |tag|
     driver_name = tag.sub(/^@/, '').to_sym
-    Capybara.current_driver = driver_name if Capybara.drivers.key?(driver_name)
+    Capybara.current_driver = driver_name if Capybara.drivers[driver_name]
   end
 end

data/lib/capybara/driver/base.rb

@@ -59,6 +59,14 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#status_code'
   end
 
+  def send_keys(*)
+    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,9 +47,11 @@ module Capybara
     end
 
     Session::DSL_METHODS.each do |method|
-      define_method method do |*args, &block|
-        page.send method, *args, &block
-      end
+      class_eval <<~METHOD, __FILE__, __LINE__ + 1
+        def #{method}(...)
+          page.method("#{method}").call(...)
+        end
+      METHOD
     end
   end
 

data/lib/capybara/helpers.rb

@@ -15,7 +15,7 @@ module Capybara
     # @return [String]         Normalized text
     #
     def normalize_whitespace(text)
-      warn 'DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver'
+      Capybara::Helpers.warn 'DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver'
       text.to_s.gsub(/[[:space:]]+/, ' ').strip
     end
 
@@ -70,6 +70,21 @@ module Capybara
       count == 1 ? singular : plural
     end
 
+    def filter_backtrace(trace)
+      return 'No backtrace' unless trace
+
+      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?
+
+      new_trace.first.split(/:in /, 2).first
+    end
+
+    def warn(message, uplevel: 1)
+      Kernel.warn(message, uplevel: uplevel)
+    end
+
     if defined?(Process::CLOCK_MONOTONIC)
       def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC; end
     else
@@ -87,7 +102,9 @@ module Capybara
       end
 
       def expired?
-        raise Capybara::FrozenInTime, 'Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead' if stalled?
+        if stalled?
+          raise Capybara::FrozenInTime, 'Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead'
+        end
 
         current - @start >= @expire_in
       end