capybara 3.16.1 → 3.33.0

data/lib/capybara/rspec/matcher_proxies.rb

@@ -2,17 +2,17 @@
 
 module Capybara
   module RSpecMatcherProxies
-    def all(*args, &block)
+    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, &block)
+        find_all(*args, **kwargs, &block)
       end
     end
 
-    def within(*args)
+    def within(*args, **kwargs, &block)
       if block_given?
-        within_element(*args, &Proc.new)
+        within_element(*args, **kwargs, &block)
       else
         be_within(*args)
       end
@@ -21,6 +21,7 @@ module Capybara
 end
 
 if RUBY_ENGINE == 'jruby'
+  # :nocov:
   module Capybara::DSL
     class <<self
       remove_method :included
@@ -43,6 +44,7 @@ if RUBY_ENGINE == 'jruby'
       end
     end
   end
+  # :nocov:
 else
   module Capybara::DSLRSpecProxyInstaller
     module ClassMethods

data/lib/capybara/rspec/matchers.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'capybara/rspec/matchers/have_selector'
+require 'capybara/rspec/matchers/have_ancestor'
+require 'capybara/rspec/matchers/have_sibling'
 require 'capybara/rspec/matchers/match_selector'
 require 'capybara/rspec/matchers/have_current_path'
 require 'capybara/rspec/matchers/match_style'
@@ -10,123 +12,142 @@ require 'capybara/rspec/matchers/become_closed'
 
 module Capybara
   module RSpecMatchers
-    # RSpec matcher for whether the element(s) matching a given selector exist
-    # See {Capybara::Node::Matcher#assert_selector}
-    def have_selector(*args, &optional_filter_block)
-      Matchers::HaveSelector.new(*args, &optional_filter_block)
+    # RSpec matcher for whether the element(s) matching a given selector exist.
+    #
+    # @see Capybara::Node::Matchers#assert_selector
+    def have_selector(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveSelector.new(*args, **kw_args, &optional_filter_block)
     end
 
-    # RSpec matcher for whether the element(s) matching a group of selectors exist
-    # See {Capybara::Node::Matcher#assert_all_of_selectors}
-    def have_all_of_selectors(*args, &optional_filter_block)
-      Matchers::HaveAllSelectors.new(*args, &optional_filter_block)
+    # RSpec matcher for whether the element(s) matching a group of selectors exist.
+    #
+    # @see Capybara::Node::Matchers#assert_all_of_selectors
+    def have_all_of_selectors(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveAllSelectors.new(*args, **kw_args, &optional_filter_block)
     end
 
-    # RSpec matcher for whether no element(s) matching a group of selectors exist
-    # See {Capybara::Node::Matcher#assert_none_of_selectors}
-    def have_none_of_selectors(*args, &optional_filter_block)
-      Matchers::HaveNoSelectors.new(*args, &optional_filter_block)
+    # RSpec matcher for whether no element(s) matching a group of selectors exist.
+    #
+    # @see Capybara::Node::Matchers#assert_none_of_selectors
+    def have_none_of_selectors(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveNoSelectors.new(*args, **kw_args, &optional_filter_block)
     end
 
-    # RSpec matcher for whether the element(s) matching any of a group of selectors exist
-    # See {Capybara::Node::Matcher#assert_any_of_selectors}
-    def have_any_of_selectors(*args, &optional_filter_block)
-      Matchers::HaveAnySelectors.new(*args, &optional_filter_block)
+    # RSpec matcher for whether the element(s) matching any of a group of selectors exist.
+    #
+    # @see Capybara::Node::Matchers#assert_any_of_selectors
+    def have_any_of_selectors(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveAnySelectors.new(*args, **kw_args, &optional_filter_block)
     end
 
-    # RSpec matcher for whether the current element matches a given selector
-    # See {Capybara::Node::Matchers#assert_matches_selector}
-    def match_selector(*args, &optional_filter_block)
-      Matchers::MatchSelector.new(*args, &optional_filter_block)
+    # RSpec matcher for whether the current element matches a given selector.
+    #
+    # @see Capybara::Node::Matchers#assert_matches_selector
+    def match_selector(*args, **kw_args, &optional_filter_block)
+      Matchers::MatchSelector.new(*args, **kw_args, &optional_filter_block)
     end
 
     %i[css xpath].each do |selector|
       define_method "have_#{selector}" do |expr, **options, &optional_filter_block|
-        Matchers::HaveSelector.new(selector, expr, options, &optional_filter_block)
+        Matchers::HaveSelector.new(selector, expr, **options, &optional_filter_block)
       end
 
       define_method "match_#{selector}" do |expr, **options, &optional_filter_block|
-        Matchers::MatchSelector.new(selector, expr, options, &optional_filter_block)
+        Matchers::MatchSelector.new(selector, expr, **options, &optional_filter_block)
       end
     end
 
     # @!method have_xpath(xpath, **options, &optional_filter_block)
-    #   RSpec matcher for whether elements(s) matching a given xpath selector exist
-    #   See {Capybara::Node::Matchers#has_xpath?}
+    #   RSpec matcher for whether elements(s) matching a given xpath selector exist.
+    #
+    #   @see Capybara::Node::Matchers#has_xpath?
 
     # @!method have_css(css, **options, &optional_filter_block)
     #   RSpec matcher for whether elements(s) matching a given css selector exist
-    #   See {Capybara::Node::Matchers#has_css?}
+    #
+    #   @see Capybara::Node::Matchers#has_css?
 
     # @!method match_xpath(xpath, **options, &optional_filter_block)
-    #   RSpec matcher for whether the current element matches a given xpath selector
-    #   See {Capybara::Node::Matchers#matches_xpath?}
+    #   RSpec matcher for whether the current element matches a given xpath selector.
+    #
+    #   @see Capybara::Node::Matchers#matches_xpath?
 
     # @!method match_css(css, **options, &optional_filter_block)
-    #   RSpec matcher for whether the current element matches a given css selector
-    #   See {Capybara::Node::Matchers#matches_css?}
+    #   RSpec matcher for whether the current element matches a given css selector.
+    #
+    #   @see Capybara::Node::Matchers#matches_css?
 
     %i[link button field select table].each do |selector|
       define_method "have_#{selector}" do |locator = nil, **options, &optional_filter_block|
-        Matchers::HaveSelector.new(selector, locator, options, &optional_filter_block)
+        Matchers::HaveSelector.new(selector, locator, **options, &optional_filter_block)
       end
     end
 
     # @!method have_link(locator = nil, **options, &optional_filter_block)
-    #   RSpec matcher for links
-    #   See {Capybara::Node::Matchers#has_link?}
+    #   RSpec matcher for links.
+    #
+    #   @see Capybara::Node::Matchers#has_link?
 
     # @!method have_button(locator = nil, **options, &optional_filter_block)
-    #   RSpec matcher for buttons
-    #   See {Capybara::Node::Matchers#has_button?}
+    #   RSpec matcher for buttons.
+    #
+    #   @see Capybara::Node::Matchers#has_button?
 
     # @!method have_field(locator = nil, **options, &optional_filter_block)
-    #   RSpec matcher for links
-    #   See {Capybara::Node::Matchers#has_field?}
+    #   RSpec matcher for links.
+    #
+    #   @see Capybara::Node::Matchers#has_field?
 
     # @!method have_select(locator = nil, **options, &optional_filter_block)
-    #   RSpec matcher for select elements
-    #   See {Capybara::Node::Matchers#has_select?}
+    #   RSpec matcher for select elements.
+    #
+    #   @see Capybara::Node::Matchers#has_select?
 
     # @!method have_table(locator = nil, **options, &optional_filter_block)
-    #   RSpec matcher for table elements
-    #   See {Capybara::Node::Matchers#has_table?}
+    #   RSpec matcher for table elements.
+    #
+    #   @see Capybara::Node::Matchers#has_table?
 
     %i[checked unchecked].each do |state|
       define_method "have_#{state}_field" do |locator = nil, **options, &optional_filter_block|
-        Matchers::HaveSelector.new(:field, locator, options.merge(state => true), &optional_filter_block)
+        Matchers::HaveSelector.new(:field, locator, **options.merge(state => true), &optional_filter_block)
       end
     end
 
     # @!method have_checked_field(locator = nil, **options, &optional_filter_block)
-    #   RSpec matcher for checked fields
-    #   See {Capybara::Node::Matchers#has_checked_field?}
+    #   RSpec matcher for checked fields.
+    #
+    #   @see Capybara::Node::Matchers#has_checked_field?
 
     # @!method have_unchecked_field(locator = nil, **options, &optional_filter_block)
-    #   RSpec matcher for unchecked fields
-    #   See {Capybara::Node::Matchers#has_unchecked_field?}
+    #   RSpec matcher for unchecked fields.
+    #
+    #   @see Capybara::Node::Matchers#has_unchecked_field?
 
-    # RSpec matcher for text content
-    # See {Capybara::Node::Matchers#assert_text}
-    def have_text(*args)
-      Matchers::HaveText.new(*args)
+    # RSpec matcher for text content.
+    #
+    # @see Capybara::Node::Matchers#assert_text
+    def have_text(text_or_type, *args, **options)
+      Matchers::HaveText.new(text_or_type, *args, **options)
     end
     alias_method :have_content, :have_text
 
     def have_title(title, **options)
-      Matchers::HaveTitle.new(title, options)
+      Matchers::HaveTitle.new(title, **options)
     end
 
-    # RSpec matcher for the current path
-    # See {Capybara::SessionMatchers#assert_current_path}
+    # RSpec matcher for the current path.
+    #
+    # @see Capybara::SessionMatchers#assert_current_path
     def have_current_path(path, **options)
-      Matchers::HaveCurrentPath.new(path, options)
+      Matchers::HaveCurrentPath.new(path, **options)
     end
 
-    # RSpec matcher for element style
-    # See {Capybara::Node::Matchers#matches_style?}
+    # RSpec matcher for element style.
+    #
+    # @see Capybara::Node::Matchers#matches_style?
     def match_style(styles, **options)
-      Matchers::MatchStyle.new(styles, options)
+      Matchers::MatchStyle.new(styles, **options)
     end
 
     ##
@@ -138,25 +159,41 @@ module Capybara
     end
 
     %w[selector css xpath text title current_path link button
-       field checked_field unchecked_field select table].each do |matcher_type|
-      define_method "have_no_#{matcher_type}" do |*args, &optional_filter_block|
-        Matchers::NegatedMatcher.new(send("have_#{matcher_type}", *args, &optional_filter_block))
+       field checked_field unchecked_field select table
+       sibling ancestor].each do |matcher_type|
+      define_method "have_no_#{matcher_type}" do |*args, **kw_args, &optional_filter_block|
+        Matchers::NegatedMatcher.new(send("have_#{matcher_type}", *args, **kw_args, &optional_filter_block))
       end
     end
     alias_method :have_no_content, :have_no_text
 
     %w[selector css xpath].each do |matcher_type|
-      define_method "not_match_#{matcher_type}" do |*args, &optional_filter_block|
-        Matchers::NegatedMatcher.new(send("match_#{matcher_type}", *args, &optional_filter_block))
+      define_method "not_match_#{matcher_type}" do |*args, **kw_args, &optional_filter_block|
+        Matchers::NegatedMatcher.new(send("match_#{matcher_type}", *args, **kw_args, &optional_filter_block))
       end
     end
 
+    # RSpec matcher for whether sibling element(s) matching a given selector exist.
+    #
+    # @see Capybara::Node::Matchers#assert_sibling
+    def have_sibling(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveSibling.new(*args, **kw_args, &optional_filter_block)
+    end
+
+    # RSpec matcher for whether ancestor element(s) matching a given selector exist.
+    #
+    # @see Capybara::Node::Matchers#assert_ancestor
+    def have_ancestor(*args, **kw_args, &optional_filter_block)
+      Matchers::HaveAncestor.new(*args, **kw_args, &optional_filter_block)
+    end
+
     ##
     # Wait for window to become closed.
+    #
     # @example
     #   expect(window).to become_closed(wait: 0.8)
-    # @param options [Hash] optional param
-    # @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum wait time
+    #
+    # @option options [Numeric] :wait   Maximum wait time. Defaults to {Capybara.configure default_max_wait_time}
     def become_closed(**options)
       Matchers::BecomeClosed.new(options)
     end

data/lib/capybara/rspec/matchers/base.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
 require 'capybara/rspec/matchers/compound'
+require 'capybara/rspec/matchers/count_sugar'
+require 'capybara/rspec/matchers/spatial_sugar'
 
 module Capybara
   module RSpecMatchers
@@ -10,22 +12,28 @@ module Capybara
 
         attr_reader :failure_message, :failure_message_when_negated
 
-        def initialize(*args, &filter_block)
+        def initialize(*args, **kw_args, &filter_block)
           @args = args.dup
+          @kw_args = kw_args || {}
           @filter_block = filter_block
         end
 
       private
 
         def session_query_args
-          if @args.last.is_a? Hash
-            @args.last[:session_options] = session_options
-          else
-            @args.push(session_options: session_options)
-          end
+          # if @args.last.is_a? Hash
+          #   @args.last[:session_options] = session_options
+          # else
+          #   @args.push(session_options: session_options)
+          # end
           @args
         end
 
+        def session_query_options
+          @kw_args[:session_options] = session_options
+          @kw_args
+        end
+
         def session_options
           @context_el ||= nil
           if @context_el.respond_to? :session_options
@@ -41,15 +49,15 @@ module Capybara
       class WrappedElementMatcher < Base
         def matches?(actual)
           element_matches?(wrap(actual))
-        rescue Capybara::ExpectationNotMet => err
-          @failure_message = err.message
+        rescue Capybara::ExpectationNotMet => e
+          @failure_message = e.message
           false
         end
 
         def does_not_match?(actual)
           element_does_not_match?(wrap(actual))
-        rescue Capybara::ExpectationNotMet => err
-          @failure_message_when_negated = err.message
+        rescue Capybara::ExpectationNotMet => e
+          @failure_message_when_negated = e.message
           false
         end
 
@@ -65,6 +73,11 @@ module Capybara
         end
       end
 
+      class CountableWrappedElementMatcher < WrappedElementMatcher
+        include ::Capybara::RSpecMatchers::CountSugar
+        include ::Capybara::RSpecMatchers::SpatialSugar
+      end
+
       class NegatedMatcher
         include ::Capybara::RSpecMatchers::Matchers::Compound if defined?(::Capybara::RSpecMatchers::Matchers::Compound)
 

data/lib/capybara/rspec/matchers/count_sugar.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Capybara
+  module RSpecMatchers
+    module CountSugar
+      def once; exactly(1); end
+      def twice; exactly(2); end
+      def thrice; exactly(3); end
+
+      def exactly(number)
+        options[:count] = number
+        self
+      end
+
+      def at_most(number)
+        options[:maximum] = number
+        self
+      end
+
+      def at_least(number)
+        options[:minimum] = number
+        self
+      end
+
+      def times
+        self
+      end
+
+    private
+
+      def options
+        # (@args.last.is_a?(Hash) ? @args : @args.push({})).last
+        @kw_args
+      end
+    end
+  end
+end

data/lib/capybara/rspec/matchers/have_ancestor.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class HaveAncestor < CountableWrappedElementMatcher
+        def element_matches?(el)
+          el.assert_ancestor(*@args, **session_query_options, &@filter_block)
+        end
+
+        def element_does_not_match?(el)
+          el.assert_no_ancestor(*@args, **session_query_options, &@filter_block)
+        end
+
+        def description
+          "have ancestor #{query.description}"
+        end
+
+        def query
+          # @query ||= Capybara::Queries::AncestorQuery.new(*session_query_args, &@filter_block)
+          @query ||= Capybara::Queries::AncestorQuery.new(*session_query_args, **session_query_options, &@filter_block)
+        end
+      end
+    end
+  end
+end

data/lib/capybara/rspec/matchers/have_current_path.rb

@@ -7,11 +7,11 @@ module Capybara
     module Matchers
       class HaveCurrentPath < WrappedElementMatcher
         def element_matches?(el)
-          el.assert_current_path(*@args)
+          el.assert_current_path(current_path, **@kw_args)
         end
 
         def element_does_not_match?(el)
-          el.assert_no_current_path(*@args)
+          el.assert_no_current_path(current_path, **@kw_args)
         end
 
         def description