capybara 3.13.2 → 3.40.0

data/lib/capybara/queries/text_query.rb

@@ -6,11 +6,19 @@ module Capybara
     class TextQuery < BaseQuery
       def initialize(type = nil, expected_text, session_options:, **options) # rubocop:disable Style/OptionalArguments
         @type = type.nil? ? default_type : type
-        @expected_text = expected_text.is_a?(Regexp) ? expected_text : expected_text.to_s
+        raise ArgumentError, "#{@type} is not a valid type for a text query" unless valid_types.include?(@type)
+
         @options = options
         super(@options)
         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. ' \
+               "Please specify a string or regexp instead. #{Capybara::Helpers.filter_backtrace(caller)}"
+        end
+
+        @expected_text = expected_text.is_a?(Regexp) ? expected_text : expected_text.to_s
+
         @search_regexp = Capybara::Helpers.to_regexp(@expected_text, exact: exact?)
 
         assert_valid_keys
@@ -83,6 +91,10 @@ module Capybara
         COUNT_KEYS + %i[wait exact normalize_ws]
       end
 
+      def valid_types
+        %i[all visible]
+      end
+
       def check_visible_text?
         @type == :visible
       end

data/lib/capybara/queries/title_query.rb

@@ -13,7 +13,7 @@ module Capybara
       end
 
       def resolves_for?(node)
-        (@actual_title = node.title).match(@search_regexp)
+        (@actual_title = node.title).match?(@search_regexp)
       end
 
       def failure_message

data/lib/capybara/rack_test/browser.rb

@@ -8,6 +8,7 @@ class Capybara::RackTest::Browser
 
   def initialize(driver)
     @driver = driver
+    @current_fragment = nil
   end
 
   def app
@@ -19,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
@@ -28,20 +31,29 @@ 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?
-    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => current_url)
+    uri = build_uri(path)
+    uri.query = '' if method.to_s.casecmp('get').zero?
+    env = { 'HTTP_REFERER' => referer_url }
+    env['CONTENT_TYPE'] = content_type if content_type
+    process_and_follow_redirects(
+      method,
+      uri.to_s,
+      attributes,
+      env
+    )
   end
 
   def follow(method, path, **attributes)
     return if fragment_or_script?(path)
 
-    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => current_url)
+    process_and_follow_redirects(method, path, attributes, 'HTTP_REFERER' => referer_url)
   end
 
   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
@@ -53,32 +65,42 @@ class Capybara::RackTest::Browser
         end
       end
     end
-    raise Capybara::InfiniteRedirectError, "redirected more than #{driver.redirect_limit} times, check for infinite redirects." if last_response.redirect?
+
+    if last_response.redirect? # rubocop:disable Style/GuardClause
+      raise Capybara::InfiniteRedirectError, "redirected more than #{driver.redirect_limit} times, check for infinite redirects."
+    end
   end
 
   def process(method, path, attributes = {}, env = {})
     method = method.downcase
     new_uri = build_uri(path)
     @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
 
   def build_uri(path)
-    URI.parse(path).tap do |uri|
-      uri.path = request_path if path.empty? || path.start_with?('?')
-      uri.path = '/' if uri.path.empty?
-      uri.path = request_path.sub(%r{/[^/]*$}, '/') + uri.path unless uri.path.start_with?('/')
+    uri = URI.parse(path)
+    base_uri = base_relative_uri_for(uri)
+
+    uri.path = base_uri.path + uri.path unless uri.absolute? || uri.path.start_with?('/')
 
+    if base_uri.absolute?
+      base_uri.merge(uri)
+    else
       uri.scheme ||= @current_scheme
       uri.host ||= @current_host
       uri.port ||= @current_port unless uri.default_port == @current_port
+      uri
     end
   end
 
   def current_url
-    last_request.url
+    uri = build_uri(last_request.url)
+    uri.fragment = @current_fragment if @current_fragment
+    uri.to_s
   rescue Rack::Test::Error
     ''
   end
@@ -114,8 +136,39 @@ 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
+    find(:css, 'head > base').first&.[](:href).to_s
+  end
+
+  def base_relative_uri_for(uri)
+    base_uri = URI.parse(base_href)
+    current_uri = URI.parse(safe_last_request&.url.to_s).tap do |c|
+      c.path.sub!(%r{/[^/]*$}, '/') unless uri.path.empty?
+      c.path = '/' if c.path.empty?
+    end
+
+    if [current_uri, base_uri].any?(&:absolute?)
+      current_uri.merge(base_uri)
+    else
+      base_uri.path = current_uri.path if base_uri.path.empty?
+      base_uri
+    end
+  end
+
   def build_rack_mock_session
     reset_host! unless current_host
     Rack::MockSession.new(app, current_host)
@@ -127,9 +180,21 @@ protected
     '/'
   end
 
+  def safe_last_request
+    last_request
+  rescue Rack::Test::Error
+    nil
+  end
+
 private
 
   def fragment_or_script?(path)
     path.gsub(/^#{Regexp.escape(request_path)}/, '').start_with?('#') || path.downcase.start_with?('javascript:')
   end
+
+  def referer_url
+    build_uri(last_request.url).to_s
+  rescue Rack::Test::Error
+    ''
+  end
 end

data/lib/capybara/rack_test/driver.rb

@@ -17,6 +17,7 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
   def initialize(app, **options)
     raise ArgumentError, 'rack-test requires a rack application, but none was given' unless app
 
+    super()
     @app = app
     @options = DEFAULT_OPTIONS.merge(options)
   end
@@ -42,7 +43,7 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
   end
 
   def visit(path, **attributes)
-    browser.visit(path, attributes)
+    browser.visit(path, **attributes)
   end
 
   def refresh
@@ -97,9 +98,13 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
     @browser = nil
   end
 
-  def get(*args, &block); browser.get(*args, &block); end
-  def post(*args, &block); browser.post(*args, &block); end
-  def put(*args, &block); browser.put(*args, &block); end
-  def delete(*args, &block); browser.delete(*args, &block); end
+  def get(...); browser.get(...); end
+  def post(...); browser.post(...); end
+  def put(...); browser.put(...); end
+  def delete(...); browser.delete(...); end
   def header(key, value); browser.header(key, value); end
+
+  def invalid_element_errors
+    [Capybara::RackTest::Errors::StaleElementReferenceError]
+  end
 end

data/lib/capybara/rack_test/errors.rb

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+module Capybara::RackTest::Errors
+  class StaleElementReferenceError < StandardError
+  end
+end

data/lib/capybara/rack_test/form.rb

@@ -6,7 +6,7 @@ class Capybara::RackTest::Form < Capybara::RackTest::Node
   # That check should be based solely on the form element's 'enctype' attribute value,
   # which should probably be provided to Rack::Test in its non-GET request methods.
   class NilUploadedFile < Rack::Test::UploadedFile
-    def initialize
+    def initialize # rubocop:disable Lint/MissingSuper
       @empty_file = Tempfile.new('nil_uploaded_file')
       @empty_file.close
     end
@@ -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?
@@ -56,7 +70,7 @@ private
   end
 
   def request_method
-    self[:method] =~ /post/i ? :post : :get
+    /post/i.match?(self[:method] || '') ? :post : :get
   end
 
   def merge_param!(params, key, value)
@@ -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/rack_test/node.rb

@@ -1,23 +1,19 @@
 # frozen_string_literal: true
 
+require 'capybara/rack_test/errors'
+require 'capybara/node/whitespace_normalizer'
+
 class Capybara::RackTest::Node < Capybara::Driver::Node
+  include Capybara::Node::WhitespaceNormalizer
+
   BLOCK_ELEMENTS = %w[p h1 h2 h3 h4 h5 h6 ol ul pre address blockquote dl div fieldset form hr noscript table].freeze
 
   def all_text
-    native.text
-          .gsub(/[\u200b\u200e\u200f]/, '')
-          .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
-          .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
-          .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
-          .tr("\u00a0", ' ')
+    normalize_spacing(native.text)
   end
 
   def visible_text
-    displayed_text.gsub(/\ +/, ' ')
-                  .gsub(/[\ \n]*\n[\ \n]*/, "\n")
-                  .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
-                  .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
-                  .tr("\u00a0", ' ')
+    normalize_visible_spacing(displayed_text)
   end
 
   def [](name)
@@ -43,6 +39,7 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
 
     if radio? then set_radio(value)
     elsif checkbox? then set_checkbox(value)
+    elsif range? then set_range(value)
     elsif input_field? then set_input(value)
     elsif textarea? then native['_capybara_raw_value'] = value.to_s
     end
@@ -61,8 +58,9 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     native.remove_attribute('selected')
   end
 
-  def click(keys = [], **offset)
-    raise ArgumentError, 'The RackTest driver does not support click options' unless keys.empty? && offset.empty?
+  def click(keys = [], **options)
+    options.delete(:offset)
+    raise ArgumentError, 'The RackTest driver does not support click options' unless keys.empty? && options.empty?
 
     if link?
       follow_link
@@ -73,6 +71,8 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
       set(!checked?)
     elsif tag_name == 'label'
       click_label
+    elsif (details = native.xpath('.//ancestor-or-self::details').last)
+      toggle_details(details)
     end
   end
 
@@ -102,20 +102,35 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     end
   end
 
+  def readonly?
+    # readonly attribute not valid on these input types
+    return false if input_field? && %w[hidden range color checkbox radio file submit image reset button].include?(type)
+
+    super
+  end
+
   def path
     native.path
   end
 
-  def find_xpath(locator)
+  def find_xpath(locator, **_hints)
     native.xpath(locator).map { |el| self.class.new(driver, el) }
   end
 
-  def find_css(locator)
+  def find_css(locator, **_hints)
     native.css(locator, Capybara::RackTest::CSSHandlers.new).map { |el| self.class.new(driver, el) }
   end
 
-  def ==(other)
-    native == other.native
+  public_instance_methods(false).each do |meth_name|
+    alias_method "unchecked_#{meth_name}", meth_name
+    private "unchecked_#{meth_name}" # rubocop:disable Style/AccessModifierDeclarations
+
+    class_eval <<~METHOD, __FILE__, __LINE__ + 1
+      def #{meth_name}(...)
+        stale_check
+        method(:"unchecked_#{meth_name}").call(...)
+      end
+    METHOD
   end
 
 protected
@@ -125,22 +140,28 @@ protected
     if !string_node.visible?(check_ancestor)
       ''
     elsif native.text?
-      native.text
-            .gsub(/[\u200b\u200e\u200f]/, '')
-            .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
+      native
+        .text
+        .delete(REMOVED_CHARACTERS)
+        .tr(SQUEEZED_SPACES, ' ')
+        .squeeze(' ')
     elsif native.element?
       text = native.children.map do |child|
         Capybara::RackTest::Node.new(driver, child).displayed_text(check_ancestor: false)
       end.join || ''
       text = "\n#{text}\n" if BLOCK_ELEMENTS.include?(tag_name)
       text
-    else
+    else # rubocop:disable Lint/DuplicateBranch
       ''
     end
   end
 
 private
 
+  def stale_check
+    raise Capybara::RackTest::Errors::StaleElementReferenceError unless native.document == driver.dom
+  end
+
   def deselect_options
     select_node.find_xpath('.//option[@selected]').each { |node| node.native.remove_attribute('selected') }
   end
@@ -180,6 +201,14 @@ private
     end
   end
 
+  def set_range(value) # rubocop:disable Naming/AccessorMethodName
+    min, max, step = (native['min'] || 0).to_f, (native['max'] || 100).to_f, (native['step'] || 1).to_f
+    value = value.to_f
+    value = value.clamp(min, max)
+    value = (((value - min) / step).round * step) + min
+    native['value'] = value.clamp(min, max)
+  end
+
   def set_input(value) # rubocop:disable Naming/AccessorMethodName
     if text_or_password? && attribute_is_not_blank?(:maxlength)
       # Browser behavior for maxlength="0" is inconsistent, so we stick with
@@ -195,7 +224,14 @@ private
       end
       native.remove
     else
-      native['value'] = value.to_s
+      value.to_s.tap do |set_value|
+        if set_value.end_with?("\n") && form&.css('input, textarea')&.count == 1
+          native['value'] = set_value.to_s.chop
+          Capybara::RackTest::Form.new(driver, form).submit(self)
+        else
+          native['value'] = set_value
+        end
+      end
     end
   end
 
@@ -204,7 +240,7 @@ private
   end
 
   def follow_link
-    method = self['data-method'] if driver.options[:respect_data_method]
+    method = self['data-method'] || self['data-turbo-method'] if driver.options[:respect_data_method]
     method ||= :get
     driver.follow(method, self[:href].to_s)
   end
@@ -219,6 +255,17 @@ private
     labelled_control.set(!labelled_control.checked?) if checkbox_or_radio?(labelled_control)
   end
 
+  def toggle_details(details = nil)
+    details ||= native.xpath('.//ancestor-or-self::details').last
+    return unless details
+
+    if details.has_attribute?('open')
+      details.remove_attribute('open')
+    else
+      details.set_attribute('open', 'open')
+    end
+  end
+
   def link?
     tag_name == 'a' && !self[:href].nil?
   end
@@ -257,6 +304,10 @@ protected
     tag_name == 'textarea'
   end
 
+  def range?
+    input_field? && type == 'range'
+  end
+
   OPTION_OWNER_XPATH = XPath.parent(:optgroup, :select, :datalist).to_s.freeze
   DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|
     x.parent(:fieldset)[

data/lib/capybara/registration_container.rb

@@ -0,0 +1,41 @@
+# frozen_string_literal: true
+
+module Capybara
+  # @api private
+  class RegistrationContainer
+    def names
+      @registered.keys
+    end
+
+    def [](name)
+      @registered[name]
+    end
+
+    def []=(name, value)
+      Capybara::Helpers.warn 'DEPRECATED: Directly setting drivers/servers is deprecated, please use Capybara.register_driver/register_server instead'
+      @registered[name] = value
+    end
+
+    def method_missing(method_name, ...)
+      if @registered.respond_to?(method_name)
+        Capybara::Helpers.warn "DEPRECATED: Calling '#{method_name}' on the drivers/servers container is deprecated without replacement"
+        return @registered.public_send(method_name, ...)
+      end
+      super
+    end
+
+    def respond_to_missing?(method_name, include_all)
+      @registered.respond_to?(method_name) || super
+    end
+
+  private
+
+    def initialize
+      @registered = {}
+    end
+
+    def register(name, block)
+      @registered[name] = block
+    end
+  end
+end

data/lib/capybara/registrations/drivers.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+Capybara.register_driver :rack_test do |app|
+  Capybara::RackTest::Driver.new(app)
+end
+
+Capybara.register_driver :selenium do |app|
+  Capybara::Selenium::Driver.new(app)
+end
+
+Capybara.register_driver :selenium_headless do |app|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  browser_options = Selenium::WebDriver::Firefox::Options.new.tap do |opts|
+    opts.add_argument '-headless'
+  end
+  Capybara::Selenium::Driver.new(app, **{ :browser => :firefox, options_key => browser_options })
+end
+
+Capybara.register_driver :selenium_chrome do |app|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  browser_options = Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    # Workaround https://bugs.chromium.org/p/chromedriver/issues/detail?id=2650&q=load&sort=-id&colspec=ID%20Status%20Pri%20Owner%20Summary
+    opts.add_argument('--disable-site-isolation-trials')
+  end
+
+  Capybara::Selenium::Driver.new(app, **{ :browser => :chrome, options_key => browser_options })
+end
+
+Capybara.register_driver :selenium_chrome_headless do |app|
+  version = Capybara::Selenium::Driver.load_selenium
+  options_key = Capybara::Selenium::Driver::CAPS_VERSION.satisfied_by?(version) ? :capabilities : :options
+  browser_options = Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    opts.add_argument('--headless=new')
+    opts.add_argument('--disable-gpu') if Gem.win_platform?
+    # Workaround https://bugs.chromium.org/p/chromedriver/issues/detail?id=2650&q=load&sort=-id&colspec=ID%20Status%20Pri%20Owner%20Summary
+    opts.add_argument('--disable-site-isolation-trials')
+  end
+
+  Capybara::Selenium::Driver.new(app, **{ :browser => :chrome, options_key => browser_options })
+end

data/lib/capybara/registrations/patches/puma_ssl.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Puma
+  module MiniSSL
+    class Socket
+      def read_nonblock(size, *_)
+        wait_states = %i[wait_readable wait_writable]
+
+        loop do
+          output = engine_read_all
+          return output if output
+
+          data = @socket.read_nonblock(size, exception: false)
+          raise IO::EAGAINWaitReadable if wait_states.include? data
+          return nil if data.nil?
+
+          @engine.inject(data)
+          output = engine_read_all
+
+          return output if output
+
+          while (neg_data = @engine.extract)
+            @socket.write neg_data
+          end
+        end
+      end
+    end
+  end
+end