capybara 3.32.0 → 3.35.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f60918220b590a4a64f3bb1a42b7e8c5dac86dddcec48d46c0f92c1ac6c491f
-  data.tar.gz: aab5f09c11d94dc1becdb514d753011cdfad7f2a43f0e59b074ff6e69aa49847
+  metadata.gz: 00bf1cfd1e72093422fb61df1dae86d72948e8026d57fb00084d5bedceb0967e
+  data.tar.gz: 65a8c6b66d1ef91586ca39f7eabcf800019f853e33e087d1bb65f02a85140c8b
 SHA512:
-  metadata.gz: 7adcf8fbe5fe95d42c3c7fe513f62236cf93dd0f95bbccb20d31c1022a5e87bd64514d2fd6f57a263d31b96945a2e1c7a300d6b16db018651b929abd137e8290
-  data.tar.gz: d28874576cd8613f16b1d455785e4e6fba9cb387b8580ba0bdc0c46f13255661f07e47a51f5d7f2c28afa6691a4c330e094ff9625a89bb4f6f5d9532a3123063
+  metadata.gz: f961de052aa75cb3e3a941ea031d40d6d0f1fc2a9a80190c7dbe2f7d8e96b462fa71d4ed96d4dc45687e2baaf151579ca4508a2753a6e2073814857e2dee9bb4
+  data.tar.gz: 4b02c84f7bd1d9da419e3f43848da87290ba303541df516e6217fd3fc2e4cf5263e212e9a4a5329c8505b2f6111c0ce6ea17537ea3099b04f12c9b662d364088

data/History.md

@@ -1,10 +1,94 @@
+# Version 3.35.0
+Release date: 2020-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
-Relesae date: 2020-03-29
+Release date: 2020-03-29
 
 ### Added
 
 * Support `delay` setting on click with Selenium
-* Implement rapid set for values longer thn 30 characters in text fields with Selenium
+* Implement rapid set for values longer than 30 characters in text fields with Selenium
 
 ### Fixed
 
@@ -125,8 +209,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
@@ -405,7 +489,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
 
@@ -522,7 +606,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]
 
@@ -621,7 +705,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
@@ -895,7 +979,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]
 
@@ -957,7 +1041,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
 
@@ -1024,7 +1108,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]
@@ -1038,7 +1122,7 @@ Release date: 2016-04-07
 
 # Version 2.6.2
 
-Relase date: 2016-01-27
+Release date: 2016-01-27
 
 ### Fixed
 
@@ -1584,8 +1668,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]
@@ -1727,7 +1811,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
@@ -1746,7 +1830,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

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.32.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.5.0 or later. To install, add this line to your
 `Gemfile` and run `bundle install`:
 
 ```ruby
@@ -149,7 +147,7 @@ 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.
 
@@ -1055,6 +1053,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.rb

@@ -5,6 +5,7 @@ require 'nokogiri'
 require 'xpath'
 require 'forwardable'
 require 'capybara/config'
+require 'capybara/registration_container'
 
 module Capybara
   class CapybaraError < StandardError; end
@@ -81,6 +82,7 @@ module Capybara
     # - **default_selector** (`:css`, `:xpath` = `:css`) - Methods which take a selector use the given type by default. See also {Capybara::Selector}.
     # - **default_set_options** (Hash = `{}`) - The default options passed to {Capybara::Node::Element#set Element#set}.
     # - **enable_aria_label** (Boolean = `false`) - Whether fields, links, and buttons will match against `aria-label` attribute.
+    # - **enable_aria_role** (Boolean = `false`) - Selectors will check for relevant aria role (currently only `button`).
     # - **exact** (Boolean = `false`) - Whether locators are matched exactly or with substrings. Only affects selector conditions
     #   written using the `XPath#is` method.
     # - **exact_text** (Boolean = `false`) - Whether the text matchers and `:text` filter match exactly or on substrings.
@@ -93,6 +95,7 @@ module Capybara
     # - **save_path** (String = `Dir.pwd`) - Where to put pages saved through {Capybara::Session#save_page save_page}, {Capybara::Session#save_screenshot save_screenshot},
     #   {Capybara::Session#save_and_open_page save_and_open_page}, or {Capybara::Session#save_and_open_screenshot save_and_open_screenshot}.
     # - **server** (Symbol = `:default` (which uses puma)) - The name of the registered server to use when running the app under test.
+    # - **server_port** (Integer) - The port Capybara will run the application server on, if not specified a random port will be used.
     # - **server_errors** (Array\<Class> = `[Exception]`) - Error classes that should be raised in the tests if they are raised in the server
     #   and {configure raise_server_errors} is `true`.
     # - **test_id** (Symbol, String, `nil` = `nil`) - Optional attribute to match locator against with built-in selectors along with id.
@@ -124,7 +127,7 @@ module Capybara
     # @yieldreturn [Capybara::Driver::Base]   A Capybara driver instance
     #
     def register_driver(name, &block)
-      drivers[name] = block
+      drivers.send(:register, name, block)
     end
 
     ##
@@ -143,7 +146,7 @@ module Capybara
     # @yieldparam host                        The host/ip to bind to
     #
     def register_server(name, &block)
-      servers[name.to_sym] = block
+      servers.send(:register, name.to_sym, block)
     end
 
     ##
@@ -197,11 +200,11 @@ module Capybara
     end
 
     def drivers
-      @drivers ||= {}
+      @drivers ||= RegistrationContainer.new
     end
 
     def servers
-      @servers ||= {}
+      @servers ||= RegistrationContainer.new
     end
 
     # Wraps the given string, which should contain an HTML document or fragment
@@ -349,7 +352,8 @@ module Capybara
     #
     # Yield a block using a specific session name or {Capybara::Session} instance.
     #
-    def using_session(name_or_session)
+    def using_session(name_or_session, &block)
+      previous_session = current_session
       previous_session_info = {
         specified_session: specified_session,
         session_name: session_name,
@@ -362,7 +366,12 @@ module Capybara
       else
         self.session_name = name_or_session
       end
-      yield
+
+      if block.arity.zero?
+        yield
+      else
+        yield current_session, previous_session
+      end
     ensure
       self.session_name, self.specified_session = previous_session_info.values_at(:session_name, :specified_session)
       self.current_driver, self.app = previous_session_info.values_at(:current_driver, :app) if threadsafe
@@ -394,7 +403,7 @@ module Capybara
             template.inner_html = ''
           end
           document.xpath('//textarea').each do |textarea|
-            textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/, '')
+            textarea['_capybara_raw_value'] = textarea.content.delete_prefix("\n")
           end
         end
       end
@@ -475,7 +484,7 @@ module Capybara
   require 'capybara/rack_test/node'
   require 'capybara/rack_test/form'
   require 'capybara/rack_test/browser'
-  require 'capybara/rack_test/css_handlers.rb'
+  require 'capybara/rack_test/css_handlers'
 
   require 'capybara/selenium/node'
   require 'capybara/selenium/driver'
@@ -501,6 +510,7 @@ Capybara.configure do |config|
   config.visible_text_only = false
   config.automatic_label_click = false
   config.enable_aria_label = false
+  config.enable_aria_role = false
   config.reuse_server = true
   config.default_set_options = {}
   config.test_id = nil

data/lib/capybara/config.rb

@@ -9,11 +9,9 @@ module Capybara
 
     OPTIONS = %i[app reuse_server threadsafe server default_driver javascript_driver allow_gumbo].freeze
 
-    attr_accessor :app
-    attr_reader :reuse_server, :threadsafe
-    attr_reader :session_options
+    attr_accessor :app, :allow_gumbo
+    attr_reader :reuse_server, :threadsafe, :session_options
     attr_writer :default_driver, :javascript_driver
-    attr_accessor :allow_gumbo
 
     SessionConfig::OPTIONS.each do |method|
       def_delegators :session_options, method, "#{method}="
@@ -83,10 +81,10 @@ module Capybara
       @javascript_driver || :selenium
     end
 
-    def deprecate(method, alternate_method, once = false)
+    def deprecate(method, alternate_method, once: false)
       @deprecation_notified ||= {}
       unless once && @deprecation_notified[method]
-        warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
+        Capybara::Helpers.warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead: #{Capybara::Helpers.filter_backtrace(caller)}"
       end
       @deprecation_notified[method] = true
     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,10 @@ 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
+
   ##
   #
   # @param frame [Capybara::Node::Element, :parent, :top]  The iframe element to switch to

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,30 @@ module Capybara
       count == 1 ? singular : plural
     end
 
+    def filter_backtrace(trace)
+      return 'No backtrace' unless trace
+
+      filter = %r{lib/capybara/|lib/rspec/|lib/minitest/}
+      new_trace = trace.take_while { |line| line !~ filter }
+      new_trace = trace.reject { |line| line =~ 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
+    end
+
     if defined?(Process::CLOCK_MONOTONIC)
       def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC; end
     else

data/lib/capybara/minitest.rb

@@ -50,15 +50,14 @@ module Capybara
 
       %w[text no_text title no_title current_path no_current_path].each do |assertion_name|
         class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def assert_#{assertion_name} *args
+          def assert_#{assertion_name}(*args, **kwargs, &optional_filter_block)
             self.assertions +=1
             subject, args = determine_subject(args)
-            subject.assert_#{assertion_name}(*args)
+            subject.assert_#{assertion_name}(*args, **kwargs, &optional_filter_block)
           rescue Capybara::ExpectationNotMet => e
             raise ::Minitest::Assertion, e.message
           end
         ASSERTION
-        ruby2_keywords "assert_#{assertion_name}" if respond_to?(:ruby2_keywords)
       end
 
       alias_method :refute_title, :assert_no_title