capybara 3.0.0 → 3.40.0

data/lib/capybara/driver/base.rb

@@ -15,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
 
@@ -59,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
@@ -90,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)
@@ -155,6 +167,12 @@ class Capybara::Driver::Base
   end
 
   def session_options
-    (@session && @session.config) || Capybara.session_options
+    session&.config || Capybara.session_options
+  end
+
+private
+
+  def session
+    @session ||= nil
   end
 end

data/lib/capybara/driver/node.rb

@@ -3,11 +3,12 @@
 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
@@ -26,8 +27,12 @@ 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 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
@@ -40,15 +45,15 @@ module Capybara
         raise NotImplementedError
       end
 
-      def click(keys = [], options = {})
+      def click(keys = [], **options)
         raise NotImplementedError
       end
 
-      def right_click(keys = [], options = {})
+      def right_click(keys = [], **options)
         raise NotImplementedError
       end
 
-      def double_click(keys = [], options = {})
+      def double_click(keys = [], **options)
         raise NotImplementedError
       end
 
@@ -60,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
 
@@ -72,6 +89,10 @@ module Capybara
         raise NotImplementedError
       end
 
+      def obscured?
+        raise NotImplementedError
+      end
+
       def checked?
         raise NotImplementedError
       end
@@ -92,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
@@ -100,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
@@ -107,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

@@ -5,12 +5,12 @@ 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
 
@@ -18,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.
@@ -47,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

@@ -3,7 +3,7 @@
 module Capybara
   # @api private
   module Helpers
-    extend self
+  module_function
 
     ##
     # @deprecated
@@ -15,7 +15,7 @@ module Capybara
     # @return [String]         Normalized text
     #
     def normalize_whitespace(text)
-      warn "DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver"
+      Capybara::Helpers.warn 'DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver'
       text.to_s.gsub(/[[:space:]]+/, ' ').strip
     end
 
@@ -33,7 +33,7 @@ module Capybara
       return text if text.is_a?(Regexp)
 
       escaped = Regexp.escape(text)
-      escaped = escaped.gsub("\\ ", "[[:blank:]]") if all_whitespace
+      escaped = escaped.gsub('\\ ', '[[:blank:]]') if all_whitespace
       escaped = "\\A#{escaped}\\z" if exact
       Regexp.new(escaped, options)
     end
@@ -41,16 +41,17 @@ module Capybara
     ##
     #
     # 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, host: Capybara.asset_host)
-      if host && Nokogiri::HTML(html).css("base").empty?
-        match = html.match(/<head[^<]*?>/)
-        return html.clone.insert match.end(0), "<base href='#{host}' />" if match
+      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
@@ -69,10 +70,58 @@ module Capybara
       count == 1 ? singular : plural
     end
 
-    if defined?(Process::CLOCK_MONOTONIC)
+    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; 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
 end

data/lib/capybara/minitest/spec.rb

@@ -1,178 +1,279 @@
+# frozen_string_literal: true
+
 require 'minitest/spec'
 
 module Capybara
   module Minitest
     module Expectations
-      %w[text content title current_path].each do |assertion|
-        infect_an_assertion "assert_#{assertion}", "must_have_#{assertion}", :reverse
-        infect_an_assertion "refute_#{assertion}", "wont_have_#{assertion}", :reverse
-      end
+      ##
+      # Expectation that there is an ancestor
+      #
+      # @!method must_have_ancestor
+      #   See {Capybara::Node::Matchers#has_ancestor?}
 
-      # rubocop:disable Style/MultilineBlockChain
-      (%w[selector xpath css link button field select table checked_field unchecked_field].flat_map do |assertion|
-        [%W[assert_#{assertion} must_have_#{assertion}],
-         %W[refute_#{assertion} wont_have_#{assertion}]]
-      end + [%w[assert_all_of_selectors must_have_all_of_selectors],
-             %w[assert_none_of_selectors must_have_none_of_selectors]] +
-      %w[selector xpath css].flat_map do |assertion|
-        [%W[assert_matches_#{assertion} must_match_#{assertion}],
-         %W[refute_matches_#{assertion} wont_match_#{assertion}]]
-      end).each do |(meth, new_name)|
-        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def #{new_name} *args, &block
-            ::Minitest::Expectation.new(self, ::Minitest::Spec.current).#{new_name}(*args, &block)
-          end
-        ASSERTION
+      ##
+      # Expectation that there is button
+      #
+      # @!method must_have_button
+      #   See {Capybara::Node::Matchers#has_button?}
 
-        ::Minitest::Expectation.class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
-          def #{new_name} *args, &block
-            ctx.#{meth}(target, *args, &block)
-          end
-        ASSERTION
-      end
-      # rubocop:enable Style/MultilineBlockChain
+      ##
+      # Expectation that there is no button
+      #
+      # @!method wont_have_button
+      #   See {Capybara::Node::Matchers#has_no_button?}
 
       ##
-      # Expectation that there is xpath
+      # Expectation that there is checked_field
       #
-      # @!method must_have_xpath
-      #   see Capybara::Node::Matchers#has_xpath?
+      # @!method must_have_checked_field
+      #   See {Capybara::Node::Matchers#has_checked_field?}
 
       ##
-      # Expectation that there is no xpath
+      # Expectation that there is no checked_field
       #
-      # @!method wont_have_xpath
-      #   see Capybara::Node::Matchers#has_no_xpath?
+      # @!method wont_have_checked_field
+      #   See {Capybara::Node::Matchers#has_no_checked_field?}
 
       ##
-      # Expectation that there is css
+      # Expectation that there is unchecked_field
       #
-      # @!method must_have_css
-      #   see Capybara::Node::Matchers#has_css?
+      # @!method must_have_unchecked_field
+      #   See {Capybara::Node::Matchers#has_unchecked_field?}
 
       ##
-      # Expectation that there is no css
+      # Expectation that there is no unchecked_field
       #
-      # @!method wont_have_css
-      #   see Capybara::Node::Matchers#has_no_css?
+      # @!method wont_have_unchecked_field
+      #   See {Capybara::Node::Matchers#has_no_unchecked_field?}
 
       ##
-      # Expectation that there is link
+      # Expectation that page content does match
       #
-      # @!method must_have_link
-      #   see {Capybara::Node::Matchers#has_link?}
+      # @!method must_have_content
+      #   See {Capybara::Node::Matchers#has_content?}
 
       ##
-      # Expectation that there is no link
+      # Expectation that page content does not match
       #
-      # @!method wont_have_link
-      # see {Capybara::Node::Matchers#has_no_link?}
+      # @!method wont_have_content
+      #   See {Capybara::Node::Matchers#has_no_content?}
 
       ##
-      # Expectation that there is button
+      # Expectation that there is css
       #
-      # @!method must_have_button
-      #   see {Capybara::Node::Matchers#has_button?}
+      # @!method must_have_css
+      #   See {Capybara::Node::Matchers#has_css?}
 
       ##
-      # Expectation that there is no button
+      # Expectation that there is no css
       #
-      # @!method wont_have_button
-      #   see {Capybara::Node::Matchers#has_no_button?}
+      # @!method wont_have_css
+      #   See {Capybara::Node::Matchers#has_no_css?}
+
+      ##
+      # Expectation that current path matches
+      #
+      # @!method must_have_current_path
+      #   See {Capybara::SessionMatchers#has_current_path?}
+
+      ##
+      # Expectation that current page does not match
+      #
+      # @!method wont_have_current_path
+      #   See {Capybara::SessionMatchers#has_no_current_path?}
 
       ##
       # Expectation that there is field
       #
       # @!method must_have_field
-      #   see {Capybara::Node::Matchers#has_field?}
+      #   See {Capybara::Node::Matchers#has_field?}
 
       ##
       # Expectation that there is no field
       #
       # @!method wont_have_field
-      #   see {Capybara::Node::Matchers#has_no_field?}
+      #   See {Capybara::Node::Matchers#has_no_field?}
 
       ##
-      # Expectation that there is checked_field
+      # Expectation that there is element
       #
-      # @!method must_have_checked_field
-      #   see {Capybara::Node::Matchers#has_checked_field?}
+      # @!method must_have_element
+      #   See {Capybara::Node::Matchers#has_element?}
 
       ##
-      # Expectation that there is no checked_field
+      # Expectation that there is no element
       #
-      # @!method wont_have_chceked_field
+      # @!method wont_have_element
+      #   See {Capybara::Node::Matchers#has_no_element?}
 
       ##
-      # Expectation that there is unchecked_field
+      # Expectation that there is link
       #
-      # @!method must_have_unchecked_field
-      #   see {Capybara::Node::Matchers#has_unchecked_field?}
+      # @!method must_have_link
+      #   See {Capybara::Node::Matchers#has_link?}
 
       ##
-      # Expectation that there is no unchecked_field
+      # Expectation that there is no link
       #
-      # @!method wont_have_unchceked_field
+      # @!method wont_have_link
+      #   See {Capybara::Node::Matchers#has_no_link?}
+
+      ##
+      # Expectation that page text does match
+      #
+      # @!method must_have_text
+      #   See {Capybara::Node::Matchers#has_text?}
+
+      ##
+      # Expectation that page text does not match
+      #
+      # @!method wont_have_text
+      #   See {Capybara::Node::Matchers#has_no_text?}
+
+      ##
+      # Expectation that page title does match
+      #
+      # @!method must_have_title
+      #   See {Capybara::Node::DocumentMatchers#has_title?}
+
+      ##
+      # Expectation that page title does not match
+      #
+      # @!method wont_have_title
+      #   See {Capybara::Node::DocumentMatchers#has_no_title?}
 
       ##
       # Expectation that there is select
       #
       # @!method must_have_select
-      #   see {Capybara::Node::Matchers#has_select?}
+      #   See {Capybara::Node::Matchers#has_select?}
 
       ##
       # Expectation that there is no select
       #
       # @!method wont_have_select
-      #   see {Capybara::Node::Matchers#has_no_select?}
+      #   See {Capybara::Node::Matchers#has_no_select?}
+
+      ##
+      # Expectation that there is a selector
+      #
+      # @!method must_have_selector
+      #   See {Capybara::Node::Matchers#has_selector?}
+
+      ##
+      # Expectation that there is no selector
+      #
+      # @!method wont_have_selector
+      #   See {Capybara::Node::Matchers#has_no_selector?}
+
+      ##
+      # Expectation that all of the provided selectors are present
+      #
+      # @!method must_have_all_of_selectors
+      #   See {Capybara::Node::Matchers#assert_all_of_selectors}
+
+      ##
+      # Expectation that none of the provided selectors are present
+      #
+      # @!method must_have_none_of_selectors
+      #   See {Capybara::Node::Matchers#assert_none_of_selectors}
+
+      ##
+      # Expectation that any of the provided selectors are present
+      #
+      # @!method must_have_any_of_selectors
+      #   See {Capybara::Node::Matchers#assert_any_of_selectors}
+
+      ##
+      # Expectation that there is a sibling
+      #
+      # @!method must_have_sibling
+      #   See {Capybara::Node::Matchers#has_sibling?}
+
+      ##
+      # Expectation that element has style
+      #
+      # @!method must_match_style
+      #   See {Capybara::Node::Matchers#matches_style?}
 
       ##
       # Expectation that there is table
       #
       # @!method must_have_table
-      #   see {Capybara::Node::Matchers#has_table?}
+      #   See {Capybara::Node::Matchers#has_table?}
 
       ##
       # Expectation that there is no table
       #
       # @!method wont_have_table
-      #   see {Capybara::Node::Matchers#has_no_table?}
+      #   See {Capybara::Node::Matchers#has_no_table?}
 
       ##
-      # Expectation that page title does match
+      # Expectation that there is xpath
       #
-      # @!method must_have_title
-      #   see {Capybara::Node::DocumentMatchers#assert_title}
+      # @!method must_have_xpath
+      #   See {Capybara::Node::Matchers#has_xpath?}
 
       ##
-      # Expectation that page title does not match
+      # Expectation that there is no xpath
       #
-      # @!method wont_have_title
-      #   see {Capybara::Node::DocumentMatchers#assert_no_title}
+      # @!method wont_have_xpath
+      #   See {Capybara::Node::Matchers#has_no_xpath?}
 
-      ##
-      # Expectation that current path matches
-      #
-      # @!method must_have_current_path
-      #   see {Capybara::SessionMatchers#assert_current_path}
+      # This currently doesn't work for Ruby 2.8 due to Minitest not forwarding keyword args separately
+      # %w[text content title current_path].each do |assertion|
+      #   infect_an_assertion "assert_#{assertion}", "must_have_#{assertion}", :reverse
+      #   infect_an_assertion "refute_#{assertion}", "wont_have_#{assertion}", :reverse
+      # end
+
+      # rubocop:disable Style/MultilineBlockChain
+      (%w[text content title current_path
+          selector xpath css link button field select table checked_field unchecked_field
+          ancestor sibling].flat_map do |assertion|
+            [%W[assert_#{assertion} must_have_#{assertion}],
+             %W[refute_#{assertion} wont_have_#{assertion}]]
+          end + [%w[assert_all_of_selectors must_have_all_of_selectors],
+                 %w[assert_none_of_selectors must_have_none_of_selectors],
+                 %w[assert_any_of_selectors must_have_any_of_selectors],
+                 %w[assert_matches_style must_match_style]] +
+      %w[selector xpath css].flat_map do |assertion|
+        [%W[assert_matches_#{assertion} must_match_#{assertion}],
+         %W[refute_matches_#{assertion} wont_match_#{assertion}]]
+      end).each do |(meth, new_name)|
+        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
+          def #{new_name}(...)
+            ::Minitest::Expectation.new(self, ::Minitest::Spec.current).#{new_name}(...)
+          end
+        ASSERTION
+
+        ::Minitest::Expectation.class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
+          def #{new_name}(...)
+            raise "Calling ##{new_name} outside of test." unless ctx
+            ctx.#{meth}(target, ...)
+          end
+        ASSERTION
+      end
+      # rubocop:enable Style/MultilineBlockChain
 
       ##
-      # Expectation that current page does not match
-      #
-      # @!method wont_have_current_path
-      #   see {Capybara::SessionMatchers#assert_no_current_path}
+      # @deprecated
+      def must_have_style(...)
+        warn 'must_have_style is deprecated, please use must_match_style'
+        must_match_style(...)
+      end
     end
   end
 end
 
 class Capybara::Session
-  include Capybara::Minitest::Expectations unless ENV["MT_NO_EXPECTATIONS"]
+  include Capybara::Minitest::Expectations unless ENV['MT_NO_EXPECTATIONS']
 end
 
 class Capybara::Node::Base
-  include Capybara::Minitest::Expectations unless ENV["MT_NO_EXPECTATIONS"]
+  include Capybara::Minitest::Expectations unless ENV['MT_NO_EXPECTATIONS']
 end
 
 class Capybara::Node::Simple
-  include Capybara::Minitest::Expectations unless ENV["MT_NO_EXPECTATIONS"]
+  include Capybara::Minitest::Expectations unless ENV['MT_NO_EXPECTATIONS']
 end