capybara 3.29.0 → 3.31.0

data/lib/capybara/selenium/node.rb

@@ -54,7 +54,9 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   #   :backspace => send backspace keystrokes to clear the field <br/>
   #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]
   def set(value, **options)
-    raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}" if value.is_a?(Array) && !multiple?
+    if value.is_a?(Array) && !multiple?
+      raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
+    end
 
     tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase }
     @tag_name ||= tag_name
@@ -76,11 +78,13 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
         set_datetime_local(value)
       when 'color'
         set_color(value)
+      when 'range'
+        set_range(value)
       else
-        set_text(value, options)
+        set_text(value, **options)
       end
     when 'textarea'
-      set_text(value, options)
+      set_text(value, **options)
     else
       set_content_editable(value)
     end
@@ -132,11 +136,17 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     scroll_if_needed { browser_action.move_to(native).perform }
   end
 
-  def drag_to(element, **)
+  def drag_to(element, drop_modifiers: [], **)
+    drop_modifiers = Array(drop_modifiers)
     # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary
     # which means Seleniums `drag_and_drop` is now broken - do it manually
     scroll_if_needed { browser_action.click_and_hold(native).perform }
-    element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    # element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
+    element.scroll_if_needed do
+      keys_down = modifiers_down(browser_action, drop_modifiers)
+      keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers)
+      keys_up.perform
+    end
   end
 
   def drop(*_)
@@ -202,7 +212,7 @@ protected
     JS
     begin
       driver.execute_script(script, self)
-    rescue StandardError # rubocop:disable Lint/HandleExceptions
+    rescue StandardError # rubocop:disable Lint/SuppressedException
       # Swallow error if scrollIntoView with options isn't supported
     end
   end
@@ -288,6 +298,10 @@ private
     update_value_js(value)
   end
 
+  def set_range(value) # rubocop:disable Naming/AccessorMethodName
+    update_value_js(value)
+  end
+
   def update_value_js(value)
     driver.execute_script(<<-JS, self, value)
       if (arguments[0].readOnly) { return };
@@ -373,10 +387,12 @@ private
 
   def modifiers_down(actions, keys)
     each_key(keys) { |key| actions.key_down(key) }
+    actions
   end
 
   def modifiers_up(actions, keys)
     each_key(keys) { |key| actions.key_up(key) }
+    actions
   end
 
   def browser
@@ -391,18 +407,21 @@ private
     browser.action
   end
 
-  def each_key(keys)
-    keys.each do |key|
-      key = case key
+  def normalize_keys(keys)
+    keys.map do |key|
+      case key
       when :ctrl then :control
       when :command, :cmd then :meta
       else
         key
       end
-      yield key
     end
   end
 
+  def each_key(keys)
+    normalize_keys(keys).each { |key| yield(key) }
+  end
+
   def find_context
     native
   end

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

@@ -18,14 +18,16 @@ class Capybara::Selenium::ChromeNode < 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 browser_version >= 75.0
       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
     end
     super
   rescue *file_errors => e
-    raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload" if e.message.match?(/File not found : .+\n.+/m)
+    if e.message.match?(/File not found : .+\n.+/m)
+      raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload"
+    end
 
     raise
   end
@@ -34,13 +36,15 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     html5_drop(*args)
   end
 
-  def click(*)
+  def click(*, **)
     super
   rescue ::Selenium::WebDriver::Error::ElementClickInterceptedError
     raise
   rescue ::Selenium::WebDriver::Error::WebDriverError => e
     # chromedriver 74 (at least on mac) raises the wrong error for this
-    raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message if e.message.match?(/element click intercepted/)
+    if e.message.match?(/element click intercepted/)
+      raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message
+    end
 
     raise
   end
@@ -71,9 +75,11 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
 
 private
 
-  def perform_legacy_drag(element)
+  def perform_legacy_drag(element, drop_modifiers)
     return super if chromedriver_fixed_actions_key_state? || !w3c? || element.obscured?
 
+    raise ArgumentError, 'Modifier keys are not supported while dragging in this version of Chrome.' unless drop_modifiers.empty?
+
     # W3C Chrome/chromedriver < 77 doesn't maintain mouse button state across actions API performs
     # https://bugs.chromium.org/p/chromedriver/issues/detail?id=2981
     browser_action.release.perform

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

@@ -18,14 +18,16 @@ 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
     end
     super
   rescue *file_errors => e
-    raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload" if e.message.match?(/File not found : .+\n.+/m)
+    if e.message.match?(/File not found : .+\n.+/m)
+      raise ArgumentError, "Selenium < 3.14 with remote Chrome doesn't support multiple file upload"
+    end
 
     raise
   end

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

@@ -14,7 +14,7 @@ class Capybara::Selenium::FirefoxNode < Capybara::Selenium::Node
       warn 'You are attempting to click a table row which has issues in geckodriver/marionette - '\
            'see https://github.com/mozilla/geckodriver/issues/1228. Your test should probably be '\
            'clicking on a table cell like a user would. Clicking the first cell in the row instead.'
-      return find_css('th:first-child,td:first-child')[0].click(keys, options)
+      return find_css('th:first-child,td:first-child')[0].click(keys, **options)
     end
     raise
   end
@@ -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

data/lib/capybara/server.rb

@@ -24,7 +24,9 @@ module Capybara
                    host: Capybara.server_host,
                    reportable_errors: Capybara.server_errors,
                    extra_middleware: [])
-      warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments' unless deprecated_options.empty?
+      unless deprecated_options.empty?
+        warn 'Positional arguments, other than the application, to Server#new are deprecated, please use keyword arguments'
+      end
       @app = app
       @extra_middleware = extra_middleware
       @server_thread = nil # suppress warnings
@@ -61,7 +63,7 @@ module Capybara
     def wait_for_pending_requests
       timer = Capybara::Helpers.timer(expire_in: 60)
       while pending_requests?
-        raise 'Requests did not finish in 60 seconds' if timer.expired?
+        raise "Requests did not finish in 60 seconds: #{middleware.pending_requests}" if timer.expired?
 
         sleep 0.01
       end
@@ -106,7 +108,17 @@ module Capybara
 
     def find_available_port(host)
       server = TCPServer.new(host, 0)
-      server.addr[1]
+      port = server.addr[1]
+      server.close
+
+      # Workaround issue where some platforms (mac, ???) when passed a host
+      # of '0.0.0.0' will return a port that is only available on one of the
+      # ip addresses that resolves to, but the next binding to that port requires
+      # that port to be available on all ips
+      server = TCPServer.new(host, port)
+      port
+    rescue Errno::EADDRINUSE
+      retry
     ensure
       server&.close
     end

data/lib/capybara/server/checker.rb

@@ -29,7 +29,7 @@ module Capybara
       end
 
       def https_request(&block)
-        make_request(ssl_options, &block)
+        make_request(**ssl_options, &block)
       end
 
       def make_request(**options, &block)

data/lib/capybara/server/middleware.rb

@@ -4,19 +4,25 @@ module Capybara
   class Server
     class Middleware
       class Counter
-        attr_reader :value
-
         def initialize
-          @value = 0
+          @value = []
           @mutex = Mutex.new
         end
 
-        def increment
-          @mutex.synchronize { @value += 1 }
+        def increment(uri)
+          @mutex.synchronize { @value.push(uri) }
+        end
+
+        def decrement(uri)
+          @mutex.synchronize { @value.delete_at(@value.index(uri) || @value.length) }
         end
 
-        def decrement
-          @mutex.synchronize { @value -= 1 }
+        def positive?
+          @mutex.synchronize { @value.length.positive? }
+        end
+
+        def value
+          @mutex.synchronize { @value.dup }
         end
       end
 
@@ -31,8 +37,12 @@ module Capybara
         @server_errors = server_errors
       end
 
+      def pending_requests
+        @counter.value
+      end
+
       def pending_requests?
-        @counter.value.positive?
+        @counter.positive?
       end
 
       def clear_error
@@ -43,14 +53,14 @@ module Capybara
         if env['PATH_INFO'] == '/__identify__'
           [200, {}, [@app.object_id.to_s]]
         else
-          @counter.increment
+          @counter.increment(env['REQUEST_URI'])
           begin
             @extended_app.call(env)
           rescue *@server_errors => e
             @error ||= e
             raise e
           ensure
-            @counter.decrement
+            @counter.decrement(env['REQUEST_URI'])
           end
         end
       end

data/lib/capybara/session.rb

@@ -75,7 +75,9 @@ module Capybara
     attr_accessor :synchronized
 
     def initialize(mode, app = nil)
-      raise TypeError, 'The second parameter to Session::new should be a rack app if passed.' if app && !app.respond_to?(:call)
+      if app && !app.respond_to?(:call)
+        raise TypeError, 'The second parameter to Session::new should be a rack app if passed.'
+      end
 
       @@instance_created = true # rubocop:disable Style/ClassVars
       @mode = mode
@@ -88,7 +90,7 @@ module Capybara
       @server = if config.run_server && @app && driver.needs_server?
         server_options = { port: config.server_port, host: config.server_host, reportable_errors: config.server_errors }
         server_options[:extra_middleware] = [Capybara::Server::AnimationDisabler] if config.disable_animation
-        Capybara::Server.new(@app, server_options).boot
+        Capybara::Server.new(@app, **server_options).boot
       end
       @touched = false
     end
@@ -336,8 +338,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?
@@ -421,8 +423,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
@@ -494,7 +496,7 @@ module Capybara
                                     '`within` or `within_frame` blocks.'
       end
 
-      _switch_to_window(window, options, &window_locator)
+      _switch_to_window(window, **options, &window_locator)
     end
 
     ##
@@ -528,7 +530,7 @@ module Capybara
         when Proc
           _switch_to_window { window_or_proc.call }
         else
-          raise ArgumentError('`#within_window` requires a `Capybara::Window` instance or a lambda')
+          raise ArgumentError, '`#within_window` requires a `Capybara::Window` instance or a lambda'
         end
 
         begin
@@ -721,7 +723,7 @@ module Capybara
     # @param [Hash] options   a customizable set of options
     # @return [String]        the path to which the file was saved
     def save_screenshot(path = nil, **options)
-      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, options) }
+      prepare_path(path, 'png').tap { |p_path| driver.save_screenshot(p_path, **options) }
     end
 
     ##
@@ -736,7 +738,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) } # rubocop:disable Lint/Debugger
     end
 
     def document
@@ -744,15 +746,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
 
@@ -819,11 +838,11 @@ module Capybara
     end
 
     def accept_modal(type, text_or_options, options, &blk)
-      driver.accept_modal(type, modal_options(text_or_options, options), &blk)
+      driver.accept_modal(type, **modal_options(text_or_options, **options), &blk)
     end
 
     def dismiss_modal(type, text_or_options, options, &blk)
-      driver.dismiss_modal(type, modal_options(text_or_options, options), &blk)
+      driver.dismiss_modal(type, **modal_options(text_or_options, **options), &blk)
     end
 
     def modal_options(text = nil, **options)
@@ -871,16 +890,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

@@ -79,14 +79,18 @@ module Capybara
 
     remove_method :app_host=
     def app_host=(url)
-      raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+      unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+        raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}."
+      end
 
       @app_host = url
     end
 
     remove_method :default_host=
     def default_host=(url)
-      raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+      unless url.nil? || url.match?(URI::DEFAULT_PARSER.make_regexp)
+        raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}."
+      end
 
       @default_host = url
     end