capybara 3.8.1 → 3.33.0

data/README.md

@@ -3,12 +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 development version of Capybara.  If you are using the current release version
-you can find the README at https://github.com/teamcapybara/capybara/blob/3.8_stable/README.md
-
+**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 +36,7 @@ GitHub): http://groups.google.com/group/ruby-capybara
     - [Selecting the Driver](#selecting-the-driver)
     - [RackTest](#racktest)
     - [Selenium](#selenium)
-    - [Capybara-webkit](#capybara-webkit)
-    - [Poltergeist](#poltergeist)
+    - [Apparition](#apparition)
 - [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
@@ -140,7 +140,7 @@ There are also explicit tags for each registered driver set up for you (`@seleni
 
 ## <a name="using-capybara-with-rspec"></a>Using Capybara with RSpec
 
-Load RSpec 3.x support by adding the following line (typically to your
+Load RSpec 3.5+ support by adding the following line (typically to your
 `spec_helper.rb` file):
 
 ```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
 ```
 
@@ -219,7 +219,7 @@ feature "Signing in" do
 end
 ```
 
-`feature` is in fact just an alias for `describe ..., type:> :feature`,
+`feature` is in fact just an alias for `describe ..., type: :feature`,
 `background` is an alias for `before`, `scenario` for `it`, and
 `given`/`given!` aliases for `let`/`let!`, respectively.
 
@@ -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,9 +391,10 @@ 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
   * :selenium_chrome          => Selenium driving Chrome
   * :selenium_chrome_headless => Selenium driving Chrome in a headless configuration
 
@@ -405,37 +405,16 @@ to the browsers.  See the section on adding and configuring drivers.
 
 **Note**: drivers which run the server in a different thread may not share the
 same transaction as your tests, causing data not to be shared between your test
-and test server, see "Transactions and database setup" below.
-
-### <a name="capybara-webkit"></a>Capybara-webkit
-
-Note: `capybara-webkit` depends on QtWebkit which went EOL quite some time ago. There has been an attempt to revive the project but `capybara-webkit` is not yet (AFAIK) compatible with the revived version of QtWebKit (could be a good OSS 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. Y
-
-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:
+and test server, see [Transactions and database setup](#transactions-and-database-setup) below.
 
-```ruby
-Capybara.javascript_driver = :webkit
-```
-
-### <a name="poltergeist"></a>Poltergeist
+### <a name="apparition"></a>Apparition
 
-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.
+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)
+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
 
@@ -630,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.
@@ -945,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
@@ -967,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
@@ -1061,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

data/lib/capybara/config.rb

@@ -7,12 +7,13 @@ module Capybara
   class Config
     extend Forwardable
 
-    OPTIONS = %i[app reuse_server threadsafe default_wait_time server default_driver javascript_driver].freeze
+    OPTIONS = %i[app reuse_server threadsafe server default_driver javascript_driver allow_gumbo].freeze
 
     attr_accessor :app
     attr_reader :reuse_server, :threadsafe
     attr_reader :session_options
     attr_writer :default_driver, :javascript_driver
+    attr_accessor :allow_gumbo
 
     SessionConfig::OPTIONS.each do |method|
       def_delegators :session_options, method, "#{method}="
@@ -26,7 +27,10 @@ module Capybara
     attr_writer :reuse_server
 
     def threadsafe=(bool)
-      raise 'Threadsafe setting cannot be changed once a session is created' if (bool != threadsafe) && Session.instance_created?
+      if (bool != threadsafe) && Session.instance_created?
+        raise 'Threadsafe setting cannot be changed once a session is created'
+      end
+
       @threadsafe = bool
     end
 
@@ -57,7 +61,7 @@ module Capybara
       @server = if name.respond_to? :call
         name
       elsif options
-        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, options) }
+        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, **options) }
       else
         Capybara.servers[name.to_sym]
       end
@@ -81,7 +85,9 @@ module Capybara
 
     def deprecate(method, alternate_method, once = false)
       @deprecation_notified ||= {}
-      warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once && @deprecation_notified[method]
+      unless once && @deprecation_notified[method]
+        warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
+      end
       @deprecation_notified[method] = true
     end
   end

data/lib/capybara/cucumber.rb

@@ -22,6 +22,6 @@ end
 Before do |scenario|
   scenario.source_tag_names.each do |tag|
     driver_name = tag.sub(/^@/, '').to_sym
-    Capybara.current_driver = driver_name if Capybara.drivers.key?(driver_name)
+    Capybara.current_driver = driver_name if Capybara.drivers[driver_name]
   end
 end

data/lib/capybara/driver/base.rb

@@ -15,11 +15,11 @@ class Capybara::Driver::Base
     raise NotImplementedError
   end
 
-  def find_xpath(query)
+  def find_xpath(query, **options)
     raise NotImplementedError
   end
 
-  def find_css(query)
+  def find_css(query, **options)
     raise NotImplementedError
   end
 

data/lib/capybara/driver/node.rb

@@ -3,11 +3,12 @@
 module Capybara
   module Driver
     class Node
-      attr_reader :driver, :native
+      attr_reader :driver, :native, :initial_cache
 
-      def initialize(driver, native)
+      def initialize(driver, native, initial_cache = {})
         @driver = driver
         @native = native
+        @initial_cache = initial_cache
       end
 
       def all_text
@@ -30,8 +31,8 @@ module Capybara
         raise NotImplementedError
       end
 
-      # @param value String or Array. Array is only allowed if node has 'multiple' attribute
-      # @param options [Hash{}] Driver specific options for how to set a value on a node
+      # @param value [String, Array] Array is only allowed if node has 'multiple' attribute
+      # @param options [Hash] Driver specific options for how to set a value on a node
       def set(value, **options)
         raise NotImplementedError
       end
@@ -64,7 +65,19 @@ module Capybara
         raise NotImplementedError
       end
 
-      def drag_to(element)
+      def drag_to(element, **options)
+        raise NotImplementedError
+      end
+
+      def drop(*args)
+        raise NotImplementedError
+      end
+
+      def scroll_by(x, y)
+        raise NotImplementedError
+      end
+
+      def scroll_to(element, alignment, position = nil)
         raise NotImplementedError
       end
 
@@ -76,6 +89,10 @@ module Capybara
         raise NotImplementedError
       end
 
+      def obscured?
+        raise NotImplementedError
+      end
+
       def checked?
         raise NotImplementedError
       end
@@ -96,6 +113,10 @@ module Capybara
         !!self[:multiple]
       end
 
+      def rect
+        raise NotSupportedByDriverError, 'Capybara::Driver::Node#rect'
+      end
+
       def path
         raise NotSupportedByDriverError, 'Capybara::Driver::Node#path'
       end

data/lib/capybara/dsl.rb

@@ -18,8 +18,8 @@ module Capybara
     #
     # Shortcut to working in a different session.
     #
-    def using_session(name, &block)
-      Capybara.using_session(name, &block)
+    def using_session(name_or_session, &block)
+      Capybara.using_session(name_or_session, &block)
     end
 
     # Shortcut to using a different wait time.
@@ -47,8 +47,16 @@ module Capybara
     end
 
     Session::DSL_METHODS.each do |method|
-      define_method method do |*args, &block|
-        page.send method, *args, &block
+      if RUBY_VERSION >= '2.7'
+        class_eval <<~METHOD, __FILE__, __LINE__ + 1
+          def #{method}(...)
+            page.method("#{method}").call(...)
+          end
+        METHOD
+      else
+        define_method method do |*args, &block|
+          page.send method, *args, &block
+        end
       end
     end
   end

data/lib/capybara/helpers.rb

@@ -41,7 +41,7 @@ module Capybara
     ##
     #
     # Injects a `<base>` tag into the given HTML code, pointing to
-    # `Capybara.asset_host`.
+    # {Capybara.configure asset_host}.
     #
     # @param [String] html     HTML code to inject into
     # @param [URL] host (Capybara.asset_host) The host from which assets should be loaded
@@ -49,8 +49,9 @@ module Capybara
     #
     def inject_asset_host(html, host: Capybara.asset_host)
       if host && Nokogiri::HTML(html).css('base').empty?
-        match = html.match(/<head[^<]*?>/)
-        return html.clone.insert match.end(0), "<base href='#{host}' />" if match
+        html.match(/<head[^<]*?>/) do |m|
+          return html.clone.insert m.end(0), "<base href='#{host}' />"
+        end
       end
       html
     end
@@ -86,7 +87,10 @@ module Capybara
       end
 
       def expired?
-        raise Capybara::FrozenInTime, 'Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead' if stalled?
+        if stalled?
+          raise Capybara::FrozenInTime, 'Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead'
+        end
+
         current - @start >= @expire_in
       end