capybara 2.18.0 → 3.0.0.rc1

data/lib/capybara/selector.rb

@@ -1,27 +1,31 @@
 # frozen_string_literal: true
+
 require 'capybara/selector/selector'
 Capybara::Selector::FilterSet.add(:_field) do
-  filter(:checked, :boolean) { |node, value| not(value ^ node.checked?) }
+  filter(:checked, :boolean) { |node, value| !(value ^ node.checked?) }
   filter(:unchecked, :boolean) { |node, value| (value ^ node.checked?) }
-  filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
+  filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }
   filter(:multiple, :boolean) { |node, value| !(value ^ node.multiple?) }
 
-  expression_filter(:name) { |xpath, val| xpath[XPath.attr(:name).equals(val)] }
-  expression_filter(:placeholder) { |xpath, val| xpath[XPath.attr(:placeholder).equals(val)] }
+  expression_filter(:name) { |xpath, val| xpath[XPath.attr(:name) == val] }
+  expression_filter(:placeholder) { |xpath, val| xpath[XPath.attr(:placeholder) == val] }
 
-  describe do |options|
-    desc, states = String.new, []
-    states << 'checked' if options[:checked] || (options[:unchecked] == false)
-    states << 'not checked' if options[:unchecked] || (options[:checked] == false)
-    states << 'disabled' if options[:disabled] == true
-    states << 'not disabled' if options[:disabled] == false
+  describe do |checked: nil, unchecked: nil, disabled: nil, multiple: nil, **_options|
+    desc, states = "".dup, []
+    states << 'checked' if checked || (unchecked == false)
+    states << 'not checked' if unchecked || (checked == false)
+    states << 'disabled' if disabled == true
+    states << 'not disabled' if disabled == false
     desc << " that is #{states.join(' and ')}" unless states.empty?
-    desc << " with the multiple attribute" if options[:multiple] == true
-    desc << " without the multiple attribute" if options[:multiple] == false
+    desc << " with the multiple attribute" if multiple == true
+    desc << " without the multiple attribute" if multiple == false
     desc
   end
 end
 
+# rubocop:disable Metrics/BlockLength
+# rubocop:disable Metrics/ParameterLists
+
 ##
 #
 # Select elements by XPath expression
@@ -69,31 +73,31 @@ end
 # @filter [Boolean] :disabled Match disabled field?
 # @filter [Boolean] :multiple Match fields that accept multiple values
 Capybara.add_selector(:field) do
-  xpath do |locator, options|
-    xpath = XPath.descendant(:input, :textarea, :select)[~XPath.attr(:type).one_of('submit', 'image', 'hidden')]
+  xpath do |locator, **options|
+    xpath = XPath.descendant(:input, :textarea, :select)[!XPath.attr(:type).one_of('submit', 'image', 'hidden')]
     locate_field(xpath, locator, options)
   end
 
   expression_filter(:type) do |expr, type|
     type = type.to_s
-    if ['textarea', 'select'].include?(type)
-      expr.axis(:self, type.to_sym)
+    if %w[textarea select].include?(type)
+      expr.self(type.to_sym)
     else
-      expr[XPath.attr(:type).equals(type)]
+      expr[XPath.attr(:type) == type]
     end
   end
 
   filter_set(:_field) # checked/unchecked/disabled/multiple/name/placeholder
 
-  filter(:readonly, :boolean) { |node, value| not(value ^ node.readonly?) }
+  filter(:readonly, :boolean) { |node, value| !(value ^ node.readonly?) }
   filter(:with) do |node, with|
     with.is_a?(Regexp) ? node.value =~ with : node.value == with.to_s
   end
-  describe do |options|
-    desc = String.new
-    (expression_filters.keys - [:type]).each { |ef| desc << " with #{ef} #{options[ef]}" if options.has_key?(ef) }
-    desc << " of type #{options[:type].inspect}" if options[:type]
-    desc << " with value #{options[:with].to_s.inspect}" if options.has_key?(:with)
+  describe do |type: nil, **options|
+    desc = "".dup
+    (expression_filters.keys - [:type]).each { |ef| desc << " with #{ef} #{options[ef]}" if options.key?(ef) }
+    desc << " of type #{type.inspect}" if type
+    desc << " with value #{options[:with].to_s.inspect}" if options.key?(:with)
     desc
   end
 end
@@ -109,10 +113,10 @@ end
 # @filter [String, Array<String>] :class Matches the class(es) provided
 #
 Capybara.add_selector(:fieldset) do
-  xpath(:legend) do |locator, options|
+  xpath(:legend) do |locator, legend: nil, **_options|
     xpath = XPath.descendant(:fieldset)
-    xpath = xpath[XPath.attr(:id).equals(locator.to_s).or XPath.child(:legend)[XPath.string.n.is(locator.to_s)]] unless locator.nil?
-    xpath = xpath[XPath.child(:legend)[XPath.string.n.is(options[:legend])]] if options[:legend]
+    xpath = xpath[(XPath.attr(:id) == locator.to_s) | XPath.child(:legend)[XPath.string.n.is(locator.to_s)]] unless locator.nil?
+    xpath = xpath[XPath.child(:legend)[XPath.string.n.is(legend)]] if legend
     xpath
   end
 end
@@ -130,24 +134,24 @@ end
 # @filter [String, Regexp,nil] :href  Matches the normalized href of the link, if nil will find <a> elements with no href attribute
 #
 Capybara.add_selector(:link) do
-  xpath(:title, :alt) do |locator, options={}|
+  xpath(:title, :alt) do |locator, href: true, enable_aria_label: false, alt: nil, title: nil, **_options|
     xpath = XPath.descendant(:a)
-    xpath = if options.fetch(:href, true).nil?
-      xpath[~XPath.attr(:href)]
+    xpath = if href.nil?
+      xpath[!XPath.attr(:href)]
     else
       xpath[XPath.attr(:href)]
     end
     unless locator.nil?
       locator = locator.to_s
-      matchers = XPath.attr(:id).equals(locator).or(
-                 XPath.string.n.is(locator)).or(
-                 XPath.attr(:title).is(locator)).or(
-                 XPath.descendant(:img)[XPath.attr(:alt).is(locator)])
-      matchers = matchers.or XPath.attr(:'aria-label').is(locator) if options[:enable_aria_label]
+      matchers = [XPath.attr(:id) == locator,
+                  XPath.string.n.is(locator),
+                  XPath.attr(:title).is(locator),
+                  XPath.descendant(:img)[XPath.attr(:alt).is(locator)]].reduce(:|)
+      matchers |= XPath.attr(:'aria-label').is(locator) if enable_aria_label
       xpath = xpath[matchers]
     end
-    xpath = [:title].inject(xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
-    xpath = xpath[XPath.descendant(:img)[XPath.attr(:alt).equals(options[:alt])]] if options[:alt]
+    xpath = xpath[find_by_attr(:title, title)]
+    xpath = xpath[XPath.descendant(:img)[XPath.attr(:alt) == alt]] if alt
     xpath
   end
 
@@ -158,12 +162,12 @@ Capybara.add_selector(:link) do
     when Regexp
       node[:href].match href
     else
-      node.first(:xpath, XPath.axis(:self)[XPath.attr(:href).equals(href.to_s)], minimum: 0)
+      node.first(:xpath, XPath.self[XPath.attr(:href) == href.to_s], minimum: 0)
     end
   end
 
-  describe do |options|
-    desc = String.new()
+  describe do |**options|
+    desc = "".dup
     desc << " with href #{options[:href].inspect}" if options[:href]
     desc << " with no href attribute" if options.fetch(:href, true).nil?
   end
@@ -181,22 +185,22 @@ end
 # @filter [String] :value Matches the value of an input button
 #
 Capybara.add_selector(:button) do
-  xpath(:value, :title) do |locator, options={}|
+  xpath(:value, :title) do |locator, **options|
     input_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).one_of('submit', 'reset', 'image', 'button')]
     btn_xpath = XPath.descendant(:button)
-    image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type).equals('image')]
+    image_btn_xpath = XPath.descendant(:input)[XPath.attr(:type) == 'image']
 
     unless locator.nil?
       locator = locator.to_s
-      locator_matches = XPath.attr(:id).equals(locator).or XPath.attr(:value).is(locator).or XPath.attr(:title).is(locator)
-      locator_matches = locator_matches.or XPath.attr(:'aria-label').is(locator) if options[:enable_aria_label]
+      locator_matches = XPath.attr(:id).equals(locator) | XPath.attr(:value).is(locator) | XPath.attr(:title).is(locator)
+      locator_matches |= XPath.attr(:'aria-label').is(locator) if options[:enable_aria_label]
 
       input_btn_xpath = input_btn_xpath[locator_matches]
 
-      btn_xpath = btn_xpath[locator_matches.or XPath.string.n.is(locator).or XPath.descendant(:img)[XPath.attr(:alt).is(locator)]]
+      btn_xpath = btn_xpath[locator_matches | XPath.string.n.is(locator) | XPath.descendant(:img)[XPath.attr(:alt).is(locator)]]
 
       alt_matches = XPath.attr(:alt).is(locator)
-      alt_matches = alt_matches.or XPath.attr(:'aria-label').is(locator) if options[:enable_aria_label]
+      alt_matches |= XPath.attr(:'aria-label').is(locator) if options[:enable_aria_label]
       image_btn_xpath = image_btn_xpath[alt_matches]
     end
 
@@ -207,11 +211,11 @@ Capybara.add_selector(:button) do
     res_xpath
   end
 
-  filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
+  filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| !(value ^ node.disabled?) }
 
-  describe do |options|
-    desc = String.new
-    desc << " that is disabled" if options[:disabled] == true
+  describe do |disabled: nil, **options|
+    desc = "".dup
+    desc << " that is disabled" if disabled == true
     desc << describe_all_expression_filters(options)
     desc
   end
@@ -223,13 +227,13 @@ end
 #
 Capybara.add_selector(:link_or_button) do
   label "link or button"
-  xpath do |locator, options|
-    self.class.all.values_at(:link, :button).map {|selector| selector.xpath.call(locator, options)}.reduce(:union)
+  xpath do |locator, **options|
+    self.class.all.values_at(:link, :button).map { |selector| selector.xpath.call(locator, options) }.reduce(:union)
   end
 
-  filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| node.tag_name == "a" or not(value ^ node.disabled?) }
+  filter(:disabled, :boolean, default: false, skip_if: :all) { |node, value| node.tag_name == "a" or !(value ^ node.disabled?) }
 
-  describe { |options| " that is disabled" if options[:disabled] }
+  describe { |disabled: nil, **_options| " that is disabled" if disabled == true }
 end
 
 ##
@@ -248,30 +252,31 @@ end
 #
 Capybara.add_selector(:fillable_field) do
   label "field"
-  xpath do |locator, options|
-    xpath = XPath.descendant(:input, :textarea)[~XPath.attr(:type).one_of('submit', 'image', 'radio', 'checkbox', 'hidden', 'file')]
+
+  xpath do |locator, **options|
+    xpath = XPath.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 ['textarea'].include?(type)
-      expr.axis(:self, type.to_sym)
+      expr.self(type.to_sym)
     else
-      expr[XPath.attr(:type).equals(type)]
+      expr[XPath.attr(:type) == type]
     end
   end
 
-  filter_set(:_field, [:disabled, :multiple, :name, :placeholder])
+  filter_set(:_field, %i[disabled multiple name placeholder])
 
   filter(:with) do |node, with|
     with.is_a?(Regexp) ? node.value =~ with : node.value == with.to_s
   end
 
   describe do |options|
-    desc = String.new
+    desc = "".dup
     desc << describe_all_expression_filters(options)
-    desc << " with value #{options[:with].to_s.inspect}" if options.has_key?(:with)
+    desc << " with value #{options[:with].to_s.inspect}" if options.key?(:with)
     desc
   end
 end
@@ -291,18 +296,19 @@ end
 #
 Capybara.add_selector(:radio_button) do
   label "radio button"
-  xpath do |locator, options|
-    xpath = XPath.descendant(:input)[XPath.attr(:type).equals('radio')]
+
+  xpath do |locator, **options|
+    xpath = XPath.descendant(:input)[XPath.attr(:type) == 'radio']
     locate_field(xpath, locator, options)
   end
 
-  filter_set(:_field, [:checked, :unchecked, :disabled, :name])
+  filter_set(:_field, %i[checked unchecked disabled name])
 
-  filter(:option)  { |node, value|  node.value == value.to_s }
+  filter(:option) { |node, value| node.value == value.to_s }
 
-  describe do |options|
-    desc = String.new
-    desc << " with value #{options[:option].inspect}" if options[:option]
+  describe do |option: nil, **options|
+    desc = "".dup
+    desc << " with value #{option.inspect}" if option
     desc << describe_all_expression_filters(options)
     desc
   end
@@ -322,18 +328,18 @@ end
 # @filter [String] :option Match the value
 #
 Capybara.add_selector(:checkbox) do
-  xpath do |locator, options|
-    xpath = XPath.descendant(:input)[XPath.attr(:type).equals('checkbox')]
+  xpath do |locator, **options|
+    xpath = XPath.descendant(:input)[XPath.attr(:type) == 'checkbox']
     locate_field(xpath, locator, options)
   end
 
-  filter_set(:_field, [:checked, :unchecked, :disabled, :name])
+  filter_set(:_field, %i[checked unchecked disabled name])
 
-  filter(:option)  { |node, value|  node.value == value.to_s }
+  filter(:option) { |node, value| node.value == value.to_s }
 
-  describe do |options|
-    desc = String.new
-    desc << " with value #{options[:option].inspect}" if options[:option]
+  describe do |option: nil, **options|
+    desc = "".dup
+    desc << " with value #{option.inspect}" if option
     desc << describe_all_expression_filters(options)
     desc
   end
@@ -357,47 +363,46 @@ end
 #
 Capybara.add_selector(:select) do
   label "select box"
-  xpath do |locator, options|
+
+  xpath do |locator, **options|
     xpath = XPath.descendant(:select)
     locate_field(xpath, locator, options)
   end
 
-  filter_set(:_field, [:disabled, :multiple, :name, :placeholder])
+  filter_set(:_field, %i[disabled multiple name placeholder])
 
   filter(:options) do |node, options|
-    if node.visible?
-      actual = node.all(:xpath, './/option').map { |option| option.text }
+    actual = if node.visible?
+      node.all(:xpath, './/option', wait: false).map(&:text)
     else
-      actual = node.all(:xpath, './/option', visible: false).map { |option| option.text(:all) }
+      node.all(:xpath, './/option', visible: false, wait: false).map { |option| option.text(:all) }
     end
     options.sort == actual.sort
   end
 
   filter(:with_options) do |node, options|
     finder_settings = { minimum: 0 }
-    if !node.visible?
-      finder_settings[:visible] = false
-    end
+    finder_settings[:visible] = false unless node.visible?
     options.all? { |option| node.first(:option, option, finder_settings) }
   end
 
   filter(:selected) do |node, selected|
-    actual = node.all(:xpath, './/option', visible: false).select(&:selected?).map { |option| option.text(:all) }
+    actual = node.all(:xpath, './/option', visible: false, wait: false).select(&:selected?).map { |option| option.text(:all) }
     Array(selected).sort == actual.sort
   end
 
   filter(:with_selected) do |node, selected|
-    actual = node.all(:xpath, './/option', visible: false).select(&:selected?).map { |option| option.text(:all) }
+    actual = node.all(:xpath, './/option', visible: false, wait: false).select(&:selected?).map { |option| option.text(:all) }
     (Array(selected) - actual).empty?
   end
 
-  describe do |options|
-    desc = String.new
-    desc << " with options #{options[:options].inspect}" if options[:options]
-    desc << " with at least options #{options[:with_options].inspect}" if options[:with_options]
-    desc << " with #{options[:selected].inspect} selected" if options[:selected]
-    desc << " with at least #{options[:with_selected].inspect} selected" if options[:with_selected]
-    desc << describe_all_expression_filters(options)
+  describe do |options: nil, with_options: nil, selected: nil, with_selected: nil, **opts|
+    desc = "".dup
+    desc << " with options #{options.inspect}" if options
+    desc << " with at least options #{with_options.inspect}" if with_options
+    desc << " with #{selected.inspect} selected" if selected
+    desc << " with at least #{with_selected.inspect} selected" if with_selected
+    desc << describe_all_expression_filters(opts)
     desc
   end
 end
@@ -417,13 +422,13 @@ Capybara.add_selector(:option) do
     xpath
   end
 
-  filter(:disabled, :boolean) { |node, value| not(value ^ node.disabled?) }
-  filter(:selected, :boolean) { |node, value| not(value ^ node.selected?) }
+  filter(:disabled, :boolean) { |node, value| !(value ^ node.disabled?) }
+  filter(:selected, :boolean) { |node, value| !(value ^ node.selected?) }
 
-  describe do |options|
-    desc = String.new
-    desc << " that is#{' not' unless options[:disabled]} disabled" if options.has_key?(:disabled)
-    desc << " that is#{' not' unless options[:selected]} selected" if options.has_key?(:selected)
+  describe do |**options|
+    desc = "".dup
+    desc << " that is#{' not' unless options[:disabled]} disabled" if options.key?(:disabled)
+    desc << " that is#{' not' unless options[:selected]} selected" if options.key?(:selected)
     desc
   end
 end
@@ -442,14 +447,14 @@ end
 Capybara.add_selector(:file_field) do
   label "file field"
   xpath do |locator, options|
-    xpath = XPath.descendant(:input)[XPath.attr(:type).equals('file')]
+    xpath = XPath.descendant(:input)[XPath.attr(:type) == 'file']
     locate_field(xpath, locator, options)
   end
 
-  filter_set(:_field, [:disabled, :multiple, :name])
+  filter_set(:_field, %i[disabled multiple name])
 
-  describe do |options|
-    desc = String.new
+  describe do |**options|
+    desc = "".dup
     desc << describe_all_expression_filters(options)
     desc
   end
@@ -466,9 +471,13 @@ Capybara.add_selector(:label) do
   label "label"
   xpath(:for) do |locator, options|
     xpath = XPath.descendant(:label)
-    xpath = xpath[XPath.string.n.is(locator.to_s).or XPath.attr(:id).equals(locator.to_s)] unless locator.nil?
-    if options.has_key?(:for) && !options[:for].is_a?(Capybara::Node::Element)
-      xpath = xpath[XPath.attr(:for).equals(options[:for].to_s).or((~XPath.attr(:for)).and(XPath.descendant()[XPath.attr(:id).equals(options[:for].to_s)]))]
+    xpath = xpath[XPath.string.n.is(locator.to_s) | (XPath.attr(:id) == locator.to_s)] unless locator.nil?
+    if options.key?(:for) && !options[:for].is_a?(Capybara::Node::Element)
+      with_attr = XPath.attr(:for) == options[:for].to_s
+      labelable_elements = %i[button input keygen meter output progress select textarea]
+      wrapped = !XPath.attr(:for) &
+                XPath.descendant(*labelable_elements)[XPath.attr(:id) == options[:for].to_s]
+      xpath = xpath[with_attr | wrapped]
     end
     xpath
   end
@@ -481,13 +490,13 @@ Capybara.add_selector(:label) do
         field_or_value.find_xpath('./ancestor::label[1]').include? node.base
       end
     else
-      #Non element values were handled through the expression filter
+      # Non element values were handled through the expression filter
       true
     end
   end
 
-  describe do |options|
-    desc = String.new
+  describe do |**options|
+    desc = "".dup
     desc << " for #{options[:for]}" if options[:for]
     desc
   end
@@ -505,14 +514,14 @@ end
 Capybara.add_selector(:table) do
   xpath(:caption) do |locator, options|
     xpath = XPath.descendant(:table)
-    xpath = xpath[XPath.attr(:id).equals(locator.to_s).or XPath.descendant(:caption).is(locator.to_s)] unless locator.nil?
-    xpath = xpath[XPath.descendant(:caption).equals(options[:caption])] if options[:caption]
+    xpath = xpath[(XPath.attr(:id) == locator.to_s) | XPath.descendant(:caption).is(locator.to_s)] unless locator.nil?
+    xpath = xpath[XPath.descendant(:caption) == options[:caption]] if options[:caption]
     xpath
   end
 
-  describe do |options|
-    desc = String.new
-    desc << " with caption #{options[:caption]}" if options[:caption]
+  describe do |caption: nil, **_options|
+    desc = "".dup
+    desc << " with caption #{caption}" if caption
     desc
   end
 end
@@ -527,16 +536,19 @@ end
 # @filter [String, Array<String>] :class  Matches the class(es) provided
 #
 Capybara.add_selector(:frame) do
-  xpath(:name) do |locator, options|
+  xpath(:name) do |locator, **options|
     xpath = XPath.descendant(:iframe).union(XPath.descendant(:frame))
-    xpath = xpath[XPath.attr(:id).equals(locator.to_s).or XPath.attr(:name).equals(locator)] unless locator.nil?
+    xpath = xpath[(XPath.attr(:id) == locator.to_s) | (XPath.attr(:name) == locator.to_s)] unless locator.nil?
     xpath = expression_filters.keys.inject(xpath) { |memo, ef| memo[find_by_attr(ef, options[ef])] }
     xpath
   end
 
-  describe do |options|
-    desc = String.new
-    desc << " with name #{options[:name]}" if options[:name]
+  describe do |name: nil, **_options|
+    desc = "".dup
+    desc << " with name #{name}" if name
     desc
   end
 end
+
+# rubocop:enable Metrics/BlockLength
+# rubocop:enable Metrics/ParameterLists