capybara 3.9.0 → 3.10.0

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

@@ -26,16 +26,14 @@ module Capybara
 
         def class_conditions(classes)
           case classes
-          when XPath::Expression
-            XPath.attr(:class)[classes]
-          when Regexp
-            XPath.attr(:class)[regexp_to_xpath_conditions(classes)]
+          when XPath::Expression, Regexp
+            attribute_conditions(class: classes)
           else
             Array(classes).map do |klass|
-              if klass.start_with?('!')
+              if klass.start_with?('!') && !klass.start_with?('!!!')
                 !XPath.attr(:class).contains_word(klass.slice(1..-1))
               else
-                XPath.attr(:class).contains_word(klass)
+                XPath.attr(:class).contains_word(klass.sub(/^!!/, ''))
               end
             end.reduce(:&)
           end

data/lib/capybara/selector/regexp_disassembler.rb

@@ -1,66 +1,65 @@
 # frozen_string_literal: true
 
+require 'regexp_parser'
+
 module Capybara
   class Selector
     # @api private
     class RegexpDisassembler
       def initialize(regexp)
         @regexp = regexp
-        @regexp_source = regexp.source
       end
 
       def substrings
         @substrings ||= begin
-          source = @regexp_source.dup
-          source.gsub!(/\\[^pgk]/, '.') # replace escaped characters with wildcard
-          source.gsub!(/\\[gk](?:<[^>]*>)?/, '.') # replace sub expressions and back references with wildcard
-          source.gsub!(/\\p\{[[:alpha:]]+\}?/, '.') # replace character properties with wildcard
-          source.gsub!(/\[\[:[a-z]+:\]\]/, '.') # replace posix classes with wildcard
-          while source.gsub!(/\[(?:[^\[\]]+)\]/, '.'); end # replace character classes with wildcard
-          source.gsub!(/\(\?<?[=!][^)]*\)/, '') # remove lookahead/lookbehind assertions
-          source.gsub!(/\(\?(?:<[^>]+>|>|:)/, '(') # replace named, atomic, and non-matching groups with unnamed matching groups
-
-          while source.gsub!(GROUP_REGEX) { |_m| simplify_group(Regexp.last_match) }; end
-          source.gsub!(/.[*?]\??/, '.') # replace optional character with wildcard
-          source.gsub!(/(.)\+\??/, '\1.') # replace one or more with character plus wildcard
-          source.gsub!(/(?<char>.)#{COUNTED_REP_REGEX.source}/) do |_m| # repeat counted characters
-            (Regexp.last_match[:char] * Regexp.last_match[:min_rep].to_i).tap { |str| str << '.' if Regexp.last_match[:max_rep] }
-          end
-          return [] if source.include?('|') # can't handle alternation here
-
-          strs = source.match(/\A\^?(.*?)\$?\Z/).captures[0].split('.').reject(&:empty?).uniq
-          strs = strs.map(&:upcase) if @regexp.casefold?
-          strs
+          strs = extract_strings(Regexp::Parser.parse(@regexp), [+''])
+          strs.map!(&:upcase) if @regexp.casefold?
+          strs.reject(&:empty?).uniq
         end
       end
 
     private
 
-      def simplify_group(matches)
-        if matches[:group].include?('|') # no support for alternation in groups
-          '.'
-        elsif matches[:one_or_more] # required but may repeat becomes text + wildcard
-          matches[:group][1..-2] + '.'
-        elsif matches[:optional] # optional group becomes wildcard
-          '.'
-        elsif matches[:min_rep]
-          (matches[:group] * matches[:min_rep].to_i).tap { |r| r << '.' if matches[:max_rep] }
-        else
-          matches[:group][1..-2]
-        end
+      def min_repeat(exp)
+        exp.quantifier&.min || 1
+      end
+
+      def fixed_repeat?(exp)
+        min_repeat(exp) == (exp.quantifier&.max || 1)
+      end
+
+      def optional?(exp)
+        min_repeat(exp).zero?
       end
 
-      COUNTED_REP_REGEX = /\{(?<min_rep>\d*)(?:,(?<max_rep>\d*))?\}/
-      GROUP_REGEX = /
-        (?<group>\([^()]*\))
-          (?:
-            (?:
-             (?<optional>[*?]) |
-             (?<one_or_more>\+) |
-             (?:#{COUNTED_REP_REGEX.source})
-            )\??
-          )?
-      /x
+      def extract_strings(expression, strings)
+        expression.each do |exp|
+          if optional?(exp)
+            strings.push(+'')
+            next
+          end
+
+          if %i[meta set].include?(exp.type)
+            strings.push(+'')
+            next
+          end
+
+          if exp.terminal?
+            case exp.type
+            when :literal
+              strings.last << (exp.text * min_repeat(exp))
+            when :escape
+              strings.last << (exp.char * min_repeat(exp))
+            else
+              strings.push(+'')
+            end
+          else
+            min_repeat(exp).times { extract_strings(exp, strings) }
+          end
+          strings.push(+'') unless fixed_repeat?(exp)
+        end
+        strings
+      end
     end
   end
 end

data/lib/capybara/selector/selector.rb

@@ -217,7 +217,7 @@ module Capybara
     # Define a selector by an xpath expression
     #
     # @overload xpath(*expression_filters, &block)
-    #   @param [Array<Symbol>] expression_filters ([])  Names of filters that can be implemented via this expression
+    #   @param [Array<Symbol>] expression_filters ([])  Names of filters that are implemented via this expression, if not specified the names of any keyword parameters in the block will be used
     #   @yield [locator, options]                       The block to use to generate the XPath expression
     #   @yieldparam [String] locator                    The locator string passed to the query
     #   @yieldparam [Hash] options                      The options hash passed to the query
@@ -227,11 +227,7 @@ module Capybara
     # @return [#call]                             The block that will be called to generate the XPath expression
     #
     def xpath(*allowed_filters, &block)
-      if block
-        @format, @expression = :xpath, block
-        allowed_filters.flatten.each { |ef| expression_filters[ef] = Filters::IdentityExpressionFilter.new(ef) }
-      end
-      format == :xpath ? @expression : nil
+      expression(:xpath, allowed_filters, &block)
     end
 
     ##
@@ -249,11 +245,7 @@ module Capybara
     # @return [#call]                             The block that will be called to generate the CSS selector
     #
     def css(*allowed_filters, &block)
-      if block
-        @format, @expression = :css, block
-        allowed_filters.flatten.each { |ef| expression_filters[ef] = nil }
-      end
-      format == :css ? @expression : nil
+      expression(:css, allowed_filters, &block)
     end
 
     ##
@@ -459,6 +451,19 @@ module Capybara
     def find_by_class_attr(classes)
       Array(classes).map { |klass| XPath.attr(:class).contains_word(klass) }.reduce(:&)
     end
+
+    def parameter_names(block)
+      block.parameters.select { |(type, _name)| %i[key keyreq].include? type }.map { |(_type, name)| name }
+    end
+
+    def expression(type, allowed_filters, &block)
+      if block
+        @format, @expression = type, block
+        allowed_filters = parameter_names(block) if allowed_filters.empty?
+        allowed_filters.flatten.each { |ef| expression_filters[ef] = Filters::IdentityExpressionFilter.new(ef) }
+      end
+      format == type ? @expression : nil
+    end
   end
 end
 

data/lib/capybara/selenium/driver.rb

@@ -107,33 +107,17 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     navigated = false
     timer = Capybara::Helpers.timer(expire_in: 10)
     begin
-      unless navigated
-        # Only trigger a navigation if we haven't done it already, otherwise it
-        # can trigger an endless series of unload modals
-        clear_browser_state
-        @browser.navigate.to('about:blank')
-      end
+      # Only trigger a navigation if we haven't done it already, otherwise it
+      # can trigger an endless series of unload modals
+      reset_browser_state unless navigated
       navigated = true
-
       # Ensure the page is empty and trigger an UnhandledAlertError for any modals that appear during unload
-      until find_xpath('/html/body/*').empty?
-        raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?
-
-        sleep 0.05
-      end
+      wait_for_empty_page(timer)
     rescue Selenium::WebDriver::Error::UnhandledAlertError, Selenium::WebDriver::Error::UnexpectedAlertOpenError
       # This error is thrown if an unhandled alert is on the page
       # Firefox appears to automatically dismiss this alert, chrome does not
       # We'll try to accept it
-      begin
-        @browser.switch_to.alert.accept
-        sleep 0.25 # allow time for the modal to be handled
-      rescue modal_error
-        # The alert is now gone.
-        # If navigation has not occurred attempt again and accept alert
-        # since FF may have dismissed the alert at first attempt.
-        navigate_with_accept('about:blank') if current_url != 'about:blank'
-      end
+      accept_unhandled_reset_alert
       # try cleaning up the browser again
       retry
     end
@@ -382,6 +366,29 @@ private
       exit @exit_status if @exit_status # Force exit with stored status
     end
   end
+
+  def reset_browser_state
+    clear_browser_state
+    @browser.navigate.to('about:blank')
+  end
+
+  def wait_for_empty_page(timer)
+    until find_xpath('/html/body/*').empty?
+      raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?
+
+      sleep 0.05
+    end
+  end
+
+  def accept_unhandled_reset_alert
+    @browser.switch_to.alert.accept
+    sleep 0.25 # allow time for the modal to be handled
+  rescue modal_error
+    # The alert is now gone.
+    # If navigation has not occurred attempt again and accept alert
+    # since FF may have dismissed the alert at first attempt.
+    navigate_with_accept('about:blank') if current_url != 'about:blank'
+  end
 end
 
 require 'capybara/selenium/driver_specializations/chrome_driver'

data/lib/capybara/selenium/nodes/marionette_node.rb

@@ -36,16 +36,11 @@ class Capybara::Selenium::MarionetteNode < Capybara::Selenium::Node
     return super if browser_version >= 62.0
 
     # Workaround lack of support for multiple upload by uploading one at a time
-    path_names = value.to_s.empty? ? [] : value
-    Array(path_names).each do |path|
-      unless driver.browser.respond_to?(:upload)
-        if (fd = bridge.file_detector)
-          local_file = fd.call([path])
-          path = upload(local_file) if local_file
-        end
-      end
-      native.send_keys(path)
+    path_names = value.to_s.empty? ? [] : Array(value)
+    if (fd = bridge.file_detector) && !driver.browser.respond_to?(:upload)
+      path_names.map! { |path| upload(fd.call([path])) || path }
     end
+    path_names.each { |path| native.send_keys(path) }
   end
 
   def send_keys(*args)
@@ -101,9 +96,8 @@ private
   end
 
   def upload(local_file)
-    unless File.file?(local_file)
-      raise ArgumentError, "You may only upload files: #{local_file.inspect}"
-    end
+    return nil unless local_file
+    raise ArgumentError, "You may only upload files: #{local_file.inspect}" unless File.file?(local_file)
 
     result = bridge.http.call(:post, "session/#{bridge.session_id}/file", file: Selenium::WebDriver::Zipper.zip_file(local_file))
     result['value']

data/lib/capybara/server.rb

@@ -48,9 +48,7 @@ module Capybara
 
       res = @checker.request { |http| http.get('/__identify__') }
 
-      if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
-        return res.body == app.object_id.to_s
-      end
+      return res.body == app.object_id.to_s if res.is_a?(Net::HTTPSuccess) || res.is_a?(Net::HTTPRedirection)
     rescue SystemCallError, Net::ReadTimeout, OpenSSL::SSL::SSLError
       false
     end

data/lib/capybara/server/animation_disabler.rb

@@ -16,7 +16,7 @@ module Capybara
 
       def initialize(app)
         @app = app
-        @disable_markup = DISABLE_MARKUP_TEMPLATE % AnimationDisabler.selector_for(Capybara.disable_animation)
+        @disable_markup = format(DISABLE_MARKUP_TEMPLATE, selector: AnimationDisabler.selector_for(Capybara.disable_animation))
       end
 
       def call(env)
@@ -46,7 +46,7 @@ module Capybara
       DISABLE_MARKUP_TEMPLATE = <<~HTML
         <script defer>(typeof jQuery !== 'undefined') && (jQuery.fx.off = true);</script>
         <style>
-           %s {
+           %<selector>s {
              transition: none !important;
              animation-duration: 0s !important;
              animation-delay: 0s !important;

data/lib/capybara/session.rb

@@ -49,7 +49,7 @@ module Capybara
       has_no_table? has_table? unselect has_select? has_no_select?
       has_selector? has_no_selector? click_on has_no_checked_field?
       has_no_unchecked_field? query assert_selector assert_no_selector
-      assert_all_of_selectors assert_none_of_selectors
+      assert_all_of_selectors assert_none_of_selectors assert_any_of_selectors
       refute_selector assert_text assert_no_text
     ].freeze
     # @api private

data/lib/capybara/spec/session/assert_all_of_selectors_spec.rb

@@ -19,6 +19,10 @@ Capybara::SpecHelper.spec '#assert_all_of_selectors' do
     @session.assert_all_of_selectors('p a#foo', 'h2#h2two', 'h2#h2one')
   end
 
+  it 'should support filter block' do
+    expect { @session.assert_all_of_selectors(:css, 'h2#h2one', 'h2#h2two') { |n| n[:id] == 'h2one' } }.to raise_error(Capybara::ElementNotFound, /custom filter block/)
+  end
+
   context 'should respect scopes' do
     it 'when used with `within`' do
       @session.within "//p[@id='first']" do
@@ -109,3 +113,28 @@ Capybara::SpecHelper.spec '#assert_none_of_selectors' do
     end
   end
 end
+
+Capybara::SpecHelper.spec '#assert_any_of_selectors' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should be true if any of the given selectors are on the page' do
+    @session.assert_any_of_selectors(:css, 'a#foo', 'h2#h2three')
+    @session.assert_any_of_selectors(:css, 'h2#h2three', 'a#foo')
+  end
+
+  it 'should be false if none of the given selectors are on the page' do
+    expect { @session.assert_any_of_selectors(:css, 'h2#h2three', 'h4#h4four') }.to raise_error(Capybara::ElementNotFound)
+  end
+
+  it 'should use default selector' do
+    Capybara.default_selector = :css
+    expect { @session.assert_any_of_selectors('h2#h2three', 'h5#h5five') }.to raise_error(Capybara::ElementNotFound)
+    @session.assert_any_of_selectors('p a#foo', 'h2#h2two', 'h2#h2one')
+  end
+
+  it 'should support filter block' do
+    expect { @session.assert_any_of_selectors(:css, 'h2#h2one', 'h2#h2two') { |_n| false } }.to raise_error(Capybara::ElementNotFound, /custom filter block/)
+  end
+end

data/lib/capybara/spec/session/click_button_spec.rb

@@ -376,6 +376,12 @@ Capybara::SpecHelper.spec '#click_button' do
     expect(@results['no_value']).not_to be_nil
   end
 
+  it 'should send button in document order' do
+    @session.click_button('outside_button')
+    @results = extract_results(@session)
+    expect(@results.keys).to eq %w[for_form2 outside_button which_form post_count]
+  end
+
   it 'should not send image buttons that were not clicked' do
     @session.click_button('Click me!')
     @results = extract_results(@session)

data/lib/capybara/spec/session/click_link_spec.rb

@@ -211,7 +211,7 @@ Capybara::SpecHelper.spec '#click_link' do
     download_file = File.join(Capybara.save_path, 'download.csv')
     expect(File).not_to exist(download_file)
     @session.click_link('Download Me')
-    sleep 2
+    sleep 2 # allow time for file to download
     expect(File).to exist(download_file)
     FileUtils.rm_rf download_file
   end

data/lib/capybara/spec/session/has_all_selectors_spec.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-Capybara::SpecHelper.spec '#have_all_selectors' do
+Capybara::SpecHelper.spec '#have_all_of_selectors' do
   before do
     @session.visit('/with_html')
   end

data/lib/capybara/spec/session/has_any_selectors_spec.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#have_any_of_selectors' do
+  before do
+    @session.visit('/with_html')
+  end
+
+  it 'should be true if any of the given selectors are on the page' do
+    expect(@session).to have_any_of_selectors(:css, 'p a#foo', 'h2#blah', 'h2#h2two')
+  end
+
+  it 'should be false if none of the given selectors are not on the page' do
+    expect do
+      expect(@session).to have_any_of_selectors(:css, 'span a#foo', 'h2#h2nope', 'h2#h2one_no')
+    end.to raise_error ::RSpec::Expectations::ExpectationNotMetError
+  end
+
+  it 'should use default selector' do
+    Capybara.default_selector = :css
+    expect(@session).to have_any_of_selectors('p a#foo', 'h2#h2two', 'a#not_on_page')
+    expect do
+      expect(@session).to have_any_of_selectors('p a#blah', 'h2#h2three')
+    end.to raise_error ::RSpec::Expectations::ExpectationNotMetError
+  end
+end

data/lib/capybara/spec/session/html_spec.rb

@@ -1,5 +1,9 @@
 # frozen_string_literal: true
 
+# Note: This file uses `sleep` to sync up parts of the tests. This is only implemented like this
+# because of the methods being tested. In tests using Capybara this type of behavior should be implemented
+# using Capybara provided assertions with builtin waiting behavior.
+
 Capybara::SpecHelper.spec '#html' do
   it 'should return the unmodified page body' do
     @session.visit('/')
@@ -8,6 +12,7 @@ Capybara::SpecHelper.spec '#html' do
 
   it 'should return the current state of the page', requires: [:js] do
     @session.visit('/with_js')
+    sleep 1
     expect(@session.html).to include('I changed it')
     expect(@session.html).not_to include('This is text')
   end
@@ -21,6 +26,7 @@ Capybara::SpecHelper.spec '#source' do
 
   it 'should return the current state of the page', requires: [:js] do
     @session.visit('/with_js')
+    sleep 1
     expect(@session.source).to include('I changed it')
     expect(@session.source).not_to include('This is text')
   end
@@ -34,6 +40,7 @@ Capybara::SpecHelper.spec '#body' do
 
   it 'should return the current state of the page', requires: [:js] do
     @session.visit('/with_js')
+    sleep 1
     expect(@session.body).to include('I changed it')
     expect(@session.body).not_to include('This is text')
   end