capybara 2.7.0 → 3.35.3

data/lib/capybara/config.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+require 'forwardable'
+require 'capybara/session/config'
+
+module Capybara
+  class Config
+    extend Forwardable
+
+    OPTIONS = %i[app reuse_server threadsafe server default_driver javascript_driver allow_gumbo].freeze
+
+    attr_accessor :app, :allow_gumbo
+    attr_reader :reuse_server, :threadsafe, :session_options
+    attr_writer :default_driver, :javascript_driver
+
+    SessionConfig::OPTIONS.each do |method|
+      def_delegators :session_options, method, "#{method}="
+    end
+
+    def initialize
+      @session_options = Capybara::SessionConfig.new
+      @javascript_driver = nil
+    end
+
+    attr_writer :reuse_server
+
+    def threadsafe=(bool)
+      if (bool != threadsafe) && Session.instance_created?
+        raise 'Threadsafe setting cannot be changed once a session is created'
+      end
+
+      @threadsafe = bool
+    end
+
+    ##
+    #
+    # 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 use puma.
+    #
+    attr_reader :server
+
+    ##
+    #
+    # Set the server to use.
+    #
+    #     Capybara.server = :webrick
+    #     Capybara.server = :puma, { Silent: true }
+    #
+    # @overload server=(name)
+    #   @param [Symbol] name     Name of the server type to use
+    # @overload server=([name, options])
+    #   @param [Symbol] name Name of the server type to use
+    #   @param [Hash] options Options to pass to the server block
+    # @see register_server
+    #
+    def server=(name)
+      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
+        Capybara.servers[name.to_sym]
+      end
+    end
+
+    ##
+    #
+    # @return [Symbol]    The name of the driver to use by default
+    #
+    def default_driver
+      @default_driver || :rack_test
+    end
+
+    ##
+    #
+    # @return [Symbol]    The name of the driver used when JavaScript is needed
+    #
+    def javascript_driver
+      @javascript_driver || :selenium
+    end
+
+    def deprecate(method, alternate_method, once: false)
+      @deprecation_notified ||= {}
+      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
+  end
+end

data/lib/capybara/cucumber.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
+
 require 'capybara/dsl'
 require 'capybara/rspec/matchers'
+require 'capybara/rspec/matcher_proxies'
 
 World(Capybara::DSL)
 World(Capybara::RSpecMatchers)
@@ -20,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,5 +1,8 @@
 # frozen_string_literal: true
+
 class Capybara::Driver::Base
+  attr_writer :session
+
   def current_url
     raise NotImplementedError
   end
@@ -8,11 +11,15 @@ class Capybara::Driver::Base
     raise NotImplementedError
   end
 
-  def find_xpath(query)
+  def refresh
     raise NotImplementedError
   end
 
-  def find_css(query)
+  def find_xpath(query, **options)
+    raise NotImplementedError
+  end
+
+  def find_css(query, **options)
     raise NotImplementedError
   end
 
@@ -28,15 +35,19 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#go_forward'
   end
 
-  def execute_script(script)
+  def execute_script(script, *args)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#execute_script'
   end
 
-  def evaluate_script(script)
+  def evaluate_script(script, *args)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#evaluate_script'
   end
 
-  def save_screenshot(path, options={})
+  def evaluate_async_script(script, *args)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#evaluate_script_asnyc'
+  end
+
+  def save_screenshot(path, **options)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#save_screenshot'
   end
 
@@ -48,8 +59,26 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#status_code'
   end
 
-  def within_frame(frame_handle)
-    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#within_frame'
+  def send_keys(*)
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#send_keys'
+  end
+
+  ##
+  #
+  # @param frame [Capybara::Node::Element, :parent, :top]  The iframe element to switch to
+  #
+  def switch_to_frame(frame)
+    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
@@ -65,7 +94,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)
@@ -84,15 +117,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.
@@ -103,7 +131,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
 
@@ -116,7 +144,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
 
@@ -128,16 +156,19 @@ class Capybara::Driver::Base
     false
   end
 
-  def reset!
-  end
+  def reset!; end
 
   def needs_server?
     false
   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
+  def session_options
+    session&.config || Capybara.session_options
+  end
+
+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,27 +45,39 @@ 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
-      
+
       def send_keys(*args)
         raise NotImplementedError
       end
-      
+
       def hover
         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
@@ -83,6 +105,18 @@ module Capybara
         raise NotImplementedError
       end
 
+      def readonly?
+        !!self[:readonly]
+      end
+
+      def multiple?
+        !!self[:multiple]
+      end
+
+      def rect
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#rect'
+      end
+
       def path
         raise NotSupportedByDriverError, 'Capybara::Driver::Node#path'
       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,16 +18,14 @@ 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.
     #
     def using_wait_time(seconds, &block)
-      Capybara.using_wait_time(seconds, &block)
+      page.using_wait_time(seconds, &block)
     end
 
     ##
@@ -48,8 +47,16 @@ module Capybara
     end
 
     Session::DSL_METHODS.each do |method|
-      define_method method do |*args, &block|
-        page.send method, *args, &block
+      if RUBY_VERSION >= '2.7'
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          def #{method}(...)
+            page.method("#{method}").call(...)
+          end
+        METHOD
+      else
+        define_method method do |*args, &block|
+          page.send method, *args, &block
+        end
       end
     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,90 +25,37 @@ 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)
-      text.is_a?(Regexp) ? text : Regexp.new(Regexp.escape(normalize_whitespace(text)))
+    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)
-      if Capybara.asset_host && Nokogiri::HTML(html).css("base").empty?
-        match = html.match(/<head[^<]*?>/)
-        if match
-          return html.clone.insert match.end(0), "<base href='#{Capybara.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
 
-    ##
-    #
-    # Checks if the given count matches the given count options.
-    # Defaults to true if no options are specified. If multiple
-    # options are provided, it tests that all conditions are met;
-    # however, if :count is supplied, all other options are ignored.
-    #
-    # @param [Integer] count     The actual number. Should be coercible via Integer()
-    # @option [Range] between    Count must be within the given range
-    # @option [Integer] count    Count must be exactly this
-    # @option [Integer] maximum  Count must be smaller than or equal to this value
-    # @option [Integer] minimum  Count must be larger than or equal to this value
-    #
-    def matches_count?(count, options={})
-      return (Integer(options[:count]) == count)     if options[:count]
-      return false if options[:maximum] && (Integer(options[:maximum]) < count)
-      return false if options[:minimum] && (Integer(options[:minimum]) > count)
-      return false if options[:between] && !(options[:between] === count)
-      return true
-    end
-
-    ##
-    #
-    # Checks if a count of 0 is valid for the given options hash.
-    # Returns false if options hash does not specify any count options.
-    #
-    def expects_none?(options={})
-      if [:count, :maximum, :minimum, :between].any? { |k| options.has_key? k }
-        matches_count?(0,options)
-      else
-        false
-      end
-    end
-
-    ##
-    #
-    # Generates a failure message given a description of the query and count
-    # options.
-    #
-    # @param [String] description   Description of a query
-    # @option [Range] between       Count should have been within the given range
-    # @option [Integer] count       Count should have been exactly this
-    # @option [Integer] maximum     Count should have been smaller than or equal to this value
-    # @option [Integer] minimum     Count should have been larger than or equal to this value
-    #
-    def failure_message(description, options={})
-      message = String.new("expected to find #{description}")
-      if options[:count]
-        message << " #{options[:count]} #{declension('time', 'times', options[:count])}"
-      elsif options[:between]
-        message << " between #{options[:between].first} and #{options[:between].last} times"
-      elsif options[:maximum]
-        message << " at most #{options[:maximum]} #{declension('time', 'times', options[:maximum])}"
-      elsif options[:minimum]
-        message << " at least #{options[:minimum]} #{declension('time', 'times', options[:minimum])}"
-      end
-      message
-    end
-
     ##
     #
     # A poor man's `pluralize`. Given two declensions, one singular and one
@@ -121,20 +67,65 @@ module Capybara
     # @param [Integer] count       The number of items
     #
     def declension(singular, plural, count)
-      if count == 1
-        singular
+      count == 1 ? singular : plural
+    end
+
+    def filter_backtrace(trace)
+      return 'No backtrace' unless trace
+
+      filter = %r{lib/capybara/|lib/rspec/|lib/minitest/}
+      new_trace = trace.take_while { |line| line !~ filter }
+      new_trace = trace.reject { |line| line =~ 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)
+      return Kernel.warn(message, uplevel: uplevel) if RUBY_VERSION >= '2.6'
+
+      # TODO: Remove when we drop support for Ruby 2.5
+      # Workaround for emulating `warn '...', uplevel: n` in Ruby 2.5 or lower.
+      if (match = /^(?<file>.+?):(?<line>\d+)(?::in `.*')?/.match(caller[uplevel]))
+        location = [match[:file], match[:line]].join(':')
+        Kernel.warn "#{location}: #{message}"
       else
-        plural
+        Kernel.warn message
       end
     end
 
     if defined?(Process::CLOCK_MONOTONIC)
-      def monotonic_time
-        Process.clock_gettime Process::CLOCK_MONOTONIC
-      end
+      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