capybara 2.9.2 → 2.10.0

data/lib/capybara/queries/selector_query.rb

@@ -7,8 +7,9 @@ module Capybara
       VALID_KEYS = COUNT_KEYS + [:text, :id, :class, :visible, :exact, :match, :wait, :filter_set]
       VALID_MATCH = [:first, :smart, :prefer_exact, :one]
 
-      def initialize(*args)
+      def initialize(*args, &filter_block)
         @options = if args.last.is_a?(Hash) then args.pop.dup else {} end
+        @filter_block = filter_block
 
         if args[0].is_a?(Symbol)
           @selector = Selector.all.fetch(args.shift) do |selector_type|
@@ -45,6 +46,7 @@ module Capybara
         @description << " with id #{options[:id]}" if options[:id]
         @description << " with classes #{Array(options[:class]).join(',')}]" if options[:class]
         @description << selector.description(options)
+        @description << " that also matches the custom filter block" if @filter_block
         @description
       end
 
@@ -59,7 +61,7 @@ module Capybara
           when :hidden then return false if node.visible?
         end
 
-        query_filters.all? do |name, filter|
+        res = query_filters.all? do |name, filter|
           if options.has_key?(name)
             filter.matches?(node, options[name])
           elsif filter.default?
@@ -68,21 +70,16 @@ module Capybara
             true
           end
         end
+
+        res &&= @filter_block.call(node) unless @filter_block.nil?
+        res
       end
 
       def visible
-        if options.has_key?(:visible)
-          case @options[:visible]
-            when true then :visible
-            when false then :all
-            else @options[:visible]
-          end
-        else
-          if Capybara.ignore_hidden_elements
-            :visible
-          else
-            :all
-          end
+        case (vis = options.fetch(:visible){ @selector.default_visibility })
+          when true then :visible
+          when false then :all
+          else vis
         end
       end
 

data/lib/capybara/rack_test/driver.rb

@@ -7,9 +7,9 @@ require 'cgi'
 
 class Capybara::RackTest::Driver < Capybara::Driver::Base
   DEFAULT_OPTIONS = {
-    :respect_data_method => false,
-    :follow_redirects => true,
-    :redirect_limit => 5
+    respect_data_method: false,
+    follow_redirects: true,
+    redirect_limit: 5
   }
   attr_reader :app, :options
 

data/lib/capybara/rails.rb

@@ -16,5 +16,5 @@ Capybara.save_path = Rails.root.join('tmp/capybara')
 
 # Override default rack_test driver to respect data-method attributes.
 Capybara.register_driver :rack_test do |app|
-  Capybara::RackTest::Driver.new(app, :respect_data_method => true)
+  Capybara::RackTest::Driver.new(app, respect_data_method: true)
 end

data/lib/capybara/rspec/features.rb

@@ -51,6 +51,6 @@ else
   end
 
   RSpec.configure do |config|
-    config.include(Capybara::Features, :capybara_feature => true)
+    config.include(Capybara::Features, capybara_feature: true)
   end
 end

data/lib/capybara/rspec/matchers.rb

@@ -16,8 +16,9 @@ module Capybara
     class HaveSelector < Matcher
       attr_reader :failure_message, :failure_message_when_negated
 
-      def initialize(*args)
+      def initialize(*args, &filter_block)
         @args = args
+        @filter_block = filter_block
       end
 
       def matches?(actual)
@@ -39,7 +40,7 @@ module Capybara
       end
 
       def query
-        @query ||= Capybara::Queries::SelectorQuery.new(*@args)
+        @query ||= Capybara::Queries::SelectorQuery.new(*@args, &@filter_block)
       end
 
       # RSpec 2 compatibility:
@@ -221,8 +222,8 @@ module Capybara
       alias_method :failure_message_for_should_not, :failure_message_when_negated
     end
 
-    def have_selector(*args)
-      HaveSelector.new(*args)
+    def have_selector(*args, &optional_filter_block)
+      HaveSelector.new(*args, &optional_filter_block)
     end
 
     def match_selector(*args)
@@ -233,16 +234,16 @@ module Capybara
     ::RSpec::Matchers.define_negated_matcher :not_match_selector, :match_selector if defined?(::RSpec::Expectations::Version) && (Gem::Version.new(RSpec::Expectations::Version::STRING) >= Gem::Version.new('3.1'))
 
 
-    def have_xpath(xpath, options={})
-      HaveSelector.new(:xpath, xpath, options)
+    def have_xpath(xpath, options={}, &optional_filter_block)
+      HaveSelector.new(:xpath, xpath, options, &optional_filter_block)
     end
 
     def match_xpath(xpath, options={})
       MatchSelector.new(:xpath, xpath, options)
     end
 
-    def have_css(css, options={})
-      HaveSelector.new(:css, css, options)
+    def have_css(css, options={}, &optional_filter_block)
+      HaveSelector.new(:css, css, options, &optional_filter_block)
     end
 
     def match_css(css, options={})
@@ -262,32 +263,39 @@ module Capybara
       HaveCurrentPath.new(path, options)
     end
 
-    def have_link(locator, options={})
-      HaveSelector.new(:link, locator, options)
+    def have_link(locator=nil, options={}, &optional_filter_block)
+      locator, options = nil, locator if locator.is_a? Hash
+      HaveSelector.new(:link, locator, options, &optional_filter_block)
     end
 
-    def have_button(locator, options={})
-      HaveSelector.new(:button, locator, options)
+    def have_button(locator=nil, options={}, &optional_filter_block)
+      locator, options = nil, locator if locator.is_a? Hash
+      HaveSelector.new(:button, locator, options, &optional_filter_block)
     end
 
-    def have_field(locator, options={})
-      HaveSelector.new(:field, locator, options)
+    def have_field(locator=nil, options={}, &optional_filter_block)
+      locator, options = nil, locator if locator.is_a? Hash
+      HaveSelector.new(:field, locator, options, &optional_filter_block)
     end
 
-    def have_checked_field(locator, options={})
-      HaveSelector.new(:field, locator, options.merge(:checked => true))
+    def have_checked_field(locator=nil, options={}, &optional_filter_block)
+      locator, options = nil, locator if locator.is_a? Hash
+      HaveSelector.new(:field, locator, options.merge(checked: true), &optional_filter_block)
     end
 
-    def have_unchecked_field(locator, options={})
-      HaveSelector.new(:field, locator, options.merge(:unchecked => true))
+    def have_unchecked_field(locator=nil, options={}, &optional_filter_block)
+      locator, options = nil, locator if locator.is_a? Hash
+      HaveSelector.new(:field, locator, options.merge(unchecked: true), &optional_filter_block)
     end
 
-    def have_select(locator, options={})
-      HaveSelector.new(:select, locator, options)
+    def have_select(locator=nil, options={}, &optional_filter_block)
+      locator, options = nil, locator if locator.is_a? Hash
+      HaveSelector.new(:select, locator, options, &optional_filter_block)
     end
 
-    def have_table(locator, options={})
-      HaveSelector.new(:table, locator, options)
+    def have_table(locator=nil, options={}, &optional_filter_block)
+      locator, options = nil, locator if locator.is_a? Hash
+      HaveSelector.new(:table, locator, options, &optional_filter_block)
     end
 
     ##
@@ -299,5 +307,6 @@ module Capybara
     def become_closed(options = {})
       BecomeClosed.new(options)
     end
+
   end
 end

data/lib/capybara/selector.rb

@@ -157,7 +157,7 @@ end
 #
 #  Find buttons ( input [of type submit, reset, image, button] or button elements )
 #
-# @locator Matches the id, value, or title attributes, string content of a button, or the alt attribute of an image type button
+# @locator Matches the id, 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
 #
 # @filter [String] :id  Matches the id attribute
 # @filter [String] :title Matches the title attribute
@@ -177,7 +177,7 @@ Capybara.add_selector(:button) do
 
       input_btn_xpath = input_btn_xpath[locator_matches]
 
-      btn_xpath = btn_xpath[locator_matches | XPath.string.n.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 |= XPath.attr(:'aria-label').is(locator) if Capybara.enable_aria_label

data/lib/capybara/selector/selector.rb

@@ -50,6 +50,7 @@ module Capybara
       @format = nil
       @expression = nil
       @expression_filters = []
+      @default_visibility = nil
       instance_eval(&block)
     end
 
@@ -186,6 +187,27 @@ module Capybara
       @filter_set.describe &block
     end
 
+    ##
+    #
+    # Set the default visibility mode that shouble be used if no visibile option is passed when using the selector.
+    # If not specified will default to the behavior indicated by Capybara.ignore_hidden_elements
+    #
+    # @param [Symbol] default_visibility  Only find elements with the specified visibility:
+    #                                              * :all - finds visible and invisible elements.
+    #                                              * :hidden - only finds invisible elements.
+    #                                              * :visible - only finds visible elements.
+    def visible(default_visibility)
+      @default_visibility = default_visibility
+    end
+
+    def default_visibility
+      if @default_visibility.nil?
+        Capybara.ignore_hidden_elements
+      else
+        @default_visibility
+      end
+    end
+
     private
 
     def locate_field(xpath, locator, options={})

data/lib/capybara/session.rb

@@ -20,7 +20,7 @@ module Capybara
   # +current_path, and so on. It also delegate a number of methods to a Capybara::Document, representing
   # the current HTML document. This allows interaction:
   #
-  #     session.fill_in('q', :with => 'Capybara')
+  #     session.fill_in('q', with: 'Capybara')
   #     session.click_button('Search')
   #     expect(session).to have_content('Capybara')
   #
@@ -264,7 +264,7 @@ module Capybara
     # to the given element.
     #
     #     within(:xpath, '//div[@id="delivery-address"]') do
-    #       fill_in('Street', :with => '12 Main Street')
+    #       fill_in('Street', with: '12 Main Street')
     #     end
     #
     # Just as with `find`, if multiple elements match the selector given to
@@ -275,13 +275,13 @@ module Capybara
     # assumed to be of the type set in Capybara.default_selector.
     #
     #     within('div#delivery-address') do
-    #       fill_in('Street', :with => '12 Main Street')
+    #       fill_in('Street', with: '12 Main Street')
     #     end
     #
     # Note that a lot of uses of `within` can be replaced more succinctly with
     # chaining:
     #
-    #     find('div#delivery-address').fill_in('Street', :with => '12 Main Street')
+    #     find('div#delivery-address').fill_in('Street', with: '12 Main Street')
     #
     # @overload within(*find_args)
     #   @param (see Capybara::Node::Finders#all)

data/lib/capybara/spec/session/accept_alert_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-Capybara::SpecHelper.spec '#accept_alert', :requires => [:modals] do
+Capybara::SpecHelper.spec '#accept_alert', requires: [:modals] do
   before do
     @session.visit('/with_js')
   end
@@ -10,14 +10,14 @@ Capybara::SpecHelper.spec '#accept_alert', :requires => [:modals] do
     end
     expect(@session).to have_xpath("//a[@id='open-alert' and @opened='true']")
   end
-  
+
   it "should accept the alert if the text matches" do
     @session.accept_alert 'Alert opened' do
       @session.click_link('Open alert')
     end
     expect(@session).to have_xpath("//a[@id='open-alert' and @opened='true']")
   end
-  
+
   it "should not accept the alert if the text doesnt match" do
     expect do
       @session.accept_alert 'Incorrect Text' do
@@ -47,7 +47,7 @@ Capybara::SpecHelper.spec '#accept_alert', :requires => [:modals] do
       end
       expect(message).to eq('Delayed alert opened')
     end
-    
+
     it "should allow to adjust the delay" do
       @session.accept_alert wait: 4 do
         @session.click_link('Open slow alert')

data/lib/capybara/spec/session/accept_confirm_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-Capybara::SpecHelper.spec '#accept_confirm', :requires => [:modals] do
+Capybara::SpecHelper.spec '#accept_confirm', requires: [:modals] do
   before do
     @session.visit('/with_js')
   end

data/lib/capybara/spec/session/accept_prompt_spec.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
-Capybara::SpecHelper.spec '#accept_prompt', :requires => [:modals] do
+Capybara::SpecHelper.spec '#accept_prompt', requires: [:modals] do
   before do
     @session.visit('/with_js')
   end
@@ -17,21 +17,21 @@ Capybara::SpecHelper.spec '#accept_prompt', :requires => [:modals] do
     end
     expect(message).to eq('Prompt opened')
   end
-  
+
   it "should accept the prompt with a response" do
     @session.accept_prompt with: 'the response' do
       @session.click_link('Open prompt')
     end
     expect(@session).to have_xpath("//a[@id='open-prompt' and @response='the response']")
   end
-  
+
   it "should accept the prompt if the message matches" do
     @session.accept_prompt 'Prompt opened', with: 'matched' do
       @session.click_link('Open prompt')
     end
     expect(@session).to have_xpath("//a[@id='open-prompt' and @response='matched']")
   end
-  
+
   it "should not accept the prompt if the message doesn't match" do
     expect do
       @session.accept_prompt 'Incorrect Text', with: 'not matched' do
@@ -39,7 +39,7 @@ Capybara::SpecHelper.spec '#accept_prompt', :requires => [:modals] do
       end
     end.to raise_error(Capybara::ModalNotFound)
   end
-  
+
 
   it "should return the message presented" do
     message = @session.accept_prompt with: 'the response' do

data/lib/capybara/spec/session/all_spec.rb

@@ -22,7 +22,7 @@ Capybara::SpecHelper.spec "#all" do
   end
 
   it "should raise an error when given invalid options" do
-    expect { @session.all('//p', :schmoo => "foo") }.to raise_error(ArgumentError)
+    expect { @session.all('//p', schmoo: "foo") }.to raise_error(ArgumentError)
   end
 
   context "with css selectors" do
@@ -53,11 +53,11 @@ Capybara::SpecHelper.spec "#all" do
 
   context "with visible filter" do
     it "should only find visible nodes when true" do
-      expect(@session.all(:css, "a.simple", :visible => true).size).to eq(1)
+      expect(@session.all(:css, "a.simple", visible: true).size).to eq(1)
     end
 
     it "should find nodes regardless of whether they are invisible when false" do
-      expect(@session.all(:css, "a.simple", :visible => false).size).to eq(2)
+      expect(@session.all(:css, "a.simple", visible: false).size).to eq(2)
     end
 
     it "should default to Capybara.ignore_hidden_elements" do
@@ -71,68 +71,68 @@ Capybara::SpecHelper.spec "#all" do
   context 'with element count filters' do
     context ':count' do
       it 'should succeed when the number of elements founds matches the expectation' do
-        expect { @session.all(:css, 'h1, p', :count => 4) }.to_not raise_error
+        expect { @session.all(:css, 'h1, p', count: 4) }.to_not raise_error
       end
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
-        expect { @session.all(:css, 'h1, p', :count => 5) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.all(:css, 'h1, p', count: 5) }.to raise_error(Capybara::ExpectationNotMet)
       end
     end
     context ':minimum' do
       it 'should succeed when the number of elements founds matches the expectation' do
-        expect { @session.all(:css, 'h1, p', :minimum => 0) }.to_not raise_error
+        expect { @session.all(:css, 'h1, p', minimum: 0) }.to_not raise_error
       end
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
-        expect { @session.all(:css, 'h1, p', :minimum => 5) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.all(:css, 'h1, p', minimum: 5) }.to raise_error(Capybara::ExpectationNotMet)
       end
     end
     context ':maximum' do
       it 'should succeed when the number of elements founds matches the expectation' do
-        expect { @session.all(:css, 'h1, p', :maximum => 4) }.to_not raise_error
+        expect { @session.all(:css, 'h1, p', maximum: 4) }.to_not raise_error
       end
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
-        expect { @session.all(:css, 'h1, p', :maximum => 0) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.all(:css, 'h1, p', maximum: 0) }.to raise_error(Capybara::ExpectationNotMet)
       end
     end
     context ':between' do
       it 'should succeed when the number of elements founds matches the expectation' do
-        expect { @session.all(:css, 'h1, p', :between => 2..7) }.to_not raise_error
+        expect { @session.all(:css, 'h1, p', between: 2..7) }.to_not raise_error
       end
       it 'should raise ExpectationNotMet when the number of elements founds does not match the expectation' do
-        expect { @session.all(:css, 'h1, p', :between => 0..3) }.to raise_error(Capybara::ExpectationNotMet)
+        expect { @session.all(:css, 'h1, p', between: 0..3) }.to raise_error(Capybara::ExpectationNotMet)
       end
     end
 
     context 'with multiple count filters' do
       it 'ignores other filters when :count is specified' do
-        o = {:count   => 4,
-             :minimum => 5,
-             :maximum => 0,
-             :between => 0..3}
+        o = {count: 4,
+             minimum: 5,
+             maximum: 0,
+             between: 0..3}
         expect { @session.all(:css, 'h1, p', o) }.to_not raise_error
       end
       context 'with no :count expectation' do
         it 'fails if :minimum is not met' do
-          o = {:minimum => 5,
-               :maximum => 4,
-               :between => 2..7}
+          o = {minimum: 5,
+               maximum: 4,
+               between: 2..7}
           expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
         end
         it 'fails if :maximum is not met' do
-          o = {:minimum => 0,
-               :maximum => 0,
-               :between => 2..7}
+          o = {minimum: 0,
+               maximum: 0,
+               between: 2..7}
           expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
         end
         it 'fails if :between is not met' do
-          o = {:minimum => 0,
-               :maximum => 4,
-               :between => 0..3}
+          o = {minimum: 0,
+               maximum: 4,
+               between: 0..3}
           expect { @session.all(:css, 'h1, p', o) }.to raise_error(Capybara::ExpectationNotMet)
         end
         it 'succeeds if all combineable expectations are met' do
-          o = {:minimum => 0,
-               :maximum => 4,
-               :between => 2..7}
+          o = {minimum: 0,
+               maximum: 4,
+               between: 2..7}
           expect { @session.all(:css, 'h1, p', o) }.to_not raise_error
         end
       end