capybara 2.9.0 → 2.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 074717523be47e7a162c2d4bc45f5ff49737e6a8
-  data.tar.gz: 25c95e6c9273c09663933921ba177067e622ea65
+  metadata.gz: 0e04794fbb1724e14269beeff9388b53a6f8603b
+  data.tar.gz: 377ee4cf8d61e2c1420ad7bc44b400e1f991ac30
 SHA512:
-  metadata.gz: d1db39b289e31ac1432a30cbe5ff8ce957867e1b3fd854813d8bfa954af0babb5a89ac1ccfa21ff6d5074b112a69e4b6deb751bc9c054026bad65d9a2f7d6e0d
-  data.tar.gz: 635c3bfb9e2d366ad8bc87a2abe075f2286e496fd2171bf32e6ef6628a55f8f95dfee2fd8e326819ca81d1dc0c85ac0dfee86d0491c5710e5c53f6e756e50c65
+  metadata.gz: afcaeaf6eb1aa0690b74ffa21acbaea6282b2ed0aba4382bc926ec6a6fbdd43bff3facc886e2d5558f7cf9af167a8278ef9ded0e946dbc9052168fc6583e94f4
+  data.tar.gz: b6be9f0cd07cc125a46f14c9a322b789547eb875252a10d217b4c1410080bf4be0c146c83361846a17a114b1c648416dca1a3301eefdb26087f215a0fa120872

data/History.md

@@ -1,3 +1,26 @@
+#2.10.0
+Release date: 2016-10-05
+
+### Added
+* Select `<button>` elements with descendant images with `alt` attributes matching the locator [Ian Lesperance]
+* Locator string is optional in selector based matchers [Thomas Walpole]
+* Selectors can specify their default visible setting [Thomas Walpole]
+* Selector based finders and matchers can be passed a block to filter the results within the retry behavior [Thomas Walpole]
+
+#Version 2.9.2
+Release date: 2016-09-29
+
+### Fixed
+* :label built-in selector finds nested label/control by control id if the label has no 'for' attribute [Thomas Walpole]
+* Warning issued if an unknown selector type is specified [Thomas Walpole]
+
+#Version 2.9.1
+Release date: 2016-09-23
+
+### Fixed
+* allow_label_click option did not work in some cases with Poltergeist - Issue #1762 [Thomas Walpole]
+* matches_selector? should have access to all of a selectors options except the count options [Thomas Walpole]
+
 #Version 2.9.0
 Release date: 2016-09-19
 

data/README.md

@@ -13,7 +13,7 @@ through an external gem.
 **Need help?** Ask on the mailing list (please do not open an issue on
 GitHub): http://groups.google.com/group/ruby-capybara
 
-**Note: Firefox 48** If you're using Firefox with selenium-webdriver, stay on either Firefox [45.0esr](https://ftp.mozilla.org/pub/firefox/releases/45.0esr/) or [47.0.1](https://ftp.mozilla.org/pub/firefox/releases/47.0.1/) and selenium-webdriver 2.53.4.  Firefox 48 requires geckodriver and selenium-webdriver v3, the combo of which currently has multiple issues and is feature incomplete.
+**Note: Firefox 48+** If you're using Firefox with selenium-webdriver, stay on either Firefox [45.0esr](https://ftp.mozilla.org/pub/firefox/releases/45.0esr/) or [47.0.1](https://ftp.mozilla.org/pub/firefox/releases/47.0.1/) and selenium-webdriver 2.53.4.  Firefox 48+ requires geckodriver and selenium-webdriver v3, the combo of which currently has multiple issues and is feature incomplete.
 
 ## Table of contents
 
@@ -107,8 +107,8 @@ You can use the Capybara DSL in your steps, like so:
 ```ruby
 When /I sign in/ do
   within("#session") do
-    fill_in 'Email', :with => 'user@example.com'
-    fill_in 'Password', :with => 'password'
+    fill_in 'Email', with: 'user@example.com'
+    fill_in 'Password', with: 'password'
   end
   click_button 'Sign in'
 end
@@ -150,14 +150,14 @@ You can now write your specs like so:
 ```ruby
 describe "the signin process", :type => :feature do
   before :each do
-    User.make(:email => 'user@example.com', :password => 'password')
+    User.make(email: 'user@example.com', password: 'password')
   end
 
   it "signs me in" do
     visit '/sessions/new'
     within("#session") do
-      fill_in 'Email', :with => 'user@example.com'
-      fill_in 'Password', :with => 'password'
+      fill_in 'Email', with: 'user@example.com'
+      fill_in 'Password', with: 'password'
     end
     click_button 'Sign in'
     expect(page).to have_content 'Success'
@@ -165,12 +165,12 @@ describe "the signin process", :type => :feature do
 end
 ```
 
-Use `:js => true` to switch to the `Capybara.javascript_driver`
+Use `js: true` to switch to the `Capybara.javascript_driver`
 (`:selenium` by default), or provide a `:driver` option to switch
 to one specific driver. For example:
 
 ```ruby
-describe 'some stuff which requires js', :js => true do
+describe 'some stuff which requires js', js: true do
   it 'will use the default js driver'
   it 'will switch to one specific driver', :driver => :webkit
 end
@@ -181,26 +181,26 @@ Capybara also comes with a built in DSL for creating descriptive acceptance test
 ```ruby
 feature "Signing in" do
   background do
-    User.make(:email => 'user@example.com', :password => 'caplin')
+    User.make(email: 'user@example.com', password: 'caplin')
   end
 
   scenario "Signing in with correct credentials" do
     visit '/sessions/new'
     within("#session") do
-      fill_in 'Email', :with => 'user@example.com'
-      fill_in 'Password', :with => 'caplin'
+      fill_in 'Email', with: 'user@example.com'
+      fill_in 'Password', with: 'caplin'
     end
     click_button 'Sign in'
     expect(page).to have_content 'Success'
   end
 
-  given(:other_user) { User.make(:email => 'other@example.com', :password => 'rous') }
+  given(:other_user) { User.make(email: 'other@example.com', password: 'rous') }
 
   scenario "Signing in as another user" do
     visit '/sessions/new'
     within("#session") do
-      fill_in 'Email', :with => other_user.email
-      fill_in 'Password', :with => other_user.password
+      fill_in 'Email', with: other_user.email
+      fill_in 'Password', with: other_user.password
     end
     click_button 'Sign in'
     expect(page).to have_content 'Invalid email or password'
@@ -308,7 +308,7 @@ Capybara.default_driver = :selenium
 
 However, if you are using RSpec or Cucumber, you may instead want to consider
 leaving the faster `:rack_test` as the __default_driver__, and marking only those
-tests that require a JavaScript-capable driver using `:js => true` or
+tests that require a JavaScript-capable driver using `js: true` or
 `@javascript`, respectively.  By default, JavaScript tests are run using the
 `:selenium` driver. You can change this by setting
 `Capybara.javascript_driver`.
@@ -344,7 +344,7 @@ RackTest can be configured with a set of headers like this:
 
 ```ruby
 Capybara.register_driver :rack_test do |app|
-  Capybara::RackTest::Driver.new(app, :headers => { 'HTTP_USER_AGENT' => 'Capybara' })
+  Capybara::RackTest::Driver.new(app, headers: { 'HTTP_USER_AGENT' => 'Capybara' })
 end
 ```
 
@@ -448,14 +448,14 @@ click_on('Button Value')
 There are a number of tools for interacting with form elements:
 
 ```ruby
-fill_in('First Name', :with => 'John')
-fill_in('Password', :with => 'Seekrit')
-fill_in('Description', :with => 'Really Long Text...')
+fill_in('First Name', with: 'John')
+fill_in('Password', with: 'Seekrit')
+fill_in('Description', with: 'Really Long Text...')
 choose('A Radio Button')
 check('A Checkbox')
 uncheck('A Checkbox')
 attach_file('Image', '/path/to/image.jpg')
-select('Option', :from => 'Select Box')
+select('Option', from: 'Select Box')
 ```
 
 ### <a name="querying"></a>Querying
@@ -504,6 +504,13 @@ find("#overlay").find("h1").click
 all('a').each { |a| a[:href] }
 ```
 
+If you need to find elements by additional attributes/properties you can also pass a filter block, which will be checked inside the normal waiting behavior.
+If you find yourself needing to use this a lot you may be better off adding a [custom selector](http://www.rubydoc.info/github/jnicklas/capybara/Capybara#add_selector-class_method) or [adding a filter to an existing selector](http://www.rubydoc.info/github/jnicklas/capybara/Capybara#modify_selector-class_method).
+
+```ruby
+find_field('First Name'){ |el| el['data-xyz'] == '123' }
+````
+
 **Note**: `find` will wait for an element to appear on the page, as explained in the
 Ajax section. If the element does not appear it will raise an error.
 
@@ -525,11 +532,11 @@ method. Optionally you can specify which kind of selector to use.
 
 ```ruby
 within("li#employee") do
-  fill_in 'Name', :with => 'Jimmy'
+  fill_in 'Name', with: 'Jimmy'
 end
 
 within(:xpath, "//li[@id='employee']") do
-  fill_in 'Name', :with => 'Jimmy'
+  fill_in 'Name', with: 'Jimmy'
 end
 ```
 
@@ -539,11 +546,11 @@ specific table, identified by either id or text of the table's caption tag.
 
 ```ruby
 within_fieldset('Employee') do
-  fill_in 'Name', :with => 'Jimmy'
+  fill_in 'Name', with: 'Jimmy'
 end
 
 within_table('Employee') do
-  fill_in 'Name', :with => 'Jimmy'
+  fill_in 'Name', with: 'Jimmy'
 end
 ```
 
@@ -781,9 +788,9 @@ module MyModule
   include Capybara::DSL
 
   def login!
-    within("//form[@id='session']") do
-      fill_in 'Email', :with => 'user@example.com'
-      fill_in 'Password', :with => 'password'
+    within(:xpath, "//form[@id='session']") do
+      fill_in 'Email', with: 'user@example.com'
+      fill_in 'Password', with: 'password'
     end
     click_button 'Sign in'
   end
@@ -852,9 +859,9 @@ manually.
 require 'capybara'
 
 session = Capybara::Session.new(:webkit, my_rack_app)
-session.within("//form[@id='session']") do
-  session.fill_in 'Email', :with => 'user@example.com'
-  session.fill_in 'Password', :with => 'password'
+session.within("form#session") do
+  session.fill_in 'Email', with: 'user@example.com'
+  session.fill_in 'Password', with: 'password'
 end
 session.click_button 'Sign in'
 ```

data/lib/capybara/node/actions.rb

@@ -62,7 +62,7 @@ module Capybara
       # Locate a text field or text area and fill it in with the given text
       # The field can be found via its name, id or label text.
       #
-      #     page.fill_in 'Name', :with => 'Bob'
+      #     page.fill_in 'Name', with: 'Bob'
       #
       #
       # @overload fill_in([locator], options={})
@@ -109,11 +109,12 @@ module Capybara
         allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }
 
         begin
-          find(:radio_button, locator, options).set(true)
-        rescue Capybara::ElementNotFound => e
-          raise unless allow_label_click
+          radio = find(:radio_button, locator, options)
+          radio.set(true)
+        rescue => e
+          raise unless allow_label_click && catch_error?(e)
           begin
-            radio = find(:radio_button, locator, options.merge({wait: 0, visible: :hidden}))
+            radio ||= find(:radio_button, locator, options.merge({wait: 0, visible: :all}))
             label = find(:label, for: radio, wait: 0, visible: true)
             label.click unless radio.checked?
           rescue
@@ -145,11 +146,12 @@ module Capybara
         allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }
 
         begin
-          find(:checkbox, locator, options).set(true)
-        rescue Capybara::ElementNotFound => e
-          raise unless allow_label_click
+          cbox = find(:checkbox, locator, options)
+          cbox.set(true)
+        rescue => e
+          raise unless allow_label_click && catch_error?(e)
           begin
-            cbox = find(:checkbox, locator, options.merge({wait: 0, visible: :hidden}))
+            cbox ||= find(:checkbox, locator, options.merge({wait: 0, visible: :all}))
             label = find(:label, for: cbox, wait: 0, visible: true)
             label.click unless cbox.checked?
           rescue
@@ -181,11 +183,12 @@ module Capybara
         allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }
 
         begin
-          find(:checkbox, locator, options).set(false)
-        rescue Capybara::ElementNotFound => e
-          raise unless allow_label_click
+          cbox = find(:checkbox, locator, options)
+          cbox.set(false)
+        rescue => e
+          raise unless allow_label_click && catch_error?(e)
           begin
-            cbox = find(:checkbox, locator, options.merge({wait: 0, visible: :hidden}))
+            cbox ||= find(:checkbox, locator, options.merge({wait: 0, visible: :all}))
             label = find(:label, for: cbox, wait: 0, visible: true)
             label.click if cbox.checked?
           rescue
@@ -203,7 +206,7 @@ module Capybara
       # one option.
       # The select box can be found via its name, id or label text. The option can be found by its text.
       #
-      #     page.select 'March', :from => 'Month'
+      #     page.select 'March', from: 'Month'
       #
       # @macro waiting_behavior
       #
@@ -225,7 +228,7 @@ module Capybara
       # box is a multiple select, +unselect+ can be called multiple times to unselect more than
       # one option. The select box can be found via its name, id or label text.
       #
-      #     page.unselect 'March', :from => 'Month'
+      #     page.unselect 'March', from: 'Month'
       #
       # @macro waiting_behavior
       #

data/lib/capybara/node/base.rb

@@ -17,9 +17,9 @@ module Capybara
     #
     #     session = Capybara::Session.new(:rack_test, my_app)
     #     session.visit('/')
-    #     session.fill_in('Foo', :with => 'Bar')    # from Capybara::Node::Actions
+    #     session.fill_in('Foo', with: 'Bar')    # from Capybara::Node::Actions
     #     bar = session.find('#bar')                # from Capybara::Node::Finders
-    #     bar.select('Baz', :from => 'Quox')        # from Capybara::Node::Actions
+    #     bar.select('Baz', from: 'Quox')        # from Capybara::Node::Actions
     #     session.has_css?('#foobar')               # from Capybara::Node::Matchers
     #
     class Base

data/lib/capybara/node/element.rb

@@ -10,7 +10,7 @@ module Capybara
     #     session = Capybara::Session.new(:rack_test, my_app)
     #
     #     bar = session.find('#bar')              # from Capybara::Node::Finders
-    #     bar.select('Baz', :from => 'Quox')      # from Capybara::Node::Actions
+    #     bar.select('Baz', from: 'Quox')      # from Capybara::Node::Actions
     #
     # {Capybara::Node::Element} also has access to HTML attributes and other properties of the
     # element:

data/lib/capybara/node/finders.rb

@@ -19,7 +19,7 @@ module Capybara
       #
       #     page.find('#foo').find('.bar')
       #     page.find(:xpath, '//div[contains(., "bar")]')
-      #     page.find('li', :text => 'Quox').click_link('Delete')
+      #     page.find('li', text: 'Quox').click_link('Delete')
       #
       # @param (see Capybara::Node::Finders#all)
       #
@@ -28,8 +28,8 @@ module Capybara
       # @return [Capybara::Node::Element]      The found element
       # @raise  [Capybara::ElementNotFound]    If the element can't be found before time expires
       #
-      def find(*args)
-        query = Capybara::Queries::SelectorQuery.new(*args)
+      def find(*args, &optional_filter_block)
+        query = Capybara::Queries::SelectorQuery.new(*args, &optional_filter_block)
         synchronize(query.wait) do
           if (query.match == :smart or query.match == :prefer_exact) and query.supports_exact?
             result = query.resolve_for(self, true)
@@ -74,9 +74,9 @@ module Capybara
       # @return [Capybara::Node::Element]   The found element
       #
 
-      def find_field(locator=nil, options={})
+      def find_field(locator=nil, options={}, &optional_filter_block)
         locator, options = nil, locator if locator.is_a? Hash
-        find(:field, locator, options)
+        find(:field, locator, options, &optional_filter_block)
       end
       alias_method :field_labeled, :find_field
 
@@ -96,9 +96,9 @@ module Capybara
       #   @option options [String, Array<String>] class    Match links that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
-      def find_link(locator=nil, options={})
+      def find_link(locator=nil, options={}, &optional_filter_block)
         locator, options = nil, locator if locator.is_a? Hash
-        find(:link, locator, options)
+        find(:link, locator, options, &optional_filter_block)
       end
 
       ##
@@ -125,9 +125,9 @@ module Capybara
       #   @option options [String, Array<String>] class    Match links that match the class(es) provided
       # @return [Capybara::Node::Element]   The found element
       #
-      def find_button(locator=nil, options={})
+      def find_button(locator=nil, options={}, &optional_filter_block)
         locator, options = nil, locator if locator.is_a? Hash
-        find(:button, locator, options)
+        find(:button, locator, options, &optional_filter_block)
       end
 
       ##
@@ -140,11 +140,12 @@ module Capybara
       #
       # @return [Capybara::Node::Element]   The found element
       #
-      def find_by_id(id, options={})
-        find(:id, id, options)
+      def find_by_id(id, options={}, &optional_filter_block)
+        find(:id, id, options, &optional_filter_block)
       end
 
       ##
+      # @!method all([kind = Capybara.default_selector], locator = nil, options = {})
       #
       # Find all elements on the page matching the given selector
       # and options.
@@ -168,42 +169,45 @@ module Capybara
       # The set of found elements can further be restricted by specifying
       # options. It's possible to select elements by their text or visibility:
       #
-      #     page.all('a', :text => 'Home')
-      #     page.all('#menu li', :visible => true)
+      #     page.all('a', text: 'Home')
+      #     page.all('#menu li', visible: true)
       #
       # By default if no elements are found, an empty array is returned;
       # however, expectations can be set on the number of elements to be found which
       # will trigger Capybara's waiting behavior for the expectations to match.The
       # expectations can be set using
       #
-      #     page.assert_selector('p#foo', :count => 4)
-      #     page.assert_selector('p#foo', :maximum => 10)
-      #     page.assert_selector('p#foo', :minimum => 1)
-      #     page.assert_selector('p#foo', :between => 1..10)
+      #     page.assert_selector('p#foo', count: 4)
+      #     page.assert_selector('p#foo', maximum: 10)
+      #     page.assert_selector('p#foo', minimum: 1)
+      #     page.assert_selector('p#foo', between: 1..10)
       #
       # See {Capybara::Helpers#matches_count?} for additional information about
       # count matching.
       #
-      # @overload all([kind], locator, options)
-      #   @param [:css, :xpath] kind                 The type of selector
-      #   @param [String] locator                    The selector
-      #   @option options [String, Regexp] text      Only find elements which contain this text or match this regexp
-      #   @option options [Boolean, Symbol] visible  Only find elements with the specified visibility:
+      # @param [Symbol] kind                       Optional selector type (:css, :xpath, :field, etc.) - Defaults to Capybara.default_selector
+      # @param [String] locator                    The selector
+      # @option options [String, Regexp] text      Only find elements which contain this text or match this regexp
+      # @option options [Boolean, Symbol] visible  Only find elements with the specified visibility:
       #                                              * true - only finds visible elements.
       #                                              * false - finds invisible _and_ visible elements.
       #                                              * :all - same as false; finds visible and invisible elements.
       #                                              * :hidden - only finds invisible elements.
       #                                              * :visible - same as true; only finds visible elements.
-      #   @option options [Integer] count            Exact number of matches that are expected to be found
-      #   @option options [Integer] maximum          Maximum number of matches that are expected to be found
-      #   @option options [Integer] minimum          Minimum number of matches that are expected to be found
-      #   @option options [Range]   between          Number of matches found must be within the given range
-      #   @option options [Boolean] exact            Control whether `is` expressions in the given XPath match exactly or partially
-      #   @option options [Integer] wait (Capybara.default_max_wait_time)  The time to wait for element count expectations to become true
+      # @option options [Integer] count            Exact number of matches that are expected to be found
+      # @option options [Integer] maximum          Maximum number of matches that are expected to be found
+      # @option options [Integer] minimum          Minimum number of matches that are expected to be found
+      # @option options [Range]   between          Number of matches found must be within the given range
+      # @option options [Boolean] exact            Control whether `is` expressions in the given XPath match exactly or partially
+      # @option options [Integer] wait (Capybara.default_max_wait_time)  The time to wait for element count expectations to become true
+      # @overload all([kind = Capybara.default_selector], locator = nil, options = {})
+      # @overload all([kind = Capybara.default_selector], locator = nil, options = {}, &filter_block)
+      #   @yieldparam element [Capybara::Node::Element]  The element being considered for inclusion in the results
+      #   @yieldreturn [Boolean]                     Should the element be considered in the results?
       # @return [Capybara::Result]                   A collection of found elements
       #
-      def all(*args)
-        query = Capybara::Queries::SelectorQuery.new(*args)
+      def all(*args, &optional_filter_block)
+        query = Capybara::Queries::SelectorQuery.new(*args, &optional_filter_block)
         synchronize(query.wait) do
           result = query.resolve_for(self)
           raise Capybara::ExpectationNotMet, result.failure_message unless result.matches_count?
@@ -227,15 +231,16 @@ module Capybara
       #   @param [Hash] options                      Additional options; see {#all}
       # @return [Capybara::Node::Element]            The found element or nil
       #
-      def first(*args)
+      def first(*args, &optional_filter_block)
         if Capybara.wait_on_first_by_default
           options = if args.last.is_a?(Hash) then args.pop.dup else {} end
           args.push({minimum: 1}.merge(options))
         end
-        all(*args).first
+        all(*args, &optional_filter_block).first
       rescue Capybara::ExpectationNotMet
         nil
       end
+
     end
   end
 end