capybara 3.12.0 → 3.13.0

data/lib/capybara/selector/selector.rb

@@ -35,6 +35,7 @@ module Capybara
   #       * :unchecked (Boolean) — Match unchecked fields?
   #       * :disabled (Boolean) — Match disabled field?
   #       * :multiple (Boolean) — Match fields that accept multiple values
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:fieldset** - Select fieldset elements
   #     * Locator: Matches id or contents of wrapped legend
@@ -42,6 +43,7 @@ module Capybara
   #       * :id (String, Regexp, XPath::Expression) — Matches id attribute
   #       * :legend (String) — Matches contents of wrapped legend
   #       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:link** - Find links ( <a> elements with an href attribute )
   #     * Locator: Matches the id or title attributes, or the string content of the link, or the alt attribute of a contained img element
@@ -51,6 +53,7 @@ module Capybara
   #       * :alt (String) — Matches the alt attribute of a contained img element
   #       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
   #       * :href (String, Regexp, nil) — Matches the normalized href of the link, if nil will find <a> elements with no href attribute
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:button** - Find buttons ( input [of type submit, reset, image, button] or button elements )
   #     * Locator: Matches the id, Capybara.test_id attribute, value, or title attributes, string content of a button, or the alt attribute of an image type button or of a descendant image of a button
@@ -60,6 +63,7 @@ module Capybara
   #       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
   #       * :value (String) — Matches the value of an input button
   #       * :type
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:link_or_button** - Find links or buttons
   #     * Locator: See :link and :button selectors
@@ -75,6 +79,7 @@ module Capybara
   #       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
   #       * :disabled (Boolean) — Match disabled field?
   #       * :multiple (Boolean) — Match fields that accept multiple values
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:radio_button** - Find radio buttons
   #     * Locator: Match id, Capybara.test_id attribute, name, or associated label text
@@ -86,6 +91,7 @@ module Capybara
   #       * :unchecked (Boolean) — Match unchecked fields?
   #       * :disabled (Boolean) — Match disabled field?
   #       * :option (String) — Match the value
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:checkbox** - Find checkboxes
   #     * Locator: Match id, Capybara.test_id attribute, name, or associated label text
@@ -97,6 +103,7 @@ module Capybara
   #       * *:unchecked (Boolean) — Match unchecked fields?
   #       * *:disabled (Boolean) — Match disabled field?
   #       * *:option (String) — Match the value
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:select** - Find select elements
   #     * Locator: Match id, Capybara.test_id attribute, name, placeholder, or associated label text
@@ -111,6 +118,7 @@ module Capybara
   #       * :with_options (Array<String>) — Partial match options
   #       * :selected (String, Array<String>) — Match the selection(s)
   #       * :with_selected (String, Array<String>) — Partial match the selection(s)
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:option** - Find option elements
   #     * Locator: Match text of option
@@ -136,6 +144,7 @@ module Capybara
   #       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
   #       * :disabled (Boolean) — Match disabled field?
   #       * :multiple (Boolean) — Match field that accepts multiple values
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:label** - Find label elements
   #     * Locator: Match id or text contents
@@ -148,6 +157,7 @@ module Capybara
   #       * :id (String, Regexp, XPath::Expression) — Match id attribute of table
   #       * :caption (String) — Match text of associated caption
   #       * :class ((String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:frame** - Find frame/iframe elements
   #     * Locator: Match id or name
@@ -155,6 +165,7 @@ module Capybara
   #       * :id (String, Regexp, XPath::Expression) — Match id attribute
   #       * :name (String) — Match name attribute
   #       * :class (String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
+  #       * :style (String, Regexp, Hash)
   #
   #   * **:element**
   #     * Locator: Type of element ('div', 'a', etc) - if not specified defaults to '*'
@@ -173,8 +184,8 @@ module Capybara
         all.fetch(name.to_sym) { |sel_type| raise ArgumentError, "Unknown selector type (:#{sel_type})" }
       end
 
-      def add(name, &block)
-        all[name.to_sym] = Capybara::Selector.new(name.to_sym, &block)
+      def add(name, **options, &block)
+        all[name.to_sym] = Capybara::Selector.new(name.to_sym, **options, &block)
       end
 
       def update(name, &block)
@@ -190,7 +201,7 @@ module Capybara
       end
     end
 
-    def initialize(name, &block)
+    def initialize(name, locator_type: nil, raw_locator: false, &block)
       @name = name
       @filter_set = FilterSet.add(name) {}
       @match = nil
@@ -201,6 +212,8 @@ module Capybara
       @expression_filters = {}
       @locator_filter = nil
       @default_visibility = nil
+      @locator_type = locator_type
+      @raw_locator = raw_locator
       @config = {
         enable_aria_label: false,
         test_id: nil
@@ -301,6 +314,8 @@ module Capybara
       else
         warn 'Selector has no format'
       end
+    ensure
+      warn "Locator #{locator.inspect} must #{locator_description}. This will raise an error in a future version of Capybara." unless locator_valid?(locator)
     end
 
     ##
@@ -428,8 +443,37 @@ module Capybara
       Thread.current["capybara_#{object_id}_errors"] = nil
     end
 
+    # @api private
+    def raw_locator?
+      !!@raw_locator
+    end
+
   private
 
+    def locator_types
+      return nil unless @locator_type
+
+      Array(@locator_type)
+    end
+
+    def locator_valid?(locator)
+      return true unless locator && locator_types
+
+      locator_types&.any? do |type_or_method|
+        type_or_method.is_a?(Symbol) ? locator.respond_to?(type_or_method) : type_or_method === locator # rubocop:disable Style/CaseEquality
+      end
+    end
+
+    def locator_description
+      locator_types.group_by { |lt| lt.is_a? Symbol }.map do |symbol, types_or_methods|
+        if symbol
+          "respond to #{types_or_methods.join(' or ')}"
+        else
+          "be an instance of #{types_or_methods.join(' or ')}"
+        end
+      end.join(' or ')
+    end
+
     def errors
       Thread.current["capybara_#{object_id}_errors"] || []
     end

data/lib/capybara/selenium/driver.rb

@@ -4,6 +4,8 @@ require 'uri'
 require 'English'
 
 class Capybara::Selenium::Driver < Capybara::Driver::Base
+  include Capybara::Selenium::Find
+
   DEFAULT_OPTIONS = {
     browser: :firefox,
     clear_local_storage: nil,
@@ -73,14 +75,6 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     browser.current_url
   end
 
-  def find_xpath(selector)
-    browser.find_elements(:xpath, selector).map(&method(:build_node))
-  end
-
-  def find_css(selector)
-    browser.find_elements(:css, selector).map(&method(:build_node))
-  end
-
   def wait?; true; end
   def needs_server?; true; end
 
@@ -348,8 +342,12 @@ private
     end
   end
 
-  def build_node(native_node)
-    ::Capybara::Selenium::Node.new(self, native_node)
+  def find_context
+    browser
+  end
+
+  def build_node(native_node, initial_cache = {})
+    ::Capybara::Selenium::Node.new(self, native_node, initial_cache)
   end
 
   def specialize_driver(sel_driver)
@@ -359,6 +357,8 @@ private
     when :firefox
       require 'capybara/selenium/patches/pause_duration_fix' if pause_broken?(sel_driver)
       extend FirefoxDriver if sel_driver.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
+    when :ie, :internet_explorer
+      extend InternetExplorerDriver
     end
   end
 
@@ -385,7 +385,7 @@ private
     until find_xpath('/html/body/*').empty?
       raise Capybara::ExpectationNotMet, 'Timed out waiting for Selenium session reset' if timer.expired?
 
-      sleep 0.05
+      sleep 0.01
     end
   end
 
@@ -402,3 +402,4 @@ end
 
 require 'capybara/selenium/driver_specializations/chrome_driver'
 require 'capybara/selenium/driver_specializations/firefox_driver'
+require 'capybara/selenium/driver_specializations/internet_explorer_driver'

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

@@ -23,7 +23,7 @@ module Capybara::Selenium::Driver::ChromeDriver
 
     # 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.
-    sleep 0.5
+    sleep 0.25
     super
   end
 
@@ -51,8 +51,8 @@ private
     result['value']
   end
 
-  def build_node(native_node)
-    ::Capybara::Selenium::ChromeNode.new(self, native_node)
+  def build_node(native_node, initial_cache = {})
+    ::Capybara::Selenium::ChromeNode.new(self, native_node, initial_cache)
   end
 
   def bridge

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

@@ -44,7 +44,7 @@ module Capybara::Selenium::Driver::FirefoxDriver
 
 private
 
-  def build_node(native_node)
-    ::Capybara::Selenium::FirefoxNode.new(self, native_node)
+  def build_node(native_node, initial_cache = {})
+    ::Capybara::Selenium::FirefoxNode.new(self, native_node, initial_cache)
   end
 end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Capybara::Selenium::Driver::InternetExplorerDriver
+  def switch_to_frame(frame)
+    return super unless frame == :parent
+
+    # iedriverserver has an issue if the current frame is removed from within it
+    # so we have to move to the default_content and iterate back through the frames
+    handles = @frame_handles[current_window_handle]
+    browser.switch_to.default_content
+    handles.tap(&:pop).each { |fh| browser.switch_to.frame(fh) }
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Selenium
+    module Find
+      def find_xpath(selector, uses_visibility: false, styles: nil, **_options)
+        find_by(:xpath, selector, uses_visibility: uses_visibility, texts: [], styles: styles)
+      end
+
+      def find_css(selector, uses_visibility: false, texts: [], styles: nil, **_options)
+        find_by(:css, selector, uses_visibility: uses_visibility, texts: texts, styles: styles)
+      end
+
+    private
+
+      def find_by(format, selector, uses_visibility:, texts:, styles:)
+        els = find_context.find_elements(format, selector)
+        hints = []
+        if (els.size > 2) && !ENV['DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS']
+          els = filter_by_text(els, texts) unless texts.empty?
+
+          hints_js = +''
+          functions = []
+          if uses_visibility
+            hints_js << <<~VISIBILITY_JS
+              var vis_func = #{is_displayed_atom};
+            VISIBILITY_JS
+            functions << 'vis_func'
+          end
+
+          if styles.is_a? Hash
+            hints_js << <<~STYLE_JS
+              var style_func = function(el){
+                var el_styles = window.getComputedStyle(el);
+                return #{styles.keys.map(&:to_s)}.reduce(function(res, style){
+                  res[style] = el_styles[style];
+                  return res;
+                }, {});
+              };
+            STYLE_JS
+            functions << 'style_func'
+          end
+
+          unless functions.empty?
+            hints_js << <<~EACH_JS
+              return arguments[0].map(function(el){
+                return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });              });
+            EACH_JS
+
+            hints = es_context.execute_script hints_js, els
+            hints.map! do |results|
+              result = {}
+              result[:style] = results.pop if styles.is_a? Hash
+              result[:visible] = results.pop if uses_visibility
+              result
+            end
+          end
+        end
+        els.map.with_index { |el, idx| build_node(el, hints[idx] || {}) }
+      end
+
+      def filter_by_text(elements, texts)
+        es_context.execute_script <<~JS, elements, texts
+          var texts = arguments[1]
+          return arguments[0].filter(function(el){
+            var content = el.textContent.toLowerCase();
+            return texts.every(function(txt){ return content.indexOf(txt.toLowerCase()) != -1 });
+          })
+        JS
+      end
+
+      def es_context
+        respond_to?(:execute_script) ? self : driver
+      end
+
+      def is_displayed_atom # rubocop:disable Naming/PredicateName
+        @@is_displayed_atom ||= browser.send(:bridge).send(:read_atom, 'isDisplayed')
+      end
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+# frozen_string_literal: true
+
+module Capybara
+  module Selenium
+    module Scroll
+      def scroll_by(x, y)
+        driver.execute_script <<~JS, self, x, y
+          var el = arguments[0];
+          if (el.scrollBy){
+            el.scrollBy(arguments[1], arguments[2]);
+          } else {
+            el.scrollTop = el.scrollTop + arguments[2];
+            el.scrollLeft = el.scrollLeft + arguments[1];
+          }
+        JS
+      end
+
+      def scroll_to(element, location, position = nil)
+        # location, element = element, nil if element.is_a? Symbol
+        if element.is_a? Capybara::Selenium::Node
+          scroll_element_to_location(element, location)
+        elsif location.is_a? Symbol
+          scroll_to_location(location)
+        else
+          scroll_to_coords(*position)
+        end
+        self
+      end
+
+    private
+
+      def scroll_element_to_location(element, location)
+        scroll_opts = case location
+        when :top
+          'true'
+        when :bottom
+          'false'
+        when :center
+          "{behavior: 'instant', block: 'center'}"
+        else
+          raise ArgumentError, "Invalid scroll_to location: #{location}"
+        end
+        driver.execute_script <<~JS, element
+          arguments[0].scrollIntoView(#{scroll_opts})
+        JS
+      end
+
+      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});
+          } else {
+            arguments[0].scrollTop = #{scroll_y};
+          }
+        JS
+      end
+
+      def scroll_to_coords(x, y)
+        driver.execute_script <<~JS, self, x, y
+          if (arguments[0].scrollTo){
+            arguments[0].scrollTo(arguments[1], arguments[2]);
+          } else {
+            arguments[0].scrollTop = arguments[2];
+            arguments[0].scrollLeft = arguments[1];
+          }
+        JS
+      end
+    end
+  end
+end

data/lib/capybara/selenium/node.rb

@@ -1,13 +1,20 @@
 # frozen_string_literal: true
 
 # Selenium specific implementation of the Capybara::Driver::Node API
+
+require 'capybara/selenium/extensions/find'
+require 'capybara/selenium/extensions/scroll'
+
 class Capybara::Selenium::Node < Capybara::Driver::Node
+  include Capybara::Selenium::Find
+  include Capybara::Selenium::Scroll
+
   def visible_text
     native.text
   end
 
   def all_text
-    text = driver.execute_script('return arguments[0].textContent', self)
+    text = driver.evaluate_script('arguments[0].textContent', self)
     text.gsub(/[\u200b\u200e\u200f]/, '')
         .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
         .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
@@ -148,35 +155,12 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
     native.attribute('isContentEditable')
   end
 
-  def find_xpath(locator)
-    native.find_elements(:xpath, locator).map { |el| self.class.new(driver, el) }
-  end
-
-  def find_css(locator)
-    native.find_elements(:css, locator).map { |el| self.class.new(driver, el) }
-  end
-
   def ==(other)
     native == other.native
   end
 
   def path
-    path = find_xpath(XPath.ancestor_or_self).reverse
-
-    result = []
-    default_ns = path.last[:namespaceURI]
-    while (node = path.shift)
-      parent = path.first
-      selector = node[:tagName]
-      if node[:namespaceURI] != default_ns
-        selector = XPath.child.where((XPath.local_name == selector) & (XPath.namespace_uri == node[:namespaceURI])).to_s
-      end
-
-      selector += sibling_index(parent, node, selector) if parent
-      result.push selector
-    end
-
-    '/' + result.reverse.join('/')
+    driver.evaluate_script GET_XPATH_SCRIPT, self
   end
 
 protected
@@ -305,7 +289,7 @@ private
     # Ensure we are focused on the element
     click
 
-    script = <<-JS
+    driver.execute_script <<-JS, self
       var range = document.createRange();
       var sel = window.getSelection();
       arguments[0].focus();
@@ -313,7 +297,6 @@ private
       sel.removeAllRanges();
       sel.addRange(range);
     JS
-    driver.execute_script script, self
 
     # The action api has a speed problem but both chrome and firefox 58 raise errors
     # if we use the faster direct send_keys.  For now just send_keys to the element
@@ -341,8 +324,12 @@ private
     each_key(keys) { |key| actions.key_up(key) }
   end
 
+  def browser
+    driver.browser
+  end
+
   def browser_action
-    driver.browser.action
+    browser.action
   end
 
   def each_key(keys)
@@ -357,6 +344,43 @@ private
     end
   end
 
+  def find_context
+    native
+  end
+
+  def build_node(native_node, initial_cache = {})
+    self.class.new(driver, native_node, initial_cache)
+  end
+
+  GET_XPATH_SCRIPT = <<~'JS'
+    (function(el, xml){
+      var xpath = '';
+    	var pos, tempitem2;
+
+      while(el !== xml.documentElement) {
+        pos = 0;
+        tempitem2 = el;
+        while(tempitem2) {
+          if (tempitem2.nodeType === 1 && tempitem2.nodeName === el.nodeName) { // If it is ELEMENT_NODE of the same name
+            pos += 1;
+          }
+          tempitem2 = tempitem2.previousSibling;
+        }
+
+        if (el.namespaceURI != xml.documentElement.namespaceURI) {
+          xpath = "*[local-name()='"+el.nodeName+"' and namespace-uri()='"+(el.namespaceURI===null?'':el.namespaceURI)+"']["+pos+']'+'/'+xpath;
+        } else {
+          xpath = el.nodeName.toUpperCase()+"["+pos+"]/"+xpath;
+        }
+
+        el = el.parentNode;
+      }
+      xpath = '/'+xml.documentElement.nodeName.toUpperCase()+'/'+xpath;
+      xpath = xpath.replace(/\/$/, '');
+      return xpath;
+    })(arguments[0], document)
+  JS
+
   # SettableValue encapsulates time/date field formatting
   class SettableValue
     attr_reader :value