capybara 3.33.0 → 3.34.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ab64d9d47c6374c4f203945be70b868fb9e4c48d3fdca087ba4e66498e40b91c
-  data.tar.gz: 451c97390c148b5b0fad1b06107a4f0de87f17f7b8cef7156fb76ad2ee503f76
+  metadata.gz: 73f13e5f3cec460ee010f53337dcbf2d7e692a3b5c557110331d81c75f5f2897
+  data.tar.gz: e137144d97fdb0c47a0464c07c4d12a39c36d62cc3c30aaa9201ed5676b2c66f
 SHA512:
-  metadata.gz: b0ca3fd8a4535e1df696ddc7f547e066b873d3f4be2b54655fdbb0b6588c5086a87b93500e241e0da031b586c0b6a30cdd8522f209309cf6729c683226bfcf7f
-  data.tar.gz: d295dcd733856816a1c89810f4d54304a52c251d585afcc62b986a66d63e080e03ddc81bdc46cf51a044e29d2849ccce9bb3cb307a0757746e662394f648a717
+  metadata.gz: 8130baab61559c5221035964a776d72ab84a119be31a6b6534de14ca3ebb5ca1cdcd128ad2cd7d004c45d3ff5c7de0103a756cc3fdcf19fb154d874c876883a5
+  data.tar.gz: 2379315a8629b50b0681fea69eb603d62d44c058df355f52151e319701d7577e5691fa43283848d0068c769bbd8be0a7890ddac904e7d7aa67e6be0a46261b7d

data/History.md

@@ -1,3 +1,31 @@
+# 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 assetsions/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
 
@@ -7,11 +35,12 @@ Release date: 2020-06-21
 * 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 manupulation of the driver and server registries
+* Deprecated direct manipulation of the driver and server registries
 
 ### Fixed
 
@@ -41,7 +70,7 @@ 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
 
@@ -162,8 +191,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
@@ -442,7 +471,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
 
@@ -559,7 +588,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]
 
@@ -658,7 +687,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
@@ -932,7 +961,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]
 
@@ -994,7 +1023,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
 
@@ -1061,7 +1090,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]
@@ -1075,7 +1104,7 @@ Release date: 2016-04-07
 
 # Version 2.6.2
 
-Relase date: 2016-01-27
+Release date: 2016-01-27
 
 ### Fixed
 
@@ -1621,8 +1650,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]
@@ -1764,7 +1793,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
@@ -1783,7 +1812,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.33.x release 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

data/lib/capybara.rb

@@ -484,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'

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/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,10 +50,10 @@ 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, **kwargs)
+          def assert_#{assertion_name}(*args, **kwargs, &optional_filter_block)
             self.assertions +=1
             subject, args = determine_subject(args)
-            subject.assert_#{assertion_name}(*args, **kwargs)
+            subject.assert_#{assertion_name}(*args, **kwargs, &optional_filter_block)
           rescue Capybara::ExpectationNotMet => e
             raise ::Minitest::Assertion, e.message
           end

data/lib/capybara/minitest/spec.rb

@@ -209,13 +209,15 @@ module Capybara
       # @!method wont_have_xpath
       #   See {Capybara::Node::Matchers#has_no_xpath?}
 
-      %w[text content title current_path].each do |assertion|
-        infect_an_assertion "assert_#{assertion}", "must_have_#{assertion}", :reverse
-        infect_an_assertion "refute_#{assertion}", "wont_have_#{assertion}", :reverse
-      end
+      # This currently doesn't work for Ruby 2.8 due to Minitest not forwarding keyword args separately
+      # %w[text content title current_path].each do |assertion|
+      #   infect_an_assertion "assert_#{assertion}", "must_have_#{assertion}", :reverse
+      #   infect_an_assertion "refute_#{assertion}", "wont_have_#{assertion}", :reverse
+      # end
 
       # rubocop:disable Style/MultilineBlockChain
-      (%w[selector xpath css link button field select table checked_field unchecked_field
+      (%w[text content title current_path
+          selector xpath css link button field select table checked_field unchecked_field
           ancestor sibling].flat_map do |assertion|
             [%W[assert_#{assertion} must_have_#{assertion}],
              %W[refute_#{assertion} wont_have_#{assertion}]]
@@ -228,14 +230,15 @@ module Capybara
          %W[refute_matches_#{assertion} wont_match_#{assertion}]]
       end).each do |(meth, new_name)|
         class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def #{new_name} *args, &block
-            ::Minitest::Expectation.new(self, ::Minitest::Spec.current).#{new_name}(*args, &block)
+          def #{new_name} *args, **kw_args, &block
+            ::Minitest::Expectation.new(self, ::Minitest::Spec.current).#{new_name}(*args, **kw_args, &block)
           end
         ASSERTION
 
         ::Minitest::Expectation.class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def #{new_name} *args, &block
-            ctx.#{meth}(target, *args, &block)
+          def #{new_name} *args, **kw_args, &block
+            raise "Calling ##{new_name} outside of test." unless ctx
+            ctx.#{meth}(target, *args, **kw_args, &block)
           end
         ASSERTION
       end
@@ -243,9 +246,9 @@ module Capybara
 
       ##
       # @deprecated
-      def must_have_style(*args, &block)
+      def must_have_style(*args, **kw_args, &block)
         warn 'must_have_style is deprecated, please use must_match_style'
-        must_match_style(*args, &block)
+        must_match_style(*args, **kw_args, &block)
       end
     end
   end

data/lib/capybara/node/actions.rb

@@ -363,7 +363,6 @@ module Capybara
       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
           el = find(selector, locator, **options)
           el.set(checked)
@@ -372,7 +371,7 @@ module Capybara
 
           begin
             el ||= find(selector, locator, **options.merge(visible: :all))
-            el.session.find(:label, for: el, visible: true).click unless el.checked? == checked
+            el.session.find(:label, for: el, visible: true, match: :first).click unless el.checked? == checked
           rescue StandardError # swallow extra errors - raise original
             raise e
           end

data/lib/capybara/node/element.rb

@@ -435,11 +435,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element
       def drop(*args)
-        options = args.map do |arg|
-          return arg.to_path if arg.respond_to?(:to_path)
-
-          arg
-        end
+        options = args.map { |arg| arg.respond_to?(:to_path) ? arg.to_path : arg }
         synchronize { base.drop(*options) }
         self
       end

data/lib/capybara/node/finders.rb

@@ -24,12 +24,13 @@ module Capybara
       #   @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.
       #     Defaults to {Capybara.configure default_normalize_ws}.
-      #   @option options [Boolean, Symbol] visible  Only find elements with the specified visibility:
-      #                                              * true - only finds visible elements.
-      #                                              * false - finds invisible _and_ visible elements.
-      #                                              * :all - same as false; finds visible and invisible elements.
-      #                                              * :hidden - only finds invisible elements.
-      #                                              * :visible - same as true; only finds visible elements.
+      #   @option options [Boolean, Symbol] visible
+      #     Only find elements with the specified visibility. Defaults to behavior indicated by {Capybara.configure ignore_hidden_elements}.
+      #       * true - only finds visible elements.
+      #       * false - finds invisible _and_ visible elements.
+      #       * :all - same as false; finds visible and invisible elements.
+      #       * :hidden - only finds invisible elements.
+      #       * :visible - same as true; only finds visible elements.
       #   @option options [Boolean] obscured  Only find elements with the specified obscured state:
       #                                       * true - only find elements whose centerpoint is not in the viewport or is obscured by another non-descendant element.
       #                                       * false - only find elements whose centerpoint is in the viewport and is not obscured by other non-descendant elements.

data/lib/capybara/node/matchers.rb

@@ -60,15 +60,16 @@ module Capybara
       # @param styles [Hash]
       # @return [Boolean]                       If the styles match
       #
-      def matches_style?(styles, **options)
+      def matches_style?(styles = nil, **options)
+        styles, options = options, {} if styles.nil?
         make_predicate(options) { assert_matches_style(styles, **options) }
       end
 
       ##
       # @deprecated Use {#matches_style?} instead.
       #
-      def has_style?(styles, **options)
-        warn 'DEPRECATED: has_style? is deprecated, please use matches_style?'
+      def has_style?(styles = nil, **options)
+        Capybara::Helpers.warn "DEPRECATED: has_style? is deprecated, please use matches_style? : #{Capybara::Helpers.filter_backtrace(caller)}"
         matches_style?(styles, **options)
       end
 
@@ -122,7 +123,8 @@ module Capybara
       # @param styles [Hash]
       # @raise [Capybara::ExpectationNotMet]    If the element doesn't have the specified styles
       #
-      def assert_matches_style(styles, **options)
+      def assert_matches_style(styles = nil, **options)
+        styles, options = options, {} if styles.nil?
         query_args, query_opts = _set_query_session_options(styles, options)
         query = Capybara::Queries::StyleQuery.new(*query_args, **query_opts)
         synchronize(query.wait) do
@@ -134,7 +136,7 @@ module Capybara
       ##
       # @deprecated Use {#assert_matches_style} instead.
       #
-      def assert_style(styles, **options)
+      def assert_style(styles = nil, **options)
         warn 'assert_style is deprecated, please use assert_matches_style instead'
         assert_matches_style(styles, **options)
       end

data/lib/capybara/node/simple.rb

@@ -100,7 +100,7 @@ module Capybara
       # @param  [Boolean] check_ancestors  Whether to inherit visibility from ancestors
       # @return [Boolean]     Whether the element is visible
       #
-      def visible?(check_ancestors = true)
+      def visible?(check_ancestors = true) # rubocop:disable Style/OptionalBooleanParameter
         return false if (tag_name == 'input') && (native[:type] == 'hidden')
         return false if tag_name == 'template'
 
@@ -148,6 +148,10 @@ module Capybara
         native.has_attribute?('multiple')
       end
 
+      def readonly?
+        native.has_attribute?('readonly')
+      end
+
       def synchronize(_seconds = nil)
         yield # simple nodes don't need to wait
       end

data/lib/capybara/queries/ancestor_query.rb

@@ -16,7 +16,7 @@ module Capybara
         end
       end
 
-      def description(applied = false)
+      def description(applied = false) # rubocop:disable Style/OptionalBooleanParameter
         child_query = @child_node&.instance_variable_get(:@query)
         desc = super
         desc += " that is an ancestor of #{child_query.description}" if child_query