capybara 3.3.1 → 3.4.0

data/lib/capybara/queries/current_path_query.rb

@@ -10,7 +10,7 @@ module Capybara
         super(options)
         @expected_path = expected_path
         @options = {
-          url: !@expected_path.is_a?(Regexp) && !::Addressable::URI.parse(@expected_path || "").hostname.nil?,
+          url: !@expected_path.is_a?(Regexp) && !::Addressable::URI.parse(@expected_path || '').hostname.nil?,
           ignore_query: false
         }.merge(options)
         assert_valid_keys

data/lib/capybara/queries/selector_query.rb

@@ -8,7 +8,12 @@ module Capybara
       VALID_KEYS = COUNT_KEYS + %i[text id class visible exact exact_text match wait filter_set]
       VALID_MATCH = %i[first smart prefer_exact one].freeze
 
-      def initialize(*args, session_options:, **options, &filter_block)
+      def initialize(*args,
+                     session_options:,
+                     enable_aria_label: session_options.enable_aria_label,
+                     test_id: session_options.test_id,
+                     **options,
+                     &filter_block)
         @resolved_node = nil
         @options = options.dup
         super(@options)
@@ -20,7 +25,7 @@ module Capybara
 
         raise ArgumentError, "Unused parameters passed to #{self.class.name} : #{args}" unless args.empty?
 
-        @expression = @selector.call(@locator, @options.merge(enable_aria_label: session_options.enable_aria_label))
+        @expression = @selector.call(@locator, @options.merge(selector_config: { enable_aria_label: enable_aria_label, test_id: test_id }))
 
         warn_exact_usage
 
@@ -30,22 +35,31 @@ module Capybara
       def name; selector.name; end
       def label; selector.label || selector.name; end
 
-      def description
-        @description = +""
-        @description << "visible " if visible == :visible
-        @description << "non-visible " if visible == :hidden
+      def description(applied = false)
+        @description = +''
+        if !applied || @applied_filters
+          @description << 'visible ' if visible == :visible
+          @description << 'non-visible ' if visible == :hidden
+        end
         @description << "#{label} #{locator.inspect}"
-        @description << " with#{' exact' if exact_text == true} text #{options[:text].inspect}" if options[:text]
-        @description << " with exact text #{exact_text}" if exact_text.is_a?(String)
+        if !applied || @applied_filters
+          @description << " with#{' exact' if exact_text == true} text #{options[:text].inspect}" if options[:text]
+          @description << " with exact text #{exact_text}" if exact_text.is_a?(String)
+        end
         @description << " with id #{options[:id]}" if options[:id]
         @description << " with classes [#{Array(options[:class]).join(',')}]" if options[:class]
-        @description << selector.description(options)
-        @description << " that also matches the custom filter block" if @filter_block
+        @description << selector.description(node_filters: !applied || (@applied_filters == :node), **options)
+        @description << ' that also matches the custom filter block' if @filter_block && (!applied || (@applied_filters == :node))
         @description << " within #{@resolved_node.inspect}" if describe_within?
         @description
       end
 
+      def applied_description
+        description(true)
+      end
+
       def matches_filters?(node)
+        @applied_filters ||= :system
         return false if options[:text] && !matches_text_filter(node, options[:text])
         return false if exact_text.is_a?(String) && !matches_exact_text_filter(node, exact_text)
 
@@ -54,6 +68,7 @@ module Capybara
         when :hidden then return false if node.visible?
         end
 
+        @applied_filters = :node
         matches_node_filters?(node) && matches_filter_block?(node)
       rescue *(node.respond_to?(:session) ? node.session.driver.invalid_element_errors : [])
         false
@@ -88,6 +103,7 @@ module Capybara
 
       # @api private
       def resolve_for(node, exact = nil)
+        @applied_filters = false
         @resolved_node = node
         node.synchronize do
           children = if selector.format == :css
@@ -110,6 +126,14 @@ module Capybara
         @expression.respond_to? :to_xpath
       end
 
+      def failure_message
+        +"expected to find #{applied_description}" << count_message
+      end
+
+      def negative_failure_message
+        +"expected not to find #{applied_description}" << count_message
+      end
+
     private
 
       def find_selector(locator)
@@ -184,8 +208,8 @@ module Capybara
         end
 
         return if unhandled_options.empty?
-        invalid_names = unhandled_options.map(&:inspect).join(", ")
-        valid_names = valid_keys.map(&:inspect).join(", ")
+        invalid_names = unhandled_options.map(&:inspect).join(', ')
+        valid_names = valid_keys.map(&:inspect).join(', ')
         raise ArgumentError, "invalid keys #{invalid_names}, should be one of #{valid_names}"
       end
 
@@ -219,10 +243,10 @@ module Capybara
         process_class = options.key?(:class) && !custom_keys.include?(:class)
 
         if process_id && options[:id].is_a?(XPath::Expression)
-          raise ArgumentError, "XPath expressions are not supported for the :id filter with CSS based selectors"
+          raise ArgumentError, 'XPath expressions are not supported for the :id filter with CSS based selectors'
         end
         if process_class && options[:class].is_a?(XPath::Expression)
-          raise ArgumentError, "XPath expressions are not supported for the :class filter with CSS based selectors"
+          raise ArgumentError, 'XPath expressions are not supported for the :class filter with CSS based selectors'
         end
 
         if process_id || process_class
@@ -230,7 +254,7 @@ module Capybara
             sel += "##{::Capybara::Selector::CSS.escape(options[:id])}" if process_id
             sel += css_from_classes(Array(options[:class])) if process_class
             sel
-          end.join(", ")
+          end.join(', ')
         end
 
         expr

data/lib/capybara/queries/sibling_query.rb

@@ -14,7 +14,7 @@ module Capybara
         end
       end
 
-      def description
+      def description(applied = false)
         desc = super
         sibling_query = @sibling_node&.instance_variable_get(:@query)
         desc += " that is a sibling of #{sibling_query.description}" if sibling_query

data/lib/capybara/queries/text_query.rb

@@ -50,7 +50,7 @@ module Capybara
       end
 
       def build_message(report_on_invisible)
-        message = +""
+        message = +''
         unless (COUNT_KEYS & @options.keys).empty?
           message << " but found #{@count} #{Capybara::Helpers.declension('time', 'times', @count)}"
         end

data/lib/capybara/rack_test/browser.rb

@@ -46,9 +46,9 @@ class Capybara::RackTest::Browser
     driver.redirect_limit.times do
       if last_response.redirect?
         if [307, 308].include? last_response.status
-          process(last_request.request_method, last_response["Location"], last_request.params, env)
+          process(last_request.request_method, last_response['Location'], last_request.params, env)
         else
-          process(:get, last_response["Location"], {}, env)
+          process(:get, last_response['Location'], {}, env)
         end
       end
     end
@@ -61,8 +61,8 @@ class Capybara::RackTest::Browser
     if path.empty?
       new_uri.path = request_path
     else
-      new_uri.path = request_path if path.start_with?("?")
-      new_uri.path = "/" if new_uri.path.empty?
+      new_uri.path = request_path if path.start_with?('?')
+      new_uri.path = '/' if new_uri.path.empty?
       new_uri.path = request_path.sub(%r{/[^/]*$}, '/') + new_uri.path unless new_uri.path.start_with?('/')
     end
     new_uri.scheme ||= @current_scheme
@@ -78,7 +78,7 @@ class Capybara::RackTest::Browser
   def current_url
     last_request.url
   rescue Rack::Test::Error
-    ""
+    ''
   end
 
   def reset_host!
@@ -105,7 +105,7 @@ class Capybara::RackTest::Browser
   def html
     last_response.body
   rescue Rack::Test::Error
-    ""
+    ''
   end
 
   def title
@@ -122,7 +122,7 @@ protected
   def request_path
     last_request.path
   rescue Rack::Test::Error
-    "/"
+    '/'
   end
 
 private

data/lib/capybara/rack_test/driver.rb

@@ -15,7 +15,7 @@ class Capybara::RackTest::Driver < Capybara::Driver::Base
   attr_reader :app, :options
 
   def initialize(app, **options)
-    raise ArgumentError, "rack-test requires a rack application, but none was given" unless app
+    raise ArgumentError, 'rack-test requires a rack application, but none was given' unless app
     @session = nil
     @app = app
     @options = DEFAULT_OPTIONS.merge(options)

data/lib/capybara/rack_test/form.rb

@@ -7,15 +7,15 @@ class Capybara::RackTest::Form < Capybara::RackTest::Node
   # which should probably be provided to Rack::Test in its non-GET request methods.
   class NilUploadedFile < Rack::Test::UploadedFile
     def initialize
-      @empty_file = Tempfile.new("nil_uploaded_file")
+      @empty_file = Tempfile.new('nil_uploaded_file')
       @empty_file.close
     end
 
-    def original_filename; ""; end
-    def content_type; "application/octet-stream"; end
+    def original_filename; ''; end
+    def content_type; 'application/octet-stream'; end
     def path; @empty_file.path; end
     def size; 0; end
-    def read; ""; end
+    def read; ''; end
   end
 
   def params(button)
@@ -35,7 +35,7 @@ class Capybara::RackTest::Form < Capybara::RackTest::Node
       when 'textarea' then add_textarea_param(field, params)
       end
     end
-    merge_param!(params, button[:name], button[:value] || "") if button[:name]
+    merge_param!(params, button[:name], button[:value] || '') if button[:name]
 
     params.to_params_hash
   end
@@ -47,7 +47,7 @@ class Capybara::RackTest::Form < Capybara::RackTest::Node
   end
 
   def multipart?
-    self[:enctype] == "multipart/form-data"
+    self[:enctype] == 'multipart/form-data'
   end
 
 private
@@ -107,7 +107,7 @@ private
 
   def add_select_param(field, params)
     if field.has_attribute?('multiple')
-      field.xpath(".//option[@selected]").each do |option|
+      field.xpath('.//option[@selected]').each do |option|
         merge_param!(params, field['name'], (option['value'] || option.text).to_s)
       end
     else

data/lib/capybara/rack_test/node.rb

@@ -7,16 +7,16 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     native.text
           .gsub(/[\u200b\u200e\u200f]/, '')
           .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
-          .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
-          .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+          .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
+          .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
           .tr("\u00a0", ' ')
   end
 
   def visible_text
     displayed_text.gsub(/\ +/, ' ')
                   .gsub(/[\ \n]*\n[\ \n]*/, "\n")
-                  .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
-                  .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+                  .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
+                  .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
                   .tr("\u00a0", ' ')
   end
 
@@ -25,7 +25,7 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
   end
 
   def style(_styles)
-    raise NotImplementedError, "The rack_test driver does not process CSS"
+    raise NotImplementedError, 'The rack_test driver does not process CSS'
   end
 
   def value
@@ -51,16 +51,16 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
   def select_option
     return if disabled?
     deselect_options unless select_node.multiple?
-    native["selected"] = 'selected'
+    native['selected'] = 'selected'
   end
 
   def unselect_option
-    raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box." unless select_node.multiple?
+    raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?
     native.remove_attribute('selected')
   end
 
   def click(keys = [], **offset)
-    raise ArgumentError, "The RackTest driver does not support click options" unless keys.empty? && offset.empty?
+    raise ArgumentError, 'The RackTest driver does not support click options' unless keys.empty? && offset.empty?
 
     if link?
       follow_link
@@ -94,9 +94,9 @@ class Capybara::RackTest::Node < Capybara::Driver::Node
     return true if string_node.disabled?
 
     if %w[option optgroup].include? tag_name
-      find_xpath("parent::*[self::optgroup or self::select or self::datalist]")[0].disabled?
+      find_xpath('parent::*[self::optgroup or self::select or self::datalist]')[0].disabled?
     else
-      !find_xpath("parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]").empty?
+      !find_xpath('parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]').empty?
     end
   end
 
@@ -140,7 +140,7 @@ protected
 private
 
   def deselect_options
-    select_node.find_xpath(".//option[@selected]").each { |node| node.native.remove_attribute("selected") }
+    select_node.find_xpath('.//option[@selected]').each { |node| node.native.remove_attribute('selected') }
   end
 
   def string_node
@@ -166,7 +166,7 @@ private
 
   def set_radio(_value) # rubocop:disable Naming/AccessorMethodName
     other_radios_xpath = XPath.generate { |x| x.anywhere(:input)[x.attr(:name) == self[:name]] }.to_s
-    driver.dom.xpath(other_radios_xpath).each { |node| node.remove_attribute("checked") }
+    driver.dom.xpath(other_radios_xpath).each { |node| node.remove_attribute('checked') }
     native['checked'] = 'checked'
   end
 
@@ -202,7 +202,7 @@ private
   end
 
   def follow_link
-    method = self["data-method"] if driver.options[:respect_data_method]
+    method = self['data-method'] if driver.options[:respect_data_method]
     method ||= :get
     driver.follow(method, self[:href].to_s)
   end
@@ -211,7 +211,7 @@ private
     labelled_control = if native[:for]
       find_xpath("//input[@id='#{native[:for]}']")
     else
-      find_xpath(".//input")
+      find_xpath('.//input')
     end.first
 
     labelled_control.set(!labelled_control.checked?) if checkbox_or_radio?(labelled_control)
@@ -222,7 +222,7 @@ private
   end
 
   def submits?
-    (tag_name == 'input' && %w[submit image].include?(type)) || (tag_name == 'button' && [nil, "submit"].include?(type))
+    (tag_name == 'input' && %w[submit image].include?(type)) || (tag_name == 'button' && [nil, 'submit'].include?(type))
   end
 
   def checkable?
@@ -252,6 +252,6 @@ protected
   end
 
   def textarea?
-    tag_name == "textarea"
+    tag_name == 'textarea'
   end
 end

data/lib/capybara/rails.rb

@@ -3,7 +3,7 @@
 require 'capybara/dsl'
 
 Capybara.app = Rack::Builder.new do
-  map "/" do
+  map '/' do
     run Rails.application
   end
 end.to_app

data/lib/capybara/result.rb

@@ -123,13 +123,13 @@ module Capybara
     def failure_message
       message = @query.failure_message
       if count.zero?
-        message << " but there were no matches"
+        message << ' but there were no matches'
       else
-        message << ", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: " << full_results.map(&:text).map(&:inspect).join(", ")
+        message << ", found #{count} #{Capybara::Helpers.declension('match', 'matches', count)}: " << full_results.map(&:text).map(&:inspect).join(', ')
       end
       unless rest.empty?
-        elements = rest.map { |el| el.text rescue "<<ERROR>>" }.map(&:inspect).join(", ") # rubocop:disable Style/RescueModifier
-        message << ". Also found " << elements << ", which matched the selector but not all filters."
+        elements = rest.map { |el| el.text rescue '<<ERROR>>' }.map(&:inspect).join(', ') # rubocop:disable Style/RescueModifier
+        message << '. Also found ' << elements << ', which matched the selector but not all filters.'
       end
       message
     end
@@ -138,6 +138,10 @@ module Capybara
       failure_message.sub(/(to find)/, 'not \1')
     end
 
+    def unfiltered_size
+      @elements.length
+    end
+
   private
 
     def full_results

data/lib/capybara/rspec/features.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-RSpec.shared_context "Capybara Features", capybara_feature: true do
+RSpec.shared_context 'Capybara Features', capybara_feature: true do
   instance_eval do
     alias background before
     alias given let
@@ -10,14 +10,14 @@ end
 
 # ensure shared_context is included if default shared_context_metadata_behavior is changed
 RSpec.configure do |config|
-  config.include_context "Capybara Features", capybara_feature: true if config.respond_to?(:include_context)
+  config.include_context 'Capybara Features', capybara_feature: true if config.respond_to?(:include_context)
 end
 
 RSpec.configure do |config|
   config.alias_example_group_to :feature, capybara_feature: true, type: :feature
-  config.alias_example_group_to :xfeature, capybara_feature: true, type: :feature, skip: "Temporarily disabled with xfeature"
+  config.alias_example_group_to :xfeature, capybara_feature: true, type: :feature, skip: 'Temporarily disabled with xfeature'
   config.alias_example_group_to :ffeature, capybara_feature: true, type: :feature, focus: true
   config.alias_example_to :scenario
-  config.alias_example_to :xscenario, skip: "Temporarily disabled with xscenario"
+  config.alias_example_to :xscenario, skip: 'Temporarily disabled with xscenario'
   config.alias_example_to :fscenario, focus: true
 end

data/lib/capybara/rspec/matchers.rb

@@ -89,11 +89,11 @@ module Capybara
       end
 
       def does_not_match?(_actual)
-        raise ArgumentError, "The have_all_selectors matcher does not support use with not_to/should_not"
+        raise ArgumentError, 'The have_all_selectors matcher does not support use with not_to/should_not'
       end
 
       def description
-        "have all selectors"
+        'have all selectors'
       end
     end
 
@@ -108,11 +108,11 @@ module Capybara
       end
 
       def does_not_match?(_actual)
-        raise ArgumentError, "The have_none_of_selectors matcher does not support use with not_to/should_not"
+        raise ArgumentError, 'The have_none_of_selectors matcher does not support use with not_to/should_not'
       end
 
       def description
-        "have no selectors"
+        'have no selectors'
       end
     end
 
@@ -235,11 +235,11 @@ module Capybara
       end
 
       def does_not_match?(_actual)
-        raise ArgumentError, "The have_style matcher does not support use with not_to/should_not"
+        raise ArgumentError, 'The have_style matcher does not support use with not_to/should_not'
       end
 
       def description
-        "have style"
+        'have style'
       end
     end