capybara 2.18.0 → 3.40.0

data/lib/capybara/config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'forwardable'
 require 'capybara/session/config'
 
@@ -6,11 +7,12 @@ module Capybara
   class Config
     extend Forwardable
 
-    OPTIONS = [:app, :reuse_server, :threadsafe, :default_wait_time, :server, :default_driver, :javascript_driver]
+    OPTIONS = %i[
+      app reuse_server threadsafe server default_driver javascript_driver use_html5_parsing allow_gumbo
+    ].freeze
 
-    attr_accessor :app
-    attr_reader :reuse_server, :threadsafe
-    attr_reader :session_options
+    attr_accessor :app, :use_html5_parsing
+    attr_reader :reuse_server, :threadsafe, :session_options # rubocop:disable Style/BisectedAttrAccessor
     attr_writer :default_driver, :javascript_driver
 
     SessionConfig::OPTIONS.each do |method|
@@ -19,15 +21,16 @@ module Capybara
 
     def initialize
       @session_options = Capybara::SessionConfig.new
+      @javascript_driver = nil
     end
 
-    def reuse_server=(bool)
-      @reuse_server = bool
-    end
+    attr_writer :reuse_server # rubocop:disable Style/BisectedAttrAccessor
 
     def threadsafe=(bool)
-      warn "Capybara.threadsafe == true is a BETA feature and may change in future minor versions" if bool
-      raise "Threadsafe setting cannot be changed once a session is created" if (bool != threadsafe) && Session.instance_created?
+      if (bool != threadsafe) && Session.instance_created?
+        raise 'Threadsafe setting cannot be changed once a session is created'
+      end
+
       @threadsafe = bool
     end
 
@@ -35,16 +38,9 @@ module Capybara
     #
     # Return the proc that Capybara will call to run the Rack application.
     # The block returned receives a rack app, port, and host/ip and should run a Rack handler
-    # By default, Capybara will try to run webrick.
+    # By default, Capybara will try to use puma.
     #
-    def server(&block)
-      if block_given?
-        warn "DEPRECATED: Passing a block to Capybara::server is deprecated, please use Capybara::register_server instead"
-        @server = block
-      else
-        @server
-      end
-    end
+    attr_reader :server
 
     ##
     #
@@ -64,12 +60,10 @@ module Capybara
       name, options = *name if name.is_a? Array
       @server = if name.respond_to? :call
         name
+      elsif options
+        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, **options) }
       else
-        if options
-          Proc.new { |app, port, host| Capybara.servers[name.to_sym].call(app,port,host,options) }
-        else
-          Capybara.servers[name.to_sym]
-        end
+        Capybara.servers[name.to_sym]
       end
     end
 
@@ -89,44 +83,22 @@ module Capybara
       @javascript_driver || :selenium
     end
 
-    # @deprecated Use default_max_wait_time instead
-    def default_wait_time
-      deprecate('default_wait_time', 'default_max_wait_time', true)
-      default_max_wait_time
-    end
-
-    # @deprecated Use default_max_wait_time= instead
-    def default_wait_time=(t)
-      deprecate('default_wait_time=', 'default_max_wait_time=')
-      self.default_max_wait_time = t
-    end
-
-    def deprecate(method, alternate_method, once=false)
+    def deprecate(method, alternate_method, once: false)
       @deprecation_notified ||= {}
-      warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once and @deprecation_notified[method]
-      @deprecation_notified[method]=true
-    end
-  end
-
-  # @api private
-  class ConfigureDeprecator
-    def initialize(config)
-      @config = config
+      unless once && @deprecation_notified[method]
+        Capybara::Helpers.warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead: #{Capybara::Helpers.filter_backtrace(caller)}"
+      end
+      @deprecation_notified[method] = true
     end
 
-    def method_missing(m, *args, &block)
-      if @config.respond_to?(m)
-        @config.public_send(m, *args, &block)
-      elsif Capybara.respond_to?(m)
-        warn "Calling #{m} from Capybara.configure is deprecated - please call it on Capybara directly ( Capybara.#{m}(...) )"
-        Capybara.public_send(m, *args, &block)
-      else
-        super
-      end
+    def allow_gumbo=(val)
+      deprecate('allow_gumbo=', 'use_html5_parsing=')
+      self.use_html5_parsing = val
     end
 
-    def respond_to_missing?(m, include_private = false)
-      @config.respond_to?(m) || Capybara.respond_to?(m) || super
+    def allow_gumbo
+      deprecate('allow_gumbo', 'use_html5_parsing')
+      use_html5_parsing
     end
   end
-end
+end

data/lib/capybara/cucumber.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'capybara/dsl'
 require 'capybara/rspec/matchers'
 require 'capybara/rspec/matcher_proxies'
@@ -21,8 +22,6 @@ end
 Before do |scenario|
   scenario.source_tag_names.each do |tag|
     driver_name = tag.sub(/^@/, '').to_sym
-    if Capybara.drivers.has_key?(driver_name)
-      Capybara.current_driver = driver_name
-    end
+    Capybara.current_driver = driver_name if Capybara.drivers[driver_name]
   end
 end

data/lib/capybara/driver/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Capybara::Driver::Base
   attr_writer :session
 
@@ -14,11 +15,11 @@ class Capybara::Driver::Base
     raise NotImplementedError
   end
 
-  def find_xpath(query)
+  def find_xpath(query, **options)
     raise NotImplementedError
   end
 
-  def find_css(query)
+  def find_css(query, **options)
     raise NotImplementedError
   end
 
@@ -46,7 +47,7 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#evaluate_script_asnyc'
   end
 
-  def save_screenshot(path, options={})
+  def save_screenshot(path, **options)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#save_screenshot'
   end
 
@@ -58,6 +59,14 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#status_code'
   end
 
+  def send_keys(*)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#send_keys'
+  end
+
+  def active_element
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#active_element'
+  end
+
   ##
   #
   # @param frame [Capybara::Node::Element, :parent, :top]  The iframe element to switch to
@@ -66,6 +75,16 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#switch_to_frame'
   end
 
+  def frame_title
+    find_xpath('/html/head/title').map(&:all_text).first.to_s
+  end
+
+  def frame_url
+    evaluate_script('document.location.href')
+  rescue Capybara::NotSupportedByDriverError
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#frame_title'
+  end
+
   def current_window_handle
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#current_window_handle'
   end
@@ -79,7 +98,11 @@ class Capybara::Driver::Base
   end
 
   def maximize_window(handle)
-    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#maximize_current_window'
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#maximize_window'
+  end
+
+  def fullscreen_window(handle)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#fullscreen_window'
   end
 
   def close_window(handle)
@@ -98,15 +121,10 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#switch_to_window'
   end
 
-  def within_window(locator)
-    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#within_window'
-  end
-
   def no_such_window_error
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#no_such_window_error'
   end
 
-
   ##
   #
   # Execute the block, and then accept the modal opened.
@@ -117,7 +135,7 @@ class Capybara::Driver::Base
   # @return [String]  the message shown in the modal
   # @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found
   #
-  def accept_modal(type, options={}, &blk)
+  def accept_modal(type, **options, &blk)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#accept_modal'
   end
 
@@ -130,7 +148,7 @@ class Capybara::Driver::Base
   # @return [String]  the message shown in the modal
   # @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found
   #
-  def dismiss_modal(type, options={}, &blk)
+  def dismiss_modal(type, **options, &blk)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#dismiss_modal'
   end
 
@@ -142,20 +160,19 @@ class Capybara::Driver::Base
     false
   end
 
-  def reset!
-  end
+  def reset!; end
 
   def needs_server?
     false
   end
 
   def session_options
-    (@session && @session.config) || Capybara.session_options
+    session&.config || Capybara.session_options
   end
 
-  # @deprecated This method is being removed
-  def browser_initialized?
-    warn "DEPRECATED: #browser_initialized? is deprecated and will be removed in the next version of Capybara"
-    true
+private
+
+  def session
+    @session ||= nil
   end
 end

data/lib/capybara/driver/node.rb

@@ -1,12 +1,14 @@
 # frozen_string_literal: true
+
 module Capybara
   module Driver
     class Node
-      attr_reader :driver, :native
+      attr_reader :driver, :native, :initial_cache
 
-      def initialize(driver, native)
+      def initialize(driver, native, initial_cache = {})
         @driver = driver
         @native = native
+        @initial_cache = initial_cache
       end
 
       def all_text
@@ -25,9 +27,13 @@ module Capybara
         raise NotImplementedError
       end
 
-      # @param value String or Array. Array is only allowed if node has 'multiple' attribute
-      # @param options [Hash{}] Driver specific options for how to set a value on a node
-      def set(value, options={})
+      def style(styles)
+        raise NotImplementedError
+      end
+
+      # @param value [String, Array] Array is only allowed if node has 'multiple' attribute
+      # @param options [Hash] Driver specific options for how to set a value on a node
+      def set(value, **options)
         raise NotImplementedError
       end
 
@@ -39,15 +45,15 @@ module Capybara
         raise NotImplementedError
       end
 
-      def click
+      def click(keys = [], **options)
         raise NotImplementedError
       end
 
-      def right_click
+      def right_click(keys = [], **options)
         raise NotImplementedError
       end
 
-      def double_click
+      def double_click(keys = [], **options)
         raise NotImplementedError
       end
 
@@ -59,7 +65,19 @@ module Capybara
         raise NotImplementedError
       end
 
-      def drag_to(element)
+      def drag_to(element, **options)
+        raise NotImplementedError
+      end
+
+      def drop(*args)
+        raise NotImplementedError
+      end
+
+      def scroll_by(x, y)
+        raise NotImplementedError
+      end
+
+      def scroll_to(element, alignment, position = nil)
         raise NotImplementedError
       end
 
@@ -71,6 +89,10 @@ module Capybara
         raise NotImplementedError
       end
 
+      def obscured?
+        raise NotImplementedError
+      end
+
       def checked?
         raise NotImplementedError
       end
@@ -91,6 +113,10 @@ module Capybara
         !!self[:multiple]
       end
 
+      def rect
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#rect'
+      end
+
       def path
         raise NotSupportedByDriverError, 'Capybara::Driver::Node#path'
       end
@@ -99,6 +125,10 @@ module Capybara
         raise NotSupportedByDriverError, 'Capybara::Driver::Node#trigger'
       end
 
+      def shadow_root
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#shadow_root'
+      end
+
       def inspect
         %(#<#{self.class} tag="#{tag_name}" path="#{path}">)
       rescue NotSupportedByDriverError
@@ -106,7 +136,7 @@ module Capybara
       end
 
       def ==(other)
-        raise NotSupportedByDriverError, 'Capybara::Driver::Node#=='
+        eql?(other) || (other.respond_to?(:native) && native == other.native)
       end
     end
   end

data/lib/capybara/dsl.rb

@@ -1,15 +1,16 @@
 # frozen_string_literal: true
+
 require 'capybara'
 
 module Capybara
   module DSL
     def self.included(base)
-      warn "including Capybara::DSL in the global scope is not recommended!" if base == Object
+      warn 'including Capybara::DSL in the global scope is not recommended!' if base == Object
       super
     end
 
     def self.extended(base)
-      warn "extending the main object with Capybara::DSL is not recommended!" if base == TOPLEVEL_BINDING.eval("self")
+      warn 'extending the main object with Capybara::DSL is not recommended!' if base == TOPLEVEL_BINDING.eval('self')
       super
     end
 
@@ -17,8 +18,8 @@ module Capybara
     #
     # Shortcut to working in a different session.
     #
-    def using_session(name, &block)
-      Capybara.using_session(name, &block)
+    def using_session(name_or_session, &block)
+      Capybara.using_session(name_or_session, &block)
     end
 
     # Shortcut to using a different wait time.
@@ -46,9 +47,11 @@ module Capybara
     end
 
     Session::DSL_METHODS.each do |method|
-      define_method method do |*args, &block|
-        page.send method, *args, &block
-      end
+      class_eval <<~METHOD, __FILE__, __LINE__ + 1
+        def #{method}(...)
+          page.method("#{method}").call(...)
+        end
+      METHOD
     end
   end
 

data/lib/capybara/helpers.rb

@@ -1,14 +1,12 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 
 module Capybara
-
   # @api private
   module Helpers
-    extend self
+  module_function
 
     ##
-    #
+    # @deprecated
     # Normalizes whitespace space by stripping leading and trailing
     # whitespace and replacing sequences of whitespace characters
     # with a single space.
@@ -17,6 +15,7 @@ module Capybara
     # @return [String]         Normalized text
     #
     def normalize_whitespace(text)
+      Capybara::Helpers.warn 'DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver'
       text.to_s.gsub(/[[:space:]]+/, ' ').strip
     end
 
@@ -26,34 +25,34 @@ module Capybara
     # if text is not a regexp
     #
     # @param [String] text Text to escape
-    # @return [String]     Escaped text
+    # @param [Boolean] exact (false) Whether or not this should be an exact text match
+    # @param [Fixnum, Boolean, nil] options Options passed to Regexp.new when creating the Regexp
+    # @return [Regexp] Regexp to match the passed in text and options
     #
-    def to_regexp(text, regexp_options=nil, exact=false)
-      if text.is_a?(Regexp)
-        text
-      else
-        escaped = Regexp.escape(normalize_whitespace(text))
-        escaped = "\\A#{escaped}\\z" if exact
-        Regexp.new(escaped, regexp_options)
-      end
+    def to_regexp(text, exact: false, all_whitespace: false, options: nil)
+      return text if text.is_a?(Regexp)
+
+      escaped = Regexp.escape(text)
+      escaped = escaped.gsub('\\ ', '[[:blank:]]') if all_whitespace
+      escaped = "\\A#{escaped}\\z" if exact
+      Regexp.new(escaped, options)
     end
 
     ##
     #
     # Injects a `<base>` tag into the given HTML code, pointing to
-    # `Capybara.asset_host`.
+    # {Capybara.configure asset_host}.
     #
     # @param [String] html     HTML code to inject into
+    # @param [URL] host (Capybara.asset_host) The host from which assets should be loaded
     # @return [String]         The modified HTML code
     #
-    def inject_asset_host(html, asset_host = Capybara.asset_host)
-      if asset_host && Nokogiri::HTML(html).css("base").empty?
-        match = html.match(/<head[^<]*?>/)
-        if match
-          return html.clone.insert match.end(0), "<base href='#{asset_host}' />"
+    def inject_asset_host(html, host: Capybara.asset_host)
+      if host && Nokogiri::HTML(html).css('base').empty?
+        html.match(/<head[^<]*?>/) do |m|
+          return html.clone.insert m.end(0), "<base href='#{host}' />"
         end
       end
-
       html
     end
 
@@ -68,20 +67,60 @@ module Capybara
     # @param [Integer] count       The number of items
     #
     def declension(singular, plural, count)
-      if count == 1
-        singular
-      else
-        plural
-      end
+      count == 1 ? singular : plural
     end
 
-    if defined?(Process::CLOCK_MONOTONIC)
-      def monotonic_time
-        Process.clock_gettime Process::CLOCK_MONOTONIC
-      end
+    def filter_backtrace(trace)
+      return 'No backtrace' unless trace
+
+      filter = %r{lib/capybara/|lib/rspec/|lib/minitest/|delegate.rb}
+      new_trace = trace.take_while { |line| line !~ filter }
+      new_trace = trace.grep_v(filter) if new_trace.empty?
+      new_trace = trace.dup if new_trace.empty?
+
+      new_trace.first.split(':in ', 2).first
+    end
+
+    def warn(message, uplevel: 1)
+      Kernel.warn(message, uplevel: uplevel)
+    end
+
+    if defined?(Process::CLOCK_MONOTONIC_RAW)
+      def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC_RAW; end
+    elsif defined?(Process::CLOCK_MONOTONIC_PRECISE)
+      def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC_PRECISE; end
+    elsif defined?(Process::CLOCK_MONOTONIC)
+      def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC; end
     else
-      def monotonic_time
-        Time.now.to_f
+      def monotonic_time; Time.now.to_f; end
+    end
+
+    def timer(expire_in:)
+      Timer.new(expire_in)
+    end
+
+    class Timer
+      def initialize(expire_in)
+        @start = current
+        @expire_in = expire_in
+      end
+
+      def expired?
+        if stalled?
+          raise Capybara::FrozenInTime, 'Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead'
+        end
+
+        current - @start >= @expire_in
+      end
+
+      def stalled?
+        @start == current
+      end
+
+    private
+
+      def current
+        Capybara::Helpers.monotonic_time
       end
     end
   end