capybara 2.18.0 → 3.40.0

data/lib/capybara/rspec/matchers.rb

@@ -1,371 +1,207 @@
 # frozen_string_literal: true
-module Capybara
-  module RSpecMatchers
-    class Matcher
-      if defined?(::RSpec::Expectations::Version) && (Gem::Version.new(RSpec::Expectations::Version::STRING) >= Gem::Version.new('3.0'))
-        require 'capybara/rspec/compound'
-        include ::Capybara::RSpecMatchers::Compound
-      end
-
-      attr_reader :failure_message, :failure_message_when_negated
-
-      def wrap(actual)
-        @context_el = if actual.respond_to?("has_selector?")
-          actual
-        else
-          Capybara.string(actual.to_s)
-        end
-      end
 
-      # RSpec 2 compatibility:
-      def failure_message_for_should; failure_message end
-      def failure_message_for_should_not; failure_message_when_negated end
+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'
 
-      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
+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(...)
+      Matchers::HaveSelector.new(...)
     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(...)
+      Matchers::HaveAllSelectors.new(...)
     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(...)
+      Matchers::HaveNoSelectors.new(...)
     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(...)
+      Matchers::HaveAnySelectors.new(...)
     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(...)
+      Matchers::MatchSelector.new(...)
     end
 
-    class HaveText < Matcher
-      attr_reader :type, :content, :options
-
-      def initialize(*args)
-        @args = args.dup
-
-        # are set just for backwards compatability
-        @type = args.shift if args.first.is_a?(Symbol)
-        @content = args.shift
-        @options = (args.first.is_a?(Hash))? args.first : {}
-      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)}"
+    %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 format(content)
-        content = Capybara::Helpers.normalize_whitespace(content) unless content.is_a? Regexp
-        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
-      attr_reader :title
+    # @!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?
 
-      def initialize(*args)
-        @args = args
+    # @!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?
 
-        # are set just for backwards compatability
-        @title = args.first
-      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 matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_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 does_not_match?(actual)
-        wrap_does_not_match?(actual) { |el| el.assert_no_title(*@args) }
-      end
-
-      def description
-        "have title #{title.inspect}"
+    %i[link button field select table element].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
-      attr_reader :current_path
+    # @!method have_element(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for elements.
+    #
+    #   @see Capybara::Node::Matchers#has_element?
 
-      def initialize(*args)
-        @args = args
+    # @!method have_link(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for links.
+    #
+    #   @see Capybara::Node::Matchers#has_link?
 
-        # are set just for backwards compatability
-        @current_path = args.first
-      end
+    # @!method have_button(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for buttons.
+    #
+    #   @see Capybara::Node::Matchers#has_button?
 
-      def matches?(actual)
-        wrap_matches?(actual) { |el| el.assert_current_path(*@args) }
-      end
+    # @!method have_field(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for form fields.
+    #
+    #   @see Capybara::Node::Matchers#has_field?
 
-      def does_not_match?(actual)
-        wrap_does_not_match?(actual) { |el| el.assert_no_current_path(*@args) }
-      end
+    # @!method have_select(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for select elements.
+    #
+    #   @see Capybara::Node::Matchers#has_select?
 
-      def description
-        "have current path #{current_path.inspect}"
-      end
-    end
+    # @!method have_table(locator = nil, **options, &optional_filter_block)
+    #   RSpec matcher for table elements.
+    #
+    #   @see Capybara::Node::Matchers#has_table?
 
-    class BecomeClosed
-      def initialize(options)
-        @options = options
+    %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 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
-      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
-
-      # RSpec 2 compatibility:
-      alias_method :failure_message_for_should, :failure_message
-      alias_method :failure_message_for_should_not, :failure_message_when_negated
-    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
-    # defined_negated_matcher was added in RSpec 3.1 - it's syntactic sugar only since a user can do
-    # expect(page).not_to match_selector, so not sure we really need to support not_match_selector for prior to RSpec 3.1
-    ::RSpec::Matchers.define_negated_matcher :not_match_selector, :match_selector if defined?(::RSpec::Expectations::Version) && (Gem::Version.new(RSpec::Expectations::Version::STRING) >= Gem::Version.new('3.1'))
-
-
-    # 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
 
-    # 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
+    # @!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 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
+    # @!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 on the page
-    # 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)
+    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 = {})
-      HaveCurrentPath.new(path, options)
+    # 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 links
-    # See {Capybara::Node::Matchers#has_link?}
-    def have_link(locator=nil, options={}, &optional_filter_block)
-      locator, options = nil, locator if locator.is_a? Hash
-      HaveSelector.new(:link, 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 buttons
-    # See {Capybara::Node::Matchers#has_button?}
-    def have_button(locator=nil, options={}, &optional_filter_block)
-      locator, options = nil, locator if locator.is_a? Hash
-      HaveSelector.new(:button, locator, options, &optional_filter_block)
-    end
-
-    # RSpec matcher for links
-    # See {Capybara::Node::Matchers#has_field?}
-    def have_field(locator=nil, options={}, &optional_filter_block)
-      locator, options = nil, locator if locator.is_a? Hash
-      HaveSelector.new(:field, 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
 
-    # RSpec matcher for checked fields
-    # See {Capybara::Node::Matchers#has_checked_field?}
-    def have_checked_field(locator=nil, options={}, &optional_filter_block)
-      locator, options = nil, locator if locator.is_a? Hash
-      HaveSelector.new(:field, locator, options.merge(checked: true), &optional_filter_block)
+    %w[selector css xpath text title current_path link button
+       field checked_field unchecked_field select table
+       sibling ancestor element].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
 
-    # RSpec matcher for unchecked fields
-    # See {Capybara::Node::Matchers#has_unchecked_field?}
-    def have_unchecked_field(locator=nil, options={}, &optional_filter_block)
-      locator, options = nil, locator if locator.is_a? Hash
-      HaveSelector.new(:field, locator, options.merge(unchecked: true), &optional_filter_block)
+    %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 select elements
-    # See {Capybara::Node::Matchers#has_select?}
-    def have_select(locator=nil, options={}, &optional_filter_block)
-      locator, options = nil, locator if locator.is_a? Hash
-      HaveSelector.new(:select, locator, options, &optional_filter_block)
+    # RSpec matcher for whether sibling element(s) matching a given selector exist.
+    #
+    # @see Capybara::Node::Matchers#assert_sibling
+    def have_sibling(...)
+      Matchers::HaveSibling.new(...)
     end
 
-    # RSpec matcher for table elements
-    # See {Capybara::Node::Matchers#has_table?}
-    def have_table(locator=nil, options={}, &optional_filter_block)
-      locator, options = nil, locator if locator.is_a? Hash
-      HaveSelector.new(:table, locator, options, &optional_filter_block)
+    # RSpec matcher for whether ancestor element(s) matching a given selector exist.
+    #
+    # @see Capybara::Node::Matchers#assert_ancestor
+    def have_ancestor(...)
+      Matchers::HaveAncestor.new(...)
     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
-    def become_closed(options = {})
-      BecomeClosed.new(options)
+    #
+    # @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
+end

data/lib/capybara/rspec.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'rspec/core'
 require 'capybara/dsl'
 require 'capybara/rspec/matchers'
@@ -6,14 +7,11 @@ require 'capybara/rspec/features'
 require 'capybara/rspec/matcher_proxies'
 
 RSpec.configure do |config|
-  config.include Capybara::DSL, :type => :feature
-  config.include Capybara::RSpecMatchers, :type => :feature
-  config.include Capybara::RSpecMatchers, :type => :view
-
-  # A work-around to support accessing the current example that works in both
-  # RSpec 2 and RSpec 3.
-  fetch_current_example = RSpec.respond_to?(:current_example) ?
-    proc { RSpec.current_example } : proc { |context| context.example }
+  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
   # might not actually be used in all examples where it's included.
@@ -24,12 +22,10 @@ RSpec.configure do |config|
     end
   end
 
-  config.before do
+  config.before do |example|
     if self.class.include?(Capybara::DSL)
-      example = fetch_current_example.call(self)
       Capybara.current_driver = Capybara.javascript_driver if example.metadata[:js]
       Capybara.current_driver = example.metadata[:driver] if example.metadata[:driver]
     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).reject { |c| c.is_a? Regexp }.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..))})" }).join]
+        end
+      end
+    end
+  end
+end