capybara 3.13.2 → 3.40.0

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:field, locator_type: [String, Symbol]) do
+  visible { |options| :hidden if options[:type].to_s == 'hidden' }
+
+  xpath do |locator, **options|
+    invalid_types = %w[submit image]
+    invalid_types << 'hidden' unless options[:type].to_s == 'hidden'
+    xpath = XPath.descendant(:input, :textarea, :select)[!XPath.attr(:type).one_of(*invalid_types)]
+    locate_field(xpath, locator, **options)
+  end
+
+  expression_filter(:type) do |expr, type|
+    type = type.to_s
+    if %w[textarea select].include?(type)
+      expr.self(type.to_sym)
+    else
+      expr[XPath.attr(:type) == type]
+    end
+  end
+
+  filter_set(:_field) # checked/unchecked/disabled/multiple/name/placeholder
+
+  node_filter(:readonly, :boolean) { |node, value| !(value ^ node.readonly?) }
+
+  node_filter(:with) do |node, with|
+    val = node.value
+    (with.is_a?(Regexp) ? with.match?(val) : val == with.to_s).tap do |res|
+      add_error("Expected value to be #{with.inspect} but was #{val.inspect}") unless res
+    end
+  end
+
+  describe_expression_filters do |type: nil, **|
+    " of type #{type.inspect}" if type
+  end
+
+  describe_node_filters do |**options|
+    " with value #{options[:with].to_s.inspect}" if options.key?(:with)
+  end
+end

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

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:fieldset, locator_type: [String, Symbol]) do
+  xpath do |locator, legend: nil, **|
+    locator_matchers = (XPath.attr(:id) == locator.to_s) | XPath.child(:legend)[XPath.string.n.is(locator.to_s)]
+    locator_matchers |= XPath.attr(test_id) == locator.to_s if test_id
+    xpath = XPath.descendant(:fieldset)[locator && locator_matchers]
+    xpath = xpath[XPath.child(:legend)[XPath.string.n.is(legend)]] if legend
+    xpath
+  end
+
+  node_filter(:disabled, :boolean) { |node, value| !(value ^ node.disabled?) }
+  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
+end

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

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:file_field, locator_type: [String, Symbol]) do
+  label 'file field'
+  xpath do |locator, allow_self: nil, **options|
+    xpath = XPath.axis(allow_self ? :'descendant-or-self' : :descendant, :input)[
+      XPath.attr(:type) == 'file'
+    ]
+    locate_field(xpath, locator, **options)
+  end
+
+  filter_set(:_field, %i[disabled multiple name])
+end

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

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:fillable_field, locator_type: [String, Symbol]) do
+  label 'field'
+  xpath do |locator, allow_self: nil, **options|
+    xpath = XPath.axis(allow_self ? :'descendant-or-self' : :descendant, :input, :textarea)[
+      !XPath.attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')
+    ]
+    locate_field(xpath, locator, **options)
+  end
+
+  expression_filter(:type) do |expr, type|
+    type = type.to_s
+    if type == 'textarea'
+      expr.self(type.to_sym)
+    else
+      expr[XPath.attr(:type) == type]
+    end
+  end
+
+  filter_set(:_field, %i[disabled multiple name placeholder valid validation_message])
+
+  node_filter(:with) do |node, with|
+    val = node.value
+    (with.is_a?(Regexp) ? with.match?(val) : val == with.to_s).tap do |res|
+      add_error("Expected value to be #{with.inspect} but was #{val.inspect}") unless res
+    end
+  end
+
+  describe_node_filters do |**options|
+    " with value #{options[:with].to_s.inspect}" if options.key?(:with)
+  end
+end

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

@@ -0,0 +1,17 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:frame, locator_type: [String, Symbol]) do
+  xpath do |locator, name: nil, **|
+    xpath = XPath.descendant(:iframe).union(XPath.descendant(:frame))
+    unless locator.nil?
+      locator_matchers = (XPath.attr(:id) == locator.to_s) | (XPath.attr(:name) == locator.to_s)
+      locator_matchers |= XPath.attr(test_id) == locator if test_id
+      xpath = xpath[locator_matchers]
+    end
+    xpath[find_by_attr(:name, name)]
+  end
+
+  describe_expression_filters do |name: nil, **|
+    " with name #{name}" if name
+  end
+end

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

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:id, locator_type: [String, Symbol, Regexp]) do
+  xpath { |id| builder(XPath.descendant).add_attribute_conditions(id: id) }
+  locator_filter { |node, id| id.is_a?(Regexp) ? id.match?(node[:id]) : true }
+end

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

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:label, locator_type: [String, Symbol]) do
+  label 'label'
+  xpath(:for) do |locator, **options|
+    xpath = XPath.descendant(:label)
+    unless locator.nil?
+      locator_matchers = XPath.string.n.is(locator.to_s) | (XPath.attr(:id) == locator.to_s)
+      locator_matchers |= XPath.attr(test_id) == locator if test_id
+      xpath = xpath[locator_matchers]
+    end
+    if options.key?(:for)
+      for_option = options[:for]
+      for_option = for_option[:id] if for_option.is_a?(Capybara::Node::Element)
+      if for_option && (for_option != '')
+        with_attr = builder(XPath.self).add_attribute_conditions(for: for_option)
+        wrapped = !XPath.attr(:for) &
+                  builder(XPath.self.descendant(*labelable_elements)).add_attribute_conditions(id: for_option)
+        xpath = xpath[with_attr | wrapped]
+      end
+    end
+    xpath
+  end
+
+  node_filter(:for) do |node, field_or_value|
+    case field_or_value
+    when Capybara::Node::Element
+      if (for_val = node[:for])
+        field_or_value[:id] == for_val
+      else
+        field_or_value.find_xpath('./ancestor::label[1]').include? node.base
+      end
+    when Regexp
+      if (for_val = node[:for])
+        field_or_value.match? for_val
+      else
+        node.find_xpath(XPath.descendant(*labelable_elements).to_s)
+            .any? { |n| field_or_value.match? n[:id] }
+      end
+    else
+      # Non element/regexp values were handled through the expression filter
+      true
+    end
+  end
+
+  describe_expression_filters do |**options|
+    next unless options.key?(:for) && !options[:for].is_a?(Capybara::Node::Element)
+
+    if options[:for].is_a? Regexp
+      " for element with id matching #{options[:for].inspect}"
+    else
+      " for element with id of \"#{options[:for]}\""
+    end
+  end
+  describe_node_filters do |**options|
+    " for element #{options[:for]}" if options[:for].is_a?(Capybara::Node::Element)
+  end
+
+  def labelable_elements
+    %i[button input keygen meter output progress select textarea]
+  end
+end

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

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:link, locator_type: [String, Symbol]) do
+  xpath do |locator, href: true, alt: nil, title: nil, target: nil, **|
+    xpath = XPath.descendant(:a)
+    xpath = builder(xpath).add_attribute_conditions(href: href) unless href == false
+
+    if enable_aria_role
+      role_path = XPath.descendant[XPath.attr(:role).equals('link')]
+      role_path = builder(role_path).add_attribute_conditions(href: href) unless [true, false].include? href
+
+      xpath += role_path
+    end
+
+    unless locator.nil?
+      locator = locator.to_s
+      matchers = [XPath.attr(:id) == locator,
+                  XPath.string.n.is(locator),
+                  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).equals(locator) if test_id
+      xpath = xpath[matchers.reduce(:|)]
+    end
+
+    xpath = xpath[find_by_attr(:title, title)]
+    xpath = xpath[XPath.descendant(:img)[XPath.attr(:alt) == alt]] if alt
+    xpath = xpath[find_by_attr(:target, target)] if target
+
+    xpath
+  end
+
+  node_filter(:href) do |node, href|
+    # If not a Regexp it's been handled in the main XPath
+    (href.is_a?(Regexp) ? node[:href].match?(href) : true).tap do |res|
+      add_error "Expected href to match #{href.inspect} but it was #{node[:href].inspect}" unless res
+    end
+  end
+
+  expression_filter(:download, valid_values: [true, false, String]) do |expr, download|
+    builder(expr).add_attribute_conditions(download: download)
+  end
+
+  describe_expression_filters do |download: nil, **options|
+    desc = +''
+    if (href = options[:href])
+      desc << " with href #{'matching ' if href.is_a? Regexp}#{href.inspect}"
+    elsif options.key?(:href) && href != false # is nil specified?
+      desc << ' with no href attribute'
+    end
+    desc << " with download attribute#{" #{download}" if download.is_a? String}" if download
+    desc << ' without download attribute' if download == false
+    desc
+  end
+end

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

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:link_or_button, locator_type: [String, Symbol]) do
+  label 'link or button'
+  xpath do |locator, **options|
+    %i[link button].map do |selector|
+      expression_for(selector, locator, **options)
+    end.reduce(:union)
+  end
+
+  node_filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }
+
+  describe_node_filters do |disabled: nil, **|
+    ' that is disabled' if disabled == true
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:option, locator_type: [String, Symbol, Integer]) do
+  xpath do |locator|
+    xpath = XPath.descendant(:option)
+    xpath = xpath[XPath.string.n.is(locator.to_s)] unless locator.nil?
+    xpath
+  end
+
+  node_filter(:disabled, :boolean) { |node, value| !(value ^ node.disabled?) }
+  expression_filter(:disabled) { |xpath, val| val ? xpath : xpath[~XPath.attr(:disabled)] }
+
+  node_filter(:selected, :boolean) { |node, value| !(value ^ node.selected?) }
+
+  describe_expression_filters do |disabled: nil, **options|
+    desc = +''
+    desc << ' that is not disabled' if disabled == false
+    (expression_filters.keys & options.keys).inject(desc) { |memo, ef| memo << " with #{ef} #{options[ef]}" }
+  end
+
+  describe_node_filters do |**options|
+    desc = +''
+    desc << ' that is disabled' if options[:disabled]
+    desc << " that is#{' not' unless options[:selected]} selected" if options.key?(:selected)
+    desc
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:radio_button, locator_type: [String, Symbol]) do
+  label 'radio button'
+  xpath do |locator, allow_self: nil, **options|
+    xpath = XPath.axis(allow_self ? :'descendant-or-self' : :descendant, :input)[
+      XPath.attr(:type) == 'radio'
+    ]
+    locate_field(xpath, locator, **options)
+  end
+
+  filter_set(:_field, %i[checked unchecked disabled name])
+
+  node_filter(%i[option with]) do |node, value|
+    val = node.value
+    (value.is_a?(Regexp) ? value.match?(val) : val == value.to_s).tap do |res|
+      add_error("Expected value to be #{value.inspect} but it was #{val.inspect}") unless res
+    end
+  end
+
+  describe_node_filters do |option: nil, with: nil, **|
+    desc = +''
+    desc << " with value #{option.inspect}" if option
+    desc << " with value #{with.inspect}" if with
+    desc
+  end
+end

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

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:select, locator_type: [String, Symbol]) do
+  label 'select box'
+
+  xpath do |locator, **options|
+    xpath = XPath.descendant(:select)
+    locate_field(xpath, locator, **options)
+  end
+
+  filter_set(:_field, %i[disabled multiple name placeholder])
+
+  node_filter(:options) do |node, options|
+    actual = options_text(node)
+    (options.sort == actual.sort).tap do |res|
+      add_error("Expected options #{options.inspect} found #{actual.inspect}") unless res
+    end
+  end
+
+  node_filter(:enabled_options) do |node, options|
+    actual = options_text(node) { |o| !o.disabled? }
+    (options.sort == actual.sort).tap do |res|
+      add_error("Expected enabled options #{options.inspect} found #{actual.inspect}") unless res
+    end
+  end
+
+  node_filter(:disabled_options) do |node, options|
+    actual = options_text(node, &:disabled?)
+    (options.sort == actual.sort).tap do |res|
+      add_error("Expected disabled options #{options.inspect} found #{actual.inspect}") unless res
+    end
+  end
+
+  expression_filter(:with_options) do |expr, options|
+    options.inject(expr) do |xpath, option|
+      xpath.where(expression_for(:option, option))
+    end
+  end
+
+  node_filter(:selected) do |node, selected|
+    actual = options_text(node, visible: false, &:selected?)
+    (Array(selected).sort == actual.sort).tap do |res|
+      add_error("Expected #{selected.inspect} to be selected found #{actual.inspect}") unless res
+    end
+  end
+
+  node_filter(:with_selected) do |node, selected|
+    actual = options_text(node, visible: false, &:selected?)
+    (Array(selected) - actual).empty?.tap do |res|
+      add_error("Expected at least #{selected.inspect} to be selected found #{actual.inspect}") unless res
+    end
+  end
+
+  describe_expression_filters do |with_options: nil, **|
+    desc = +''
+    desc << " with at least options #{with_options.inspect}" if with_options
+    desc
+  end
+
+  describe_node_filters do |
+    options: nil, disabled_options: nil, enabled_options: nil,
+    selected: nil, with_selected: nil,
+    disabled: nil, **|
+    desc = +''
+    desc << " with options #{options.inspect}" if options
+    desc << " with disabled options #{disabled_options.inspect}}" if disabled_options
+    desc << " with enabled options #{enabled_options.inspect}" if enabled_options
+    desc << " with #{selected.inspect} selected" if selected
+    desc << " with at least #{with_selected.inspect} selected" if with_selected
+    desc << ' which is disabled' if disabled
+    desc
+  end
+
+  def options_text(node, **opts, &filter_block)
+    opts[:wait] = false
+    opts[:visible] = false unless node.visible?
+    node.all(:xpath, './/option', **opts, &filter_block).map do |o|
+      o.text((:all if opts[:visible] == false))
+    end
+  end
+end

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

@@ -0,0 +1,109 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:table, locator_type: [String, Symbol]) do
+  xpath do |locator, caption: nil, **|
+    xpath = XPath.descendant(:table)
+    unless locator.nil?
+      locator_matchers = (XPath.attr(:id) == locator.to_s) | XPath.descendant(:caption).is(locator.to_s)
+      locator_matchers |= XPath.attr(test_id) == locator if test_id
+      xpath = xpath[locator_matchers]
+    end
+    xpath = xpath[XPath.descendant(:caption) == caption] if caption
+    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_str)|
+          header = XPath.descendant(:th)[XPath.string.n.is(header)]
+          td = XPath.descendant(:tr)[header].descendant(:td)
+          cell_condition = XPath.string.n.is(cell_str)
+          if xp
+            prev_cell = XPath.ancestor(:table)[1].join(xp)
+            cell_condition &= (prev_cell & prev_col_position?(prev_cell))
+          end
+          td[cell_condition]
+        end
+      else
+        cells_xp = col.reduce(nil) do |prev_cell, cell_str|
+          cell_condition = XPath.string.n.is(cell_str)
+
+          if prev_cell
+            prev_cell = XPath.ancestor(:tr)[1].preceding_sibling(:tr).join(prev_cell)
+            cell_condition &= (prev_cell & prev_col_position?(prev_cell))
+          end
+
+          XPath.descendant(:td)[cell_condition]
+        end
+        XPath.descendant(:tr).join(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?(Array)
+
+    rows = cols.transpose
+    col_conditions = rows.map { |row| match_row(row, match_size: true) }.reduce(:&)
+    xpath[match_row_count(rows.size)][col_conditions]
+  end
+
+  expression_filter(:with_rows, valid_values: [Array]) do |xpath, rows|
+    rows_conditions = rows.map { |row| match_row(row) }.reduce(:&)
+    xpath[rows_conditions]
+  end
+
+  expression_filter(:rows, valid_values: [Array]) do |xpath, rows|
+    rows_conditions = rows.map { |row| match_row(row, match_size: true) }.reduce(:&)
+    xpath[match_row_count(rows.size)][rows_conditions]
+  end
+
+  describe_expression_filters do |caption: nil, **|
+    " with caption \"#{caption}\"" if caption
+  end
+
+  def prev_col_position?(cell)
+    XPath.position.equals(cell_position(cell))
+  end
+
+  def cell_position(cell)
+    cell.preceding_sibling(:td).count.plus(1)
+  end
+
+  def match_row(row, match_size: false)
+    xp = XPath.descendant(:tr)[
+      if row.is_a? Hash
+        row_match_cells_to_headers(row)
+      else
+        XPath.descendant(:td)[row_match_ordered_cells(row)]
+      end
+    ]
+    xp = xp[XPath.descendant(:td).count.equals(row.size)] if match_size
+    xp
+  end
+
+  def match_row_count(size)
+    XPath.descendant(:tbody).descendant(:tr).count.equals(size) |
+      (XPath.descendant(:tr).count.equals(size) & ~XPath.descendant(:tbody))
+  end
+
+  def row_match_cells_to_headers(row)
+    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) & header_xp.boolean & XPath.position.equals(header_xp.preceding_sibling.count.plus(1))
+      ]
+    end.reduce(:&)
+  end
+
+  def row_match_ordered_cells(row)
+    row_conditions = row.map do |cell|
+      XPath.self(:td)[XPath.string.n.is(cell)]
+    end
+    row_conditions.reverse.reduce do |cond, cell|
+      cell[XPath.following_sibling[cond]]
+    end
+  end
+end

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

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+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) & header_xp.boolean & XPath.position.equals(header_xp.preceding_sibling.count.plus(1))
+        ]
+        xp.where(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| cell.where(xp) }
+      xpath[initial_td[tds]]
+    end
+  end
+end

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

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+Capybara.add_selector(:xpath, locator_type: [:to_xpath, String], raw_locator: true) do
+  xpath { |xpath| xpath }
+end