capybara 3.33.0 → 3.34.0

data/lib/capybara/selector/definition/element.rb

@@ -18,7 +18,8 @@ Capybara.add_selector(:element, locator_type: [String, Symbol]) do
   end
 
   describe_expression_filters do |**options|
-    booleans, values = options.partition { |_k, v| [true, false].include? v }.map(&:to_h)
+    boolean_values = [true, false]
+    booleans, values = options.partition { |_k, v| boolean_values.include? v }.map(&:to_h)
     desc = describe_all_expression_filters(**values)
     desc + booleans.map do |k, v|
       v ? " with #{k} attribute" : "without #{k} attribute"

data/lib/capybara/selector/definition/label.rb

@@ -53,7 +53,7 @@ Capybara.add_selector(:label, locator_type: [String, Symbol]) do
     end
   end
   describe_node_filters do |**options|
-    " for element #{options[:for]}" if options[:for]&.is_a?(Capybara::Node::Element)
+    " for element #{options[:for]}" if options[:for].is_a?(Capybara::Node::Element)
   end
 
   def labelable_elements

data/lib/capybara/selector/definition/select.rb

@@ -33,7 +33,7 @@ Capybara.add_selector(:select, locator_type: [String, Symbol]) do
 
   expression_filter(:with_options) do |expr, options|
     options.inject(expr) do |xpath, option|
-      xpath[expression_for(:option, option)]
+      xpath.where(expression_for(:option, option))
     end
   end
 

data/lib/capybara/selector/definition/table_row.rb

@@ -14,7 +14,7 @@ Capybara.add_selector(:table_row, locator_type: [Array, Hash]) do
     else
       initial_td = XPath.descendant(:td)[XPath.string.n.is(locator.shift)]
       tds = locator.reverse.map { |cell| XPath.following_sibling(:td)[XPath.string.n.is(cell)] }
-                   .reduce { |xp, cell| xp[cell] }
+                   .reduce { |xp, cell| xp.where(cell) }
       xpath[initial_td[tds]]
     end
   end

data/lib/capybara/selector/filter_set.rb

@@ -12,7 +12,7 @@ module Capybara
         @node_filters = {}
         @expression_filters = {}
         @descriptions = Hash.new { |hsh, key| hsh[key] = [] }
-        instance_eval(&block)
+        instance_eval(&block) if block
       end
 
       def node_filter(names, *types, **options, &block)
@@ -49,7 +49,7 @@ module Capybara
       end
 
       def descriptions
-        warn 'DEPRECATED: FilterSet#descriptions is deprecated without replacement'
+        Capybara::Helpers.warn 'DEPRECATED: FilterSet#descriptions is deprecated without replacement'
         [undeclared_descriptions, node_filter_descriptions, expression_filter_descriptions].flatten
       end
 

data/lib/capybara/selector/selector.rb

@@ -132,7 +132,11 @@ module Capybara
       attr_matchers |= XPath.attr(test_id) == locator if test_id
 
       locate_xpath = locate_xpath[attr_matchers]
-      locate_xpath + XPath.descendant(:label)[XPath.string.n.is(locator)].descendant(xpath)
+      locate_xpath + locate_label(locator).descendant(xpath)
+    end
+
+    def locate_label(locator)
+      XPath.descendant(:label)[XPath.string.n.is(locator)]
     end
 
     def find_by_attr(attribute, value)

data/lib/capybara/selenium/driver.rb

@@ -21,11 +21,28 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
       require 'capybara/selenium/patches/atoms'
       require 'capybara/selenium/patches/is_displayed'
       require 'capybara/selenium/patches/action_pauser'
-      if Gem.loaded_specs['selenium-webdriver'].version < Gem::Version.new('3.5.0')
+
+      # Look up the version of `selenium-webdriver` to
+      # see if it's a version we support.
+      #
+      # By default, we use Gem.loaded_specs to determine
+      # the version number. However, in some cases, such
+      # as when loading `selenium-webdriver` outside of
+      # Rubygems, we fall back to referencing
+      # Selenium::WebDriver::VERSION. Ideally we'd
+      # use the constant in all cases, but earlier versions
+      # of `selenium-webdriver` didn't provide the constant.
+      selenium_webdriver_version =
+        if Gem.loaded_specs['selenium-webdriver']
+          Gem.loaded_specs['selenium-webdriver'].version
+        else
+          Gem::Version.new(Selenium::WebDriver::VERSION)
+        end
+      if selenium_webdriver_version < Gem::Version.new('3.5.0')
         warn "Warning: You're using an unsupported version of selenium-webdriver, please upgrade."
       end
     rescue LoadError => e
-      raise e unless e.message.match?(/selenium-webdriver/)
+      raise e unless e.message.include?('selenium-webdriver')
 
       raise LoadError, "Capybara's selenium driver is unable to load `selenium-webdriver`, please install the gem and add `gem 'selenium-webdriver'` to your Gemfile if you are using bundler."
     end
@@ -58,6 +75,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def initialize(app, **options)
+    super()
     self.class.load_selenium
     @app = app
     @browser = nil
@@ -86,7 +104,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   def html
     browser.page_source
   rescue Selenium::WebDriver::Error::JavascriptError => e
-    raise unless e.message.match?(/documentElement is null/)
+    raise unless e.message.include?('documentElement is null')
   end
 
   def title
@@ -115,6 +133,10 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     unwrap_script_result(result)
   end
 
+  def send_keys(*args)
+    active_element.send_keys(*args)
+  end
+
   def save_screenshot(path, **_options)
     browser.save_screenshot(path)
   end
@@ -437,6 +459,10 @@ private
     browser
   end
 
+  def active_element
+    browser.switch_to.active_element
+  end
+
   def build_node(native_node, initial_cache = {})
     ::Capybara::Selenium::Node.new(self, native_node, initial_cache)
   end

data/lib/capybara/selenium/driver_specializations/chrome_driver.rb

@@ -7,7 +7,7 @@ module Capybara::Selenium::Driver::ChromeDriver
   def self.extended(base)
     bridge = base.send(:bridge)
     bridge.extend Capybara::Selenium::ChromeLogs unless bridge.respond_to?(:log)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
     base.options[:native_displayed] = false if base.options[:native_displayed].nil?
   end
 
@@ -15,7 +15,7 @@ module Capybara::Selenium::Driver::ChromeDriver
     within_given_window(handle) do
       super
     rescue NoMethodError => e
-      raise unless e.message.match?(/full_screen_window/)
+      raise unless e.message.include?('full_screen_window')
 
       result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
       result['value']
@@ -25,7 +25,7 @@ module Capybara::Selenium::Driver::ChromeDriver
   def resize_window_to(handle, width, height)
     super
   rescue Selenium::WebDriver::Error::UnknownError => e
-    raise unless e.message.match?(/failed to change window state/)
+    raise unless e.message.include?('failed to change window state')
 
     # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen
     # and raises unnecessary error. Wait a bit and try again.

data/lib/capybara/selenium/driver_specializations/edge_driver.rb

@@ -5,7 +5,7 @@ require 'capybara/selenium/nodes/edge_node'
 module Capybara::Selenium::Driver::EdgeDriver
   def self.extended(base)
     bridge = base.send(:bridge)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
     base.options[:native_displayed] = false if base.options[:native_displayed].nil?
   end
 
@@ -15,7 +15,7 @@ module Capybara::Selenium::Driver::EdgeDriver
     within_given_window(handle) do
       super
     rescue NoMethodError => e
-      raise unless e.message.match?(/full_screen_window/)
+      raise unless e.message.include?('full_screen_window')
 
       result = bridge.http.call(:post, "session/#{bridge.session_id}/window/fullscreen", {})
       result['value']
@@ -25,7 +25,7 @@ module Capybara::Selenium::Driver::EdgeDriver
   def resize_window_to(handle, width, height)
     super
   rescue Selenium::WebDriver::Error::UnknownError => e
-    raise unless e.message.match?(/failed to change window state/)
+    raise unless e.message.include?('failed to change window state')
 
     # Chromedriver doesn't wait long enough for state to change when coming out of fullscreen
     # and raises unnecessary error. Wait a bit and try again.

data/lib/capybara/selenium/driver_specializations/firefox_driver.rb

@@ -6,7 +6,7 @@ module Capybara::Selenium::Driver::FirefoxDriver
   def self.extended(driver)
     driver.extend Capybara::Selenium::Driver::W3CFirefoxDriver if w3c?(driver)
     bridge = driver.send(:bridge)
-    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.commands(:is_element_displayed)
+    bridge.extend Capybara::Selenium::IsDisplayed unless bridge.send(:commands, :is_element_displayed)
   end
 
   def self.w3c?(driver)

data/lib/capybara/selenium/extensions/find.rb

@@ -100,9 +100,9 @@ module Capybara
       def is_displayed_atom # rubocop:disable Naming/PredicateName
         @@is_displayed_atom ||= begin # rubocop:disable Style/ClassVars
           browser.send(:bridge).send(:read_atom, 'isDisplayed')
-                                rescue StandardError
-                                  # If the atom doesn't exist or other error
-                                  ''
+        rescue StandardError
+          # If the atom doesn't exist or other error
+          ''
         end
       end
     end

data/lib/capybara/selenium/extensions/scroll.rb

@@ -45,20 +45,18 @@ module Capybara
         JS
       end
 
+      SCROLL_POSITIONS = {
+        top: '0',
+        bottom: 'arguments[0].scrollHeight',
+        center: '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'
+      }.freeze
+
       def scroll_to_location(location)
-        scroll_y = case location
-        when :top
-          '0'
-        when :bottom
-          'arguments[0].scrollHeight'
-        when :center
-          '(arguments[0].scrollHeight - arguments[0].clientHeight)/2'
-        end
         driver.execute_script <<~JS, self
           if (arguments[0].scrollTo){
-            arguments[0].scrollTo(0, #{scroll_y});
+            arguments[0].scrollTo(0, #{SCROLL_POSITIONS[location]});
           } else {
-            arguments[0].scrollTop = #{scroll_y};
+            arguments[0].scrollTop = #{SCROLL_POSITIONS[location]};
           }
         JS
       end

data/lib/capybara/selenium/node.rb

@@ -120,7 +120,7 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     end
   rescue StandardError => e
     if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
-       e.message.match?(/Other element would receive the click/)
+       e.message.include?('Other element would receive the click')
       scroll_to_center
     end
 
@@ -464,8 +464,8 @@ private
     end
   end
 
-  def each_key(keys)
-    normalize_keys(keys).each { |key| yield(key) }
+  def each_key(keys, &block)
+    normalize_keys(keys).each(&block)
   end
 
   def find_context
@@ -493,6 +493,9 @@ private
       var xpath = '';
     	var pos, tempitem2;
 
+      if (el.getRootNode && el.getRootNode() instanceof ShadowRoot) {
+        return "(: Shadow DOM element - no XPath :)";
+      };
       while(el !== xml.documentElement) {
         pos = 0;
         tempitem2 = el;

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

@@ -42,7 +42,7 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     raise
   rescue ::Selenium::WebDriver::Error::WebDriverError => e
     # chromedriver 74 (at least on mac) raises the wrong error for this
-    if e.message.match?(/element click intercepted/)
+    if e.message.include?('element click intercepted')
       raise ::Selenium::WebDriver::Error::ElementClickInterceptedError, e.message
     end
 
@@ -73,6 +73,24 @@ class Capybara::Selenium::ChromeNode < Capybara::Selenium::Node
     end
   end
 
+  def send_keys(*args)
+    args.chunk { |inp| inp.is_a?(String) && inp.match?(/\p{Emoji Presentation}/) }
+        .each do |contains_emoji, inputs|
+      if contains_emoji
+        inputs.join.grapheme_clusters.chunk { |gc| gc.match?(/\p{Emoji Presentation}/) }
+              .each do |emoji, clusters|
+          if emoji
+            driver.send(:execute_cdp, 'Input.insertText', text: clusters.join)
+          else
+            super(clusters.join)
+          end
+        end
+      else
+        super(*inputs)
+      end
+    end
+  end
+
 private
 
   def perform_legacy_drag(element, drop_modifiers)
@@ -92,7 +110,7 @@ private
     end
   end
 
-  def browser_version(to_float = true)
+  def browser_version(to_float: true)
     caps = capabilities
     ver = (caps[:browser_version] || caps[:version])
     ver = ver.to_f if to_float

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/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,10 +27,10 @@ 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|
           ::Selenium::WebDriver::LogEntry.new l.fetch('level', 'UNKNOWN'), l.fetch('timestamp'), l.fetch('message')

data/lib/capybara/server/animation_disabler.rb

@@ -40,16 +40,17 @@ module Capybara
       end
 
       def insert_disable(html)
-        html.sub(%r{(</head>)}, disable_markup + '\\1')
+        html.sub(%r{(</head>)}, "#{disable_markup}\\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 {
+          %<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
@@ -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
@@ -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
@@ -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
@@ -788,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
@@ -798,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