capybara 2.7.0 → 3.35.3

data/lib/capybara/rails.rb

@@ -1,14 +1,10 @@
 # frozen_string_literal: true
+
 require 'capybara/dsl'
 
 Capybara.app = Rack::Builder.new do
-  map "/" do
-    if Gem::Version.new(Rails.version) >= Gem::Version.new("3.0")
-      run Rails.application
-    else # Rails 2
-      use Rails::Rack::Static
-      run ActionController::Dispatcher.new
-    end
+  map '/' do
+    run Rails.application
   end
 end.to_app
 
@@ -16,5 +12,5 @@ Capybara.save_path = Rails.root.join('tmp/capybara')
 
 # Override default rack_test driver to respect data-method attributes.
 Capybara.register_driver :rack_test do |app|
-  Capybara::RackTest::Driver.new(app, :respect_data_method => true)
+  Capybara::RackTest::Driver.new(app, respect_data_method: true)
 end

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

@@ -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, **Hash[: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, **Hash[: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')
+    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, **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

@@ -0,0 +1,45 @@
+# 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|
+  require 'rack/handler/webrick'
+  options = { Host: host, Port: port, AccessLog: [], Logger: WEBrick::Log.new(nil, 0) }.merge(options)
+  Rack::Handler::WEBrick.run(app, **options)
+end
+
+Capybara.register_server :puma do |app, port, host, **options|
+  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`.'
+  else
+    unless Rack::Handler::Puma.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
+  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))
+  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]}"
+
+  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]
+  end.run.join
+end

data/lib/capybara/result.rb

@@ -1,13 +1,13 @@
 # frozen_string_literal: true
+
 require 'forwardable'
 
 module Capybara
-
   ##
   # A {Capybara::Result} represents a collection of {Capybara::Node::Element} on the page. It is possible to interact with this
   # collection similar to an Array because it implements Enumerable and offers the following Array methods through delegation:
   #
-  # * []
+  # * \[\]
   # * each()
   # * at()
   # * size()
@@ -16,6 +16,8 @@ module Capybara
   # * first()
   # * last()
   # * empty?()
+  # * values_at()
+  # * sample()
   #
   # @see Capybara::Node::Element
   #
@@ -25,28 +27,101 @@ module Capybara
 
     def initialize(elements, query)
       @elements = elements
-      @result = elements.select { |node| query.matches_filters?(node) }
-      @rest = @elements - @result
+      @result_cache = []
+      @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
+
+    alias index find_index
+
+    def each(&block)
+      return enum_for(:each) unless block
+
+      @result_cache.each(&block)
+      loop do
+        next_result = @results_enum.next
+        add_to_cache(next_result)
+        yield next_result
+      end
+      self
     end
 
-    def_delegators :@result, :each, :[], :at, :size, :count, :length,
-                   :first, :last, :values_at, :empty?, :inspect, :sample, :index
+    def [](*args)
+      idx, length = args
+      max_idx = case idx
+      when Integer
+        if idx.negative?
+          nil
+        else
+          length.nil? ? idx : idx + length - 1
+        end
+      when Range
+        # 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?
+        full_results[*args]
+      else
+        load_up_to(max_idx + 1)
+        @result_cache[*args]
+      end
+    end
+    alias :at :[]
+
+    def empty?
+      !any?
+    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
+      if count && (count = Integer(count))
+        return load_up_to(count + 1) <=> count
+      end
+
+      return -1 if min && (min = Integer(min)) && (load_up_to(min) < min)
+
+      return 1 if max && (max = Integer(max)) && (load_up_to(max + 1) > max)
+
+      if between
+        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
+
+      0
+    end
 
     def matches_count?
-      Capybara::Helpers.matches_count?(@result.size, @query.options)
+      compare_count.zero?
     end
 
     def failure_message
-      message = Capybara::Helpers.failure_message(@query.description, @query.options)
-      if count > 0
-        message << ", found #{count} #{Capybara::Helpers.declension("match", "matches", count)}: " << @result.map(&:text).map(&:inspect).join(", ")
+      message = @query.failure_message
+      if count.zero?
+        message << ' but there were no matches'
       else
-        message << " but there were no matches"
+        message << ", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: " \
+                << full_results.map(&:text).map(&:inspect).join(', ')
       end
-      unless @rest.empty?
-        elements = @rest.map(&:text).map(&:inspect).join(", ")
-        message << ". Also found " << elements << ", which matched the selector but not all filters."
+      unless rest.empty?
+        elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier
+        message << '. Also found ' << elements << ', which matched the selector but not all filters. '
+        message << @filter_errors.join('. ') if (rest.size == 1) && count.zero?
       end
       message
     end
@@ -54,5 +129,58 @@ module Capybara
     def negative_failure_message
       failure_message.sub(/(to find)/, 'not \1')
     end
+
+    def unfiltered_size
+      @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
+
+        add_to_cache(@results_enum.next)
+      end
+      @result_cache.size
+    end
+
+    def full_results
+      loop { @result_cache << @results_enum.next }
+      @result_cache
+    end
+
+    def rest
+      @rest ||= @elements - full_results
+    end
+
+    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
+      # 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
+      end
+    else
+      def lazy_select_elements(&block)
+        @elements.lazy.select(&block)
+      end
+    end
   end
 end

data/lib/capybara/rspec/features.rb

@@ -1,48 +1,23 @@
 # frozen_string_literal: true
-if RSpec::Core::Version::STRING.to_f >= 3.0
-  RSpec.shared_context "Capybara Features", :capybara_feature => true do
-    instance_eval do
-      alias background before
-      alias given let
-      alias given! let!
-    end
-  end
 
-  RSpec.configure do |config|
-    config.alias_example_group_to :feature, :capybara_feature => true, :type => :feature
-    config.alias_example_group_to :xfeature, :capybara_feature => true, :type => :feature, :skip => "Temporarily disabled with xfeature"
-    config.alias_example_group_to :ffeature, :capybara_feature => true, :type => :feature, :focus => true
-    config.alias_example_to :scenario
-    config.alias_example_to :xscenario, :skip => "Temporarily disabled with xscenario"
-    config.alias_example_to :fscenario, :focus => true
-  end
-else
-  module Capybara
-    module Features
-      def self.included(base)
-        base.instance_eval do
-          alias :background :before
-          alias :scenario :it
-          alias :xscenario :xit
-          alias :given :let
-          alias :given! :let!
-          alias :feature :describe
-        end
-      end
-    end
+RSpec.shared_context 'Capybara Features', capybara_feature: true do
+  instance_eval do
+    alias background before
+    alias given let
+    alias given! let!
   end
+end
 
+# ensure shared_context is included if default shared_context_metadata_behavior is changed
+RSpec.configure do |config|
+  config.include_context 'Capybara Features', capybara_feature: true if config.respond_to?(:include_context)
+end
 
-  def self.feature(*args, &block)
-    options = if args.last.is_a?(Hash) then args.pop else {} end
-    options[:capybara_feature] = true
-    options[:type] = :feature
-    options[:caller] ||= caller
-    args.push(options)
-
-    #call describe on RSpec in case user has expose_dsl_globally set to false
-    RSpec.describe(*args, &block)
-  end
-
-  RSpec.configuration.include Capybara::Features, :capybara_feature => true
+RSpec.configure do |config|
+  config.alias_example_group_to :feature, :capybara_feature, type: :feature
+  config.alias_example_group_to :xfeature, :capybara_feature, type: :feature, skip: 'Temporarily disabled with xfeature'
+  config.alias_example_group_to :ffeature, :capybara_feature, :focus, type: :feature
+  config.alias_example_to :scenario
+  config.alias_example_to :xscenario, skip: 'Temporarily disabled with xscenario'
+  config.alias_example_to :fscenario, :focus
 end