capybara 2.7.1 → 2.8.0

data/lib/capybara/rspec/features.rb

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 if RSpec::Core::Version::STRING.to_f >= 3.0
-  RSpec.shared_context "Capybara Features", :capybara_feature => true do
+  RSpec.shared_context "Capybara Features", capybara_feature: true do
     instance_eval do
       alias background before
       alias given let
@@ -8,13 +8,20 @@ if RSpec::Core::Version::STRING.to_f >= 3.0
     end
   end
 
+  # ensure shared_context is included if default shared_context_metadata_behavior is changed
+  if RSpec::Core::Version::STRING.to_f >= 3.5
+    RSpec.configure do |config|
+      config.include_context "Capybara Features", capybara_feature: true
+    end
+  end
+
   RSpec.configure do |config|
-    config.alias_example_group_to :feature, :capybara_feature => true, :type => :feature
-    config.alias_example_group_to :xfeature, :capybara_feature => true, :type => :feature, :skip => "Temporarily disabled with xfeature"
-    config.alias_example_group_to :ffeature, :capybara_feature => true, :type => :feature, :focus => true
+    config.alias_example_group_to :feature, capybara_feature: true, type: :feature
+    config.alias_example_group_to :xfeature, capybara_feature: true, type: :feature, skip: "Temporarily disabled with xfeature"
+    config.alias_example_group_to :ffeature, capybara_feature: true, type: :feature, focus: true
     config.alias_example_to :scenario
-    config.alias_example_to :xscenario, :skip => "Temporarily disabled with xscenario"
-    config.alias_example_to :fscenario, :focus => true
+    config.alias_example_to :xscenario, skip: "Temporarily disabled with xscenario"
+    config.alias_example_to :fscenario, focus: true
   end
 else
   module Capybara

data/lib/capybara/selector.rb

@@ -1,10 +1,10 @@
 # frozen_string_literal: true
-require 'capybara/selector/filter'
+require 'capybara/selector/filter_set'
 
 module Capybara
   class Selector
 
-    attr_reader :name, :custom_filters, :format
+    attr_reader :name, :format
 
     class << self
       def all
@@ -26,7 +26,7 @@ module Capybara
 
     def initialize(name, &block)
       @name = name
-      @custom_filters = {}
+      @filter_set = FilterSet.add(name){}
       @match = nil
       @label = nil
       @failure_message = nil
@@ -36,6 +36,10 @@ module Capybara
       instance_eval(&block)
     end
 
+    def custom_filters
+      @filter_set.filters
+    end
+
     def xpath(&block)
       @format, @expression = :xpath, block if block
       format == :xpath ? @expression : nil
@@ -57,7 +61,7 @@ module Capybara
     end
 
     def description(options={})
-      (@description && @description.call(options)).to_s
+      @filter_set.description(options)
     end
 
     def call(locator)
@@ -73,20 +77,31 @@ module Capybara
     end
 
     def filter(name, options={}, &block)
-      @custom_filters[name] = Filter.new(name, block, options)
+      custom_filters[name] = Filter.new(name, block, options)
+    end
+
+    def filter_set(name, filters_to_use = nil)
+      f_set = FilterSet.all[name]
+      f_set.filters.each do | name, filter |
+        custom_filters[name] = filter if filters_to_use.nil? || filters_to_use.include?(name)
+      end
+      f_set.descriptions.each { |desc| @filter_set.describe &desc }
     end
 
     def describe &block
-      @description = block
+      @filter_set.describe &block
     end
 
     private
 
     def locate_field(xpath, locator)
-      locate_field = xpath[XPath.attr(:id).equals(locator) |
-                           XPath.attr(:name).equals(locator) |
-                           XPath.attr(:placeholder).equals(locator) |
-                           XPath.attr(:id).equals(XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for))]
+      attr_matchers =  XPath.attr(:id).equals(locator) |
+                       XPath.attr(:name).equals(locator) |
+                       XPath.attr(:placeholder).equals(locator) |
+                       XPath.attr(:id).equals(XPath.anywhere(:label)[XPath.string.n.is(locator)].attr(:for))
+      attr_matchers |= XPath.attr(:'aria-label').is(locator) if Capybara.enable_aria_label
+
+      locate_field = xpath[attr_matchers]
       locate_field += XPath.descendant(:label)[XPath.string.n.is(locator)].descendant(xpath)
       locate_field
     end
@@ -105,35 +120,55 @@ Capybara.add_selector(:id) do
   xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }
 end
 
+Capybara::Selector::FilterSet.add(:_field) do
+  filter(:id) { |node, id| node['id'] == id }
+  filter(:name) { |node, name| node['name'] == name }
+  filter(:placeholder) { |node, placeholder| node['placeholder'] == placeholder }
+  filter(:checked, boolean: true) { |node, value| not(value ^ node.checked?) }
+  filter(:unchecked, boolean: true) { |node, value| (value ^ node.checked?) }
+  filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
+  filter(:multiple, boolean: true) { |node, value| !(value ^ node.multiple?) }
+
+  describe do |options|
+    desc, states = String.new, []
+    [:id, :name, :placeholder].each do |opt|
+      desc << " with #{opt.to_s} #{options[opt]}" if options.has_key?(opt)
+    end
+    states << 'checked' if options[:checked] || (options[:unchecked] === false)
+    states << 'not checked' if options[:unchecked] || (options[:checked] === false)
+    states << 'disabled' if options[:disabled] == true
+    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
+  end
+end
+
 Capybara.add_selector(:field) do
   xpath do |locator|
     xpath = XPath.descendant(:input, :textarea, :select)[~XPath.attr(:type).one_of('submit', 'image', 'hidden')]
     xpath = locate_field(xpath, locator.to_s) unless locator.nil?
     xpath
   end
-  filter(:checked, boolean: true) { |node, value| not(value ^ node.checked?) }
-  filter(:unchecked, boolean: true) { |node, value| (value ^ node.checked?) }
-  filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
-  filter(:readonly, boolean: true) { |node, value| not(value ^ node[:readonly]) }
-  filter(:with) { |node, with| node.value == with.to_s }
+
+  filter_set(:_field)
+
+  filter(:readonly, boolean: true) { |node, value| not(value ^ node.readonly?) }
+  filter(:with) do |node, with|
+    with.is_a?(Regexp) ? node.value =~ with : node.value == with.to_s
+  end
   filter(:type) do |node, type|
+    type = type.to_s
     if ['textarea', 'select'].include?(type)
       node.tag_name == type
     else
       node[:type] == type
     end
   end
-  filter(:multiple, boolean: true) { |node, value| !(value ^ node[:multiple]) }
   describe do |options|
     desc, states = String.new, []
     desc << " of type #{options[:type].inspect}" if options[:type]
     desc << " with value #{options[:with].to_s.inspect}" if options.has_key?(:with)
-    states << 'checked' if options[:checked] || (options.has_key?(:unchecked) && !options[:unchecked])
-    states << 'not checked' if options[:unchecked] || (options.has_key?(:checked) && !options[:checked])
-    states << 'disabled' if options[:disabled] == true
-    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
   end
 end
@@ -151,10 +186,12 @@ Capybara.add_selector(:link) do
     xpath = XPath.descendant(:a)[XPath.attr(:href)]
     unless locator.nil?
       locator = locator.to_s
-      xpath = xpath[XPath.attr(:id).equals(locator) |
-                    XPath.string.n.is(locator) |
-                    XPath.attr(:title).is(locator) |
-                    XPath.descendant(:img)[XPath.attr(:alt).is(locator)]]
+      matchers = XPath.attr(:id).equals(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 Capybara.enable_aria_label
+      xpath = xpath[matchers]
     end
     xpath
   end
@@ -178,9 +215,16 @@ Capybara.add_selector(:button) do
 
     unless locator.nil?
       locator = locator.to_s
-      input_btn_xpath = input_btn_xpath[XPath.attr(:id).equals(locator) | XPath.attr(:value).is(locator) | XPath.attr(:title).is(locator)]
-      btn_xpath = btn_xpath[XPath.attr(:id).equals(locator) | XPath.attr(:value).is(locator) | XPath.string.n.is(locator) | XPath.attr(:title).is(locator)]
-      image_btn_xpath = image_btn_xpath[XPath.attr(:alt).is(locator)]
+      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 Capybara.enable_aria_label
+
+      input_btn_xpath = input_btn_xpath[locator_matches]
+
+      btn_xpath = btn_xpath[locator_matches | XPath.string.n.is(locator)]
+
+      alt_matches = XPath.attr(:alt).is(locator)
+      alt_matches |= XPath.attr(:'aria-label').is(locator) if Capybara.enable_aria_label
+      image_btn_xpath = image_btn_xpath[alt_matches]
     end
 
     input_btn_xpath + btn_xpath + image_btn_xpath
@@ -197,7 +241,7 @@ Capybara.add_selector(:link_or_button) do
     self.class.all.values_at(:link, :button).map {|selector| selector.xpath.call(locator)}.reduce(:+)
   end
 
-  filter(:disabled, default: false, boolean: true) { |node, value| node.tag_name == "a" or not(value ^ node.disabled?) }
+  filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| node.tag_name == "a" or not(value ^ node.disabled?) }
 
   describe { |options| " that is disabled" if options[:disabled] }
 end
@@ -210,16 +254,7 @@ Capybara.add_selector(:fillable_field) do
     xpath
   end
 
-  filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
-  filter(:multiple, boolean: true) { |node, value| !(value ^ node[:multiple]) }
-
-  describe do |options|
-    desc = String.new
-    desc << " that is disabled" if options[:disabled] == true
-    desc << " with the multiple attribute" if options[:multiple] == true
-    desc << " without the multiple attribute" if options[:multiple] === false
-    desc
-  end
+  filter_set(:_field, [:id, :name, :placeholder, :disabled, :multiple])
 end
 
 Capybara.add_selector(:radio_button) do
@@ -230,18 +265,13 @@ Capybara.add_selector(:radio_button) do
     xpath
   end
 
-  filter(:checked, boolean: true) { |node, value| not(value ^ node.checked?) }
-  filter(:unchecked, boolean: true) { |node, value| (value ^ node.checked?) }
+  filter_set(:_field, [:id, :name, :checked, :unchecked, :disabled])
+
   filter(:option)  { |node, value|  node.value == value.to_s }
-  filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
 
   describe do |options|
-    desc, states = String.new, []
+    desc = String.new
     desc << " with value #{options[:option].inspect}" if options[:option]
-    states << 'checked' if options[:checked] || (options.has_key?(:unchecked) && !options[:unchecked])
-    states << 'not checked' if options[:unchecked] || (options.has_key?(:checked) && !options[:checked])
-    states << 'disabled' if options[:disabled] == true
-    desc << " that is #{states.join(' and ')}" unless states.empty?
     desc
   end
 end
@@ -253,18 +283,13 @@ Capybara.add_selector(:checkbox) do
     xpath
   end
 
-  filter(:checked, boolean: true) { |node, value| not(value ^ node.checked?) }
-  filter(:unchecked, boolean: true) { |node, value| (value ^ node.checked?) }
+  filter_set(:_field, [:id, :name, :checked, :unchecked, :disabled])
+
   filter(:option)  { |node, value|  node.value == value.to_s }
-  filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
 
   describe do |options|
-    desc, states = String.new, []
+    desc = String.new
     desc << " with value #{options[:option].inspect}" if options[:option]
-    states << 'checked' if options[:checked] || (options.has_key?(:unchecked) && !options[:unchecked])
-    states << 'not checked' if options[:unchecked] || (options.has_key?(:checked) && !options[:checked])
-    states << 'disabled' if options[:disabled] == true
-    desc << " that is #{states.join(' and ')}" unless states.empty?
     desc
   end
 end
@@ -277,6 +302,8 @@ Capybara.add_selector(:select) do
     xpath
   end
 
+  filter_set(:_field, [:id, :name, :placeholder, :disabled, :multiple])
+
   filter(:options) do |node, options|
     if node.visible?
       actual = node.all(:xpath, './/option').map { |option| option.text }
@@ -296,17 +323,12 @@ Capybara.add_selector(:select) do
     actual = node.all(:xpath, './/option', visible: false).select { |option| option.selected? }.map { |option| option.text(:all) }
     [selected].flatten.sort == actual.sort
   end
-  filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
-  filter(:multiple, boolean: true) { |node, value| !(value ^ node[:multiple]) }
 
   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 << " that is disabled" if options[:disabled] == true
-    desc << " that allows multiple selection" if options[:multiple] == true
-    desc << " that only allows single selection" if options[:multiple] === false
     desc
   end
 end
@@ -337,16 +359,7 @@ Capybara.add_selector(:file_field) do
     xpath
   end
 
-  filter(:disabled, default: false, boolean: true, skip_if: :all) { |node, value| not(value ^ node.disabled?) }
-  filter(:multiple, boolean: true) { |node, value| !(value ^ node[:multiple]) }
-
-  describe do |options|
-    desc = String.new
-    desc << " that is disabled" if options[:disabled] == true
-    desc << " that allows multiple files" if options[:multiple] == true
-    desc << " that only allows a single file" if options[:multiple] === false
-    desc
-  end
+  filter_set(:_field, [:id, :name, :disabled, :multiple])
 end
 
 Capybara.add_selector(:label) do
@@ -368,6 +381,12 @@ Capybara.add_selector(:label) do
       node[:for] == field_or_value.to_s
     end
   end
+
+  describe do |options|
+    desc = String.new
+    desc << " for #{options[:for]}" if options[:for]
+    desc
+  end
 end
 
 Capybara.add_selector(:table) do
@@ -377,3 +396,11 @@ Capybara.add_selector(:table) do
     xpath
   end
 end
+
+Capybara.add_selector(:frame) do
+  xpath do |locator|
+    xpath = XPath.descendant(:iframe) + XPath.descendant(:frame)
+    xpath = xpath[XPath.attr(:id).equals(locator.to_s) | XPath.attr(:name).equals(locator)] unless locator.nil?
+    xpath
+  end
+end

data/lib/capybara/selector/filter_set.rb

@@ -0,0 +1,46 @@
+# frozen_string_literal: true
+require 'capybara/selector/filter'
+
+module Capybara
+  class Selector
+    class FilterSet
+      attr_reader :descriptions
+
+      def initialize(name, &block)
+        @name = name
+        @descriptions = []
+        instance_eval(&block)
+      end
+
+      def filter(name, options={}, &block)
+        filters[name] = Filter.new(name, block, options)
+      end
+
+      def describe(&block)
+        descriptions.push block
+      end
+
+      def description(options={})
+        @descriptions.map {|desc| desc.call(options).to_s }.join
+      end
+
+      def filters
+        @filters ||= {}
+      end
+
+      class << self
+        def all
+          @filter_sets ||= {}
+        end
+
+        def add(name, &block)
+          all[name.to_sym] = FilterSet.new(name.to_sym, &block)
+        end
+
+        def remove(name)
+          all.delete(name.to_sym)
+        end
+      end
+    end
+  end
+end

data/lib/capybara/selenium/driver.rb

@@ -11,6 +11,11 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
 
   def browser
     unless @browser
+      if options[:browser].to_s == "firefox"
+        options[:desired_capabilities] ||= Selenium::WebDriver::Remote::Capabilities.firefox
+        options[:desired_capabilities].merge!({ unexpectedAlertBehaviour: "ignore" })
+      end
+
       @browser = Selenium::WebDriver.for(options[:browser], options.reject { |key,val| SPECIAL_OPTIONS.include?(key) })
 
       main = Process.pid
@@ -130,29 +135,22 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
     end
   end
 
-  ##
-  #
-  # Webdriver supports frame name, id, index(zero-based) or {Capybara::Node::Element} to find iframe
-  #
-  # @overload within_frame(index)
-  #   @param [Integer] index                 index of a frame
-  # @overload within_frame(name_or_id)
-  #   @param [String] name_or_id             name or id of a frame
-  # @overload within_frame(element)
-  #   @param [Capybara::Node::Base] a_node   frame element
-  #
-  def within_frame(frame_handle)
-    frame_handle = frame_handle.native if frame_handle.is_a?(Capybara::Node::Base)
-    @frame_handles[browser.window_handle] ||= []
-    @frame_handles[browser.window_handle] << frame_handle
-    browser.switch_to.frame(frame_handle)
-    yield
-  ensure
-    # would love to use browser.switch_to.parent_frame here
-    # but it has an issue if the current frame is removed from within it
-    @frame_handles[browser.window_handle].pop
-    browser.switch_to.default_content
-    @frame_handles[browser.window_handle].each { |fh| browser.switch_to.frame(fh) }
+  def switch_to_frame(frame)
+    case frame
+    when :top
+      @frame_handles[browser.window_handle] = []
+      browser.switch_to.default_content
+    when :parent
+      # would love to use browser.switch_to.parent_frame here
+      # but it has an issue if the current frame is removed from within it
+      @frame_handles[browser.window_handle].pop
+      browser.switch_to.default_content
+      @frame_handles[browser.window_handle].each { |fh| browser.switch_to.frame(fh) }
+    else
+      @frame_handles[browser.window_handle] ||= []
+      @frame_handles[browser.window_handle] << frame.native
+      browser.switch_to.frame(frame.native)
+    end
   end
 
   def current_window_handle
@@ -221,6 +219,7 @@ class Capybara::Selenium::Driver < Capybara::Driver::Base
   end
 
   def accept_modal(type, options={}, &blk)
+    options = options.dup
     yield if block_given?
     modal = find_modal(options)
     modal.send_keys options[:with] if options[:with]