capybara 3.12.0 → 3.13.0

data/lib/capybara/queries/selector_query.rb

@@ -4,7 +4,7 @@ module Capybara
   module Queries
     class SelectorQuery < Queries::BaseQuery
       attr_reader :expression, :selector, :locator, :options
-      VALID_KEYS = COUNT_KEYS + %i[text id class visible exact exact_text normalize_ws match wait filter_set]
+      VALID_KEYS = COUNT_KEYS + %i[text id class style visible exact exact_text normalize_ws match wait filter_set]
       VALID_MATCH = %i[first smart prefer_exact one].freeze
 
       def initialize(*args,
@@ -14,6 +14,7 @@ module Capybara
                      **options,
                      &filter_block)
         @resolved_node = nil
+        @resolved_count = 0
         @options = options.dup
         super(@options)
         self.session_options = session_options
@@ -50,9 +51,24 @@ module Capybara
         end
         desc << " with id #{options[:id]}" if options[:id]
         desc << " with classes [#{Array(options[:class]).join(',')}]" if options[:class]
+        desc << case options[:style]
+        when String
+          " with style attribute #{options[:style].inspect}"
+        when Regexp
+          " with style attribute matching #{options[:style].inspect}"
+        when Hash
+          " with styles #{options[:style].inspect}"
+        else ''
+        end
         desc << selector.description(node_filters: show_for[:node], **options)
         desc << ' that also matches the custom filter block' if @filter_block && show_for[:node]
         desc << " within #{@resolved_node.inspect}" if describe_within?
+        if locator.is_a?(String) && locator.start_with?('#', './/', '//')
+          unless selector.raw_locator?
+            desc << "\nNote: It appears you may be passing a CSS selector or XPath expression rather than a locator. " \
+                    "Please see the documentation for acceptable locator values.\n\n"
+          end
+        end
         desc
       end
 
@@ -91,7 +107,9 @@ module Capybara
         exact = exact? if exact.nil?
         expr = apply_expression_filters(@expression)
         expr = exact ? expr.to_xpath(:exact) : expr.to_s if expr.respond_to?(:to_xpath)
-        filtered_expression(expr)
+        expr = filtered_expression(expr)
+        expr = "(#{expr})[#{xpath_text_conditions}]" if try_text_match_in_expression?
+        expr
       end
 
       def css
@@ -102,6 +120,7 @@ module Capybara
       def resolve_for(node, exact = nil)
         applied_filters.clear
         @resolved_node = node
+        @resolved_count += 1
         node.synchronize do
           children = find_nodes_by_selector_format(node, exact).map(&method(:to_element))
           Capybara::Result.new(children, self)
@@ -123,6 +142,26 @@ module Capybara
 
     private
 
+      def text_fragments
+        text = (options[:text] || options[:exact_text])
+        text.is_a?(String) ? text.split : []
+      end
+
+      def xpath_text_conditions
+        (options[:text] || options[:exact_text]).split.map { |txt| XPath.contains(txt) }.reduce(&:&)
+      end
+
+      def try_text_match_in_expression?
+        first_try? &&
+          (options[:text] || options[:exact_text]).is_a?(String) &&
+          @resolved_node&.respond_to?(:session) &&
+          @resolved_node.session.driver.wait?
+      end
+
+      def first_try?
+        @resolved_count == 1
+      end
+
       def show_for_stage(only_applied)
         lambda do |stage = :any|
           !only_applied || (stage == :any ? applied_filters.any? : applied_filters.include?(stage))
@@ -141,10 +180,25 @@ module Capybara
       end
 
       def find_nodes_by_selector_format(node, exact)
+        hints = {}
+        hints[:uses_visibility] = true unless visible == :all
+        hints[:texts] = text_fragments unless selector.format == :xpath
+        hints[:styles] = options[:style] if use_default_style_filter?
+
         if selector.format == :css
-          node.find_css(css)
+          if node.method(:find_css).arity != 1
+            node.find_css(css, **hints)
+          else
+            node.find_css(css)
+          end
+        elsif selector.format == :xpath
+          if node.method(:find_xpath).arity != 1
+            node.find_xpath(xpath(exact), **hints)
+          else
+            node.find_xpath(xpath(exact))
+          end
         else
-          node.find_xpath(xpath(exact))
+          raise ArgumentError, "Unknown format: #{selector.format}"
         end
       end
 
@@ -237,6 +291,7 @@ module Capybara
         conditions = {}
         conditions[:id] = options[:id] if use_default_id_filter?
         conditions[:class] = options[:class] if use_default_class_filter?
+        conditions[:style] = options[:style] if use_default_style_filter? && !options[:style].is_a?(Hash)
         builder(expr).add_attribute_conditions(conditions)
       end
 
@@ -248,6 +303,10 @@ module Capybara
         options.key?(:class) && !custom_keys.include?(:class)
       end
 
+      def use_default_style_filter?
+        options.key?(:style) && !custom_keys.include?(:style)
+      end
+
       def apply_expression_filters(expression)
         unapplied_options = options.keys - valid_keys
         expression_filters.inject(expression) do |expr, (name, ef)|
@@ -298,11 +357,12 @@ module Capybara
       def matches_system_filters?(node)
         applied_filters << :system
 
-        matches_id_filter?(node) &&
+        matches_visible_filter?(node) &&
+          matches_id_filter?(node) &&
           matches_class_filter?(node) &&
+          matches_style_filter?(node) &&
           matches_text_filter?(node) &&
-          matches_exact_text_filter?(node) &&
-          matches_visible_filter?(node)
+          matches_exact_text_filter?(node)
       end
 
       def matches_id_filter?(node)
@@ -317,6 +377,28 @@ module Capybara
         node[:class] =~ options[:class]
       end
 
+      def matches_style_filter?(node)
+        case options[:style]
+        when String, nil
+          true
+        when Regexp
+          node[:style] =~ options[:style]
+        when Hash
+          matches_style?(node, options[:style])
+        end
+      end
+
+      def matches_style?(node, styles)
+        @actual_styles = node.initial_cache[:style] || node.style(*styles.keys)
+        styles.all? do |style, value|
+          if value.is_a? Regexp
+            @actual_styles[style.to_s] =~ value
+          else
+            @actual_styles[style.to_s] == value
+          end
+        end
+      end
+
       def matches_text_filter?(node)
         value = options[:text]
         return true unless value
@@ -334,8 +416,10 @@ module Capybara
 
       def matches_visible_filter?(node)
         case visible
-        when :visible then node.visible?
-        when :hidden then !node.visible?
+        when :visible then
+          node.initial_cache[:visible] || (node.initial_cache[:visible].nil? && node.visible?)
+        when :hidden then
+          (node.initial_cache[:visible] == false) || (node.initial_cache[:visbile].nil? && !node.visible?)
         else true
         end
       end

data/lib/capybara/rspec/matchers.rb

@@ -3,7 +3,7 @@
 require 'capybara/rspec/matchers/have_selector'
 require 'capybara/rspec/matchers/match_selector'
 require 'capybara/rspec/matchers/have_current_path'
-require 'capybara/rspec/matchers/have_style'
+require 'capybara/rspec/matchers/match_style'
 require 'capybara/rspec/matchers/have_text'
 require 'capybara/rspec/matchers/have_title'
 require 'capybara/rspec/matchers/become_closed'
@@ -124,9 +124,17 @@ module Capybara
     end
 
     # RSpec matcher for element style
-    # See {Capybara::Node::Matchers#has_style?}
+    # See {Capybara::Node::Matchers#matches_style?}
+    def match_style(styles, **options)
+      Matchers::MatchStyle.new(styles, options)
+    end
+
+    ##
+    # @deprecated
+    #
     def have_style(styles, **options)
-      Matchers::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

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

@@ -15,7 +15,7 @@ module Capybara
           while window.exists?
             return false if timer.expired?
 
-            sleep 0.05
+            sleep 0.01
           end
           true
         end

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

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'capybara/rspec/matchers/base'
+
+module Capybara
+  module RSpecMatchers
+    module Matchers
+      class MatchStyle < WrappedElementMatcher
+        def element_matches?(el)
+          el.assert_matches_style(*@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, &filter_block)
+          warn 'HaveStyle matcher is deprecated, please use the MatchStyle matcher instead'
+          super
+        end
+      end
+    end
+  end
+end

data/lib/capybara/selector.rb

@@ -25,24 +25,24 @@ end
 
 # rubocop:disable Metrics/BlockLength
 
-Capybara.add_selector(:xpath) do
+Capybara.add_selector(:xpath, locator_type: [:to_xpath, String], raw_locator: true) do
   xpath { |xpath| xpath }
 end
 
-Capybara.add_selector(:css) do
+Capybara.add_selector(:css, locator_type: [String, Symbol], raw_locator: true) do
   css { |css| css }
 end
 
-Capybara.add_selector(:id) do
+Capybara.add_selector(:id, locator_type: [String, Symbol, Regexp]) do
   xpath { |id| builder(XPath.descendant).add_attribute_conditions(id: id) }
   locator_filter {  |node, id| id.is_a?(Regexp) ? node[:id] =~ id : true }
 end
 
-Capybara.add_selector(:field) do
-  visible { |options| :hidden if options[:type] == 'hidden' }
+Capybara.add_selector(:field, locator_type: [String, Symbol]) do
+  visible { |options| :hidden if options[:type].to_s == 'hidden' }
   xpath do |locator, **options|
     invalid_types = %w[submit image]
-    invalid_types << 'hidden' unless options[:type] == 'hidden'
+    invalid_types << 'hidden' unless options[:type].to_s == 'hidden'
     xpath = XPath.descendant(:input, :textarea, :select)[!XPath.attr(:type).one_of(*invalid_types)]
     locate_field(xpath, locator, options)
   end
@@ -78,7 +78,7 @@ Capybara.add_selector(:field) do
   end
 end
 
-Capybara.add_selector(:fieldset) do
+Capybara.add_selector(:fieldset, locator_type: [String, Symbol]) do
   xpath do |locator, legend: nil, **|
     locator_matchers = (XPath.attr(:id) == locator.to_s) | XPath.child(:legend)[XPath.string.n.is(locator.to_s)]
     locator_matchers |= XPath.attr(test_id) == locator.to_s if test_id
@@ -90,7 +90,7 @@ Capybara.add_selector(:fieldset) do
   node_filter(:disabled, :boolean) { |node, value| !(value ^ node.disabled?) }
 end
 
-Capybara.add_selector(:link) do
+Capybara.add_selector(:link, locator_type: [String, Symbol]) do
   xpath do |locator, href: true, alt: nil, title: nil, **|
     xpath = builder(XPath.descendant(:a)).add_attribute_conditions(href: href)
 
@@ -132,7 +132,7 @@ Capybara.add_selector(:link) do
   end
 end
 
-Capybara.add_selector(:button) do
+Capybara.add_selector(:button, locator_type: [String, Symbol]) do
   xpath(:value, :title, :type) do |locator, **options|
     input_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')]
     btn_xpath = XPath.descendant(:button)
@@ -166,7 +166,7 @@ Capybara.add_selector(:button) do
   end
 end
 
-Capybara.add_selector(:link_or_button) do
+Capybara.add_selector(:link_or_button, locator_type: [String, Symbol]) do
   label 'link or button'
   xpath do |locator, **options|
     self.class.all.values_at(:link, :button).map do |selector|
@@ -181,9 +181,8 @@ Capybara.add_selector(:link_or_button) do
   end
 end
 
-Capybara.add_selector(:fillable_field) do
+Capybara.add_selector(:fillable_field, locator_type: [String, Symbol]) do
   label 'field'
-
   xpath do |locator, allow_self: nil, **options|
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input, :textarea)[
       !XPath.attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')
@@ -215,9 +214,8 @@ Capybara.add_selector(:fillable_field) do
   end
 end
 
-Capybara.add_selector(:radio_button) do
+Capybara.add_selector(:radio_button, locator_type: [String, Symbol]) do
   label 'radio button'
-
   xpath do |locator, allow_self: nil, **options|
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input)[
       XPath.attr(:type) == 'radio'
@@ -240,7 +238,7 @@ Capybara.add_selector(:radio_button) do
   end
 end
 
-Capybara.add_selector(:checkbox) do
+Capybara.add_selector(:checkbox, locator_type: [String, Symbol]) do
   xpath do |locator, allow_self: nil, **options|
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input)[
       XPath.attr(:type) == 'checkbox'
@@ -263,7 +261,7 @@ Capybara.add_selector(:checkbox) do
   end
 end
 
-Capybara.add_selector(:select) do
+Capybara.add_selector(:select, locator_type: [String, Symbol]) do
   label 'select box'
 
   xpath do |locator, **options|
@@ -320,7 +318,7 @@ Capybara.add_selector(:select) do
   end
 end
 
-Capybara.add_selector(:datalist_input) do
+Capybara.add_selector(:datalist_input, locator_type: [String, Symbol]) do
   label 'input box with datalist completion'
 
   xpath do |locator, **options|
@@ -355,7 +353,7 @@ Capybara.add_selector(:datalist_input) do
   end
 end
 
-Capybara.add_selector(:option) do
+Capybara.add_selector(:option, locator_type: [String, Symbol]) do
   xpath do |locator|
     xpath = XPath.descendant(:option)
     xpath = xpath[XPath.string.n.is(locator.to_s)] unless locator.nil?
@@ -373,7 +371,7 @@ Capybara.add_selector(:option) do
   end
 end
 
-Capybara.add_selector(:datalist_option) do
+Capybara.add_selector(:datalist_option, locator_type: [String, Symbol]) do
   label 'datalist option'
   visible(:all)
 
@@ -390,7 +388,7 @@ Capybara.add_selector(:datalist_option) do
   end
 end
 
-Capybara.add_selector(:file_field) do
+Capybara.add_selector(:file_field, locator_type: [String, Symbol]) do
   label 'file field'
   xpath do |locator, allow_self: nil, **options|
     xpath = XPath.axis(allow_self ? :"descendant-or-self" : :descendant, :input)[
@@ -404,7 +402,7 @@ Capybara.add_selector(:file_field) do
   describe_expression_filters
 end
 
-Capybara.add_selector(:label) do
+Capybara.add_selector(:label, locator_type: [String, Symbol]) do
   label 'label'
   xpath(:for) do |locator, options|
     xpath = XPath.descendant(:label)
@@ -413,12 +411,14 @@ Capybara.add_selector(:label) do
       locator_matchers |= XPath.attr(test_id) == locator if test_id
       xpath = xpath[locator_matchers]
     end
-    if options.key?(:for) && !options[:for].is_a?(Capybara::Node::Element)
-      with_attr = XPath.attr(:for) == options[:for].to_s
-      labelable_elements = %i[button input keygen meter output progress select textarea]
-      wrapped = !XPath.attr(:for) &
-                XPath.descendant(*labelable_elements)[XPath.attr(:id) == options[:for].to_s]
-      xpath = xpath[with_attr | wrapped]
+    if options.key?(:for)
+      if (for_option = options[:for].is_a?(Capybara::Node::Element) ? options[:for][:id] : options[:for])
+        with_attr = XPath.attr(:for) == for_option.to_s
+        labelable_elements = %i[button input keygen meter output progress select textarea]
+        wrapped = !XPath.attr(:for) &
+                  XPath.descendant(*labelable_elements)[XPath.attr(:id) == for_option.to_s]
+        xpath = xpath[with_attr | wrapped]
+      end
     end
     xpath
   end
@@ -442,7 +442,7 @@ Capybara.add_selector(:label) do
   end
 end
 
-Capybara.add_selector(:table) do
+Capybara.add_selector(:table, locator_type: [String, Symbol]) do
   xpath do |locator, caption: nil, **|
     xpath = XPath.descendant(:table)
     unless locator.nil?
@@ -459,7 +459,7 @@ Capybara.add_selector(:table) do
   end
 end
 
-Capybara.add_selector(:frame) do
+Capybara.add_selector(:frame, locator_type: [String, Symbol]) do
   xpath do |locator, name: nil, **|
     xpath = XPath.descendant(:iframe).union(XPath.descendant(:frame))
     unless locator.nil?
@@ -475,7 +475,7 @@ Capybara.add_selector(:frame) do
   end
 end
 
-Capybara.add_selector(:element) do
+Capybara.add_selector(:element, locator_type: [String, Symbol]) do
   xpath do |locator, **|
     XPath.descendant.where(locator ? XPath.local_name == locator.to_s : nil)
   end