capybara 3.8.1 → 3.33.0

data/lib/capybara/rspec/matchers.rb

@@ -1,395 +1,201 @@
 # frozen_string_literal: true
 
-require 'capybara/rspec/compound'
+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
-      include ::Capybara::RSpecMatchers::Compound if defined?(::Capybara::RSpecMatchers::Compound)
-
-      attr_reader :failure_message, :failure_message_when_negated
-
-      def initialize(*args, &filter_block)
-        @args = args.dup
-        @filter_block = filter_block
-      end
-
-      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 => err
-        @failure_message = err.message
-        false
-      end
-
-      def wrap_does_not_match?(actual)
-        yield(wrap(actual))
-      rescue Capybara::ExpectationNotMet => err
-        @failure_message_when_negated = err.message
-        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 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
-    end
-
-    class HaveAllSelectors < Matcher
-      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 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 HaveNoSelectors < Matcher
-      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 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 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 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 HaveText < Matcher
-      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(text)}"
-      end
-
-      def format(content)
-        content.inspect
-      end
-
-    private
-
-      def text
-        @args[0].is_a?(Symbol) ? @args[1] : @args[0]
-      end
-    end
-
-    class HaveTitle < Matcher
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_title(*@args) }
-      end
-
-      def does_not_match?(actual)
-        wrap_does_not_match?(actual) { |el| el.assert_no_title(*@args) }
-      end
-
-      def description
-        "have title #{title.inspect}"
-      end
-
-    private
-
-      def title
-        @args.first
-      end
-    end
-
-    class HaveCurrentPath < Matcher
-      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
-
-    private
-
-      def current_path
-        @args.first
-      end
-    end
-
-    class NegatedMatcher
-      include ::Capybara::RSpecMatchers::Compound if defined?(::Capybara::RSpecMatchers::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
-
-    class HaveStyle < Matcher
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_style(*@args) }
-      end
-
-      def does_not_match?(_actual)
-        raise ArgumentError, 'The have_style matcher does not support use with not_to/should_not'
-      end
-
-      def description
-        'have style'
-      end
-    end
-
-    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.05
-        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
-
-    # 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)
+    # 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|
-        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|
-        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|
-        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|
-        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::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)
+      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)
-      HaveCurrentPath.new(path, options)
+      Matchers::HaveCurrentPath.new(path, **options)
     end
 
-    # RSpec matcher for element style
-    # See {Capybara::Node::Matchers#has_style?}
+    # 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)
-      HaveStyle.new(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].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/selector/builders/css_builder.rb

@@ -0,0 +1,84 @@
+# frozen_string_literal: true
+
+require 'xpath'
+
+module Capybara
+  class Selector
+    # @api private
+    class CSSBuilder
+      def initialize(expression)
+        @expression = expression || ''
+      end
+
+      attr_reader :expression
+
+      def add_attribute_conditions(**attributes)
+        @expression = attributes.inject(expression) do |css, (name, value)|
+          conditions = if name == :class
+            class_conditions(value)
+          elsif value.is_a? Regexp
+            regexp_conditions(name, value)
+          else
+            [attribute_conditions(name => value)]
+          end
+
+          ::Capybara::Selector::CSS.split(css).map do |sel|
+            next sel if conditions.empty?
+
+            conditions.map { |cond| sel + cond }.join(', ')
+          end.join(', ')
+        end
+      end
+
+    private
+
+      def regexp_conditions(name, value)
+        Selector::RegexpDisassembler.new(value).alternated_substrings.map do |strs|
+          strs.map do |str|
+            "[#{name}*='#{str}'#{' i' if value.casefold?}]"
+          end.join
+        end
+      end
+
+      def attribute_conditions(attributes)
+        attributes.map do |attribute, value|
+          case value
+          when XPath::Expression
+            raise ArgumentError, "XPath expressions are not supported for the :#{attribute} filter with CSS based selectors"
+          when Regexp
+            Selector::RegexpDisassembler.new(value).substrings.map do |str|
+              "[#{attribute}*='#{str}'#{' i' if value.casefold?}]"
+            end.join
+          when true
+            "[#{attribute}]"
+          when false
+            ':not([attribute])'
+          else
+            if attribute == :id
+              "##{::Capybara::Selector::CSS.escape(value)}"
+            else
+              "[#{attribute}='#{value}']"
+            end
+          end
+        end.join
+      end
+
+      def class_conditions(classes)
+        case classes
+        when XPath::Expression
+          raise ArgumentError, 'XPath expressions are not supported for the :class filter with CSS based selectors'
+        when Regexp
+          Selector::RegexpDisassembler.new(classes).alternated_substrings.map do |strs|
+            strs.map do |str|
+              "[class*='#{str}'#{' i' if classes.casefold?}]"
+            end.join
+          end
+        else
+          cls = Array(classes).group_by { |cl| cl.match?(/^!(?!!!)/) }
+          [(cls[false].to_a.map { |cl| ".#{Capybara::Selector::CSS.escape(cl.sub(/^!!/, ''))}" } +
+          cls[true].to_a.map { |cl| ":not(.#{Capybara::Selector::CSS.escape(cl.slice(1..-1))})" }).join]
+        end
+      end
+    end
+  end
+end

data/lib/capybara/selector/builders/xpath_builder.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+require 'xpath'
+
+module Capybara
+  class Selector
+    # @api private
+    class XPathBuilder
+      def initialize(expression)
+        @expression = expression || ''
+      end
+
+      attr_reader :expression
+
+      def add_attribute_conditions(**conditions)
+        @expression = conditions.inject(expression) do |xp, (name, value)|
+          conditions = name == :class ? class_conditions(value) : attribute_conditions(name => value)
+          if xp.is_a? XPath::Expression
+            xp[conditions]
+          else
+            "(#{xp})[#{conditions}]"
+          end
+        end
+      end
+
+    private
+
+      def attribute_conditions(attributes)
+        attributes.map do |attribute, value|
+          case value
+          when XPath::Expression
+            XPath.attr(attribute)[value]
+          when Regexp
+            XPath.attr(attribute)[regexp_to_xpath_conditions(value)]
+          when true
+            XPath.attr(attribute)
+          when false, nil
+            !XPath.attr(attribute)
+          else
+            XPath.attr(attribute) == value.to_s
+          end
+        end.reduce(:&)
+      end
+
+      def class_conditions(classes)
+        case classes
+        when XPath::Expression, Regexp
+          attribute_conditions(class: classes)
+        else
+          Array(classes).map do |klass|
+            if klass.match?(/^!(?!!!)/)
+              !XPath.attr(:class).contains_word(klass.slice(1..-1))
+            else
+              XPath.attr(:class).contains_word(klass.sub(/^!!/, ''))
+            end
+          end.reduce(:&)
+        end
+      end
+
+      def regexp_to_xpath_conditions(regexp)
+        condition = XPath.current
+        condition = condition.uppercase if regexp.casefold?
+        Selector::RegexpDisassembler.new(regexp).alternated_substrings.map do |strs|
+          strs.map { |str| condition.contains(str) }.reduce(:&)
+        end.reduce(:|)
+      end
+    end
+  end
+end