capybara 3.32.2

data/lib/capybara/rails.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+require 'capybara/dsl'
+
+Capybara.app = Rack::Builder.new do
+  map '/' do
+    run Rails.application
+  end
+end.to_app
+
+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)
+end

data/lib/capybara/registrations/drivers.rb

@@ -0,0 +1,36 @@
+# 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|
+  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)
+end
+
+Capybara.register_driver :selenium_chrome do |app|
+  Capybara::Selenium::Driver.load_selenium
+  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'
+  end
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end
+
+Capybara.register_driver :selenium_chrome_headless do |app|
+  Capybara::Selenium::Driver.load_selenium
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new.tap do |opts|
+    opts.args << '--headless'
+    opts.args << '--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'
+  end
+  Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Puma
+  module MiniSSL
+    class Socket
+      def read_nonblock(size, *_)
+        loop do
+          output = engine_read_all
+          return output if output
+
+          data = @socket.read_nonblock(size, exception: false)
+          raise IO::EAGAINWaitReadable if %i[wait_readable wait_writable].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,44 @@
+# 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)
+  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::Version.new('4.0.0')...Gem::Version.new('4.1.0')).cover? 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

@@ -0,0 +1,190 @@
+# 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()
+  # * count()
+  # * length()
+  # * first()
+  # * last()
+  # * empty?()
+  # * values_at()
+  # * sample()
+  #
+  # @see Capybara::Node::Element
+  #
+  class Result
+    include Enumerable
+    extend Forwardable
+
+    def initialize(elements, query)
+      @elements = elements
+      @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_given?
+
+      @result_cache.each(&block)
+      loop do
+        next_result = @results_enum.next
+        add_to_cache(next_result)
+        yield next_result
+      end
+      self
+    end
+
+    def [](*args)
+      idx, length = args
+      max_idx = case idx
+      when Integer
+        if !idx.negative?
+          length.nil? ? idx : idx + length - 1
+        else
+          nil
+        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
+
+      if min && (min = Integer(min))
+        return -1 if load_up_to(min) < min
+      end
+
+      if max && (max = Integer(max))
+        return 1 if load_up_to(max + 1) > max
+      end
+
+      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?
+      compare_count.zero?
+    end
+
+    def failure_message
+      message = @query.failure_message
+      if count.zero?
+        message << ' but there were no matches'
+      else
+        message << ", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: " \
+                << full_results.map(&:text).map(&:inspect).join(', ')
+      end
+      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
+
+    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.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+require 'rspec/core'
+require 'capybara/dsl'
+require 'capybara/rspec/matchers'
+require 'capybara/rspec/features'
+require 'capybara/rspec/matcher_proxies'
+
+RSpec.configure do |config|
+  config.include Capybara::DSL, type: :feature
+  config.include Capybara::RSpecMatchers, type: :feature
+  config.include Capybara::RSpecMatchers, type: :view
+
+  # The before and after blocks must run instantaneously, because Capybara
+  # might not actually be used in all examples where it's included.
+  config.after do
+    if self.class.include?(Capybara::DSL)
+      Capybara.reset_sessions!
+      Capybara.use_default_driver
+    end
+  end
+
+  config.before do |example|
+    if self.class.include?(Capybara::DSL)
+      Capybara.current_driver = Capybara.javascript_driver if example.metadata[:js]
+      Capybara.current_driver = example.metadata[:driver] if example.metadata[:driver]
+    end
+  end
+end

data/lib/capybara/rspec/features.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+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
+
+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

data/lib/capybara/rspec/matcher_proxies.rb

@@ -0,0 +1,82 @@
+# frozen_string_literal: true
+
+module Capybara
+  module RSpecMatcherProxies
+    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, **kwargs, &block)
+      end
+    end
+
+    def within(*args, **kwargs, &block)
+      if block_given?
+        within_element(*args, **kwargs, &block)
+      else
+        be_within(*args)
+      end
+    end
+  end
+end
+
+if RUBY_ENGINE == 'jruby'
+  # :nocov:
+  module Capybara::DSL
+    class <<self
+      remove_method :included
+
+      def included(base)
+        warn 'including Capybara::DSL in the global scope is not recommended!' if base == Object
+        if defined?(::RSpec::Matchers) && base.include?(::RSpec::Matchers)
+          base.send(:include, ::Capybara::RSpecMatcherProxies)
+        end
+        super
+      end
+    end
+  end
+
+  if defined?(::RSpec::Matchers)
+    module ::RSpec::Matchers
+      def self.included(base)
+        base.send(:include, ::Capybara::RSpecMatcherProxies) if base.include?(::Capybara::DSL)
+        super
+      end
+    end
+  end
+  # :nocov:
+else
+  module Capybara::DSLRSpecProxyInstaller
+    module ClassMethods
+      def included(base)
+        base.include(::Capybara::RSpecMatcherProxies) if defined?(::RSpec::Matchers) && base.include?(::RSpec::Matchers)
+        super
+      end
+    end
+
+    def self.prepended(base)
+      class <<base
+        prepend ClassMethods
+      end
+    end
+  end
+
+  module Capybara::RSpecMatcherProxyInstaller
+    module ClassMethods
+      def included(base)
+        base.include(::Capybara::RSpecMatcherProxies) if base.include?(::Capybara::DSL)
+        super
+      end
+    end
+
+    def self.prepended(base)
+      class <<base
+        prepend ClassMethods
+      end
+    end
+  end
+
+  Capybara::DSL.prepend ::Capybara::DSLRSpecProxyInstaller
+
+  ::RSpec::Matchers.prepend ::Capybara::RSpecMatcherProxyInstaller if defined?(::RSpec::Matchers)
+end