capybara 3.13.2 → 3.40.0

data/lib/capybara/registrations/servers.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+Capybara.register_server :default do |app, port, _host|
+  Capybara.run_default_server(app, port)
+end
+
+Capybara.register_server :webrick do |app, port, host, **options|
+  base_class = begin
+    require 'rack/handler/webrick'
+    Rack
+  rescue LoadError
+    # Rack 3 separated out the webrick handle - no way test currently in Capybaras automated
+    # tests due to Sinatra not yet supporting Rack 3 - experimental
+    require 'rackup/handler/webrick'
+    Rackup
+  end
+  options = { Host: host, Port: port, AccessLog: [], Logger: WEBrick::Log.new(nil, 0) }.merge(options)
+  base_class::Handler::WEBrick.run(app, **options)
+end
+
+Capybara.register_server :puma do |app, port, host, **options| # rubocop:disable Metrics/BlockLength
+  begin
+    require 'rackup'
+  rescue LoadError # rubocop:disable Lint/SuppressedException
+  end
+  begin
+    require 'rack/handler/puma'
+  rescue LoadError
+    raise LoadError, 'Capybara is unable to load `puma` for its server, please add `puma` to your project or specify a different server via something like `Capybara.server = :webrick`.'
+  end
+  puma_rack_handler = defined?(Rackup::Handler::Puma) ? Rackup::Handler::Puma : Rack::Handler::Puma
+
+  unless puma_rack_handler.respond_to?(:config)
+    raise LoadError, 'Capybara requires `puma` version 3.8.0 or higher, please upgrade `puma` or register and specify your own server block'
+  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.
+  # puma_rack_handler.run(app, { 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 = puma_rack_handler.config(app, options)
+  conf.clamp
+
+  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)
+
+  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/result.rb

@@ -31,19 +31,20 @@ 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
+    def_delegators :full_results, :size, :length, :last, :values_at, :inspect, :sample, :to_ary
 
     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?
@@ -76,6 +82,8 @@ module Capybara
     end
 
     def compare_count
+      return 0 unless @query
+
       count, min, max, between = @query.options.values_at(:count, :minimum, :maximum, :between)
 
       # Only check filters for as many elements as necessary to determine result
@@ -83,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
@@ -110,7 +116,7 @@ module Capybara
         message << ' but there were no matches'
       else
         message << ", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: " \
-                << full_results.map(&:text).map(&:inspect).join(', ')
+                << full_results.map { |r| r.text.inspect }.join(', ')
       end
       unless rest.empty?
         elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier
@@ -128,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
@@ -148,13 +167,18 @@ module Capybara
       @rest ||= @elements - full_results
     end
 
-    def lazy_select_elements(&block)
-      # JRuby has an issue with lazy enumerators which
+    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'
+      # 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
-      else
+      end
+    else
+      def lazy_select_elements(&block)
         @elements.lazy.select(&block)
       end
     end

data/lib/capybara/rspec/matcher_proxies.rb

@@ -2,17 +2,17 @@
 
 module Capybara
   module RSpecMatcherProxies
-    def all(*args, &block)
+    def all(*args, **kwargs, &block)
       if defined?(::RSpec::Matchers::BuiltIn::All) && args.first.respond_to?(:matches?)
         ::RSpec::Matchers::BuiltIn::All.new(*args)
       else
-        find_all(*args, &block)
+        find_all(*args, **kwargs, &block)
       end
     end
 
-    def within(*args)
-      if block_given?
-        within_element(*args, &Proc.new)
+    def within(*args, **kwargs, &block)
+      if block
+        within_element(*args, **kwargs, &block)
       else
         be_within(*args)
       end
@@ -21,8 +21,9 @@ module Capybara
 end
 
 if RUBY_ENGINE == 'jruby'
+  # :nocov:
   module Capybara::DSL
-    class <<self
+    class << self
       remove_method :included
 
       def included(base)
@@ -35,7 +36,7 @@ if RUBY_ENGINE == 'jruby'
     end
   end
 
-  if defined?(::RSpec::Matchers)
+  if defined?(RSpec::Matchers)
     module ::RSpec::Matchers
       def self.included(base)
         base.send(:include, ::Capybara::RSpecMatcherProxies) if base.include?(::Capybara::DSL)
@@ -43,6 +44,7 @@ if RUBY_ENGINE == 'jruby'
       end
     end
   end
+  # :nocov:
 else
   module Capybara::DSLRSpecProxyInstaller
     module ClassMethods
@@ -53,7 +55,7 @@ else
     end
 
     def self.prepended(base)
-      class <<base
+      class << base
         prepend ClassMethods
       end
     end
@@ -68,13 +70,13 @@ else
     end
 
     def self.prepended(base)
-      class <<base
+      class << base
         prepend ClassMethods
       end
     end
   end
 
-  Capybara::DSL.prepend ::Capybara::DSLRSpecProxyInstaller
+  Capybara::DSL.prepend Capybara::DSLRSpecProxyInstaller
 
-  ::RSpec::Matchers.prepend ::Capybara::RSpecMatcherProxyInstaller if defined?(::RSpec::Matchers)
+  RSpec::Matchers.prepend Capybara::RSpecMatcherProxyInstaller if defined?(RSpec::Matchers)
 end

data/lib/capybara/rspec/matchers/base.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'capybara/rspec/matchers/compound'
+require 'capybara/rspec/matchers/count_sugar'
+require 'capybara/rspec/matchers/spatial_sugar'
 
 module Capybara
   module RSpecMatchers
@@ -10,22 +12,28 @@ module Capybara
 
         attr_reader :failure_message, :failure_message_when_negated
 
-        def initialize(*args, &filter_block)
+        def initialize(*args, **kw_args, &filter_block)
           @args = args.dup
+          @kw_args = kw_args || {}
           @filter_block = filter_block
         end
 
       private
 
         def session_query_args
-          if @args.last.is_a? Hash
-            @args.last[:session_options] = session_options
-          else
-            @args.push(session_options: session_options)
-          end
+          # if @args.last.is_a? Hash
+          #   @args.last[:session_options] = session_options
+          # else
+          #   @args.push(session_options: session_options)
+          # end
           @args
         end
 
+        def session_query_options
+          @kw_args[:session_options] = session_options
+          @kw_args
+        end
+
         def session_options
           @context_el ||= nil
           if @context_el.respond_to? :session_options
@@ -39,17 +47,19 @@ module Capybara
       end
 
       class WrappedElementMatcher < Base
-        def matches?(actual)
+        def matches?(actual, &filter_block)
+          @filter_block ||= filter_block
           element_matches?(wrap(actual))
-        rescue Capybara::ExpectationNotMet => err
-          @failure_message = err.message
+        rescue Capybara::ExpectationNotMet => e
+          @failure_message = e.message
           false
         end
 
-        def does_not_match?(actual)
+        def does_not_match?(actual, &filter_block)
+          @filter_block ||= filter_block
           element_does_not_match?(wrap(actual))
-        rescue Capybara::ExpectationNotMet => err
-          @failure_message_when_negated = err.message
+        rescue Capybara::ExpectationNotMet => e
+          @failure_message_when_negated = e.message
           false
         end
 
@@ -65,6 +75,11 @@ module Capybara
         end
       end
 
+      class CountableWrappedElementMatcher < WrappedElementMatcher
+        include ::Capybara::RSpecMatchers::CountSugar
+        include ::Capybara::RSpecMatchers::SpatialSugar
+      end
+
       class NegatedMatcher
         include ::Capybara::RSpecMatchers::Matchers::Compound if defined?(::Capybara::RSpecMatchers::Matchers::Compound)
 
@@ -73,12 +88,12 @@ module Capybara
           @matcher = matcher
         end
 
-        def matches?(actual)
-          @matcher.does_not_match?(actual)
+        def matches?(actual, &filter_block)
+          @matcher.does_not_match?(actual, &filter_block)
         end
 
-        def does_not_match?(actual)
-          @matcher.matches?(actual)
+        def does_not_match?(actual, &filter_block)
+          @matcher.matches?(actual, &filter_block)
         end
 
         def description

data/lib/capybara/rspec/matchers/compound.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-if defined?(::RSpec::Expectations::Version)
+if defined?(RSpec::Expectations::Version)
   module Capybara
     module RSpecMatchers
       module Matchers

data/lib/capybara/rspec/matchers/count_sugar.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Capybara
+  module RSpecMatchers
+    module CountSugar
+      def once; exactly(1); end
+      def twice; exactly(2); end
+      def thrice; exactly(3); end
+
+      def exactly(number)
+        options[:count] = number
+        self
+      end
+
+      def at_most(number)
+        options[:maximum] = number
+        self
+      end
+
+      def at_least(number)
+        options[:minimum] = number
+        self
+      end
+
+      def times
+        self
+      end
+
+    private
+
+      def options
+        # (@args.last.is_a?(Hash) ? @args : @args.push({})).last
+        @kw_args
+      end
+    end
+  end
+end

data/lib/capybara/rspec/matchers/have_ancestor.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveAncestor < CountableWrappedElementMatcher
+        def element_matches?(el)
+          el.assert_ancestor(*@args, **session_query_options, &@filter_block)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_ancestor(*@args, **session_query_options, &@filter_block)
+        end
+
+        def description
+          "have ancestor #{query.description}"
+        end
+
+        def query
+          # @query ||= Capybara::Queries::AncestorQuery.new(*session_query_args, &@filter_block)
+          @query ||= Capybara::Queries::AncestorQuery.new(*session_query_args, **session_query_options, &@filter_block)
+        end
+      end
+    end
+  end
+end

data/lib/capybara/rspec/matchers/have_current_path.rb

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       class HaveCurrentPath < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_current_path(*@args)
+          el.assert_current_path(current_path, **@kw_args, &@filter_block)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_current_path(*@args)
+          el.assert_no_current_path(current_path, **@kw_args, &@filter_block)
         end
 
         def description

data/lib/capybara/rspec/matchers/have_selector.rb

@@ -5,64 +5,64 @@ require 'capybara/rspec/matchers/base'
 module Capybara
   module RSpecMatchers
     module Matchers
-      class HaveSelector < WrappedElementMatcher
+      class HaveSelector < CountableWrappedElementMatcher
+        def initialize(*args, **kw_args, &filter_block)
+          super
+          return unless (@args.size < 2) && @kw_args.keys.any?(String)
+
+          @args.push(@kw_args)
+          @kw_args = {}
+        end
+
         def element_matches?(el)
-          el.assert_selector(*@args, &@filter_block)
+          el.assert_selector(*@args, **session_query_options, &@filter_block)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_selector(*@args, &@filter_block)
+          el.assert_no_selector(*@args, **session_query_options, &@filter_block)
         end
 
-        def description
-          "have #{query.description}"
-        end
+        def description = "have #{query.description}"
 
         def query
-          @query ||= Capybara::Queries::SelectorQuery.new(*session_query_args, &@filter_block)
+          @query ||= Capybara::Queries::SelectorQuery.new(*session_query_args, **session_query_options, &@filter_block)
         end
       end
 
       class HaveAllSelectors < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_all_of_selectors(*@args, &@filter_block)
+          el.assert_all_of_selectors(*@args, **session_query_options, &@filter_block)
         end
 
         def does_not_match?(_actual)
           raise ArgumentError, 'The have_all_selectors matcher does not support use with not_to/should_not'
         end
 
-        def description
-          'have all selectors'
-        end
+        def description = 'have all selectors'
       end
 
       class HaveNoSelectors < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_none_of_selectors(*@args, &@filter_block)
+          el.assert_none_of_selectors(*@args, **session_query_options, &@filter_block)
         end
 
         def does_not_match?(_actual)
           raise ArgumentError, 'The have_none_of_selectors matcher does not support use with not_to/should_not'
         end
 
-        def description
-          'have no selectors'
-        end
+        def description = 'have no selectors'
       end
 
       class HaveAnySelectors < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_any_of_selectors(*@args, &@filter_block)
+          el.assert_any_of_selectors(*@args, **session_query_options, &@filter_block)
         end
 
-        def does_not_match?(_actual)
-          el.assert_none_of_selectors(*@args, &@filter_block)
+        def does_not_match?(el)
+          el.assert_none_of_selectors(*@args, **session_query_options, &@filter_block)
         end
 
-        def description
-          'have any selectors'
-        end
+        def description = 'have any selectors'
       end
     end
   end

data/lib/capybara/rspec/matchers/have_sibling.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveSibling < CountableWrappedElementMatcher
+        def element_matches?(el)
+          el.assert_sibling(*@args, **session_query_options, &@filter_block)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_sibling(*@args, **session_query_options, &@filter_block)
+        end
+
+        def description
+          "have sibling #{query.description}"
+        end
+
+        def query
+          @query ||= Capybara::Queries::SiblingQuery.new(*session_query_args, **session_query_options, &@filter_block)
+        end
+      end
+    end
+  end
+end

data/lib/capybara/rspec/matchers/have_text.rb

@@ -5,17 +5,17 @@ require 'capybara/rspec/matchers/base'
 module Capybara
   module RSpecMatchers
     module Matchers
-      class HaveText < WrappedElementMatcher
+      class HaveText < CountableWrappedElementMatcher
         def element_matches?(el)
-          el.assert_text(*@args)
+          el.assert_text(*@args, **@kw_args)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_text(*@args)
+          el.assert_no_text(*@args, **@kw_args)
         end
 
         def description
-          "text #{format(text)}"
+          "have text #{format(text)}"
         end
 
         def format(content)

data/lib/capybara/rspec/matchers/have_title.rb

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       class HaveTitle < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_title(*@args)
+          el.assert_title(*@args, **@kw_args)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_title(*@args)
+          el.assert_no_title(*@args, **@kw_args)
         end
 
         def description

data/lib/capybara/rspec/matchers/match_selector.rb

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       class MatchSelector < HaveSelector
         def element_matches?(el)
-          el.assert_matches_selector(*@args, &@filter_block)
+          el.assert_matches_selector(*@args, **session_query_options, &@filter_block)
         end
 
         def element_does_not_match?(el)
-          el.assert_not_matches_selector(*@args, &@filter_block)
+          el.assert_not_matches_selector(*@args, **session_query_options, &@filter_block)
         end
 
         def description
@@ -19,7 +19,7 @@ module Capybara
         end
 
         def query
-          @query ||= Capybara::Queries::MatchQuery.new(*session_query_args, &@filter_block)
+          @query ||= Capybara::Queries::MatchQuery.new(*session_query_args, **session_query_options, &@filter_block)
         end
       end
     end

data/lib/capybara/rspec/matchers/match_style.rb

@@ -6,8 +6,13 @@ module Capybara
   module RSpecMatchers
     module Matchers
       class MatchStyle < WrappedElementMatcher
+        def initialize(styles = nil, **kw_args, &filter_block)
+          styles, kw_args = kw_args, {} if styles.nil?
+          super(styles, **kw_args, &filter_block)
+        end
+
         def element_matches?(el)
-          el.assert_matches_style(*@args)
+          el.assert_matches_style(*@args, **@kw_args)
         end
 
         def does_not_match?(_actual)
@@ -28,7 +33,7 @@ module Capybara
       ##
       # @deprecated
       class HaveStyle < MatchStyle
-        def initialize(*args, &filter_block)
+        def initialize(*args, **kw_args, &filter_block)
           warn 'HaveStyle matcher is deprecated, please use the MatchStyle matcher instead'
           super
         end