capybara 3.32.2

data/lib/capybara/helpers.rb

@@ -0,0 +1,108 @@
+# frozen_string_literal: true
+
+module Capybara
+  # @api private
+  module Helpers
+  module_function
+
+    ##
+    # @deprecated
+    # Normalizes whitespace space by stripping leading and trailing
+    # whitespace and replacing sequences of whitespace characters
+    # with a single space.
+    #
+    # @param [String] text     Text to normalize
+    # @return [String]         Normalized text
+    #
+    def normalize_whitespace(text)
+      warn 'DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver'
+      text.to_s.gsub(/[[:space:]]+/, ' ').strip
+    end
+
+    ##
+    #
+    # Escapes any characters that would have special meaning in a regexp
+    # if text is not a regexp
+    #
+    # @param [String] text Text to escape
+    # @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, 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.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?
+        html.match(/<head[^<]*?>/) do |m|
+          return html.clone.insert m.end(0), "<base href='#{host}' />"
+        end
+      end
+      html
+    end
+
+    ##
+    #
+    # A poor man's `pluralize`. Given two declensions, one singular and one
+    # plural, as well as a count, this will pick the correct declension. This
+    # way we can generate grammatically correct error message.
+    #
+    # @param [String] singular     The singular form of the word
+    # @param [String] plural       The plural form of the word
+    # @param [Integer] count       The number of items
+    #
+    def declension(singular, plural, count)
+      count == 1 ? singular : plural
+    end
+
+    if 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.rb

@@ -0,0 +1,386 @@
+# frozen_string_literal: true
+
+require 'minitest'
+require 'capybara/dsl'
+
+module Capybara
+  module Minitest
+    module Assertions
+      ##
+      # Assert text exists
+      #
+      # @!method assert_content
+      # @!method assert_text
+      #   See {Capybara::Node::Matchers#assert_text}
+
+      ##
+      # Assert text does not exist
+      #
+      # @!method refute_content
+      # @!method assert_no_content
+      # @!method refute_text
+      # @!method assert_no_text
+      #   See {Capybara::Node::Matchers#assert_no_text}
+
+      ##
+      # Assertion that page title does match
+      #
+      # @!method assert_title
+      #   See {Capybara::Node::DocumentMatchers#assert_title}
+
+      ##
+      # Assertion that page title does not match
+      #
+      # @!method refute_title
+      # @!method assert_no_title
+      #   See {Capybara::Node::DocumentMatchers#assert_no_title}
+
+      ##
+      # Assertion that current path matches
+      #
+      # @!method assert_current_path
+      #   See {Capybara::SessionMatchers#assert_current_path}
+
+      ##
+      # Assertion that current page does not match
+      #
+      # @!method refute_current_path
+      # @!method assert_no_current_path
+      #   See {Capybara::SessionMatchers#assert_no_current_path}
+
+      %w[text no_text title no_title current_path no_current_path].each do |assertion_name|
+        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
+          def assert_#{assertion_name} *args
+            self.assertions +=1
+            subject, args = determine_subject(args)
+            subject.assert_#{assertion_name}(*args)
+          rescue Capybara::ExpectationNotMet => e
+            raise ::Minitest::Assertion, e.message
+          end
+        ASSERTION
+        ruby2_keywords "assert_#{assertion_name}" if respond_to?(:ruby2_keywords)
+      end
+
+      alias_method :refute_title, :assert_no_title
+      alias_method :refute_text, :assert_no_text
+      alias_method :refute_content, :refute_text
+      alias_method :refute_current_path, :assert_no_current_path
+      alias_method :assert_content, :assert_text
+      alias_method :assert_no_content, :refute_text
+
+      ##
+      # Assert selector exists on page
+      #
+      # @!method assert_selector
+      #   See {Capybara::Node::Matchers#assert_selector}
+
+      ##
+      # Assert selector does not exist on page
+      #
+      # @!method refute_selector
+      # @!method assert_no_selector
+      #   See {Capybara::Node::Matchers#assert_no_selector}
+
+      ##
+      # Assert element matches selector
+      #
+      # @!method assert_matches_selector
+      #   See {Capybara::Node::Matchers#assert_matches_selector}
+
+      ##
+      # Assert element does not match selector
+      #
+      # @!method refute_matches_selector
+      # @!method assert_not_matches_selector
+      #   See {Capybara::Node::Matchers#assert_not_matches_selector}
+
+      ##
+      # Assert all of the provided selectors exist on page
+      #
+      # @!method assert_all_of_selectors
+      #   See {Capybara::Node::Matchers#assert_all_of_selectors}
+
+      ##
+      # Assert none of the provided selectors exist on page
+      #
+      # @!method assert_none_of_selectors
+      #   See {Capybara::Node::Matchers#assert_none_of_selectors}
+
+      ##
+      # Assert any of the provided selectors exist on page
+      #
+      # @!method assert_any_of_selectors
+      #   See {Capybara::Node::Matchers#assert_any_of_selectors}
+
+      ##
+      # Assert element has the provided CSS styles
+      #
+      # @!method assert_matches_style
+      #   See {Capybara::Node::Matchers#assert_matches_style}
+
+      ##
+      # Assert element has a matching sibling
+      #
+      # @!method assert_sibling
+      #   See {Capybara::Node::Matchers#assert_sibling}
+
+      ##
+      # Assert element does not have a matching sibling
+      #
+      # @!method refute_sibling
+      # @!method assert_no_sibling
+      #   See {Capybara::Node::Matchers#assert_no_sibling}
+
+      ##
+      # Assert element has a matching ancestor
+      #
+      # @!method assert_ancestor
+      #   See {Capybara::Node::Matchers#assert_ancestor}
+
+      ##
+      # Assert element does not have a matching ancestor
+      #
+      # @!method refute_ancestor
+      # @!method assert_no_ancestor
+      #   See {Capybara::Node::Matchers#assert_no_ancestor}
+
+      %w[selector no_selector matches_style
+         all_of_selectors none_of_selectors any_of_selectors
+         matches_selector not_matches_selector
+         sibling no_sibling ancestor no_ancestor].each do |assertion_name|
+        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
+          def assert_#{assertion_name} *args, &optional_filter_block
+            self.assertions +=1
+            subject, args = determine_subject(args)
+            subject.assert_#{assertion_name}(*args, &optional_filter_block)
+          rescue Capybara::ExpectationNotMet => e
+            raise ::Minitest::Assertion, e.message
+          end
+        ASSERTION
+        ruby2_keywords "assert_#{assertion_name}" if respond_to?(:ruby2_keywords)
+      end
+
+      alias_method :refute_selector, :assert_no_selector
+      alias_method :refute_matches_selector, :assert_not_matches_selector
+      alias_method :refute_ancestor, :assert_no_ancestor
+      alias_method :refute_sibling, :assert_no_sibling
+
+      ##
+      # Assert that provided xpath exists
+      #
+      # @!method assert_xpath
+      #   See {Capybara::Node::Matchers#has_xpath?}
+
+      ##
+      # Assert that provide xpath does not exist
+      #
+      # @!method refute_xpath
+      # @!method assert_no_xpath
+      #   See {Capybara::Node::Matchers#has_no_xpath?}
+
+      ##
+      # Assert that provided css exists
+      #
+      # @!method assert_css
+      #   See {Capybara::Node::Matchers#has_css?}
+
+      ##
+      # Assert that provided css does not exist
+      #
+      # @!method refute_css
+      # @!method assert_no_css
+      #   See {Capybara::Node::Matchers#has_no_css?}
+
+      ##
+      # Assert that provided link exists
+      #
+      # @!method assert_link
+      #   See {Capybara::Node::Matchers#has_link?}
+
+      ##
+      # Assert that provided link does not exist
+      #
+      # @!method assert_no_link
+      # @!method refute_link
+      #   See {Capybara::Node::Matchers#has_no_link?}
+
+      ##
+      # Assert that provided button exists
+      #
+      # @!method assert_button
+      #   See {Capybara::Node::Matchers#has_button?}
+
+      ##
+      # Assert that provided button does not exist
+      #
+      # @!method refute_button
+      # @!method assert_no_button
+      #   See {Capybara::Node::Matchers#has_no_button?}
+
+      ##
+      # Assert that provided field exists
+      #
+      # @!method assert_field
+      #   See {Capybara::Node::Matchers#has_field?}
+
+      ##
+      # Assert that provided field does not exist
+      #
+      # @!method refute_field
+      # @!method assert_no_field
+      #   See {Capybara::Node::Matchers#has_no_field?}
+
+      ##
+      # Assert that provided checked field exists
+      #
+      # @!method assert_checked_field
+      #   See {Capybara::Node::Matchers#has_checked_field?}
+
+      ##
+      # Assert that provided checked_field does not exist
+      #
+      # @!method assert_no_checked_field
+      # @!method refute_checked_field
+      #   See {Capybara::Node::Matchers#has_no_checked_field?}
+
+      ##
+      # Assert that provided unchecked field exists
+      #
+      # @!method assert_unchecked_field
+      #   See {Capybara::Node::Matchers#has_unchecked_field?}
+
+      ##
+      # Assert that provided unchecked field does not exist
+      #
+      # @!method assert_no_unchecked_field
+      # @!method refute_unchecked_field
+      #   See {Capybara::Node::Matchers#has_no_unchecked_field?}
+
+      ##
+      # Assert that provided select exists
+      #
+      # @!method assert_select
+      #   See {Capybara::Node::Matchers#has_select?}
+
+      ##
+      # Assert that provided select does not exist
+      #
+      # @!method refute_select
+      # @!method assert_no_select
+      #   See {Capybara::Node::Matchers#has_no_select?}
+
+      ##
+      # Assert that provided table exists
+      #
+      # @!method assert_table
+      #   See {Capybara::Node::Matchers#has_table?}
+
+      ##
+      # Assert that provided table does not exist
+      #
+      # @!method refute_table
+      # @!method assert_no_table
+      #   See {Capybara::Node::Matchers#has_no_table?}
+
+      %w[xpath css link button field select table].each do |selector_type|
+        define_method "assert_#{selector_type}" do |*args, &optional_filter_block|
+          subject, args = determine_subject(args)
+          locator, options = extract_locator(args)
+          assert_selector(subject, selector_type.to_sym, locator, **options, &optional_filter_block)
+        end
+        ruby2_keywords "assert_#{selector_type}" if respond_to?(:ruby2_keywords)
+
+        define_method "assert_no_#{selector_type}" do |*args, &optional_filter_block|
+          subject, args = determine_subject(args)
+          locator, options = extract_locator(args)
+          assert_no_selector(subject, selector_type.to_sym, locator, **options, &optional_filter_block)
+        end
+        ruby2_keywords "assert_no_#{selector_type}" if respond_to?(:ruby2_keywords)
+        alias_method "refute_#{selector_type}", "assert_no_#{selector_type}"
+      end
+
+      %w[checked unchecked].each do |field_type|
+        define_method "assert_#{field_type}_field" do |*args, &optional_filter_block|
+          subject, args = determine_subject(args)
+          locator, options = extract_locator(args)
+          assert_selector(subject, :field, locator, **options.merge(field_type.to_sym => true), &optional_filter_block)
+        end
+        ruby2_keywords "assert_#{field_type}_field" if respond_to?(:ruby2_keywords)
+
+        define_method "assert_no_#{field_type}_field" do |*args, &optional_filter_block|
+          subject, args = determine_subject(args)
+          locator, options = extract_locator(args)
+          assert_no_selector(
+            subject,
+            :field,
+            locator,
+            **options.merge(field_type.to_sym => true),
+            &optional_filter_block
+          )
+        end
+        ruby2_keywords "assert_no_#{field_type}_field" if respond_to?(:ruby2_keywords)
+        alias_method "refute_#{field_type}_field", "assert_no_#{field_type}_field"
+      end
+
+      ##
+      # Assert that element matches xpath
+      #
+      # @!method assert_matches_xpath
+      #   See {Capybara::Node::Matchers#matches_xpath?}
+
+      ##
+      # Assert that element does not match xpath
+      #
+      # @!method refute_matches_xpath
+      # @!method assert_not_matches_xpath
+      #   See {Capybara::Node::Matchers#not_matches_xpath?}
+
+      ##
+      # Assert that element matches css
+      #
+      # @!method assert_matches_css
+      #   See {Capybara::Node::Matchers#matches_css?}
+
+      ##
+      # Assert that element matches css
+      #
+      # @!method refute_matches_css
+      # @!method assert_not_matches_css
+      #   See {Capybara::Node::Matchers#not_matches_css?}
+
+      %w[xpath css].each do |selector_type|
+        define_method "assert_matches_#{selector_type}" do |*args, &optional_filter_block|
+          subject, args = determine_subject(args)
+          assert_matches_selector(subject, selector_type.to_sym, *args, &optional_filter_block)
+        end
+        ruby2_keywords "assert_matches_#{selector_type}" if respond_to?(:ruby2_keywords)
+
+        define_method "assert_not_matches_#{selector_type}" do |*args, &optional_filter_block|
+          subject, args = determine_subject(args)
+          assert_not_matches_selector(subject, selector_type.to_sym, *args, &optional_filter_block)
+        end
+        ruby2_keywords "assert_not_matches_#{selector_type}" if respond_to?(:ruby2_keywords)
+        alias_method "refute_matches_#{selector_type}", "assert_not_matches_#{selector_type}"
+      end
+
+    private
+
+      def determine_subject(args)
+        case args.first
+        when Capybara::Session, Capybara::Node::Base, Capybara::Node::Simple
+          [args.shift, args]
+        when ->(arg) { arg.respond_to?(:to_capybara_node) }
+          [args.shift.to_capybara_node, args]
+        else
+          [page, args]
+        end
+      end
+
+      def extract_locator(args)
+        locator, options = *args, {}
+        locator, options = nil, locator if locator.is_a? Hash
+        [locator, options]
+      end
+    end
+  end
+end