capybara 3.23.0 → 3.35.3

data/lib/capybara/queries/sibling_query.rb

@@ -3,25 +3,19 @@
 module Capybara
   module Queries
     class SiblingQuery < SelectorQuery
-      def initialize(*args)
-        super
-        @count_options = {}
-        COUNT_KEYS.each do |key|
-          @count_options[key] = @options.delete(key) if @options.key?(key)
-        end
-      end
-
       # @api private
       def resolve_for(node, exact = nil)
         @sibling_node = node
         node.synchronize do
           match_results = super(node.session.current_scope, exact)
-          xpath = XPath.preceding_sibling + XPath.following_sibling
-          node.all(:xpath, xpath, **@count_options) { |el| match_results.include?(el) }
+          siblings = node.find_xpath((XPath.preceding_sibling + XPath.following_sibling).to_s)
+                         .map(&method(:to_element))
+                         .select { |el| match_results.include?(el) }
+          Capybara::Result.new(ordered_results(siblings), self)
         end
       end
 
-      def description(applied = false)
+      def description(applied = false) # rubocop:disable Style/OptionalBooleanParameter
         desc = super
         sibling_query = @sibling_node&.instance_variable_get(:@query)
         desc += " that is a sibling of #{sibling_query.description}" if sibling_query

data/lib/capybara/queries/style_query.rb

@@ -34,7 +34,7 @@ module Capybara
     private
 
       def stringify_keys(hsh)
-        hsh.each_with_object({}) { |(k, v), str_keys| str_keys[k.to_s] = v }
+        hsh.transform_keys(&:to_s)
       end
 
       def valid_keys

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/rack_test/browser.rb

@@ -8,6 +8,7 @@ class Capybara::RackTest::Browser
 
   def initialize(driver)
     @driver = driver
+    @current_fragment = nil
   end
 
   def app
@@ -30,7 +31,9 @@ class Capybara::RackTest::Browser
 
   def submit(method, path, attributes)
     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?
+    process_and_follow_redirects(method, uri.to_s, attributes, 'HTTP_REFERER' => current_url)
   end
 
   def follow(method, path, **attributes)
@@ -40,6 +43,7 @@ class Capybara::RackTest::Browser
   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?
@@ -53,14 +57,17 @@ 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!
     send(method, new_uri.to_s, attributes, env.merge(options[:headers] || {}))
   end
@@ -78,7 +85,9 @@ class Capybara::RackTest::Browser
   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

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

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
@@ -56,7 +56,7 @@ private
   end
 
   def request_method
-    /post/i.match?(self[:method]) ? :post : :get
+    /post/i.match?(self[:method] || '') ? :post : :get
   end
 
   def merge_param!(params, key, value)

data/lib/capybara/rack_test/node.rb

@@ -15,7 +15,7 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
   end
 
   def visible_text
-    displayed_text.gsub(/\ +/, ' ')
+    displayed_text.squeeze(' ')
                   .gsub(/[\ \n]*\n[\ \n]*/, "\n")
                   .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
                   .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
@@ -45,6 +45,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
@@ -63,8 +64,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
@@ -75,6 +77,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
 
@@ -120,9 +124,18 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     alias_method "unchecked_#{meth_name}", meth_name
     private "unchecked_#{meth_name}" # rubocop:disable Style/AccessModifierDeclarations
 
-    define_method meth_name do |*args|
-      stale_check
-      send("unchecked_#{meth_name}", *args)
+    if RUBY_VERSION >= '2.7'
+      class_eval <<~METHOD, __FILE__, __LINE__ + 1
+        def #{meth_name}(...)
+          stale_check
+          method(:"unchecked_#{meth_name}").call(...)
+        end
+      METHOD
+    else
+      define_method meth_name do |*args|
+        stale_check
+        send("unchecked_#{meth_name}", *args)
+      end
     end
   end
 
@@ -196,6 +209,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
@@ -235,6 +256,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
@@ -273,6 +305,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,44 @@
+# 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, *args, **options, &block)
+      if @registered.respond_to?(method_name)
+        Capybara::Helpers.warn "DEPRECATED: Calling '#{method_name}' on the drivers/servers container is deprecated without replacement"
+        # RUBY 2.6 will send an empty hash rather than nothing with **options so fix that
+        return @registered.public_send(method_name, *args, &block) if options.empty?
+
+        return @registered.public_send(method_name, *args, **options, &block)
+      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

@@ -9,28 +9,34 @@ Capybara.register_driver :selenium do |app|
 end
 
 Capybara.register_driver :selenium_headless do |app|
-  Capybara::Selenium::Driver.load_selenium
-  browser_options = ::Selenium::WebDriver::Firefox::Options.new
-  browser_options.args << '-headless'
-  Capybara::Selenium::Driver.new(app, browser: :firefox, options: browser_options)
+  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, **Hash[:browser => :firefox, options_key => browser_options])
 end
 
 Capybara.register_driver :selenium_chrome do |app|
-  Capybara::Selenium::Driver.load_selenium
+  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.args << '--disable-site-isolation-trials'
+    opts.add_argument('--disable-site-isolation-trials')
   end
-  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+
+  Capybara::Selenium::Driver.new(app, **Hash[:browser => :chrome, options_key => browser_options])
 end
 
 Capybara.register_driver :selenium_chrome_headless do |app|
-  Capybara::Selenium::Driver.load_selenium
+  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.args << '--headless'
-    opts.args << '--disable-gpu' if Gem.win_platform?
+    opts.add_argument('--headless')
+    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.args << '--disable-site-isolation-trials'
+    opts.add_argument('--disable-site-isolation-trials')
   end
-  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+
+  Capybara::Selenium::Driver.new(app, **Hash[: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

data/lib/capybara/registrations/servers.rb

@@ -7,7 +7,7 @@ end
 Capybara.register_server :webrick do |app, port, host, **options|
   require 'rack/handler/webrick'
   options = { Host: host, Port: port, AccessLog: [], Logger: WEBrick::Log.new(nil, 0) }.merge(options)
-  Rack::Handler::WEBrick.run(app, options)
+  Rack::Handler::WEBrick.run(app, **options)
 end
 
 Capybara.register_server :puma do |app, port, host, **options|
@@ -20,13 +20,20 @@ Capybara.register_server :puma do |app, port, host, **options|
       raise LoadError, 'Capybara requires `puma` version 3.8.0 or higher, please upgrade `puma` or register and specify your own server block'
     end
   end
+
   # If we just run the Puma Rack handler it installs signal handlers which prevent us from being able to interrupt tests.
   # Therefore construct and run the Server instance ourselves.
   # Rack::Handler::Puma.run(app, { Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false }.merge(options))
-  options = { Host: host, Port: port, Threads: '0:4', workers: 0, daemon: false }.merge(options)
+  default_options = { Host: host, Port: port, Threads: '0:4', workers: 0, daemon: false }
+  options = default_options.merge(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]}"

data/lib/capybara/result.rb

@@ -31,6 +31,7 @@ module Capybara
       @filter_errors = []
       @results_enum = lazy_select_elements { |node| query.matches_filters?(node, @filter_errors) }
       @query = query
+      @allow_reload = false
     end
 
     def_delegators :full_results, :size, :length, :last, :values_at, :inspect, :sample
@@ -38,12 +39,12 @@ module Capybara
     alias index find_index
 
     def each(&block)
-      return enum_for(:each) unless block_given?
+      return enum_for(:each) unless block
 
       @result_cache.each(&block)
       loop do
         next_result = @results_enum.next
-        @result_cache << next_result
+        add_to_cache(next_result)
         yield next_result
       end
       self
@@ -53,13 +54,18 @@ module Capybara
       idx, length = args
       max_idx = case idx
       when Integer
-        if !idx.negative?
-          length.nil? ? idx : idx + length - 1
-        else
+        if idx.negative?
           nil
+        else
+          length.nil? ? idx : idx + length - 1
         end
       when Range
-        idx.end && idx.max # endless range will have end == nil
+        # idx.max is broken with beginless ranges
+        # idx.end && idx.max # endless range will have end == nil
+        max = idx.end
+        max = nil if max&.negative?
+        max -= 1 if max && idx.exclude_end?
+        max
       end
 
       if max_idx.nil?
@@ -85,16 +91,14 @@ module Capybara
         return load_up_to(count + 1) <=> count
       end
 
-      if min && (min = Integer(min))
-        return -1 if load_up_to(min) < min
-      end
+      return -1 if min && (min = Integer(min)) && (load_up_to(min) < min)
 
-      if max && (max = Integer(max))
-        return 1 if load_up_to(max + 1) > max
-      end
+      return 1 if max && (max = Integer(max)) && (load_up_to(max + 1) > max)
 
       if between
-        min, max = between.min, (between.end && between.max)
+        min, max = (between.begin && between.min) || 1, between.end
+        max -= 1 if max && between.exclude_end?
+
         size = load_up_to(max ? max + 1 : min)
         return size <=> min unless between.include?(size)
       end
@@ -130,13 +134,26 @@ module Capybara
       @elements.length
     end
 
+    ##
+    # @api private
+    #
+    def allow_reload!
+      @allow_reload = true
+      self
+    end
+
   private
 
+    def add_to_cache(elem)
+      elem.allow_reload!(@result_cache.size) if @allow_reload
+      @result_cache << elem
+    end
+
     def load_up_to(num)
       loop do
         break if @result_cache.size >= num
 
-        @result_cache << @results_enum.next
+        add_to_cache(@results_enum.next)
       end
       @result_cache.size
     end
@@ -150,15 +167,18 @@ module Capybara
       @rest ||= @elements - full_results
     end
 
-    def lazy_select_elements(&block)
+    if RUBY_PLATFORM == 'java'
       # JRuby < 9.2.8.0 has an issue with lazy enumerators which
       # causes a concurrency issue with network requests here
       # https://github.com/jruby/jruby/issues/4212
-      if (RUBY_PLATFORM == 'java') && (Gem::Version.new(JRUBY_VERSION) < Gem::Version.new('9.2.8.0'))
-        # :nocov:
+      # while JRuby >= 9.2.8.0 leaks threads when using lazy enumerators
+      # https://github.com/teamcapybara/capybara/issues/2349
+      # so disable the use and JRuby users will need to pay a performance penalty
+      def lazy_select_elements(&block)
         @elements.select(&block).to_enum # non-lazy evaluation
-        # :nocov:
-      else
+      end
+    else
+      def lazy_select_elements(&block)
         @elements.lazy.select(&block)
       end
     end