capybara 3.16.1 → 3.33.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 92cb6d4aa4a576f2755522ba6641d9b4b7592f10d1e9573e12483deaba309874
-  data.tar.gz: b5d917eba936b657e3fc34533afd5c820a90de237cbf59330631cb25fa17026f
+  metadata.gz: ab64d9d47c6374c4f203945be70b868fb9e4c48d3fdca087ba4e66498e40b91c
+  data.tar.gz: 451c97390c148b5b0fad1b06107a4f0de87f17f7b8cef7156fb76ad2ee503f76
 SHA512:
-  metadata.gz: 49a1bb248d392130169b51793e62f7bb8153d157c158018865d2a62d1df9354d1b56e04f9d33d5e1c09e1e0ce595ce3fd8a82bf14b698f64d9cbeca422becc2f
-  data.tar.gz: ae82a233efabfd21e89364d1117eca4836509a7eb3d883bcf3fd3a50d82013ca9562759750004f7ee87db13ba4fda015ec0f6a25c2e29ffa33a58c0a8b784743
+  metadata.gz: b0ca3fd8a4535e1df696ddc7f547e066b873d3f4be2b54655fdbb0b6588c5086a87b93500e241e0da031b586c0b6a30cdd8522f209309cf6729c683226bfcf7f
+  data.tar.gz: d295dcd733856816a1c89810f4d54304a52c251d585afcc62b986a66d63e080e03ddc81bdc46cf51a044e29d2849ccce9bb3cb307a0757746e662394f648a717

data/.yardopts

@@ -0,0 +1 @@
+--markup markdown

data/History.md

@@ -1,3 +1,324 @@
+# Version 3.33.0
+Release date: 2020-06-21
+
+### Added
+
+* Block passed to `within_session` now receives the new and old session
+* Support for aria-role button when enabled [Seiei Miyagi]
+* Support for aria-role link when enabled
+* Support for `validation_message` filter with :field and :fillable_field selectors
+
+### Changed
+
+* Ruby 2.5.0+ is now required
+* Deprecated direct manupulation of the driver and server registries
+
+### Fixed
+
+* Ruby 2.7 warning in minitest `assert_text` [Eileen M. Uchitelle]
+
+
+# Version 3.32.2
+Release date: 2020-05-16
+
+### Fixed
+
+* Don't use lazy enumerator with JRuby due to leaking threads
+* Ruby 2.7 deprecation warning when registering Webrick [Jon Zeppieri]
+* `have_text` description [Juan Pablo Rinaldi]
+
+# Version 3.32.1
+Release date: 2020-04-05
+
+### Fixed
+
+* Rapid set now respects field maxlength (Issue #2332)
+* Only patch pause into legacy actions in Selenium < 4 (Issue #2334)
+
+# Version 3.32.0
+Release date: 2020-03-29
+
+### Added
+
+* Support `delay` setting on click with Selenium
+* Implement rapid set for values longer thn 30 characters in text fields with Selenium
+
+### Fixed
+
+* Result#[] and negative max on ranges (Issue #2302/2303) [Jeremy Evans]
+* RackTest form submission rewrites query string when using GET method
+* Ruby 2.7 deprecation warnings in RSpec matcher proxies
+
+# Version 3.31.0
+Release date: 2020-01-26
+
+### Added
+
+* Support setting range inputs with the selenium driver [Andrew White]
+* Support setting range inputs with the rack driver
+* Support drop modifier keys in drag & drop [Elliot Crosby-McCullough]
+* `enabled_options` and `disabled options` filters for select selector
+* Support beginless ranges
+* Optionally allow `all` results to be reloaded when stable - Beta feature - may be removed in
+  future version if problems occur
+
+### Fixed
+
+* Fix Ruby 2.7 deprecation notices around keyword arguments. I have tried to do this without
+  any breaking changes, but due to the nature of the 2.7 changes and some selector types accepting
+  Hashes as locators there are a lot of edge cases. If you find any broken cases please report
+  them and I'll see if they're fixable.
+* Clicking on details/summary element behavior in rack_test driver_
+
+# Version 3.30.0
+Release date: 2019-12-24
+
+### Added
+
+* Display pending requests when they don't complete in time [Juan Carlos Medina]
+* :order option in selector queries - set to :reverse to for reverse document order results
+* Support regexp for :name and :placeholder options in selectors that import filters from
+  _field filter set
+
+### Fixed
+
+* Issue around automatic port assignment - Issue #2245
+* Label selector when label has no id - Issue #2260
+* Preserve clientX/clientY in Selenium HTML5 drag emulation [Nicolò G.]
+* table selector using :with_cols option if last specified column matched but others didn't - Issue #2287
+* Some tests updated for Ruby 2.7 behavior change around keyword args
+
+# Version 3.29.0
+Release date: 2019-09-02
+
+### Added
+
+* Allow clicking on file input when using the block version of `attach_file` with Chrome and Firefox
+* Spatial filters (`left_of`, `right_of`, `above`, `below`, `near`)
+* rack_test driver now supports clicking on details elements to open/close them
+
+### Fixed
+
+* rack_test driver correctly determines visibility for open details elements descendants
+
+### Changed
+
+* Results will now be lazily evaluated when using JRuby >= 9.2.8.0
+
+
+# Version 3.28.0
+Release date: 2019-08-03
+
+### Added
+
+* Allow forcing HTML5 or legacy dragging via the `:html5` option to `drag_to` when using Selenium with Chrome or Firefox
+* Autodetection of drag type interprets not seeing the mousedown event as legacy.
+* HTML5 form validation `:valid` node filter added to `:field` and `:fillable_field` selectors
+* When using Capybara registered :puma server - patches Puma 4.0.x to fix SSL connection behavior. Removes
+  default `queue_requests` setting - Issue #2227
+
+# Version 3.27.0
+Release date: 2019-07-28
+
+### Added
+
+* Allow to use chromedriver/geckodriver native `is_element_displayed` endpoint via Selenium
+  driver `native_displayed` option for performance reasons. Disabled by default due to endpoints
+  currently not handling &lt;details> element descendants visibility correctly.
+
+### Fixed
+
+* Ignore negative lookahead/lookbehind regex when performing initial XPath text matching
+* Reloading of elements found via `ancestor` and `sibling`
+* Only default puma settings to `queue_requests: false` when using SSL
+* Visibility of descendants of &lt;details> elements is correctly determined when using rack_test
+  and the selenium driver with Capybara optimized atoms
+* local/session storage clearance in Chrome when clearing only one of them - Issue #2233
+
+# Version 3.26.0
+Release date: 2019-07-15
+
+### Added
+
+* `w3c_click_offset` configuration option applies to `right_click` and `double_click` as well as `click`
+* Warning when passing `nil` to the text/content assertions/expectations
+* `Session#server_url` returns the base url the AUT is being run at (when controlled by Capybara)
+* `option` selector type accepts an integer as locator
+
+### Fixed
+
+* Default puma server registration now specifies `queue_requests: false` - Issue #2227
+* Workaround issue with FF 68 and hanging during reset if a system modal is visible
+* Don't expand file path if it's already absolute - Issue #2228
+
+# Version 3.25.0
+Release date: 2019-06-27
+
+### Added
+
+* Animation disabler also disables before and after pseudoelements - Issue #2221 [Daniel Heath]
+* `w3c_click_offset` configuration option to determine whether click offsets are calculated from element
+  center or top left corner
+
+### Fixed
+
+* Woraround issue with chromedriver 76/77 in W3C mode losing mouse state during legacy drag. Only fixed if
+  both source and target are simultaenously inside the viewport - Issue #2223
+* Negative ancestor expectations/predicates were incorrectly checking siblings rather than ancestors
+
+# Version 3.24.0
+Release date: 2019-06-13
+
+### Added
+
+* Log access when using the Selenium driver with Chrome 75 in W3C mode has been reenabled.
+
+### Changed
+
+* Selenium driver now selects all current content and then sends keys rather than clearing field by JS
+  and then sending keys when setting values to text inputs in order to more closely simulate user behavior
+
+### Fixed
+
+* Relative paths passed to `attach_file` will be assumed to be relative to the current working directory when using the
+  Selenium driver
+
+# Version 3.23.0
+Release date: 2019-06-10
+
+### Added
+
+* Improved error message when using Chrome in W3C mode and attempting to access logs
+* Support driver specific options for Element#drag_to
+* Support setting `<input type="color">` elements with the selenium driver
+
+### Fixed
+
+* Tightened conditions when in expression text option matching will be used
+* Improved Selenium drivers HTML5 drag and drop emulation compatibility with SortableJS library (and others)
+
+# Version 3.22.0
+Release date: 2019-05-29
+
+### Added
+
+* `ancestor`/`sibling` assertions and matchers added
+* Documentation Updates and Fixes - Many thanks again to Masafumi Koba! [Masafumi Koba]
+* Added `:with` alias for `:option` filter on `:checkbox` and `:radio_button` selectors
+
+### Changed
+
+* Selenium driver with Chrome >= 73 now resets cookies and local/session storage after navigating
+  to 'about:blank' when possible to minimize potential race condition
+
+# Version 3.21.0
+Release date: 2019-05-24
+
+### Added
+
+* Element#drop - Chrome and Firefox, via the selenium driver, support dropping files/data on elements
+* Default CSS used for `attach_file` `make_visible: true` now includes auto for
+  height and width to handle more ways of hiding the file input element
+* Documentation Updates and Fixes - Many thanks to Masafumi Koba! [Masafumi Koba]
+
+### Changed
+
+* Deprecate support for CSS locator being a Symbol
+
+# Version 3.20.2
+Release date: 2019-05-19
+
+### Fixed
+
+* Move `uglifier` from runtime to development dependency [miyucy]
+
+# Version 3.20.1
+Release date: 2019-05-17
+
+### Fixed
+
+* RackTest driver considers &lt;template> elements to be non-visible and ignores the contents
+
+# Version 3.20.0
+Release date: 2019-05-14
+
+### Added
+
+* `Node#obscured?` to check viewport presence and element overlap
+* `:obscured` system filter to check whether elements are obscured in finders, assertions, and expectations
+* :label selector :for option can be a regexp
+* Significantly smaller `isDisplayed`/`getAttribute` atoms for selenium driver. If these produce issues you can disable their use
+  by setting an environment variable named 'DISABLE_CAPYBARA_SELENIUM_OPTIMIZATIONS' (Please also report any issues).
+* `href: false` option with `find_link`/`click_link`/:link selector ignores `href` presence/absence
+
+### Fixed
+
+* Workaround Safari issue with send_keys not correctly using top level modifiers
+* Workaround Safari not retrying click due to incorrect error type
+* Fix Safari attach_file block mode when clicking elements associated to the file input
+* Workaround Safari issue with repeated hover
+
+# Version 3.19.1
+Release date: 2019-05-11
+
+### Fixed
+
+* Fix access to specializations when Selenium::Driver is subclassed [James Mead]
+
+# Version 3.19.0
+Release date: 2019-05-09
+
+### Added
+
+
+* Syntactic sugar `#once`, `#twice`, `#thrice`, `#exactly`, `#at_least`, `#at_most`, and `#times`
+  added to `have_selector`, `have_css`, `have_xpath`, and `have_text` RSpec matchers
+* Support for multiple expression types in Selector definitions
+* Reduced wirecalls for common actions in Selenium driver
+
+### Fixed
+
+* Workaround Chrome 75 appending files to multiple file inputs
+* Suppressed retry when detecting http vs https server connection
+
+# Version 3.18.0
+Release date: 2019-04-22
+
+### Added
+
+* XPath Selector query optimized to make use of Regexp :text option in initial element find
+
+### Fixed
+
+* Workaround issue where Chrome/chromedriver 74 can return the wrong error type when a click is intercepted
+
+# Version 3.17.0
+Release date: 2019-04-18
+
+### Added
+
+* Initial support for selenium-webdriver 4.0.0.alpha1
+* :button selector will now also match on `name` attribute
+
+### Fixed
+
+* Suppress warnings generated by using selenium-webdriver 3.141.5926
+* Mask Appium issue with finder visibility optimizations (non-optimal)
+
+# Version 3.16.2
+Release date: 2019-04-10
+
+### Fixed
+
+* Fix Session#quit resetting of memoized document
+
+# Version 3.16.1
+Release date: 2019-03-30
+
+### Fixed
+
+* Fix potential 'uninitialized constant' error when using the :selenium_chrome driver [jeffclemens-ab]
+
 # Version 3.16
 Release date: 2019-03-28
 

data/README.md

@@ -3,11 +3,11 @@
 [![Build Status](https://secure.travis-ci.org/teamcapybara/capybara.svg)](https://travis-ci.org/teamcapybara/capybara)
 [![Build Status](https://ci.appveyor.com/api/projects/status/github/teamcapybara/capybara?svg=true)](https://ci.appveyor.com/api/projects/github/teamcapybara/capybara)
 [![Code Climate](https://codeclimate.com/github/teamcapybara/capybara.svg)](https://codeclimate.com/github/teamcapybara/capybara)
+[![Coverage Status](https://coveralls.io/repos/github/teamcapybara/capybara/badge.svg?branch=master)](https://coveralls.io/github/teamcapybara/capybara?branch=master)
 [![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)
 [![SemVer](https://api.dependabot.com/badges/compatibility_score?dependency-name=capybara&package-manager=bundler&version-scheme=semver)](https://dependabot.com/compatibility-score.html?dependency-name=capybara&package-manager=bundler&version-scheme=semver)
 
-**Note** You are viewing the README for the 3.16.x version of Capybara.
-
+**Note** You are viewing the README for the 3.33.x release of Capybara.
 
 Capybara helps you test web applications by simulating how a real user would
 interact with your app. It is agnostic about the driver running your tests and
@@ -37,8 +37,6 @@ GitHub): http://groups.google.com/group/ruby-capybara
     - [RackTest](#racktest)
     - [Selenium](#selenium)
     - [Apparition](#apparition)
-    - [Capybara-webkit](#capybara-webkit)
-    - [Poltergeist](#poltergeist)
 - [The DSL](#the-dsl)
     - [Navigating](#navigating)
     - [Clicking links and buttons](#clicking-links-and-buttons)
@@ -58,11 +56,13 @@ GitHub): http://groups.google.com/group/ruby-capybara
 - [Using the DSL elsewhere](#using-the-dsl-elsewhere)
 - [Calling remote servers](#calling-remote-servers)
 - [Using sessions](#using-sessions)
+    - [Named sessions](#named-sessions)
+    - [Using sessions manually](#using-sessions-manually)
 - [XPath, CSS and selectors](#xpath-css-and-selectors)
 - [Beware the XPath // trap](#beware-the-xpath--trap)
 - [Configuring and adding drivers](#configuring-and-adding-drivers)
 - [Gotchas:](#gotchas)
-- ["Threadsafe" mode](#threadsafe)
+- ["Threadsafe" mode](#threadsafe-mode)
 - [Development](#development)
 
 ## <a name="key-benefits"></a>Key benefits
@@ -76,7 +76,7 @@ GitHub): http://groups.google.com/group/ruby-capybara
 
 ## <a name="setup"></a>Setup
 
-Capybara requires Ruby 2.3.0 or later. To install, add this line to your
+Capybara requires Ruby 2.5.0 or later. To install, add this line to your
 `Gemfile` and run `bundle install`:
 
 ```ruby
@@ -149,7 +149,7 @@ require 'capybara/rspec'
 
 If you are using Rails, put your Capybara specs in `spec/features` or `spec/system` (only works
 if [you have it configured in
-RSpec](https://www.relishapp.com/rspec/rspec-rails/docs/upgrade#file-type-inference-disabled))
+RSpec](https://relishapp.com/rspec/rspec-rails/v/4-0/docs/directory-structure))
 and if you have your Capybara specs in a different directory, then tag the
 example groups with `type: :feature` or `type: :system` depending on which type of test you're writing.
 
@@ -183,7 +183,7 @@ to one specific driver. For example:
 ```ruby
 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
+  it 'will switch to one specific driver', driver: :apparition
 end
 ```
 
@@ -260,7 +260,7 @@ end
 
 ## <a name="using-capybara-with-minitest"></a>Using Capybara with Minitest
 
-* If you are using Rails, add the following code in your `test_helper.rb`
+* If you are using Rails, but not using Rails system tests, add the following code in your `test_helper.rb`
     file to make Capybara available in all test cases deriving from
     `ActionDispatch::IntegrationTest`:
 
@@ -275,8 +275,7 @@ end
       include Capybara::Minitest::Assertions
 
       # Reset sessions and driver between tests
-      # Use super wherever this method is redefined in your individual test classes
-      def teardown
+      teardown do
         Capybara.reset_sessions!
         Capybara.use_default_driver
       end
@@ -341,9 +340,9 @@ For example if you'd prefer to run everything in Selenium, you could do:
 Capybara.default_driver = :selenium # :selenium_chrome and :selenium_chrome_headless are also registered
 ```
 
-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
+However, if you are using RSpec or Cucumber (and your app runs correctly without JS),
+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
 `@javascript`, respectively.  By default, JavaScript tests are run using the
 `:selenium` driver. You can change this by setting
 `Capybara.javascript_driver`.
@@ -352,7 +351,7 @@ You can also change the driver temporarily (typically in the Before/setup and
 After/teardown blocks):
 
 ```ruby
-Capybara.current_driver = :webkit # temporarily select different driver
+Capybara.current_driver = :apparition # temporarily select different driver
 # tests here
 Capybara.use_default_driver       # switch back to default driver
 ```
@@ -392,7 +391,7 @@ Capybara supports [Selenium 3.5+
 In order to use Selenium, you'll need to install the `selenium-webdriver` gem,
 and add it to your Gemfile if you're using bundler.
 
-Capybara pre-registers a number of named drives that use Selenium - they are:
+Capybara pre-registers a number of named drivers that use Selenium - they are:
 
   * :selenium                 => Selenium driving Firefox
   * :selenium_headless        => Selenium driving Firefox in a headless configuration
@@ -410,42 +409,12 @@ and test server, see [Transactions and database setup](#transactions-and-databas
 
 ### <a name="apparition"></a>Apparition
 
-The [apparition driver](https://github.com/twalpole/apparition) in a new driver that allows you to run tests using Chrome in a headless
+The [apparition driver](https://github.com/twalpole/apparition) is a new driver that allows you to run tests using Chrome in a headless
 or headed configuration. It attempts to provide backwards compatibility with the [Poltergeist driver API](https://github.com/teampoltergeist/poltergeist)
-while allowing for the use of modern JS/CSS. It uses CDP to communicate with Chrome, thereby obviating the need for chromedriver.
-A compatibility layer for capybara-webkit is planned, although has not yet been started. This driver is being developed by the
-maintainer of Capybara and will attempt to keep up to date with new Capybara releases. It will probably be moved into the
-teamcapybara repo once completely stable.
-
-### <a name="capybara-webkit"></a>Capybara-webkit
-
-Note: `capybara-webkit` depends on QtWebkit which went end-of-life quite some time ago. There has been an attempt to revive the project but `capybara-webkit` is not yet (as far as I know) compatible with the revived version of QtWebKit (could be a good open source project for someone) and as such is still limited to an old version of QtWebKit.  This means its support for modern JS and CSS is severely limited.
-
-The [capybara-webkit driver](https://github.com/thoughtbot/capybara-webkit) is for true headless
-testing. It uses QtWebKit to start a rendering engine process. It can execute JavaScript as well.
-It is significantly faster than drivers like Selenium since it does not load an entire browser.
-
-You can install it with:
-
-```bash
-gem install capybara-webkit
-```
-
-And you can use it by:
-
-```ruby
-Capybara.javascript_driver = :webkit
-```
-
-### <a name="poltergeist"></a>Poltergeist
-
-Note: `poltergeist` depends on PhantomJS for which active development ended quite some time ago (2.1.1). As such it is roughly equivalent to a 6-7 year old version of Safari, meaning lack of support for modern JS and CSS. If any effort to update PhantomJS succeeds in the future this situation could change.
-
-[Poltergeist](https://github.com/teampoltergeist/poltergeist) is another
-headless driver which integrates Capybara with
-[PhantomJS](http://phantomjs.org/). It is truly headless, so doesn't
-require Xvfb to run on your CI server. It will also detect and report
-any Javascript errors that happen within the page.
+and [capybara-webkit API](https://github.com/thoughtbot/capybara-webkit) while allowing for the use of modern JS/CSS. It
+uses CDP to communicate with Chrome, thereby obviating the need for chromedriver. This driver is being developed by the
+current developer of Capybara and will attempt to keep up to date with new Capybara releases. It will probably be moved into the
+teamcapybara repo once it reaches v1.0.
 
 ## <a name="the-dsl"></a>The DSL
 
@@ -640,13 +609,23 @@ In drivers which support it, you can easily execute JavaScript:
 page.execute_script("$('body').empty()")
 ```
 
-For simple expressions, you can return the result of the script. Note
-that this may break with more complicated expressions:
+For simple expressions, you can return the result of the script.
 
 ```ruby
 result = page.evaluate_script('4 + 4');
 ```
 
+For more complicated scripts you'll need to write them as one expression.
+
+```ruby
+result = page.evaluate_script(<<~JS, 3, element)
+  (function(n, el){
+    var val = parseInt(el.value, 10);
+    return n+val;
+  })(arguments[0], arguments[1])
+JS
+```
+
 ### <a name="modals"></a>Modals
 
 In drivers which support it, you can accept, dismiss and respond to alerts, confirms and prompts.
@@ -955,12 +934,17 @@ Capybara.default_selector = :xpath
 find('.//ul/li').text
 ```
 
-Capybara allows you to add custom selectors, which can be very useful if you
-find yourself using the same kinds of selectors very often:
+Capybara provides a number of other built-in selector types. The full list, along
+with applicable filters, can be seen at [built-in selectors](https://www.rubydoc.info/github/teamcapybara/capybara/Capybara/Selector)
+
+Capybara also allows you to add custom selectors, which can be very useful if you
+find yourself using the same kinds of selectors very often. The examples below are very
+simple, and there are many available features not demonstrated. For more in-depth examples
+please see Capybaras built-in selector definitions.
 
 ```ruby
-Capybara.add_selector(:id) do
-  xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }
+Capybara.add_selector(:my_attribute) do
+  xpath { |id| XPath.descendant[XPath.attr(:my_attribute) == id.to_s] }
 end
 
 Capybara.add_selector(:row) do
@@ -977,9 +961,9 @@ an XPath expression generated through the XPath gem. You can now use these
 selectors like this:
 
 ```ruby
-find(:id, 'post_123')
-find(:row, 3)
-find(:flash_type, :notice)
+find(:my_attribute, 'post_123') # find element with matching attribute
+find(:row, 3) # find 3rd row in table body
+find(:flash_type, :notice) # find element with id of 'flash' and class of 'notice'
 ```
 
 ## <a name="beware-the-xpath--trap"></a>Beware the XPath // trap
@@ -1071,6 +1055,13 @@ additional info about how the underlying driver can be configured.
   are testing for specific server errors and using multiple sessions make sure to test for the
   errors using the initial session (usually :default)
 
+* If WebMock is enabled, you may encounter a "Too many open files"
+  error. A simple `page.find` call may cause thousands of HTTP requests
+  until the timeout occurs. By default, WebMock will cause each of these
+  requests to spawn a new connection. To work around this problem, you
+  may need to [enable WebMock's `net_http_connect_on_start: true`
+  parameter](https://github.com/bblimke/webmock/blob/master/README.md#connecting-on-nethttpstart).
+
 ## <a name="threadsafe"></a>"Threadsafe" mode
 
 In normal mode most of Capybara's configuration options are global settings which can cause issues