capybara 3.14.0 → 3.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f79ad67119c7cc637fcab5cbc4fe95b0d80a76c2c38182f2a6b8beb3564f8448
-  data.tar.gz: 9d5c1ca24bbc3e7f2a9c18c71c5b61a78b96d24147b21c9b0f753217d4fc2772
+  metadata.gz: 023614c44b5551f29984d882a7fb13b5ff240f589eff090cfb24c4f3a2787a47
+  data.tar.gz: c5c1cd40b59700f743325cca40efbe9fd68df776c7f16f6d351336400e86cdd4
 SHA512:
-  metadata.gz: a799dc6db1032d812bf749ca8ee8ca8b46e59e957130f80ddfb9d5c2b08fce1a543ce3a0e9c28ee2bf38470867bc6d8a64ce6ed3f3d6c32ae3f31f41c071cb8f
-  data.tar.gz: d41beb222470a77bd2f2784a8def99ef3fc4b2928ee1b50cb66167d1764a94ec7ea1be59424c4d09f2a7981b3c6ba47ee6df02b13d6472480f10d9698c742e82
+  metadata.gz: a76732bb72e5e5daefaf55a2bc4c895ef56d109905b9b3b2a5c96e229d97d783f1044dd6971ed21d4e63e55200a5e00a4641f50698f79346767fe498a5b894ad
+  data.tar.gz: ac8d9499807a093c26ca861ed204087702b1a3713b757c6e9d84d43f399b38db36b3b1ab28471413dfd385b442b7636abe9f16194ae4ef17395a16d5e92b7a1c

data/History.md

@@ -1,3 +1,16 @@
+# Version 3.15
+Release date: 2019-03-19
+
+### Added
+
+* `attach_file` now supports a block mode on JS capable drivers to more accurately test user behavior when file inputs are hidden (beta)
+* :table selector now supports `with_rows`, 'rows', `with_cols`, and 'cols' filters
+
+### Fixed
+
+* Fix link selector when `Capybara.test_id` is set - Issue #2166 [bingjyang]
+
+
 # Version 3.14
 Release date: 2019-02-25
 

data/README.md

@@ -6,7 +6,8 @@
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jnicklas/capybara?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=capybara&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=capybara&package-manager=bundler&version-scheme=semver)
 
-**Note** You are viewing the README for the 3.14.x version of Capybara.
+**Note** You are viewing the README for the 3.15.x version of Capybara.
+
 
 Capybara helps you test web applications by simulating how a real user would
 interact with your app. It is agnostic about the driver running your tests and

data/lib/capybara/node/actions.rb

@@ -231,11 +231,14 @@ module Capybara
 
       ##
       #
-      # Find a descendant file field on the page and attach a file given its path. The file field can
-      # be found via its name, id or label text. In the case of the file field being hidden for
+      # Find a descendant file field on the page and attach a file given its path. There are two ways to use
+      # `attach_file`, in the first method the file field can be found via its name, id or label text.
+      # In the case of the file field being hidden for
       # styling reasons the `make_visible` option can be used to temporarily change the CSS of
       # the file field, attach the file, and then revert the CSS back to original. If no locator is
       # passed this will match self or a descendant.
+      # The second method, which is currently in beta and may be changed/removed, involves passing a block
+      # which performs whatever actions would trigger the file chooser to appear.
       #
       #     # will attach file to a descendant file input element that has a name, id, or label_text matching 'My File'
       #     page.attach_file('My File', '/path/to/file.png')
@@ -243,6 +246,11 @@ module Capybara
       #     # will attach file to el if it's a file input element
       #     el.attach_file('/path/to/file.png')
       #
+      #     # will attach file to whatever file input is triggered by the block
+      #     page.attach_file('/path/to/file.png') do
+      #       page.find('#upload_button').click
+      #     end
+      #
       # @overload attach_file([locator], paths, **options)
       #   @macro waiting_behavior
       #
@@ -256,19 +264,33 @@ module Capybara
       #   @option options [String] name           Match fields that match the name attribute
       #   @option options [String, Array<String>, Regexp] class    Match fields that match the class(es) provided
       #   @option options [true, Hash] make_visible   A Hash of CSS styles to change before attempting to attach the file, if `true` { opacity: 1, display: 'block', visibility: 'visible' } is used (may not be supported by all drivers)
-      #
-      #   @return [Capybara::Node::Element]  The file field element
+      # @overload attach_file(paths, &blk)
+      #   @param [String, Array<String>] paths     The path(s) of the file(s) that will be attached
+      #   @yield Block whose actions will trigger the system file chooser to be shown
+      # @return [Capybara::Node::Element]  The file field element
       def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments
+        raise ArgumentError, '``#attach_file` does not support passing both a locator and a block' if locator && block_given?
+
         Array(paths).each do |path|
           raise Capybara::FileNotFound, "cannot attach file, #{path} does not exist" unless File.exist?(path.to_s)
         end
         options[:allow_self] = true if locator.nil?
+
+        if block_given?
+          begin
+            execute_script CAPTURE_FILE_ELEMENT_SCRIPT
+            yield
+            file_field = evaluate_script 'window._capybara_clicked_file_input'
+          rescue ::Capybara::NotSupportedByDriverError
+            warn 'Block mode of `#attach_file` is not supported by the current driver - ignoring.'
+          end
+        end
         # Allow user to update the CSS style of the file input since they are so often hidden on a page
         if make_visible
-          ff = find(:file_field, locator, options.merge(visible: :all))
+          ff = file_field || find(:file_field, locator, options.merge(visible: :all))
           while_visible(ff, make_visible) { |el| el.set(paths) }
         else
-          find(:file_field, locator, options).set(paths)
+          (file_field || find(:file_field, locator, options)).set(paths)
         end
       end
 
@@ -369,6 +391,15 @@ module Capybara
           filter(function(el){ return !el.disabled }).
           map(function(el){ return { "value": el.value, "label": el.label} })
       JS
+
+      CAPTURE_FILE_ELEMENT_SCRIPT = <<~'JS'
+        document.addEventListener('click', function(e){
+          if (e.target.matches("input[type='file']")) {
+            window._capybara_clicked_file_input = e.target;
+            e.preventDefault();
+          }
+        })
+      JS
     end
   end
 end

data/lib/capybara/node/matchers.rb

@@ -514,8 +514,16 @@ module Capybara
       #
       #    page.has_table?('People')
       #
-      # @param [String] locator                        The id or caption of a table
-      # @return [Boolean]                              Whether it exist
+      # @param [String] locator  The id or caption of a table
+      # @option options [Array<Array<String>>] :rows
+      #   Text which should be contained in the tables `<td>` elements organized by row (`<td>` visibility is not considered)
+      # @option options [Array<Array<String>>, Array<Hash<String,String>>] :with_rows
+      #   Partial set of text which should be contained in the tables `<td>` elements organized by row (`<td>` visibility is not considered)
+      # @option options [Array<Array<String>>] :cols
+      #   Text which should be contained in the tables `<td>` elements organized by column (`<td>` visibility is not considered)
+      # @option options [Array<Array<String>>, Array<Hash<String,String>>] :with_cols
+      #   Partial set of text which should be contained in the tables `<td>` elements organized by column (`<td>` visibility is not considered)
+      # @return [Boolean]        Whether it exists
       #
       def has_table?(locator = nil, **options, &optional_filter_block)
         has_selector?(:table, locator, options, &optional_filter_block)

data/lib/capybara/selector.rb

@@ -1,6 +1,8 @@
 # frozen_string_literal: true
 
+require 'capybara/selector/xpath_extensions'
 require 'capybara/selector/selector'
+
 Capybara::Selector::FilterSet.add(:_field) do
   node_filter(:checked, :boolean) { |node, value| !(value ^ node.checked?) }
   node_filter(:unchecked, :boolean) { |node, value| (value ^ node.checked?) }
@@ -101,7 +103,7 @@ Capybara.add_selector(:link, locator_type: [String, Symbol]) do
                   XPath.attr(:title).is(locator),
                   XPath.descendant(:img)[XPath.attr(:alt).is(locator)]]
       matchers << XPath.attr(:'aria-label').is(locator) if enable_aria_label
-      matchers << XPath.attr(test_id) == locator if test_id
+      matchers << XPath.attr(test_id).equals(locator) if test_id
       xpath = xpath[matchers.reduce(:|)]
     end
 
@@ -454,11 +456,125 @@ Capybara.add_selector(:table, locator_type: [String, Symbol]) do
     xpath
   end
 
+  expression_filter(:with_cols, valid_values: [Array]) do |xpath, cols|
+    col_conditions = cols.map do |col|
+      if col.is_a? Hash
+        col.reduce(nil) do |xp, (header, cell)|
+          header_xp = XPath.descendant(:th)[XPath.string.n.is(header)]
+          cell_xp = XPath.descendant(:tr)[header_xp].descendant(:td)
+          next cell_xp[XPath.string.n.is(cell)] unless xp
+
+          table_ancestor = XPath.ancestor(:table)[1]
+          xp = XPath::Expression.new(:join, table_ancestor, xp)
+          cell_xp[XPath.string.n.is(cell) & XPath.position.equals(xp.preceding_sibling(:td).count.plus(1))]
+        end
+      else
+        cells_xp = col.reduce(nil) do |xp, cell|
+          cell_conditions = [XPath.string.n.is(cell)]
+          if xp
+            prev_row_xp = XPath::Expression.new(:join, XPath.ancestor(:tr)[1].preceding_sibling(:tr), xp)
+            cell_conditions << XPath.position.equals(prev_row_xp.preceding_sibling(:td).count.plus(1))
+          end
+          XPath.descendant(:td)[cell_conditions.reduce :&]
+        end
+        XPath::Expression.new(:join, XPath.descendant(:tr), cells_xp)
+      end
+    end.reduce(:&)
+    xpath[col_conditions]
+  end
+
+  expression_filter(:cols, valid_values: [Array]) do |xpath, cols|
+    raise ArgumentError, ":cols must be an Array of Arrays" unless cols.all? { |col| col.is_a? Array }
+
+    rows = cols.transpose
+    xpath = xpath[XPath.descendant(:tbody).descendant(:tr).count.equals(rows.size) | (XPath.descendant(:tr).count.equals(rows.size) & ~XPath.descendant(:tbody))]
+
+    col_conditions = rows.map do |row|
+      row_conditions = row.map do |cell|
+        XPath.self(:td)[XPath.string.n.is(cell)]
+      end
+      row_conditions = row_conditions.reverse.reduce do |cond, cell|
+        cell[XPath.following_sibling[cond]]
+      end
+      row_xpath = XPath.descendant(:tr)[XPath.descendant(:td)[row_conditions]]
+      row_xpath[XPath.descendant(:td).count.equals(row.size)]
+    end.reduce(:&)
+
+    xpath[col_conditions]
+  end
+
+  expression_filter(:with_rows, valid_values: [Array]) do |xpath, rows|
+    rows_conditions = rows.map do |row|
+      if row.is_a? Hash
+        row_conditions = row.map do |header, cell|
+          header_xp = XPath.ancestor(:table)[1].descendant(:tr)[1].descendant(:th)[XPath.string.n.is(header)]
+          XPath.descendant(:td)[
+            XPath.string.n.is(cell) & XPath.position.equals(header_xp.preceding_sibling.count.plus(1))
+          ]
+        end.reduce(:&)
+        XPath.descendant(:tr)[row_conditions]
+      else
+        row_conditions = row.map do |cell|
+          XPath.self(:td)[XPath.string.n.is(cell)]
+        end
+        row_conditions = row_conditions.reverse.reduce do |cond, cell|
+          cell[XPath.following_sibling[cond]]
+        end
+        XPath.descendant(:tr)[XPath.descendant(:td)[row_conditions]]
+      end
+    end.reduce(:&)
+    xpath[rows_conditions]
+  end
+
+  expression_filter(:rows, valid_values: [Array]) do |xpath, rows|
+    xpath = xpath[XPath.descendant(:tbody).descendant(:tr).count.equals(rows.size) | (XPath.descendant(:tr).count.equals(rows.size) & ~XPath.descendant(:tbody))]
+    rows_conditions = rows.map do |row|
+      row_xpath = if row.is_a? Hash
+        row_conditions = row.map do |header, cell|
+          header_xp = XPath.ancestor(:table)[1].descendant(:tr)[1].descendant(:th)[XPath.string.n.is(header)]
+          XPath.descendant(:td)[
+            XPath.string.n.is(cell) & XPath.position.equals(header_xp.preceding_sibling.count.plus(1))
+          ]
+        end.reduce(:&)
+        XPath.descendant(:tr)[row_conditions]
+      else
+        row_conditions = row.map do |cell|
+          XPath.self(:td)[XPath.string.n.is(cell)]
+        end
+        row_conditions = row_conditions.reverse.reduce do |cond, cell|
+          cell[XPath.following_sibling[cond]]
+        end
+        XPath.descendant(:tr)[XPath.descendant(:td)[row_conditions]]
+      end
+      row_xpath[XPath.descendant(:td).count.equals(row.size)]
+    end.reduce(:&)
+    xpath[rows_conditions]
+  end
+
   describe_expression_filters do |caption: nil, **|
     " with caption \"#{caption}\"" if caption
   end
 end
 
+Capybara.add_selector(:table_row, locator_type: [Array, Hash]) do
+  xpath do |locator|
+    xpath = XPath.descendant(:tr)
+    if locator.is_a? Hash
+      locator.reduce(xpath) do |xp, (header, cell)|
+        header_xp = XPath.ancestor(:table)[1].descendant(:tr)[1].descendant(:th)[XPath.string.n.is(header)]
+        cell_xp = XPath.descendant(:td)[
+          XPath.string.n.is(cell) & XPath.position.equals(header_xp.preceding_sibling.count.plus(1))
+        ]
+        xp[cell_xp]
+      end
+    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] }
+      xpath[initial_td[tds]]
+    end
+  end
+end
+
 Capybara.add_selector(:frame, locator_type: [String, Symbol]) do
   xpath do |locator, name: nil, **|
     xpath = XPath.descendant(:iframe).union(XPath.descendant(:frame))

data/lib/capybara/selector/selector.rb

@@ -158,6 +158,13 @@ module Capybara
   #       * :caption (String) — Match text of associated caption
   #       * :class ((String, Array<String>, Regexp, XPath::Expression) — Matches the class(es) provided
   #       * :style (String, Regexp, Hash)
+  #       * :with_rows (Array<Array<String>>, Array<Hash<String, String>>) - Partial match <td> data - visibility of <td> elements is not considered
+  #       * :rows (Array<Array<String>>) — Match all <td>s - visibility of <td> elements is not considered
+  #       * :with_cols (Array<Array<String>>, Array<Hash<String, String>>) - Partial match <td> data - visibility of <td> elements is not considered
+  #       * :cols (Array<Array<String>>) — Match all <td>s - visibility of <td> elements is not considered
+  #
+  #   * **:table_row** - Find table row
+  #     * Locator: Array<String>, Hash<String,String> table row <td> contents - visibility of <td> elements is not considered
   #
   #   * **:frame** - Find frame/iframe elements
   #     * Locator: Match id or name

data/lib/capybara/selector/xpath_extensions.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module XPath
+  class Renderer
+    def join(*expressions)
+      expressions.join('/')
+    end
+  end
+end

data/lib/capybara/selenium/driver.rb

@@ -267,7 +267,11 @@ private
     if @browser.respond_to? :session_storage
       @browser.session_storage.clear
     else
-      warn 'sessionStorage clear requested but is not supported by this driver' unless options[:clear_session_storage].nil?
+      begin
+        @browser&.execute_script('window.sessionStorage.clear()')
+      rescue # rubocop:disable Style/RescueStandardError
+        warn 'sessionStorage clear requested but is not supported by this driver' unless options[:clear_session_storage].nil?
+      end
     end
   end
 
@@ -275,7 +279,11 @@ private
     if @browser.respond_to? :local_storage
       @browser.local_storage.clear
     else
-      warn 'localStorage clear requested but is not supported by this driver' unless options[:clear_local_storage].nil?
+      begin
+        @browser&.execute_script('window.localStorage.clear()')
+      rescue # rubocop:disable Style/RescueStandardError
+        warn 'localStorage clear requested but is not supported by this driver' unless options[:clear_local_storage].nil?
+      end
     end
   end
 
@@ -359,6 +367,8 @@ private
       extend FirefoxDriver if sel_driver.capabilities.is_a?(::Selenium::WebDriver::Remote::W3C::Capabilities)
     when :ie, :internet_explorer
       extend InternetExplorerDriver
+    when :safari, :Safari_Technology_Preview
+      extend SafariDriver
     end
   end
 
@@ -408,3 +418,4 @@ end
 require 'capybara/selenium/driver_specializations/chrome_driver'
 require 'capybara/selenium/driver_specializations/firefox_driver'
 require 'capybara/selenium/driver_specializations/internet_explorer_driver'
+require 'capybara/selenium/driver_specializations/safari_driver'

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require 'capybara/selenium/nodes/safari_node'
+
+module Capybara::Selenium::Driver::SafariDriver
+private
+
+  def build_node(native_node, initial_cache = {})
+    ::Capybara::Selenium::SafariNode.new(self, native_node, initial_cache)
+  end
+
+  def bridge
+    browser.send(:bridge)
+  end
+end

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

@@ -45,7 +45,8 @@ module Capybara
           unless functions.empty?
             hints_js << <<~EACH_JS
               return arguments[0].map(function(el){
-                return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });              });
+                return [#{functions.join(',')}].map(function(fn){ return fn.call(null, el) });
+              });
             EACH_JS
 
             hints = es_context.execute_script hints_js, els

data/lib/capybara/selenium/node.rb

@@ -398,7 +398,7 @@ private
     end
 
     def to_date_str
-      value.to_date.strftime('%Y-%m-%d')
+      value.to_date.iso8601
     end
 
     def timeable?

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

@@ -119,7 +119,7 @@ private
     x.parent(:fieldset)[
       x.attr(:disabled)
     ] + x.ancestor[
-      ~x.self(:legned) |
+      ~x.self(:legend) |
       x.preceding_sibling(:legend)
     ][
       x.parent(:fieldset)[

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

@@ -0,0 +1,145 @@
+# frozen_string_literal: true
+
+# require 'capybara/selenium/extensions/html5_drag'
+
+class Capybara::Selenium::SafariNode < Capybara::Selenium::Node
+  # include Html5Drag
+
+  def click(keys = [], **options)
+    # driver.execute_script('arguments[0].scrollIntoViewIfNeeded({block: "center"})', self)
+    super
+  rescue ::Selenium::WebDriver::Error::ElementNotInteractableError
+    if tag_name == 'tr'
+      warn 'You are attempting to click a table row which has issues in safaridriver - '\
+           '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)
+    end
+    raise
+  end
+
+  def select_option
+    driver.execute_script("arguments[0].closest('select').scrollIntoView()", self)
+    super
+  end
+
+  def unselect_option
+    driver.execute_script("arguments[0].closest('select').scrollIntoView()", self)
+    super
+  end
+
+  def visible_text
+    return '' unless visible?
+
+    vis_text = driver.execute_script('return arguments[0].innerText', self)
+    vis_text.gsub(/\ +/, ' ')
+            .gsub(/[\ \n]*\n[\ \n]*/, "\n")
+            .gsub(/\A[[:space:]&&[^\u00a0]]+/, '')
+            .gsub(/[[:space:]&&[^\u00a0]]+\z/, '')
+            .tr("\u00a0", ' ')
+  end
+
+  def disabled?
+    return true if super || (self[:disabled] == 'true')
+
+    # workaround for safaridriver reporting elements as enabled when they are nested in disabling elements
+    if %w[option optgroup].include? tag_name
+      find_xpath('parent::*[self::optgroup or self::select]')[0].disabled?
+    else
+      !find_xpath(DISABLED_BY_FIELDSET_XPATH).empty?
+    end
+  end
+
+  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
+    native.clear if multiple? && driver.evaluate_script('arguments[0].files', self).any?
+    super
+  end
+
+  def send_keys(*args)
+    return super(*args.map { |arg| arg == :space ? ' ' : arg }) if args.none? { |arg| arg.is_a? Array }
+
+    native.click
+    _send_keys(args).perform
+  end
+
+  def set_text(value, clear: nil, **_unused)
+    value = value.to_s
+    if clear == :backspace
+      # Clear field by sending the correct number of backspace keys.
+      backspaces = [:backspace] * self.value.to_s.length
+      send_keys(*([[:control, 'e']] + backspaces + [value]))
+    else
+      super.tap do
+        # React doesn't see the safaridriver element clear
+        send_keys(:space, :backspace) if value.to_s.empty? && clear.nil?
+      end
+    end
+  end
+
+private
+
+  def bridge
+    driver.browser.send(:bridge)
+  end
+
+  DISABLED_BY_FIELDSET_XPATH = XPath.generate do |x|
+    x.parent(:fieldset)[
+      x.attr(:disabled)
+    ] + x.ancestor[
+      ~x.self(:legend) |
+      x.preceding_sibling(:legend)
+    ][
+      x.parent(:fieldset)[
+        x.attr(:disabled)
+      ]
+    ]
+  end.to_s.freeze
+
+  def _send_keys(keys, actions = browser_action, down_keys = ModifierKeysStack.new)
+    case keys
+    when :control, :left_control, :right_control,
+         :alt, :left_alt, :right_alt,
+         :shift, :left_shift, :right_shift,
+         :meta, :left_meta, :right_meta,
+         :command
+      down_keys.press(keys)
+      actions.key_down(keys)
+    when String
+      keys = keys.upcase if down_keys&.include?(:shift)
+      actions.send_keys(keys)
+    when Symbol
+      actions.send_keys(keys)
+    when Array
+      down_keys.push
+      keys.each { |sub_keys| _send_keys(sub_keys, actions, down_keys) }
+      down_keys.pop.reverse_each { |key| actions.key_up(key) }
+    else
+      raise ArgumentError, 'Unknown keys type'
+    end
+    actions
+  end
+
+  class ModifierKeysStack
+    def initialize
+      @stack = []
+    end
+
+    def include?(key)
+      @stack.flatten.include?(key)
+    end
+
+    def press(key)
+      @stack.last.push(key)
+    end
+
+    def push
+      @stack.push []
+    end
+
+    def pop
+      @stack.pop
+    end
+  end
+  private_constant :ModifierKeysStack
+end