capybara 3.37.0 → 3.38.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 125837a4db6ae6c9b12ab2339f5daa673397ef9cdb9054689fb1d155a5d6e62f
-  data.tar.gz: 445b064e8ae642678457cbf2739a1a6124b7d35dd6aaf295d3d9edce4f6ee8f3
+  metadata.gz: 163cb499d23bf17278c9912462fb3fb337b2d28b764a95c5ed3f9c4af3f1c317
+  data.tar.gz: 7010ef4e7f6af6c4d78ae58a05846c2607864d6fe24d05c49747fc1e1ded8675
 SHA512:
-  metadata.gz: 95154994ad904eae4c9eeb73605bcc273daef240a0cbf241afa8cf1bcfef1ca2de52ecd159fe551ee2d863a0a9a07a2fb9a3beab659f334ec5782f50c5af4ba1
-  data.tar.gz: 600e6610c5c48ac5619d1c4cf2ddfc83b86d5315ea259c7d8a6476863a14d4a209bcec0c6334dab5f3ebefac5eaeb1ccaa8a263114a5838f7a49a8483fb44538
+  metadata.gz: 66ac2676f22d83ec1a4478f68a8f7f095c9c9f9396eb1b5c1bf34803e15e19ed02c1f1342731d55787219ddd2d9d0829eb0c76ef702c4e07ac3a0b19a9c2aaec
+  data.tar.gz: f35c37f9ccdcdd58c1c76c80cf58eb8c62b0878bb40ff1dd6191978978409b41adabbc34013868e30a5ec4f33d077532ad8c1a90fdf0138dd524703c5168a001

data/History.md

@@ -1,3 +1,40 @@
+# 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
 
@@ -803,7 +840,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
@@ -1209,7 +1246,7 @@ Release date: 2016-01-27
 
 # Version 2.6.0
 
-Relase date: 2016-01-17
+Release date: 2016-01-17
 
 ### Fixed
 
@@ -1273,7 +1310,7 @@ Release date: 2014-10-13
 
 # Version 2.4.3
 
-Relase date: 2014-09-21
+Release date: 2014-09-21
 
 ### Fixed
 

data/README.md

@@ -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/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/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/finders.rb

@@ -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/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

@@ -272,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)
@@ -570,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

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
 

data/lib/capybara/rack_test/browser.rb

@@ -20,6 +20,8 @@ class Capybara::RackTest::Browser
   end
 
   def visit(path, **attributes)
+    @new_visit_request = true
+    reset_cache!
     reset_host!
     process_and_follow_redirects(:get, path, attributes)
   end
@@ -29,11 +31,17 @@ class Capybara::RackTest::Browser
     request(last_request.fullpath, last_request.env)
   end
 
-  def submit(method, path, attributes)
+  def submit(method, path, attributes, content_type: nil)
     path = request_path if path.nil? || path.empty?
     uri = build_uri(path)
     uri.query = '' if method.to_s.casecmp('get').zero?
-    process_and_follow_redirects(method, uri.to_s, attributes, 'HTTP_REFERER' => referer_url)
+    process_and_follow_redirects(
+      method,
+      uri.to_s,
+      attributes,
+      'HTTP_REFERER' => referer_url,
+      'CONTENT_TYPE' => content_type
+    )
   end
 
   def follow(method, path, **attributes)
@@ -45,7 +53,6 @@ class Capybara::RackTest::Browser
   def process_and_follow_redirects(method, path, attributes = {}, env = {})
     @current_fragment = build_uri(path).fragment
     process(method, path, attributes, env)
-
     return unless driver.follow_redirects?
 
     driver.redirect_limit.times do
@@ -69,6 +76,7 @@ class Capybara::RackTest::Browser
     @current_scheme, @current_host, @current_port = new_uri.select(:scheme, :host, :port)
     @current_fragment = new_uri.fragment || @current_fragment
     reset_cache!
+    @new_visit_request = false
     send(method, new_uri.to_s, attributes, env.merge(options[:headers] || {}))
   end
 
@@ -127,6 +135,18 @@ class Capybara::RackTest::Browser
     dom.title
   end
 
+  def last_request
+    raise Rack::Test::Error if @new_visit_request
+
+    super
+  end
+
+  def last_response
+    raise Rack::Test::Error if @new_visit_request
+
+    super
+  end
+
 protected
 
   def base_href

data/lib/capybara/rack_test/form.rb

@@ -16,6 +16,8 @@ class Capybara::RackTest::Form < Capybara::RackTest::Node
     def path; @empty_file.path; end
     def size; 0; end
     def read; ''; end
+    def append_to(_); end
+    def set_encoding(_); end # rubocop:disable Naming/AccessorMethodName
   end
 
   def params(button)
@@ -28,19 +30,31 @@ class Capybara::RackTest::Form < Capybara::RackTest::Node
 
     form_elements = native.xpath(form_elements_xpath).reject { |el| submitter?(el) && (el != button.native) }
 
-    form_elements.each_with_object(make_params) do |field, params|
+    form_params = form_elements.each_with_object({}.compare_by_identity) do |field, params|
       case field.name
       when 'input', 'button' then add_input_param(field, params)
       when 'select' then add_select_param(field, params)
       when 'textarea' then add_textarea_param(field, params)
       end
+    end
+
+    form_params.each_with_object(make_params) do |(name, value), params|
+      merge_param!(params, name, value)
     end.to_params_hash
+
+    # form_elements.each_with_object(make_params) do |field, params|
+    #   case field.name
+    #   when 'input', 'button' then add_input_param(field, params)
+    #   when 'select' then add_select_param(field, params)
+    #   when 'textarea' then add_textarea_param(field, params)
+    #   end
+    # end.to_params_hash
   end
 
   def submit(button)
     action = button&.[]('formaction') || native['action']
     method = button&.[]('formmethod') || request_method
-    driver.submit(method, action.to_s, params(button))
+    driver.submit(method, action.to_s, params(button), content_type: native['enctype'])
   end
 
   def multipart?
@@ -86,6 +100,8 @@ private
 
       Capybara::RackTest::Node.new(driver, field).value.to_s
     when 'file'
+      return if value.empty? && params.keys.include?(name) && Rack::Test::VERSION.to_f >= 2.0 # rubocop:disable Performance/InefficientHashSearch
+
       if multipart?
         file_to_upload(value)
       else
@@ -94,7 +110,8 @@ private
     else
       value
     end
-    merge_param!(params, name, value)
+    # merge_param!(params, name, value)
+    params[name] = value
   end
 
   def file_to_upload(filename)
@@ -107,18 +124,23 @@ private
   end
 
   def add_select_param(field, params)
+    name = field['name']
     if field.has_attribute?('multiple')
-      field.xpath('.//option[@selected]').each do |option|
-        merge_param!(params, field['name'], (option['value'] || option.text).to_s)
+      value = field.xpath('.//option[@selected]').map do |option|
+        # merge_param!(params, field['name'], (option['value'] || option.text).to_s)
+        (option['value'] || option.text).to_s
       end
+      params[name] = value unless value.empty?
     else
       option = field.xpath('.//option[@selected]').first || field.xpath('.//option').first
-      merge_param!(params, field['name'], (option['value'] || option.text).to_s) if option
+      # merge_param!(params, field['name'], (option['value'] || option.text).to_s) if option
+      params[name] = (option['value'] || option.text).to_s if option
     end
   end
 
   def add_textarea_param(field, params)
-    merge_param!(params, field['name'], field['_capybara_raw_value'].to_s.gsub(/\n/, "\r\n"))
+    # merge_param!(params, field['name'], field['_capybara_raw_value'].to_s.gsub(/\r?\n/, "\r\n"))
+    params[field['name']] = field['_capybara_raw_value'].to_s.gsub(/\r?\n/, "\r\n")
   end
 
   def submitter?(el)

data/lib/capybara/registrations/servers.rb

@@ -10,7 +10,7 @@ Capybara.register_server :webrick do |app, port, host, **options|
   Rack::Handler::WEBrick.run(app, **options)
 end
 
-Capybara.register_server :puma do |app, port, host, **options|
+Capybara.register_server :puma do |app, port, host, **options| # rubocop:disable Metrics/BlockLength
   begin
     require 'rack/handler/puma'
   rescue LoadError
@@ -29,17 +29,25 @@ Capybara.register_server :puma do |app, port, host, **options|
 
   conf = Rack::Handler::Puma.config(app, options)
   conf.clamp
-  events = conf.options[:Silent] ? ::Puma::Events.strings : ::Puma::Events.stdio
 
   puma_ver = Gem::Version.new(Puma::Const::PUMA_VERSION)
   require_relative 'patches/puma_ssl' if Gem::Requirement.new('>=4.0.0', '< 4.1.0').satisfied_by?(puma_ver)
 
-  events.log 'Capybara starting Puma...'
-  events.log "* Version #{Puma::Const::PUMA_VERSION} , codename: #{Puma::Const::CODE_NAME}"
-  events.log "* Min threads: #{conf.options[:min_threads]}, max threads: #{conf.options[:max_threads]}"
-
-  Puma::Server.new(conf.app, events, conf.options).tap do |s|
-    s.binder.parse conf.options[:binds], s.events
-    s.min_threads, s.max_threads = conf.options[:min_threads], conf.options[:max_threads]
+  logger = (defined?(::Puma::LogWriter) ? ::Puma::LogWriter : ::Puma::Events).then do |cls|
+    conf.options[:Silent] ? cls.strings : cls.stdio
+  end
+  conf.options[:log_writer] = logger
+
+  logger.log 'Capybara starting Puma...'
+  logger.log "* Version #{Puma::Const::PUMA_VERSION} , codename: #{Puma::Const::CODE_NAME}"
+  logger.log "* Min threads: #{conf.options[:min_threads]}, max threads: #{conf.options[:max_threads]}"
+
+  Puma::Server.new(
+    conf.app,
+    defined?(::Puma::LogWriter) ? nil : logger,
+    conf.options
+  ).tap do |s|
+    s.binder.parse conf.options[:binds], (s.log_writer rescue s.events) # rubocop:disable Style/RescueModifier
+    s.min_threads, s.max_threads = conf.options[:min_threads], conf.options[:max_threads] if s.respond_to? :min_threads=
   end.run.join
 end

data/lib/capybara/selector/definition.rb

@@ -203,7 +203,7 @@ module Capybara
 
       ##
       #
-      # Set the default visibility mode that shouble be used if no visibile option is passed when using the selector.
+      # Set the default visibility mode that should be used if no visible option is passed when using the selector.
       # If not specified will default to the behavior indicated by Capybara.ignore_hidden_elements
       #
       # @param [Symbol] default_visibility  Only find elements with the specified visibility:

data/lib/capybara/selector/filter_set.rb

@@ -101,11 +101,10 @@ module Capybara
     private
 
       def options_with_defaults(options)
-        expression_filters.chain(node_filters)
-                          .select { |_n, filter| filter.default? }
-                          .each_with_object(options.dup) do |(name, filter), opts|
-          opts[name] = filter.default unless opts.key?(name)
-        end
+        expression_filters
+          .chain(node_filters)
+          .filter_map { |name, filter| [name, filter.default] if filter.default? }
+          .to_h.merge!(options)
       end
 
       def add_filter(name, filter_class, *types, matcher: nil, **options, &block)

data/lib/capybara/selector/regexp_disassembler.rb

@@ -69,11 +69,8 @@ module Capybara
         suffixes = [[]]
         strs.reverse_each do |str|
           if str.is_a? Set
-            prefixes = str.each_with_object([]) { |s, memo| memo.concat combine(s) }
-
-            result = []
-            prefixes.product(suffixes) { |pair| result << pair.flatten(1) }
-            suffixes = result
+            prefixes = str.flat_map { |s| combine(s) }
+            suffixes = prefixes.product(suffixes).map { |pair| pair.flatten(1) }
           else
             suffixes.each { |arr| arr.unshift str }
           end

data/lib/capybara/selector/selector.rb

@@ -66,7 +66,11 @@ module Capybara
       end
     ensure
       unless locator_valid?(locator)
-        warn "Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. This will raise an error in a future version of Capybara."
+        Capybara::Helpers.warn(
+          "Locator #{locator.class}:#{locator.inspect} for selector #{name.inspect} must #{locator_description}. " \
+          'This will raise an error in a future version of Capybara. ' \
+          "Called from: #{Capybara::Helpers.filter_backtrace(caller)}"
+        )
       end
     end
 

data/lib/capybara/selenium/driver.rb

@@ -323,6 +323,9 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
             ]
           end
         end
+        if defined?(::Selenium::WebDriver::Error::DetachedShadowRootError)
+          errors.concat([::Selenium::WebDriver::Error::DetachedShadowRootError])
+        end
       end
   end
 

data/lib/capybara/selenium/extensions/html5_drag.rb

@@ -39,10 +39,8 @@ class Capybara::Selenium::Node
         input.set_file(args)
         driver.execute_script DROP_FILE, self, input
       else
-        items = args.each_with_object([]) do |arg, arr|
-          arg.each_with_object(arr) do |(type, data), arr_|
-            arr_ << { type: type, data: data }
-          end
+        items = args.flat_map do |arg|
+          arg.map { |(type, data)| { type: type, data: data } }
         end
         driver.execute_script DROP_STRING, items, self
       end

data/lib/capybara/selenium/logger_suppressor.rb

@@ -18,6 +18,10 @@ module Capybara
         end
       end
 
+      def warn(*args, **opts)
+        super unless @suppress_for_capybara
+      end
+
       def suppress_deprecations
         prev_suppress_for_capybara, @suppress_for_capybara = @suppress_for_capybara, true
         yield