capybara 3.32.2

data/lib/capybara/rspec/matchers.rb

@@ -0,0 +1,201 @@
+# 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
+    # 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::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::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::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, **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)
+      end
+
+      define_method "match_#{selector}" do |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?
+
+    # @!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?
+
+    # @!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?
+
+    # @!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?
+
+    %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
+
+    # @!method have_link(locator = nil, **options, &optional_filter_block)
+    #   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?
+
+    # @!method have_field(locator = nil, **options, &optional_filter_block)
+    #   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?
+
+    # @!method have_table(locator = nil, **options, &optional_filter_block)
+    #   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)
+      end
+    end
+
+    # @!method have_checked_field(locator = nil, **options, &optional_filter_block)
+    #   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 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)
+    end
+
+    # RSpec matcher for the current path.
+    #
+    # @see Capybara::SessionMatchers#assert_current_path
+    def have_current_path(path, **options)
+      Matchers::HaveCurrentPath.new(path, **options)
+    end
+
+    # RSpec matcher for element style.
+    #
+    # @see Capybara::Node::Matchers#matches_style?
+    def match_style(styles, **options)
+      Matchers::MatchStyle.new(styles, **options)
+    end
+
+    ##
+    # @deprecated
+    #
+    def have_style(styles, **options)
+      warn 'DEPRECATED: have_style is deprecated, please use match_style'
+      match_style(styles, **options)
+    end
+
+    %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, **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)
+    #
+    # @option options [Numeric] :wait   Maximum wait time. Defaults to {Capybara.configure default_max_wait_time}
+    def become_closed(**options)
+      Matchers::BecomeClosed.new(options)
+    end
+  end
+end

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

@@ -0,0 +1,111 @@
+# 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
+    module Matchers
+      class Base
+        include ::Capybara::RSpecMatchers::Matchers::Compound if defined?(::Capybara::RSpecMatchers::Matchers::Compound)
+
+        attr_reader :failure_message, :failure_message_when_negated
+
+        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
+          @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
+            @context_el.session_options
+          elsif @context_el.respond_to? :current_scope
+            @context_el.current_scope.session_options
+          else
+            Capybara.session_options
+          end
+        end
+      end
+
+      class WrappedElementMatcher < Base
+        def matches?(actual)
+          element_matches?(wrap(actual))
+        rescue Capybara::ExpectationNotMet => e
+          @failure_message = e.message
+          false
+        end
+
+        def does_not_match?(actual)
+          element_does_not_match?(wrap(actual))
+        rescue Capybara::ExpectationNotMet => e
+          @failure_message_when_negated = e.message
+          false
+        end
+
+      private
+
+        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
+      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)
+
+        def initialize(matcher)
+          super()
+          @matcher = matcher
+        end
+
+        def matches?(actual)
+          @matcher.does_not_match?(actual)
+        end
+
+        def does_not_match?(actual)
+          @matcher.matches?(actual)
+        end
+
+        def description
+          "not #{@matcher.description}"
+        end
+
+        def failure_message
+          @matcher.failure_message_when_negated
+        end
+
+        def failure_message_when_negated
+          @matcher.failure_message
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class BecomeClosed
+        def initialize(options)
+          @options = options
+        end
+
+        def matches?(window)
+          @window = window
+          @wait_time = Capybara::Queries::BaseQuery.wait(@options, window.session.config.default_max_wait_time)
+          timer = Capybara::Helpers.timer(expire_in: @wait_time)
+          while window.exists?
+            return false if timer.expired?
+
+            sleep 0.01
+          end
+          true
+        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
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+if defined?(::RSpec::Expectations::Version)
+  module Capybara
+    module RSpecMatchers
+      module Matchers
+        module Compound
+          include ::RSpec::Matchers::Composable
+
+          def and(matcher)
+            And.new(self, matcher)
+          end
+
+          def and_then(matcher)
+            ::RSpec::Matchers::BuiltIn::Compound::And.new(self, matcher)
+          end
+
+          def or(matcher)
+            Or.new(self, matcher)
+          end
+
+          class CapybaraEvaluator
+            def initialize(actual)
+              @actual = actual
+              @match_results = Hash.new { |hsh, matcher| hsh[matcher] = matcher.matches?(@actual) }
+            end
+
+            def matcher_matches?(matcher)
+              @match_results[matcher]
+            end
+
+            def reset
+              @match_results.clear
+            end
+          end
+
+          # @api private
+          module Synchronizer
+            def match(_expected, actual)
+              @evaluator = CapybaraEvaluator.new(actual)
+              syncer = sync_element(actual)
+              begin
+                syncer.synchronize do
+                  @evaluator.reset
+                  raise ::Capybara::ElementNotFound unless synchronized_match?
+
+                  true
+                end
+              rescue StandardError
+                false
+              end
+            end
+
+            def sync_element(el)
+              if el.respond_to? :synchronize
+                el
+              elsif el.respond_to? :current_scope
+                el.current_scope
+              else
+                Capybara.string(el)
+              end
+            end
+          end
+
+          class And < ::RSpec::Matchers::BuiltIn::Compound::And
+            include Synchronizer
+
+          private
+
+            def synchronized_match?
+              [matcher_1_matches?, matcher_2_matches?].all?
+            end
+          end
+
+          class Or < ::RSpec::Matchers::BuiltIn::Compound::Or
+            include Synchronizer
+
+          private
+
+            def synchronized_match?
+              [matcher_1_matches?, matcher_2_matches?].any?
+            end
+          end
+        end
+      end
+    end
+  end
+end

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