capybara 3.30.0 → 3.35.3

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

@@ -18,7 +18,7 @@ class Capybara::Selenium::EdgeNode < Capybara::Selenium::Node
     # In Chrome 75+ files are appended (due to WebDriver spec - why?) so we have to clear here if its multiple and already set
     if chrome_edge?
       driver.execute_script(<<~JS, self)
-        if (arguments[0].multiple && (arguments[0].files.length > 0)){
+        if (arguments[0].multiple && arguments[0].files.length){
           arguments[0].value = null;
         }
       JS

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

@@ -26,7 +26,7 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
   def set_file(value) # rubocop:disable Naming/AccessorMethodName
     # By default files are appended so we have to clear here if its multiple and already set
     driver.execute_script(<<~JS, self)
-      if (arguments[0].multiple && (arguments[0].files.length > 0)){
+      if (arguments[0].multiple && arguments[0].files.length){
         arguments[0].value = null;
       }
     JS
@@ -40,11 +40,16 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
     path_names.each { |path| native.send_keys(path) }
   end
 
+  def focused?
+    driver.evaluate_script('arguments[0] == document.activeElement', self)
+  end
+
   def send_keys(*args)
     # https://github.com/mozilla/geckodriver/issues/846
-    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none? { |arg| arg.is_a? Array }
+    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none?(Array)
+
+    native.click unless focused?
 
-    native.click
     _send_keys(args).perform
   end
 
@@ -85,7 +90,7 @@ private
     (driver.options[:native_displayed] != false) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']
   end
 
-  def click_with_options(click_options)
+  def perform_with_options(click_options)
     # Firefox/marionette has an issue clicking with offset near viewport edge
     # scroll element to middle just in case
     scroll_to_center if click_options.coords?

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

@@ -43,7 +43,7 @@ class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
     return '' unless visible?
 
     vis_text = driver.execute_script('return arguments[0].innerText', self)
-    vis_text.gsub(/\ +/, ' ')
+    vis_text.squeeze(' ')
             .gsub(/[\ \n]*\n[\ \n]*/, "\n")
             .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
             .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')

data/lib/capybara/selenium/patches/action_pauser.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module ActionPauser
+  def initialize(mouse, keyboard)
+    super
+    @devices[:pauser] = Pauser.new
+  end
+
+  def pause(duration)
+    @actions << [:pauser, :pause, [duration]]
+    self
+  end
+
+  class Pauser
+    def pause(duration)
+      sleep duration
+    end
+  end
+
+  private_constant :Pauser
+end
+
+if defined?(::Selenium::WebDriver::VERSION) && (::Selenium::WebDriver::VERSION.to_f < 4) &&
+   defined?(::Selenium::WebDriver::ActionBuilder)
+  ::Selenium::WebDriver::ActionBuilder.prepend(ActionPauser)
+end

data/lib/capybara/selenium/patches/atoms.rb

@@ -6,10 +6,10 @@ private
   def read_atom(function)
     @atoms ||= Hash.new do |hash, key|
       hash[key] = begin
-                    File.read(File.expand_path("../../atoms/#{key}.min.js", __FILE__))
-                  rescue Errno::ENOENT
-                    super
-                  end
+        File.read(File.expand_path("../../atoms/#{key}.min.js", __FILE__))
+      rescue Errno::ENOENT
+        super
+      end
     end
     @atoms[function]
   end

data/lib/capybara/selenium/patches/logs.rb

@@ -27,17 +27,15 @@ module Capybara
 
       def log(type)
         data = begin
-                 execute :get_log, {}, type: type.to_s
-               rescue ::Selenium::WebDriver::Error::UnknownCommandError
-                 execute :get_log_legacy, {}, type: type.to_s
-               end
+          execute :get_log, {}, type: type.to_s
+        rescue ::Selenium::WebDriver::Error::UnknownCommandError
+          execute :get_log_legacy, {}, type: type.to_s
+        end
 
         Array(data).map do |l|
-          begin
-            ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
-          rescue KeyError
-            next
-          end
+          ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')
+        rescue KeyError
+          next
         end
       rescue ::Selenium::WebDriver::Error::UnknownCommandError
         raise NotImplementedError, LOG_MSG

data/lib/capybara/server/animation_disabler.rb

@@ -40,16 +40,21 @@ module Capybara
       end
 
       def insert_disable(html)
-        html.sub(%r{(</head>)}, disable_markup + '\\1')
+        html.sub(%r{(</body>)}, "#{disable_markup}\\1")
       end
 
       DISABLE_MARKUP_TEMPLATE = <<~HTML
-        <script defer>(typeof jQuery !== 'undefined') && (jQuery.fx.off = true);</script>
+        <script>
+        //<![CDATA[
+          (typeof jQuery !== 'undefined') && (jQuery.fx.off = true);
+        //]]>
+        </script>
         <style>
-           %<selector>s, %<selector>s::before, %<selector>s::after {
+          %<selector>s, %<selector>s::before, %<selector>s::after {
              transition: none !important;
              animation-duration: 0s !important;
              animation-delay: 0s !important;
+             scroll-behavior: auto !important;
           }
         </style>
       HTML

data/lib/capybara/server/middleware.rb

@@ -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.rb

@@ -58,7 +58,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 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 +97,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)
@@ -192,7 +192,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 +303,14 @@ 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
+
     ##
     #
     # Executes the given block within the context of a node. {#within} takes the
@@ -338,8 +346,8 @@ module Capybara
     #
     # @raise  [Capybara::ElementNotFound]      If the scope can't be found before time expires
     #
-    def within(*args)
-      new_scope = args.first.respond_to?(:to_capybara_node) ? args.first.to_capybara_node : find(*args)
+    def within(*args, **kw_args)
+      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?
@@ -355,8 +363,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 +373,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
 
     ##
@@ -398,8 +406,9 @@ module Capybara
         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) }
+          if scopes.slice(idx..-1).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
@@ -423,8 +432,8 @@ module Capybara
     #   @param [String] locator   The locator for the given selector kind.  For :frame this is the name/id of a frame/iframe element
     # @overload within_frame(index)
     #   @param [Integer] index         index of a frame (0 based)
-    def within_frame(*args)
-      switch_to_frame(_find_frame(*args))
+    def within_frame(*args, **kw_args)
+      switch_to_frame(_find_frame(*args, **kw_args))
       begin
         yield if block_given?
       ensure
@@ -488,8 +497,8 @@ 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 '\
@@ -738,7 +747,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,15 +755,32 @@ module Capybara
     end
 
     NODE_METHODS.each do |method|
-      define_method method do |*args, &block|
-        @touched = true
-        current_scope.send(method, *args, &block)
+      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|
+          @touched = true
+          current_scope.send(method, *args, &block)
+        end
       end
     end
 
     DOCUMENT_METHODS.each do |method|
-      define_method method do |*args, &block|
-        document.send(method, *args, &block)
+      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)
+        end
       end
     end
 
@@ -771,7 +797,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
@@ -781,7 +807,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
 
@@ -873,16 +899,14 @@ module Capybara
       uri.port ||= @server.port if @server && config.always_include_port
     end
 
-    def _find_frame(*args)
-      return find(:frame) if args.length.zero?
-
+    def _find_frame(*args, **kw_args)
       case args[0]
       when Capybara::Node::Element
         args[0]
-      when String, Hash
-        find(:frame, *args)
+      when String, nil
+        find(:frame, *args, **kw_args)
       when Symbol
-        find(*args)
+        find(*args, **kw_args)
       when Integer
         idx = args[0]
         all(:frame, minimum: idx + 1)[idx]

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].freeze
 
     attr_accessor(*OPTIONS)
 
@@ -37,6 +37,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

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/spec/public/test.js

@@ -1,15 +1,40 @@
 var activeRequests = 0;
 $(function() {
   $('#change').text('I changed it');
-  $('#drag, #drag_scroll, #drag_link').draggable();
+  $('#drag, #drag_scroll, #drag_link').draggable({
+    start: function(event, ui){
+      $(document.body).append(
+        "<div class='drag_start'>Dragged!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "") +
+          "</div>"
+      );
+    }
+  });
   $('#drop, #drop_scroll').droppable({
     tolerance: 'touch',
     drop: function(event, ui) {
       ui.draggable.remove();
-      $(this).html('Dropped!');
+      $(this).html(
+        "Dropped!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "")
+      );
     }
   });
   $('#drag_html5, #drag_html5_scroll').on('dragstart', function(ev){
+    $(document.body).append(
+        "<div class='drag_start'>HTML5 Dragged!" +
+          (event.altKey ? "-alt" : "") +
+          (event.ctrlKey ? "-ctrl" : "") +
+          (event.metaKey ? "-meta" : "") +
+          (event.shiftKey ? "-shift" : "") +
+          "</div>"
+    );
     ev.originalEvent.dataTransfer.setData("text", ev.target.id);
   });
   $('#drag_html5, #drag_html5_scroll').on('dragend', function(ev){
@@ -38,10 +63,19 @@ $(function() {
           $(this).append('HTML5 Dropped file: ' + file.name);
         } else {
           var _this = this;
-          var callback = (function(type){
-            return function(s){
-              $(_this).append('HTML5 Dropped string: ' + type + ' ' + s)
-            }
+          var callback = (function(type) {
+            return function(s) {
+              $(_this).append(
+                "HTML5 Dropped string: " +
+                  type +
+                  " " +
+                  s +
+                  (ev.altKey ? "-alt" : "") +
+                  (ev.ctrlKey ? "-ctrl" : "") +
+                  (ev.metaKey ? "-meta" : "") +
+                  (ev.shiftKey ? "-shift" : "")
+              );
+            };
           })(item.type);
           item.getAsString(callback);
         }
@@ -74,6 +108,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() {
@@ -119,6 +160,7 @@ $(function() {
   });
   $('#click-test').on({
     click: function(e) {
+      window.click_delay = ((new Date().getTime()) - window.mouse_down_time)/1000.0;
       var desc = "";
       if (e.altKey) desc += 'alt ';
       if (e.ctrlKey) desc += 'control ';
@@ -145,6 +187,16 @@ $(function() {
       if (e.shiftKey) desc += 'shift ';
       var pos = this.getBoundingClientRect();
       $(this).after('<a id="has-been-right-clicked" href="#">Has been ' + desc + 'right clicked at ' + (e.clientX - pos.left) + ',' + (e.clientY - pos.top) + '</a>');
+    },
+    mousedown: function(e) {
+      window.click_delay = undefined;
+      window.right_click_delay = undefined;
+      window.mouse_down_time = new Date().getTime();
+    },
+    mouseup: function(e) {
+      if (e.button == 2){
+        window.right_click_delay = ((new Date().getTime()) - window.mouse_down_time)/1000.0;
+      }
     }
   });
   $('#open-alert').click(function() {
@@ -219,5 +271,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);
 });