capybara 3.32.2 → 3.39.2

data/lib/capybara/server/animation_disabler.rb

@@ -16,43 +16,65 @@ module Capybara
 
       def initialize(app)
         @app = app
-        @disable_markup = format(DISABLE_MARKUP_TEMPLATE, selector: self.class.selector_for(Capybara.disable_animation))
+        @disable_css_markup = format(DISABLE_CSS_MARKUP_TEMPLATE,
+                                     selector: self.class.selector_for(Capybara.disable_animation))
+        @disable_js_markup = +DISABLE_JS_MARKUP_TEMPLATE
       end
 
       def call(env)
-        @status, @headers, @body = @app.call(env)
-        return [@status, @headers, @body] unless html_content?
+        status, headers, body = @app.call(env)
+        return [status, headers, body] unless html_content?(headers)
 
-        response = Rack::Response.new([], @status, @headers)
+        nonces = directive_nonces(headers).transform_values { |nonce| "nonce=\"#{nonce}\"" if nonce && !nonce.empty? }
+        response = Rack::Response.new([], status, headers)
 
-        @body.each { |html| response.write insert_disable(html) }
-        @body.close if @body.respond_to?(:close)
+        body.each { |html| response.write insert_disable(html, nonces) }
+        body.close if body.respond_to?(:close)
 
         response.finish
       end
 
     private
 
-      attr_reader :disable_markup
+      attr_reader :disable_css_markup, :disable_js_markup
 
-      def html_content?
-        /html/.match?(@headers['Content-Type'])
+      def html_content?(headers)
+        /html/.match?(headers['Content-Type']) # rubocop:todo Performance/StringInclude
       end
 
-      def insert_disable(html)
-        html.sub(%r{(</head>)}, disable_markup + '\\1')
+      def insert_disable(html, nonces)
+        html.sub(%r{(</head>)}, "<style #{nonces['style-src']}>#{disable_css_markup}</style>\\1")
+            .sub(%r{(</body>)}, "<script #{nonces['script-src']}>#{disable_js_markup}</script>\\1")
       end
 
-      DISABLE_MARKUP_TEMPLATE = <<~HTML
-        <script defer>(typeof jQuery !== 'undefined') && (jQuery.fx.off = true);</script>
-        <style>
-           %<selector>s, %<selector>s::before, %<selector>s::after {
-             transition: none !important;
-             animation-duration: 0s !important;
-             animation-delay: 0s !important;
-          }
-        </style>
-      HTML
+      def directive_nonces(headers)
+        headers.fetch('Content-Security-Policy', '')
+               .split(';')
+               .map(&:split)
+               .to_h do |s|
+                 [
+                   s[0], s[1..].filter_map do |value|
+                     /^'nonce-(?<nonce>.+)'/ =~ value
+                     nonce
+                   end[0]
+                 ]
+               end
+      end
+
+      DISABLE_CSS_MARKUP_TEMPLATE = <<~CSS
+        %<selector>s, %<selector>s::before, %<selector>s::after {
+           transition: none !important;
+           animation-duration: 0s !important;
+           animation-delay: 0s !important;
+           scroll-behavior: auto !important;
+        }
+      CSS
+
+      DISABLE_JS_MARKUP_TEMPLATE = <<~SCRIPT
+        //<![CDATA[
+          (typeof jQuery !== 'undefined') && (jQuery.fx.off = true);
+        //]]>
+      SCRIPT
     end
   end
 end

data/lib/capybara/server/middleware.rb

@@ -14,7 +14,7 @@ module Capybara
         end
 
         def decrement(uri)
-          @mutex.synchronize { @value.delete_at(@value.index(uri) || @value.length) }
+          @mutex.synchronize { @value.delete_at(@value.index(uri) || - 1) }
         end
 
         def positive?
@@ -53,14 +53,16 @@ module Capybara
         if env['PATH_INFO'] == '/__identify__'
           [200, {}, [@app.object_id.to_s]]
         else
-          @counter.increment(env['REQUEST_URI'])
+          request_uri = env['REQUEST_URI']
+          @counter.increment(request_uri)
+
           begin
             @extended_app.call(env)
           rescue *@server_errors => e
             @error ||= e
             raise e
           ensure
-            @counter.decrement(env['REQUEST_URI'])
+            @counter.decrement(request_uri)
           end
         end
       end

data/lib/capybara/session/config.rb

@@ -8,7 +8,7 @@ module Capybara
                  automatic_reload match exact exact_text raise_server_errors visible_text_only
                  automatic_label_click enable_aria_label save_path asset_host default_host app_host
                  server_host server_port server_errors default_set_options disable_animation test_id
-                 predicates_wait default_normalize_ws w3c_click_offset].freeze
+                 predicates_wait default_normalize_ws w3c_click_offset enable_aria_role default_retry_interval].freeze
 
     attr_accessor(*OPTIONS)
 
@@ -21,6 +21,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method default_max_wait_time
     #   See {Capybara.configure}
+    # @!method default_retry_interval
+    #   See {Capybara.configure}
     # @!method ignore_hidden_elements
     #   See {Capybara.configure}
     # @!method automatic_reload
@@ -37,6 +39,8 @@ module Capybara
     #   See {Capybara.configure}
     # @!method enable_aria_label
     #   See {Capybara.configure}
+    # @!method enable_aria_role
+    #   See {Capybara.configure}
     # @!method save_path
     #   See {Capybara.configure}
     # @!method asset_host
@@ -98,7 +102,7 @@ module Capybara
     remove_method :test_id=
     ##
     #
-    # Set an attribue to be optionally matched against the locator for builtin selector types.
+    # Set an attribute to be optionally matched against the locator for builtin selector types.
     # This attribute will be checked by builtin selector types whenever id would normally be checked.
     # If `nil` then it will be ignored.
     #

data/lib/capybara/session/matchers.rb

@@ -13,14 +13,14 @@ module Capybara
     #     @param string [String]           The string that the current 'path' should equal
     #   @overload $0(regexp, **options)
     #     @param regexp [Regexp]           The regexp that the current 'path' should match to
-    #   @option options [Boolean] :url (true if `string` ia a full url, otherwise false) Whether the compare should be done against the full current url or just the path
+    #   @option options [Boolean] :url (true if `string` is a full url, otherwise false) Whether the comparison should be done against the full current url or just the path
     #   @option options [Boolean] :ignore_query (false)  Whether the query portion of the current url/path should be ignored
     #   @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for the current url/path to eq/match given string/regexp argument
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_current_path(path, **options)
-      _verify_current_path(path, **options) do |query|
+    def assert_current_path(path, **options, &optional_filter_block)
+      _verify_current_path(path, optional_filter_block, **options) do |query|
         raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self)
       end
     end
@@ -35,8 +35,8 @@ module Capybara
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_no_current_path(path, **options)
-      _verify_current_path(path, **options) do |query|
+    def assert_no_current_path(path, **options, &optional_filter_block)
+      _verify_current_path(path, optional_filter_block, **options) do |query|
         raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self)
       end
     end
@@ -50,8 +50,8 @@ module Capybara
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_current_path?(path, **options)
-      make_predicate(options) { assert_current_path(path, **options) }
+    def has_current_path?(path, **options, &optional_filter_block)
+      make_predicate(options) { assert_current_path(path, **options, &optional_filter_block) }
     end
 
     ##
@@ -63,14 +63,14 @@ module Capybara
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_no_current_path?(path, **options)
-      make_predicate(options) { assert_no_current_path(path, **options) }
+    def has_no_current_path?(path, **options, &optional_filter_block)
+      make_predicate(options) { assert_no_current_path(path, **options, &optional_filter_block) }
     end
 
   private
 
-    def _verify_current_path(path, **options)
-      query = Capybara::Queries::CurrentPathQuery.new(path, **options)
+    def _verify_current_path(path, filter_block, **options)
+      query = Capybara::Queries::CurrentPathQuery.new(path, **options, &filter_block)
       document.synchronize(query.wait) do
         yield(query)
       end

data/lib/capybara/session.rb

@@ -40,6 +40,7 @@ module Capybara
 
     NODE_METHODS = %i[
       all first attach_file text check choose scroll_to scroll_by
+      click double_click right_click
       click_link_or_button click_button click_link
       fill_in find find_all find_button find_by_id find_field find_link
       has_content? has_text? has_css? has_no_content? has_no_text?
@@ -58,7 +59,7 @@ module Capybara
     ].freeze
     SESSION_METHODS = %i[
       body html source current_url current_host current_path
-      execute_script evaluate_script visit refresh go_back go_forward
+      execute_script evaluate_script evaluate_async_script visit refresh go_back go_forward send_keys
       within within_element within_fieldset within_table within_frame switch_to_frame
       current_window windows open_new_window switch_to_window within_window window_opened_by
       save_page save_and_open_page save_screenshot
@@ -97,8 +98,8 @@ module Capybara
 
     def driver
       @driver ||= begin
-        unless Capybara.drivers.key?(mode)
-          other_drivers = Capybara.drivers.keys.map(&:inspect)
+        unless Capybara.drivers[mode]
+          other_drivers = Capybara.drivers.names.map(&:inspect)
           raise Capybara::DriverNotFoundError, "no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}"
         end
         driver = Capybara.drivers[mode].call(app)
@@ -129,6 +130,8 @@ module Capybara
       if @touched
         driver.reset!
         @touched = false
+        switch_to_frame(:top) rescue nil # rubocop:disable Style/RescueModifier
+        @scopes = [nil]
       end
       @server&.wait_for_pending_requests
       raise_server_error!
@@ -159,9 +162,8 @@ module Capybara
         if config.raise_server_errors
           raise CapybaraError, 'Your application server raised an error - It has been raised in your test code because Capybara.raise_server_errors == true'
         end
-      rescue CapybaraError
-        # needed to get the cause set correctly in JRuby -- otherwise we could just do raise @server.error
-        raise @server.error, @server.error.message, @server.error.backtrace
+      rescue CapybaraError => capy_error # rubocop:disable Naming/RescuedExceptionsVariableName
+        raise @server.error, cause: capy_error
       ensure
         @server.reset_error!
       end
@@ -192,7 +194,7 @@ module Capybara
     # @return [String] A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).
     #
     def html
-      driver.html
+      driver.html || ''
     end
     alias_method :body, :html
     alias_method :source, :html
@@ -303,6 +305,24 @@ module Capybara
       driver.go_forward
     end
 
+    ##
+    # @!method send_keys
+    #   @see Capybara::Node::Element#send_keys
+    #
+    def send_keys(*args, **kw_args)
+      driver.send_keys(*args, **kw_args)
+    end
+
+    ##
+    #
+    # Returns the element with focus.
+    #
+    # Not supported by Rack Test
+    #
+    def active_element
+      Capybara::Queries::ActiveElementQuery.new.resolve_for(self)[0].tap(&:allow_reload!)
+    end
+
     ##
     #
     # Executes the given block within the context of a node. {#within} takes the
@@ -342,7 +362,7 @@ module Capybara
       new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args, **kw_args)
       begin
         scopes.push(new_scope)
-        yield if block_given?
+        yield new_scope if block_given?
       ensure
         scopes.pop
       end
@@ -355,8 +375,8 @@ module Capybara
     #
     # @param [String] locator    Id or legend of the fieldset
     #
-    def within_fieldset(locator)
-      within(:fieldset, locator) { yield }
+    def within_fieldset(locator, &block)
+      within(:fieldset, locator, &block)
     end
 
     ##
@@ -365,8 +385,8 @@ module Capybara
     #
     # @param [String] locator    Id or caption of the table
     #
-    def within_table(locator)
-      within(:table, locator) { yield }
+    def within_table(locator, &block)
+      within(:table, locator, &block)
     end
 
     ##
@@ -391,19 +411,20 @@ module Capybara
         scopes.push(:frame)
       when :parent
         if scopes.last != :frame
-          raise Capybara::ScopeError, "`switch_to_frame(:parent)` cannot be called from inside a descendant frame's "\
+          raise Capybara::ScopeError, "`switch_to_frame(:parent)` cannot be called from inside a descendant frame's " \
                                       '`within` block.'
         end
         scopes.pop
         driver.switch_to_frame(:parent)
       when :top
         idx = scopes.index(:frame)
+        top_level_scopes = [:frame, nil]
         if idx
-          if scopes.slice(idx..-1).any? { |scope| ![:frame, nil].include?(scope) }
-            raise Capybara::ScopeError, "`switch_to_frame(:top)` cannot be called from inside a descendant frame's "\
+          if scopes.slice(idx..).any? { |scope| !top_level_scopes.include?(scope) }
+            raise Capybara::ScopeError, "`switch_to_frame(:top)` cannot be called from inside a descendant frame's " \
                                         '`within` block.'
           end
-          scopes.slice!(idx..-1)
+          scopes.slice!(idx..)
           driver.switch_to_frame(:top)
         end
       else
@@ -488,11 +509,11 @@ module Capybara
     # @raise [ArgumentError]               if both or neither arguments were provided
     #
     def switch_to_window(window = nil, **options, &window_locator)
-      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && block_given?
-      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !block_given?
+      raise ArgumentError, '`switch_to_window` can take either a block or a window, not both' if window && window_locator
+      raise ArgumentError, '`switch_to_window`: either window or block should be provided' if !window && !window_locator
 
       unless scopes.last.nil?
-        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from '\
+        raise Capybara::ScopeError, '`switch_to_window` is not supposed to be invoked from ' \
                                     '`within` or `within_frame` blocks.'
       end
 
@@ -563,7 +584,7 @@ module Capybara
       synchronize_windows(options) do
         opened_handles = (driver.window_handles - old_handles)
         if opened_handles.size != 1
-          raise Capybara::WindowError, 'block passed to #window_opened_by '\
+          raise Capybara::WindowError, 'block passed to #window_opened_by ' \
                                        "opened #{opened_handles.size} windows instead of 1"
         end
         Window.new(self, opened_handles.first)
@@ -738,7 +759,7 @@ module Capybara
     # @param [Hash] options   a customizable set of options
     #
     def save_and_open_screenshot(path = nil, **options)
-      save_screenshot(path, **options).tap { |s_path| open_file(s_path) } # rubocop:disable Lint/Debugger
+      save_screenshot(path, **options).tap { |s_path| open_file(s_path) }
     end
 
     def document
@@ -746,33 +767,20 @@ module Capybara
     end
 
     NODE_METHODS.each do |method|
-      if RUBY_VERSION >= '2.7'
-        class_eval <<~METHOD, __FILE__, __LINE__ + 1
-          def #{method}(...)
-            @touched = true
-            current_scope.#{method}(...)
-          end
-        METHOD
-      else
-        define_method method do |*args, &block|
+      class_eval <<~METHOD, __FILE__, __LINE__ + 1
+        def #{method}(...)
           @touched = true
-          current_scope.send(method, *args, &block)
+          current_scope.#{method}(...)
         end
-      end
+      METHOD
     end
 
     DOCUMENT_METHODS.each do |method|
-      if RUBY_VERSION >= '2.7'
-        class_eval <<~METHOD, __FILE__, __LINE__ + 1
-          def #{method}(...)
-            document.#{method}(...)
-          end
-        METHOD
-      else
-        define_method method do |*args, &block|
-          document.send(method, *args, &block)
+      class_eval <<~METHOD, __FILE__, __LINE__ + 1
+        def #{method}(...)
+          document.#{method}(...)
         end
-      end
+      METHOD
     end
 
     def inspect
@@ -788,7 +796,7 @@ module Capybara
     #
     # Yield a block using a specific maximum wait time.
     #
-    def using_wait_time(seconds)
+    def using_wait_time(seconds, &block)
       if Capybara.threadsafe
         begin
           previous_wait_time = config.default_max_wait_time
@@ -798,7 +806,7 @@ module Capybara
           config.default_max_wait_time = previous_wait_time
         end
       else
-        Capybara.using_wait_time(seconds) { yield }
+        Capybara.using_wait_time(seconds, &block)
       end
     end
 

data/lib/capybara/spec/public/test.js

@@ -44,6 +44,10 @@ $(function() {
     $(this).after('<div class="log">DragOver with client position: ' + ev.clientX + ',' + ev.clientY)
     if ($(this).hasClass('drop')) { ev.preventDefault(); }
   });
+  $('#drop_html5, #drop_html5_scroll').on('dragenter', function(ev){
+    $(this).after('<div class="log">DragEnter')
+    if ($(this).hasClass('drop')) { ev.preventDefault(); }
+  });
   $('#drop_html5, #drop_html5_scroll').on('dragleave', function(ev){
     $(this).after('<div class="log">DragLeave with client position: ' + ev.clientX + ',' + ev.clientY)
     if ($(this).hasClass('drop')) { ev.preventDefault(); }
@@ -108,6 +112,13 @@ $(function() {
     }, 4000);
     return false;
   });
+  $('#aria-button').click(function() {
+    var span = $(this);
+    setTimeout(function() {
+      $(span).after('<span role="button">ARIA button has been clicked</span>')
+    }, 1000);
+    return false;
+  });
   $('#waiter').change(function() {
     activeRequests = 1;
     setTimeout(function() {
@@ -264,5 +275,10 @@ $(function() {
   });
   $('#multiple-file, #hidden_file').change(function(e){
     $('body').append($('<p class="file_change">File input changed</p>'));
-  })
+  });
+
+  var shadow = document.querySelector('#shadow').attachShadow({mode: 'open'});
+  var span = document.createElement('span');
+  span.textContent = 'The things we do in the shadows';
+  shadow.appendChild(span);
 });

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

@@ -53,7 +53,7 @@ Capybara::SpecHelper.spec '#accept_alert', requires: [:modals] do
       @session.click_link('Alert page change')
       sleep 1 # ensure page change occurs before the accept_alert block exits
     end
-    expect(@session).to have_current_path('/with_html')
+    expect(@session).to have_current_path('/with_html', wait: 5)
   end
 
   context 'with an asynchronous alert' do

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+Capybara::SpecHelper.spec '#active_element', requires: [:active_element] do
+  it 'should return the active element' do
+    @session.visit('/form')
+    @session.send_keys(:tab)
+
+    expect(@session.active_element).to match_selector(:css, '[tabindex="1"]')
+
+    @session.send_keys(:tab)
+
+    expect(@session.active_element).to match_selector(:css, '[tabindex="2"]')
+  end
+
+  it 'should support reloading' do
+    @session.visit('/form')
+    expect(@session.active_element).to match_selector(:css, 'body')
+    @session.execute_script <<-JS
+      window.setTimeout(() => {
+        document.querySelector('#form_title').focus();
+      }, 1000)
+    JS
+    expect(@session.active_element).to match_selector(:css, 'body', wait: false)
+    expect(@session.active_element).to match_selector(:css, '#form_title', wait: 2)
+  end
+
+  it 'should return a Capybara::Element' do
+    @session.visit('/form')
+    expect(@session.active_element).to be_a Capybara::Node::Element
+  end
+end

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

@@ -31,7 +31,7 @@ Capybara::SpecHelper.spec '#all' do
   it 'should accept an XPath instance', :exact_false do
     @session.visit('/form')
     @xpath = Capybara::Selector.new(:fillable_field, config: {}, format: :xpath).call('Name')
-    expect(@xpath).to be_a(::XPath::Union)
+    expect(@xpath).to be_a(XPath::Union)
     @result = @session.all(@xpath).map(&:value)
     expect(@result).to include('Smith', 'John', 'John Smith')
   end
@@ -132,7 +132,7 @@ Capybara::SpecHelper.spec '#all' do
       it 'should use the sessions ignore_hidden_elements', psc: true do
         Capybara.ignore_hidden_elements = true
         @session.config.ignore_hidden_elements = false
-        expect(Capybara.ignore_hidden_elements).to eq(true)
+        expect(Capybara.ignore_hidden_elements).to be(true)
         expect(@session.all(:css, 'a.simple').size).to eq(2)
         @session.config.ignore_hidden_elements = true
         expect(@session.all(:css, 'a.simple').size).to eq(1)
@@ -203,19 +203,15 @@ Capybara::SpecHelper.spec '#all' do
         expect { @session.all(:css, 'h1, p', between: 0..3) }.to raise_error(Capybara::ExpectationNotMet)
       end
 
-      eval <<~TEST, binding, __FILE__, __LINE__ + 1 if RUBY_VERSION.to_f > 2.5
-        it'treats an endless range as minimum' do
-          expect { @session.all(:css, 'h1, p', between: 2..) }.not_to raise_error
-          expect { @session.all(:css, 'h1, p', between: 5..) }.to raise_error(Capybara::ExpectationNotMet)
-        end
-      TEST
+      it 'treats an endless range as minimum' do
+        expect { @session.all(:css, 'h1, p', between: 2..) }.not_to raise_error
+        expect { @session.all(:css, 'h1, p', between: 5..) }.to raise_error(Capybara::ExpectationNotMet)
+      end
 
-      eval <<~TEST, binding, __FILE__, __LINE__ + 1 if RUBY_VERSION.to_f > 2.6
-        it'treats a beginless range as maximum' do
-          expect { @session.all(:css, 'h1, p', between: ..7) }.not_to raise_error
-          expect { @session.all(:css, 'h1, p', between: ..3) }.to raise_error(Capybara::ExpectationNotMet)
-        end
-      TEST
+      it 'treats a beginless range as maximum' do
+        expect { @session.all(:css, 'h1, p', between: ..7) }.not_to raise_error
+        expect { @session.all(:css, 'h1, p', between: ..3) }.to raise_error(Capybara::ExpectationNotMet)
+      end
     end
 
     context 'with multiple count filters' do