capybara 3.0.0 → 3.36.0

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class MatchStyle < WrappedElementMatcher
+        def initialize(styles = nil, **kw_args, &filter_block)
+          styles, kw_args = kw_args, {} if styles.nil?
+          super(styles, **kw_args, &filter_block)
+        end
+
+        def element_matches?(el)
+          el.assert_matches_style(*@args, **@kw_args)
+        end
+
+        def does_not_match?(_actual)
+          raise ArgumentError, 'The match_style matcher does not support use with not_to/should_not'
+        end
+
+        def description
+          'match style'
+        end
+      end
+    end
+  end
+end
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      ##
+      # @deprecated
+      class HaveStyle < MatchStyle
+        def initialize(*args, **kw_args, &filter_block)
+          warn 'HaveStyle matcher is deprecated, please use the MatchStyle matcher instead'
+          super
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Capybara
+  module RSpecMatchers
+    module SpatialSugar
+      def above(el)
+        options[:above] = el
+        self
+      end
+
+      def below(el)
+        options[:below] = el
+        self
+      end
+
+      def left_of(el)
+        options[:left_of] = el
+        self
+      end
+
+      def right_of(el)
+        options[:right_of] = el
+        self
+      end
+
+      def near(el)
+        options[:near] = el
+        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.rb

@@ -1,380 +1,202 @@
 # 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'
+require 'capybara/rspec/matchers/have_text'
+require 'capybara/rspec/matchers/have_title'
+require 'capybara/rspec/matchers/become_closed'
+
 module Capybara
   module RSpecMatchers
-    class Matcher
-      if defined?(::RSpec::Expectations::Version)
-        require 'capybara/rspec/compound'
-        include ::Capybara::RSpecMatchers::Compound
-      end
-
-      attr_reader :failure_message, :failure_message_when_negated
-
-      def wrap(actual)
-        actual = actual.to_capybara_node if actual.respond_to?(:to_capybara_node)
-        @context_el = if actual.respond_to?(:has_selector?)
-          actual
-        else
-          Capybara.string(actual.to_s)
-        end
-      end
-
-    private
-
-      def wrap_matches?(actual)
-        yield(wrap(actual))
-      rescue Capybara::ExpectationNotMet => e
-        @failure_message = e.message
-        return false
-      end
-
-      def wrap_does_not_match?(actual)
-        yield(wrap(actual))
-      rescue Capybara::ExpectationNotMet => e
-        @failure_message_when_negated = e.message
-        return false
-      end
-
-      def session_query_args
-        if @args.last.is_a? Hash
-          @args.last[:session_options] = session_options
-        else
-          @args.push(session_options: session_options)
-        end
-        @args
-      end
-
-      def session_options
-        @context_el ||= nil
-        if @context_el.respond_to? :session_options
-          @context_el.session_options
-        elsif @context_el.respond_to? :current_scope
-          @context_el.current_scope.session_options
-        else
-          Capybara.session_options
-        end
-      end
+    # 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
 
-    class HaveSelector < Matcher
-      def initialize(*args, &filter_block)
-        @args = args
-        @filter_block = filter_block
-      end
-
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_selector(*@args, &@filter_block) }
-      end
-
-      def does_not_match?(actual)
-        wrap_does_not_match?(actual) { |el| el.assert_no_selector(*@args, &@filter_block) }
-      end
-
-      def description
-        "have #{query.description}"
-      end
-
-      def query
-        @query ||= Capybara::Queries::SelectorQuery.new(*session_query_args, &@filter_block)
-      end
+    # 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
 
-    class HaveAllSelectors < Matcher
-      def initialize(*args, &filter_block)
-        @args = args
-        @filter_block = filter_block
-      end
-
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_all_of_selectors(*@args, &@filter_block) }
-      end
-
-      def does_not_match?(_actual)
-        raise ArgumentError, "The have_all_selectors matcher does not support use with not_to/should_not"
-      end
-
-      def description
-        "have all selectors"
-      end
+    # 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
 
-    class HaveNoSelectors < Matcher
-      def initialize(*args, &filter_block)
-        @args = args
-        @filter_block = filter_block
-      end
-
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_none_of_selectors(*@args, &@filter_block) }
-      end
-
-      def does_not_match?(_actual)
-        raise ArgumentError, "The have_none_of_selectors matcher does not support use with not_to/should_not"
-      end
-
-      def description
-        "have no selectors"
-      end
+    # 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
 
-    class MatchSelector < HaveSelector
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_matches_selector(*@args, &@filter_block) }
-      end
-
-      def does_not_match?(actual)
-        wrap_does_not_match?(actual) { |el| el.assert_not_matches_selector(*@args, &@filter_block) }
-      end
-
-      def description
-        "match #{query.description}"
-      end
-
-      def query
-        @query ||= Capybara::Queries::MatchQuery.new(*session_query_args, &@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, **kw_args, &optional_filter_block)
+      Matchers::MatchSelector.new(*args, **kw_args, &optional_filter_block)
     end
 
-    class HaveText < Matcher
-      def initialize(*args)
-        @args = args.dup
-        @content = args[0].is_a?(Symbol) ? args[1] : args[0]
+    %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)
       end
 
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_text(*@args) }
-      end
-
-      def does_not_match?(actual)
-        wrap_does_not_match?(actual) { |el| el.assert_no_text(*@args) }
-      end
-
-      def description
-        "text #{format(@content)}"
-      end
-
-      def format(content)
-        content.inspect
+      define_method "match_#{selector}" do |expr, **options, &optional_filter_block|
+        Matchers::MatchSelector.new(selector, expr, **options, &optional_filter_block)
       end
     end
 
-    class HaveTitle < Matcher
-      def initialize(*args)
-        @args = args
+    # @!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?
 
-        # are set just for backwards compatability
-        @title = args.first
-      end
+    # @!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?
 
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_title(*@args) }
-      end
+    # @!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?
 
-      def does_not_match?(actual)
-        wrap_does_not_match?(actual) { |el| el.assert_no_title(*@args) }
-      end
+    # @!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?
 
-      def description
-        "have title #{@title.inspect}"
+    %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)
       end
     end
 
-    class HaveCurrentPath < Matcher
-      def initialize(*args)
-        @args = args
-        @current_path = args.first
-      end
-
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_current_path(*@args) }
-      end
-
-      def does_not_match?(actual)
-        wrap_does_not_match?(actual) { |el| el.assert_no_current_path(*@args) }
-      end
-
-      def description
-        "have current path #{@current_path.inspect}"
-      end
-    end
-
-    class NegatedMatcher
-      def initialize(matcher)
-        @matcher = matcher
-      end
-
-      def matches?(actual)
-        @matcher.does_not_match?(actual)
-      end
-
-      def does_not_match?(actual)
-        @matcher.matches?(actual)
-      end
+    # @!method have_link(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for links.
+    #
+    #   @see Capybara::Node::Matchers#has_link?
 
-      def description
-        "not #{@matcher.description}"
-      end
+    # @!method have_button(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for buttons.
+    #
+    #   @see Capybara::Node::Matchers#has_button?
 
-      def failure_message
-        @matcher.failure_message_when_negated
-      end
+    # @!method have_field(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for form fields.
+    #
+    #   @see Capybara::Node::Matchers#has_field?
 
-      def failure_message_when_negated
-        @matcher.failure_message
-      end
-    end
+    # @!method have_select(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for select elements.
+    #
+    #   @see Capybara::Node::Matchers#has_select?
 
-    class BecomeClosed
-      def initialize(options)
-        @options = options
-      end
+    # @!method have_table(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for table elements.
+    #
+    #   @see Capybara::Node::Matchers#has_table?
 
-      def matches?(window)
-        @window = window
-        @wait_time = Capybara::Queries::BaseQuery.wait(@options, window.session.config.default_max_wait_time)
-        start_time = Capybara::Helpers.monotonic_time
-        while window.exists?
-          return false if (Capybara::Helpers.monotonic_time - start_time) > @wait_time
-          sleep 0.05
-        end
-        true
+    %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)
       end
-
-      def failure_message
-        "expected #{@window.inspect} to become closed after #{@wait_time} seconds"
-      end
-
-      def failure_message_when_negated
-        "expected #{@window.inspect} not to become closed after #{@wait_time} seconds"
-      end
-    end
-
-    # 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)
-      HaveSelector.new(*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)
-      HaveAllSelectors.new(*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)
-      HaveNoSelectors.new(*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)
-      MatchSelector.new(*args, &optional_filter_block)
-    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 whether elements(s) matching a given xpath selector exist
-    # See {Capybara::Node::Matchers#has_xpath?}
-    def have_xpath(xpath, **options, &optional_filter_block)
-      HaveSelector.new(:xpath, xpath, options, &optional_filter_block)
-    end
-
-    # RSpec matcher for whether the current element matches a given xpath selector
-    def match_xpath(xpath, **options, &optional_filter_block)
-      MatchSelector.new(:xpath, xpath, options, &optional_filter_block)
-    end
+    # @!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 whether elements(s) matching a given css selector exist
-    # See {Capybara::Node::Matchers#has_css?}
-    def have_css(css, **options, &optional_filter_block)
-      HaveSelector.new(:css, css, options, &optional_filter_block)
-    end
-
-    # RSpec matcher for whether the current element matches a given css selector
-    def match_css(css, **options, &optional_filter_block)
-      MatchSelector.new(:css, css, options, &optional_filter_block)
-    end
-
-    # RSpec matcher for text content
-    # See {Capybara::SessionMatchers#assert_text}
-    def have_text(*args)
-      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)
-      HaveTitle.new(title, options)
-    end
-
-    # RSpec matcher for the current path
-    # See {Capybara::SessionMatchers#assert_current_path}
-    def have_current_path(path, **options)
-      HaveCurrentPath.new(path, options)
+      Matchers::HaveTitle.new(title, **options)
     end
 
-    # RSpec matcher for links
-    # See {Capybara::Node::Matchers#has_link?}
-    def have_link(locator = nil, **options, &optional_filter_block)
-      HaveSelector.new(:link, locator, options, &optional_filter_block)
+    # RSpec matcher for the current path.
+    #
+    # @see Capybara::SessionMatchers#assert_current_path
+    def have_current_path(path, **options, &optional_filter_block)
+      Matchers::HaveCurrentPath.new(path, **options, &optional_filter_block)
     end
 
-    # RSpec matcher for buttons
-    # See {Capybara::Node::Matchers#has_button?}
-    def have_button(locator = nil, **options, &optional_filter_block)
-      HaveSelector.new(:button, locator, options, &optional_filter_block)
+    # RSpec matcher for element style.
+    #
+    # @see Capybara::Node::Matchers#matches_style?
+    def match_style(styles = nil, **options)
+      styles, options = options, {} if styles.nil?
+      Matchers::MatchStyle.new(styles, **options)
     end
 
-    # RSpec matcher for links
-    # See {Capybara::Node::Matchers#has_field?}
-    def have_field(locator = nil, **options, &optional_filter_block)
-      HaveSelector.new(:field, locator, options, &optional_filter_block)
-    end
-
-    # RSpec matcher for checked fields
-    # See {Capybara::Node::Matchers#has_checked_field?}
-    def have_checked_field(locator = nil, **options, &optional_filter_block)
-      HaveSelector.new(:field, locator, options.merge(checked: true), &optional_filter_block)
-    end
-
-    # RSpec matcher for unchecked fields
-    # See {Capybara::Node::Matchers#has_unchecked_field?}
-    def have_unchecked_field(locator = nil, **options, &optional_filter_block)
-      HaveSelector.new(:field, locator, options.merge(unchecked: true), &optional_filter_block)
-    end
-
-    # RSpec matcher for select elements
-    # See {Capybara::Node::Matchers#has_select?}
-    def have_select(locator = nil, **options, &optional_filter_block)
-      HaveSelector.new(:select, locator, options, &optional_filter_block)
-    end
-
-    # RSpec matcher for table elements
-    # See {Capybara::Node::Matchers#has_table?}
-    def have_table(locator = nil, **options, &optional_filter_block)
-      HaveSelector.new(:table, locator, options, &optional_filter_block)
+    ##
+    # @deprecated
+    #
+    def have_style(styles = nil, **options)
+      Capybara::Helpers.warn "DEPRECATED: have_style is deprecated, please use match_style : #{Capybara::Helpers.filter_backtrace(caller)}"
+      match_style(styles, **options)
     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|
-        NegatedMatcher.new(send("have_#{matcher_type}", *args, &optional_filter_block))
+    %w[selector css xpath text title current_path link button
+       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|
-        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)
-      BecomeClosed.new(options)
+      Matchers::BecomeClosed.new(options)
     end
   end
 end

data/lib/capybara/rspec.rb

@@ -9,6 +9,8 @@ require 'capybara/rspec/matcher_proxies'
 RSpec.configure do |config|
   config.include Capybara::DSL, type: :feature
   config.include Capybara::RSpecMatchers, type: :feature
+  config.include Capybara::DSL, type: :system
+  config.include Capybara::RSpecMatchers, type: :system
   config.include Capybara::RSpecMatchers, type: :view
 
   # The before and after blocks must run instantaneously, because Capybara
@@ -20,9 +22,8 @@ RSpec.configure do |config|
     end
   end
 
-  config.before do
+  config.before do |example|
     if self.class.include?(Capybara::DSL)
-      example = RSpec.current_example
       Capybara.current_driver = Capybara.javascript_driver if example.metadata[:js]
       Capybara.current_driver = example.metadata[:driver] if example.metadata[:driver]
     end