capybara 2.10.2 → 2.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 21fdd89225cd5ecf58f6e1eb72da29832f70ba9a
-  data.tar.gz: edada38839bc4b98461a27b02f196ec2e2e58ac7
+  metadata.gz: b4d75941bdc33b8e4b3d26aa8beb1a6d063fabca
+  data.tar.gz: 692a680d4d550e566e6c558bfe53608a024b4e49
 SHA512:
-  metadata.gz: 4f2ed74c7e278e93c5dcf3f92ab35b51a2b31578bff67e25c83076f65ab8e7edd50a2b63afd41ddd65e0a7bc438e6d27adcaae17fcafad6f0e4cd52b241e5797
-  data.tar.gz: a97567024d5a9d18858e8b4b1b9920819a6655708f87206ad5c281de9bb39cb5e2185dd1f710618e745483c925ba6e09bbba143d17f7ded222c80acab7be9ce2
+  metadata.gz: e9eee2dae8d51f3bff73da658a08d2aeefd6383c16cec7b269abbb2c99203239c996c83b0145946d473cc0d3d1076abd623f672dfa07dd4ad0ed9a74ea2ef001
+  data.tar.gz: 2fef0e0fb22d31ccbd4879df37100feb6c717508c57266539245d07a3ba74c3849ae02cab2dfc735054b6344effb2c4f6783658e95a3513737aa81cabb39f83e

data/History.md

@@ -1,3 +1,18 @@
+#2.11.0
+Release date: 2016-12-05
+
+### Added
+* Options for clearing session/local storage on reset added to the Selenium driver
+* Window size changes wait for the size to stabilize
+* Defined return value for most actions
+* Ignore specific error when qutting selenium driver instance - Issue #1773 [Dylan Reichstadt, Thomas Walpole]
+* Warn on selenium unknown errors rather than raising when quitting driver [Adam Pohorecki, Thomas Walpole]
+* Capybara::Result#each now returns an `Enumerator` when called without a block - Issue #1777 [Thomas Walpole]
+
+### Fixed
+* Selenium driver with Chrome should support multiple file upload [Thomas Walpole]
+* Fix visible: :hidden with :text option behavior [Thomas Walpole]
+
 #2.10.2
 Release date: 2016-11-30
 

data/README.md

@@ -1,8 +1,8 @@
 # Capybara
 
-[![Build Status](https://secure.travis-ci.org/jnicklas/capybara.svg)](https://travis-ci.org/jnicklas/capybara)
-[![Dependency Status](https://gemnasium.com/jnicklas/capybara.svg)](https://gemnasium.com/jnicklas/capybara)
-[![Code Climate](https://codeclimate.com/github/jnicklas/capybara.svg)](https://codeclimate.com/github/jnicklas/capybara)
+[![Build Status](https://secure.travis-ci.org/teamcapybara/capybara.svg)](https://travis-ci.org/teamcapybara/capybara)
+[![Dependency Status](https://gemnasium.com/teamcapybara/capybara.svg)](https://gemnasium.com/teamcapybara/capybara)
+[![Code Climate](https://codeclimate.com/github/teamcapybara/capybara.svg)](https://codeclimate.com/github/teamcapybara/capybara)
 [![Gitter](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/jnicklas/capybara?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
 
 Capybara helps you test web applications by simulating how a real user would
@@ -13,7 +13,21 @@ 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 and want full functionality 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/).
+If using selenium-webdriver 3.0+ this will require configuring your driver with the `marionette: false` option as shown below
+
+```ruby
+Capybara.register_driver :selenium do |app|
+  Capybara::Selenium::Driver.new(
+    app,
+    browser: :firefox,
+    desired_capabilities: Selenium::WebDriver::Remote::Capabilities.firefox(marionette: false)
+  )
+end
+```
+
+Using Firefox 48+ requires geckodriver and selenium-webdriver v3, the combo of which currently has multiple issues and is feature incomplete.
+You can read more about the missing features [here](https://github.com/teamcapybara/capybara/issues/1710).
 
 ## Table of contents
 
@@ -129,7 +143,7 @@ tags set up for you.
 
 ## <a name="using-capybara-with-rspec"></a>Using Capybara with RSpec
 
-Load RSpec 2.x support by adding the following line (typically to your
+Load RSpec 2+ support by adding the following line (typically to your
 `spec_helper.rb` file):
 
 ```ruby
@@ -392,7 +406,7 @@ any Javascript errors that happen within the page.
 ## <a name="the-dsl"></a>The DSL
 
 *A complete reference is available at
-[rubydoc.info](http://rubydoc.info/github/jnicklas/capybara/master)*.
+[rubydoc.info](http://rubydoc.info/github/teamcapybara/capybara/master)*.
 
 **Note: By default Capybara will only locate visible elements. This is because
  a real user would not be able to interact with non-visible elements.**
@@ -403,7 +417,7 @@ Capybara heavily uses XPath, which doesn't support case insensitivity.
 ### <a name="navigating"></a>Navigating
 
 You can use the
-<tt>[visit](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Session#visit-instance_method)</tt>
+<tt>[visit](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Session#visit-instance_method)</tt>
 method to navigate to other pages:
 
 ```ruby
@@ -414,8 +428,8 @@ visit(post_comments_path(post))
 The visit method only takes a single parameter, the request method is **always**
 GET.
 
-You can get the [current path](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Session#current_path-instance_method)
-of the browsing session, and test it using the [`have_current_path`](http://www.rubydoc.info/github/jnicklas/capybara/master/Capybara/RSpecMatchers#have_current_path-instance_method) matcher:
+You can get the [current path](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Session#current_path-instance_method)
+of the browsing session, and test it using the [`have_current_path`](http://www.rubydoc.info/github/teamcapybara/capybara/master/Capybara/RSpecMatchers#have_current_path-instance_method) matcher:
 
 ```ruby
 expect(page).to have_current_path(post_comments_path(post))
@@ -428,7 +442,7 @@ to ensure that preceding actions (such as a `click_link`) have completed.
 
 ### <a name="clicking-links-and-buttons"></a>Clicking links and buttons
 
-*Full reference: [Capybara::Node::Actions](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Node/Actions)*
+*Full reference: [Capybara::Node::Actions](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Node/Actions)*
 
 You can interact with the webapp by following links and buttons. Capybara
 automatically follows any redirects, and submits forms associated with buttons.
@@ -443,7 +457,7 @@ click_on('Button Value')
 
 ### <a name="interacting-with-forms"></a>Interacting with forms
 
-*Full reference: [Capybara::Node::Actions](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Node/Actions)*
+*Full reference: [Capybara::Node::Actions](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Node/Actions)*
 
 There are a number of tools for interacting with form elements:
 
@@ -460,16 +474,16 @@ select('Option', from: 'Select Box')
 
 ### <a name="querying"></a>Querying
 
-*Full reference: [Capybara::Node::Matchers](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Node/Matchers)*
+*Full reference: [Capybara::Node::Matchers](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Node/Matchers)*
 
 Capybara has a rich set of options for querying the page for the existence of
 certain elements, and working with and manipulating those elements.
 
 ```ruby
 page.has_selector?('table tr')
-page.has_selector?(:xpath, '//table/tr')
+page.has_selector?(:xpath, './/table/tr')
 
-page.has_xpath?('//table/tr')
+page.has_xpath?('.//table/tr')
 page.has_css?('table tr.foo')
 page.has_content?('foo')
 ```
@@ -481,34 +495,39 @@ You can use these with RSpec's magic matchers:
 
 ```ruby
 expect(page).to have_selector('table tr')
-expect(page).to have_selector(:xpath, '//table/tr')
+expect(page).to have_selector(:xpath, './/table/tr')
 
-expect(page).to have_xpath('//table/tr')
+expect(page).to have_xpath('.//table/tr')
 expect(page).to have_css('table tr.foo')
 expect(page).to have_content('foo')
 ```
 
 ### <a name="finding"></a>Finding
 
-_Full reference: [Capybara::Node::Finders](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Node/Finders)_
+_Full reference: [Capybara::Node::Finders](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Node/Finders)_
 
 You can also find specific elements, in order to manipulate them:
 
 ```ruby
 find_field('First Name').value
+find_field(id: 'my_field').value
 find_link('Hello', :visible => :all).visible?
+find_link(class: ['some_class', 'some_other_class'], :visible => :all).visible?
+
 find_button('Send').click
+find_button(value: '1234').click
 
-find(:xpath, "//table/tr").click
+find(:xpath, ".//table/tr").click
 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).
+If you find yourself needing to use this a lot you may be better off adding a [custom selector](http://www.rubydoc.info/github/teamcapybara/capybara/Capybara#add_selector-class_method) or [adding a filter to an existing selector](http://www.rubydoc.info/github/teamcapybara/capybara/Capybara#modify_selector-class_method).
 
 ```ruby
 find_field('First Name'){ |el| el['data-xyz'] == '123' }
+find("#img_loading"){ |img| img['complete'] == true }
 ````
 
 **Note**: `find` will wait for an element to appear on the page, as explained in the
@@ -527,7 +546,7 @@ expect(find('#navigation')).to have_button('Sign out')
 Capybara makes it possible to restrict certain actions, such as interacting with
 forms or clicking links and buttons, to within a specific area of the page. For
 this purpose you can use the generic
-<tt>[within](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Session#within-instance_method)</tt>
+<tt>[within](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Session#within-instance_method)</tt>
 method. Optionally you can specify which kind of selector to use.
 
 ```ruby
@@ -535,7 +554,7 @@ within("li#employee") do
   fill_in 'Name', with: 'Jimmy'
 end
 
-within(:xpath, "//li[@id='employee']") do
+within(:xpath, ".//li[@id='employee']") do
   fill_in 'Name', with: 'Jimmy'
 end
 ```
@@ -632,7 +651,7 @@ save_and_open_page
 ```
 
 You can also retrieve the current state of the DOM as a string using
-<tt>[page.html](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Session#html-instance_method)</tt>.
+<tt>[page.html](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Session#html-instance_method)</tt>.
 
 ```ruby
 print page.html
@@ -788,7 +807,7 @@ module MyModule
   include Capybara::DSL
 
   def login!
-    within(:xpath, "//form[@id='session']") do
+    within(:xpath, ".//form[@id='session']") do
       fill_in 'Email', with: 'user@example.com'
       fill_in 'Password', with: 'password'
     end
@@ -852,7 +871,7 @@ Capybara.session_name = "some other session"
 ### <a name="using-sessions-manually"></a>Using sessions manually
 
 For ultimate control, you can instantiate and use a
-[Session](http://rubydoc.info/github/jnicklas/capybara/master/Capybara/Session)
+[Session](http://rubydoc.info/github/teamcapybara/capybara/master/Capybara/Session)
 manually.
 
 ```ruby
@@ -873,16 +892,16 @@ and will always use CSS by default.  If you want to use XPath, you'll need to
 do:
 
 ```ruby
-within(:xpath, '//ul/li') { ... }
-find(:xpath, '//ul/li').text
-find(:xpath, '//li[contains(.//a[@href = "#"]/text(), "foo")]').value
+within(:xpath, './/ul/li') { ... }
+find(:xpath, './/ul/li').text
+find(:xpath, './/li[contains(.//a[@href = "#"]/text(), "foo")]').value
 ```
 
 Alternatively you can set the default selector to XPath:
 
 ```ruby
 Capybara.default_selector = :xpath
-find('//ul/li').text
+find('.//ul/li').text
 ```
 
 Capybara allows you to add custom selectors, which can be very useful if you
@@ -1010,5 +1029,5 @@ bundle exec rake  # run the test suite
 ```
 
 See
-[CONTRIBUTING.md](https://github.com/jnicklas/capybara/blob/master/CONTRIBUTING.md)
+[CONTRIBUTING.md](https://github.com/teamcapybara/capybara/blob/master/CONTRIBUTING.md)
 for how to send issues and pull requests.

data/lib/capybara.rb

@@ -25,7 +25,8 @@ module Capybara
     attr_accessor :server_port, :exact, :match, :exact_options, :visible_text_only, :enable_aria_label
     attr_accessor :default_selector, :default_max_wait_time, :ignore_hidden_elements
     attr_accessor :save_path, :wait_on_first_by_default, :automatic_label_click, :automatic_reload
-    attr_accessor :reuse_server, :raise_server_errors, :server_errors
+    attr_reader :reuse_server
+    attr_accessor :raise_server_errors, :server_errors
     attr_writer :default_driver, :current_driver, :javascript_driver, :session_name, :server_host
     attr_reader :save_and_open_page_path
     attr_accessor :app
@@ -331,7 +332,7 @@ module Capybara
     #
     def reset_sessions!
       #reset in reverse so sessions that started servers are reset last
-      session_pool.reverse_each { |mode, session| session.reset! }
+      session_pool.reverse_each { |_mode, session| session.reset! }
     end
     alias_method :reset!, :reset_sessions!
 
@@ -391,12 +392,12 @@ module Capybara
     end
 
     def app_host=(url)
-      raise ArgumentError.new("Capybara.app_host should be set to a url (http://www.example.com)") unless url.nil? || (url =~ URI::regexp)
+      raise ArgumentError.new("Capybara.app_host should be set to a url (http://www.example.com)") unless url.nil? || (url =~ URI::Parser.new.make_regexp)
       @app_host = url
     end
 
     def default_host=(url)
-      raise ArgumentError.new("Capybara.default_host should be set to a url (http://www.example.com)") unless url.nil? || (url =~ URI::regexp)
+      raise ArgumentError.new("Capybara.default_host should be set to a url (http://www.example.com)") unless url.nil? || (url =~ URI::Parser.new.make_regexp)
       @default_host = url
     end
 
@@ -469,7 +470,7 @@ module Capybara
   require 'capybara/selenium/driver'
 end
 
-Capybara.register_server :default do |app, port, host|
+Capybara.register_server :default do |app, port, _host|
   Capybara.run_default_server(app, port)
 end
 
@@ -479,10 +480,8 @@ Capybara.register_server :webrick do |app, port, host|
 end
 
 Capybara.register_server :puma do |app, port, host|
-  require 'puma'
-  Puma::Server.new(app).tap do |s|
-    s.add_tcp_listener host, port
-  end.run.join
+  require 'rack/handler/puma'
+  Rack::Handler::Puma.run(app, Host: host, Port: port, Threads: "0:4")
 end
 
 Capybara.configure do |config|

data/lib/capybara/node/actions.rb

@@ -18,6 +18,8 @@ module Capybara
       #
       #   @param [String] locator      Text, id or value of link or button
       #
+      # @return [Capybara::Node::Element]  The element clicked
+      #
       def click_link_or_button(locator=nil, options={})
         locator, options = nil, locator if locator.is_a? Hash
         find(:link_or_button, locator, options).click
@@ -35,6 +37,7 @@ module Capybara
       #   @param [String] locator         text, id, title or nested image's alt attribute
       #   @param options                  See {Capybara::Node::Finders#find_link}
       #
+      # @return [Capybara::Node::Element]  The element clicked
       def click_link(locator=nil, options={})
         locator, options = nil, locator if locator.is_a? Hash
         find(:link, locator, options).click
@@ -52,6 +55,7 @@ module Capybara
       # @overload click_button([locator], options)
       #   @param [String] locator      Which button to find
       #   @param options     See {Capybara::Node::Finders#find_button}
+      # @return [Capybara::Node::Element]  The element clicked
       def click_button(locator=nil, options={})
         locator, options = nil, locator if locator.is_a? Hash
         find(:button, locator, options).click
@@ -77,6 +81,7 @@ module Capybara
       #   @option options [String] :placeholder    Match fields that match the placeholder attribute
       #   @option options [String, Array<String>] :class    Match links that match the class(es) provided
       #
+      # @return [Capybara::Node::Element]  The element filled_in
       def fill_in(locator, options={})
         locator, options = nil, locator if locator.is_a? Hash
         raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with)
@@ -104,23 +109,10 @@ module Capybara
       #   @option options [String, Array<String>] :class    Match links that match the class(es) provided
       #   @macro waiting_behavior
       #   @macro label_click
+      #
+      # @return [Capybara::Node::Element]  The element chosen or the label clicked
       def choose(locator, options={})
-        locator, options = nil, locator if locator.is_a? Hash
-        allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }
-
-        begin
-          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: :all}))
-            label = find(:label, for: radio, wait: 0, visible: true)
-            label.click unless radio.checked?
-          rescue
-            raise e
-          end
-        end
+        _check_with_label(:radio_button, true, locator, options)
       end
 
       ##
@@ -141,23 +133,9 @@ module Capybara
       #   @macro label_click
       #   @macro waiting_behavior
       #
+      # @return [Capybara::Node::Element]  The element checked or the label clicked
       def check(locator, options={})
-        locator, options = nil, locator if locator.is_a? Hash
-        allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }
-
-        begin
-          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: :all}))
-            label = find(:label, for: cbox, wait: 0, visible: true)
-            label.click unless cbox.checked?
-          rescue
-            raise e
-          end
-        end
+        _check_with_label(:checkbox, true, locator, options)
       end
 
       ##
@@ -178,23 +156,9 @@ module Capybara
       #   @macro label_click
       #   @macro waiting_behavior
       #
+      # @return [Capybara::Node::Element]  The element unchecked or the label clicked
       def uncheck(locator, options={})
-        locator, options = nil, locator if locator.is_a? Hash
-        allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }
-
-        begin
-          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: :all}))
-            label = find(:label, for: cbox, wait: 0, visible: true)
-            label.click if cbox.checked?
-          rescue
-            raise e
-          end
-        end
+        _check_with_label(:checkbox, false, locator, options)
       end
 
       ##
@@ -213,6 +177,7 @@ module Capybara
       # @param [String] value                   Which option to select
       # @option options [String] :from  The id, name or label of the select box
       #
+      # @return [Capybara::Node::Element]  The option element selected
       def select(value, options={})
         if options.has_key?(:from)
           from = options.delete(:from)
@@ -235,6 +200,7 @@ module Capybara
       # @param [String] value                   Which option to unselect
       # @param [Hash{:from => String}] options  The id, name or label of the select box
       #
+      # @return [Capybara::Node::Element]  The option element unselected
       def unselect(value, options={})
         if options.has_key?(:from)
           from = options.delete(:from)
@@ -263,6 +229,7 @@ module Capybara
       # @option options [String] name           Match fields that match the name attribute
       # @option options [String, Array<String>] :class    Match links that match the class(es) provided
       #
+      # @return [Capybara::Node::Element]  The file field element
       def attach_file(locator, path, options={})
         locator, path, options = nil, locator, path if path.is_a? Hash
         Array(path).each do |p|
@@ -270,6 +237,30 @@ module Capybara
         end
         find(:file_field, locator, options).set(path)
       end
+
+    private
+
+      def _check_with_label(selector, checked, locator, options)
+        locator, options = nil, locator if locator.is_a? Hash
+        allow_label_click = options.delete(:allow_label_click) { Capybara.automatic_label_click }
+
+        synchronize(Capybara::Queries::BaseQuery::wait(options)) do
+          begin
+            el = find(selector, locator, options)
+            el.set(checked)
+          rescue => e
+            raise unless allow_label_click && catch_error?(e)
+            begin
+              el ||= find(selector, locator, options.merge(visible: :all))
+              label = find(:label, for: el, visible: true)
+              label.click unless (el.checked? == checked)
+            rescue
+              raise e
+            end
+          end
+        end
+      end
+
     end
   end
 end