capybara 2.18.0 → 3.0.0.rc1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb46b7bc5ae7408ca3870b781d015a84bd84abd0a9c7e3ea2bcdf3d8fff85ce8
-  data.tar.gz: 1865dc1efa384c3792161a134bc536c56dca3aa0670ca298ad9f3aa12b49830d
+  metadata.gz: 21f91a983551012c790ae444974b24f9d0349d79c36706d4a9143523b2827605
+  data.tar.gz: 54de192348948696b54e66ff9fc7622311b88fd7d71e842b0737be060bfdc59a
 SHA512:
-  metadata.gz: 9bc2cb739af408323d977b7ca829aa0862ef68ab7d1778c5ae67fb127a47a09258c1f5b53f9d7955bcfcd2892c869a136d7a5346b9115a9e55713ea47c95ebb3
-  data.tar.gz: e8d234ded45305e026b615c60e4eb8597e31fd67b7daefff51d13ab3d79868745e21668a6b45452366ac5a552b38e8c01dc669e73dbe45a9b38ecf8363b54e83
+  metadata.gz: 62ab87128fa70c43cfa688d55c9ae208095b632999cbd44969971cfcbefed37b4719e8c8e2c0350e13dd69a2e35ec5799d1f7f105cd717cfa277b091b42041db
+  data.tar.gz: 3c013b9add97330680def4a948246360ccf0bbc520e8b8573b0bdee4dfcbde751d7f9626268fe682aa613975d4ad126e776cba7075a50259769e120bec09b61d

data/History.md

@@ -1,4 +1,27 @@
-#Version 2.18.0
+# Version 3.0.0.rc1
+Release date: 2018-03-02
+
+### Added
+* Support for libraries wrapping Capybara elements and providing a `#to_capybara_node` method
+
+### Changed
+
+* `first` now raises ElementNotFound, by default, instead of returning nil, when no matches are found  - Issue #1507
+* 'all' now waits for at least one matching element by default.  Pass `wait: false` if you want the previous
+  behavior where an empty result would be returned immediately if no matching elements exist yet.
+* ArgumentError raised if extra parameters passed to selector queries
+
+### Removed
+
+* Ruby < 2.2.2 support
+* `Capybara.exact_options` no longer exists. Just use `exact:true` on relevant actions/finders if necessary.
+* All previously deprecated methods removed
+* RSpec 2.x support
+* selenium-webdriver 2.x support
+* Nokogiri < 1.8 support
+* `field_labeled` alaias for `find_field`
+
+# Version 2.18.0
 Release date: 2018-02-12
 
 ### Fixed
@@ -10,6 +33,7 @@ Release date: 2018-02-12
 
 * Headless chrome modal JS injection that is no longer needed for Chrome 64+/chromedriver 2.35+
 
+
 # Version 2.17.0
 Release date: 2018-01-02
 
@@ -253,6 +277,7 @@ Release date: 2016-10-05
 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]
 

data/README.md

@@ -5,6 +5,10 @@
 [![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)
 
+**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/2.17_stable/README.md
+
+
 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
 comes with Rack::Test and Selenium support built in. WebKit is supported
@@ -71,24 +75,19 @@ GitHub): http://groups.google.com/group/ruby-capybara
 
 ## <a name="setup"></a>Setup
 
-Capybara requires Ruby 1.9.3 or later. To install, add this line to your
+Capybara requires Ruby 2.2.0 or later. To install, add this line to your
 `Gemfile` and run `bundle install`:
 
 ```ruby
 gem 'capybara'
 ```
 
-**Note:** If using Ruby < 2.0 you will also need to limit the version of rack to < 2.0
-
 If the application that you are testing is a Rails app, add this line to your test helper file:
 
 ```ruby
 require 'capybara/rails'
 ```
 
-**Note:** In Rails 4.0/4.1 the default test environment (`config/environments/test.rb`) is [not threadsafe](https://github.com/rails/rails/issues/15089).
-If you experience random errors about missing constants, add `config.allow_concurrency = false` to `config/environments/test.rb`.
-
 If the application that you are testing is a Rack app, but not Rails, set Capybara.app to your Rack app:
 
 ```ruby
@@ -140,18 +139,18 @@ 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 2+ support by adding the following line (typically to your
+Load RSpec 3.x support by adding the following line (typically to your
 `spec_helper.rb` file):
 
 ```ruby
 require 'capybara/rspec'
 ```
 
-If you are using Rails, put your Capybara specs in `spec/features` (only works
+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))
 and if you have your Capybara specs in a different directory, then tag the
-example groups with `:type => :feature`.
+example groups with `:type => :feature` or `:type => :system` depending on which type of test you're writing.
 
 If you are not using Rails, tag all the example groups in which you want to use
 Capybara with `:type => :feature`.
@@ -223,7 +222,7 @@ end
 `background` is an alias for `before`, `scenario` for `it`, and
 `given`/`given!` aliases for `let`/`let!`, respectively.
 
-Finally, Capybara matchers are supported in view specs:
+Finally, Capybara matchers are also supported in view specs:
 
 ```ruby
 RSpec.describe "todos/show.html.erb", type: :view do
@@ -742,7 +741,7 @@ Capybara 1.x, set `Capybara.match` to `:prefer_exact`.
 
 ## <a name="transactions-and-database-setup"></a>Transactions and database setup
 
-**Note:**  Rails 5.1+ now "safely" shares the database connection between the app and test threads.  Therefore,
+**Note:**  Rails 5.1+ "safely" shares the database connection between the app and test threads.  Therefore,
 if using Rails 5.1+ you SHOULD be able to ignore this section.
 
 Some Capybara drivers need to run against an actual HTTP server. Capybara takes
@@ -1082,7 +1081,8 @@ To set up a development environment, simply do:
 
 ```bash
 bundle install
-bundle exec rake  # run the test suite
+bundle exec rake  # run the test suite with Firefox - requires `geckodriver` to be installed
+bundle exec rake spec_chrome # run the test suite with Chrome - require `chromedriver` to be installed
 ```
 
 See

data/lib/capybara.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'timeout'
 require 'nokogiri'
 require 'xpath'
@@ -21,7 +22,6 @@ module Capybara
   class WindowError < CapybaraError; end
   class ReadOnlyElementError < CapybaraError; end
 
-
   class << self
     extend Forwardable
 
@@ -51,8 +51,6 @@ module Capybara
     #   See {Capybara.configure}
     # @!method always_include_port
     #   See {Capybara.configure}
-    # @!method wait_on_first_by_default
-    #   See {Capybara.configure}
     SessionConfig::OPTIONS.each do |method|
       def_delegators :config, method, "#{method}="
     end
@@ -79,7 +77,6 @@ module Capybara
     # [ignore_hidden_elements = Boolean]  Whether to ignore hidden elements on the page (Default: true)
     # [automatic_reload = Boolean]        Whether to automatically reload elements as Capybara is waiting (Default: true)
     # [save_path = String]  Where to put pages saved through save_(page|screenshot), save_and_open_(page|screenshot) (Default: Dir.pwd)
-    # [wait_on_first_by_default = Boolean]   Whether Node#first defaults to Capybara waiting behavior for at least 1 element to match (Default: false)
     # [automatic_label_click = Boolean]   Whether Node#choose, Node#check, Node#uncheck will attempt to click the associated label element if the checkbox/radio button are non-visible (Default: false)
     # [enable_aria_label = Boolean]  Whether fields, links, and buttons will match against aria-label attribute (Default: false)
     # [reuse_server = Boolean]  Reuse the server thread between multiple sessions using the same app object (Default: true)
@@ -94,7 +91,7 @@ module Capybara
     # [javascript_driver = Symbol]        The name of a driver to use for JavaScript enabled tests. (Default: :selenium)
     #
     def configure
-      yield ConfigureDeprecator.new(config)
+      yield config
     end
 
     ##
@@ -128,7 +125,6 @@ module Capybara
     # @yieldparam [<Rack>] app                The rack application that this server will contain.
     # @yieldparam port                        The port number the server should listen on
     # @yieldparam host                        The host/ip to bind to
-    # @yieldreturn [Capybara::Driver::Base]   A Capybara driver instance
     #
     def register_server(name, &block)
       servers[name.to_sym] = block
@@ -192,8 +188,6 @@ module Capybara
       @servers ||= {}
     end
 
-    ##
-    #
     # Wraps the given string, which should contain an HTML document or fragment
     # in a {Capybara::Node::Simple} which exposes all {Capybara::Node::Matchers},
     # {Capybara::Node::Finders} and {Capybara::Node::DocumentMatchers}. This allows you to query
@@ -238,7 +232,7 @@ module Capybara
     # @param [Integer] port              The port to run the application on
     #
     def run_default_server(app, port)
-      servers[:webrick].call(app, port, server_host)
+      servers[:puma].call(app, port, server_host)
     end
 
     ##
@@ -310,7 +304,7 @@ module Capybara
     # as cookies.
     #
     def reset_sessions!
-      #reset in reverse so sessions that started servers are reset last
+      # reset in reverse so sessions that started servers are reset last
       session_pool.reverse_each { |_mode, session| session.reset! }
     end
     alias_method :reset!, :reset_sessions!
@@ -364,10 +358,10 @@ module Capybara
     # @param [String] html              The raw html
     # @return [Nokogiri::HTML::Document]      HTML document
     #
-    def HTML(html)
+    def HTML(html) # rubocop:disable Naming/MethodName
       Nokogiri::HTML(html).tap do |document|
         document.xpath('//textarea').each do |textarea|
-          textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/,'')
+          textarea['_capybara_raw_value'] = textarea.content.sub(/\A\n/, '')
         end
       end
     end
@@ -376,12 +370,8 @@ module Capybara
       config.session_options
     end
 
-    def included(base)
-      base.send(:include, Capybara::DSL)
-      warn "`include Capybara` is deprecated. Please use `include Capybara::DSL` instead."
-    end
-
   private
+
     def config
       @config ||= Capybara::Config.new
     end
@@ -415,7 +405,6 @@ module Capybara
   require 'capybara/queries/match_query'
   require 'capybara/queries/ancestor_query'
   require 'capybara/queries/sibling_query'
-  require 'capybara/query'
 
   require 'capybara/node/finders'
   require 'capybara/node/matchers'
@@ -443,14 +432,14 @@ Capybara.register_server :default do |app, port, _host|
   Capybara.run_default_server(app, port)
 end
 
-Capybara.register_server :webrick do |app, port, host, options={}|
+Capybara.register_server :webrick do |app, port, host, **options|
   require 'rack/handler/webrick'
-  Rack::Handler::WEBrick.run(app, {Host: host, Port: port, AccessLog: [], Logger: WEBrick::Log::new(nil, 0)}.merge(options))
+  Rack::Handler::WEBrick.run(app, { Host: host, Port: port, AccessLog: [], Logger: WEBrick::Log.new(nil, 0) }.merge(options))
 end
 
-Capybara.register_server :puma do |app, port, host, options={}|
+Capybara.register_server :puma do |app, port, host, **options|
   require 'rack/handler/puma'
-  Rack::Handler::Puma.run(app, {Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false}.merge(options))
+  Rack::Handler::Puma.run(app, { Host: host, Port: port, Threads: "0:4", workers: 0, daemon: false }.merge(options))
 end
 
 Capybara.configure do |config|
@@ -468,7 +457,6 @@ Capybara.configure do |config|
   config.raise_server_errors = true
   config.server_errors = [StandardError]
   config.visible_text_only = false
-  config.wait_on_first_by_default = false
   config.automatic_label_click = false
   config.enable_aria_label = false
   config.reuse_server = true
@@ -483,11 +471,11 @@ Capybara.register_driver :selenium do |app|
 end
 
 Capybara.register_driver :selenium_chrome do |app|
-  Capybara::Selenium::Driver.new(app, :browser => :chrome)
+  Capybara::Selenium::Driver.new(app, browser: :chrome)
 end
 
 Capybara.register_driver :selenium_chrome_headless do |app|
-  browser_options = ::Selenium::WebDriver::Chrome::Options.new()
+  browser_options = ::Selenium::WebDriver::Chrome::Options.new
   browser_options.args << '--headless'
   browser_options.args << '--disable-gpu'
   Capybara::Selenium::Driver.new(app, browser: :chrome, options: browser_options)

data/lib/capybara/config.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'forwardable'
 require 'capybara/session/config'
 
@@ -6,7 +7,7 @@ module Capybara
   class Config
     extend Forwardable
 
-    OPTIONS = [:app, :reuse_server, :threadsafe, :default_wait_time, :server, :default_driver, :javascript_driver]
+    OPTIONS = %i[app reuse_server threadsafe default_wait_time server default_driver javascript_driver].freeze
 
     attr_accessor :app
     attr_reader :reuse_server, :threadsafe
@@ -21,9 +22,7 @@ module Capybara
       @session_options = Capybara::SessionConfig.new
     end
 
-    def reuse_server=(bool)
-      @reuse_server = bool
-    end
+    attr_writer :reuse_server
 
     def threadsafe=(bool)
       warn "Capybara.threadsafe == true is a BETA feature and may change in future minor versions" if bool
@@ -35,16 +34,9 @@ module Capybara
     #
     # Return the proc that Capybara will call to run the Rack application.
     # The block returned receives a rack app, port, and host/ip and should run a Rack handler
-    # By default, Capybara will try to run webrick.
+    # By default, Capybara will try to use puma.
     #
-    def server(&block)
-      if block_given?
-        warn "DEPRECATED: Passing a block to Capybara::server is deprecated, please use Capybara::register_server instead"
-        @server = block
-      else
-        @server
-      end
-    end
+    attr_reader :server
 
     ##
     #
@@ -62,14 +54,10 @@ module Capybara
     #
     def server=(name)
       name, options = *name if name.is_a? Array
-      @server = if name.respond_to? :call
-        name
+      @server = if options
+        proc { |app, port, host| Capybara.servers[name.to_sym].call(app, port, host, options) }
       else
-        if options
-          Proc.new { |app, port, host| Capybara.servers[name.to_sym].call(app,port,host,options) }
-        else
-          Capybara.servers[name.to_sym]
-        end
+        Capybara.servers[name.to_sym]
       end
     end
 
@@ -89,44 +77,10 @@ module Capybara
       @javascript_driver || :selenium
     end
 
-    # @deprecated Use default_max_wait_time instead
-    def default_wait_time
-      deprecate('default_wait_time', 'default_max_wait_time', true)
-      default_max_wait_time
-    end
-
-    # @deprecated Use default_max_wait_time= instead
-    def default_wait_time=(t)
-      deprecate('default_wait_time=', 'default_max_wait_time=')
-      self.default_max_wait_time = t
-    end
-
-    def deprecate(method, alternate_method, once=false)
+    def deprecate(method, alternate_method, once = false)
       @deprecation_notified ||= {}
       warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once and @deprecation_notified[method]
-      @deprecation_notified[method]=true
-    end
-  end
-
-  # @api private
-  class ConfigureDeprecator
-    def initialize(config)
-      @config = config
-    end
-
-    def method_missing(m, *args, &block)
-      if @config.respond_to?(m)
-        @config.public_send(m, *args, &block)
-      elsif Capybara.respond_to?(m)
-        warn "Calling #{m} from Capybara.configure is deprecated - please call it on Capybara directly ( Capybara.#{m}(...) )"
-        Capybara.public_send(m, *args, &block)
-      else
-        super
-      end
-    end
-
-    def respond_to_missing?(m, include_private = false)
-      @config.respond_to?(m) || Capybara.respond_to?(m) || super
+      @deprecation_notified[method] = true
     end
   end
-end
+end

data/lib/capybara/cucumber.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'capybara/dsl'
 require 'capybara/rspec/matchers'
 require 'capybara/rspec/matcher_proxies'
@@ -21,8 +22,6 @@ end
 Before do |scenario|
   scenario.source_tag_names.each do |tag|
     driver_name = tag.sub(/^@/, '').to_sym
-    if Capybara.drivers.has_key?(driver_name)
-      Capybara.current_driver = driver_name
-    end
+    Capybara.current_driver = driver_name if Capybara.drivers.key?(driver_name)
   end
 end

data/lib/capybara/driver/base.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 class Capybara::Driver::Base
   attr_writer :session
 
@@ -46,7 +47,7 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#evaluate_script_asnyc'
   end
 
-  def save_screenshot(path, options={})
+  def save_screenshot(path, **options)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#save_screenshot'
   end
 
@@ -98,15 +99,10 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#switch_to_window'
   end
 
-  def within_window(locator)
-    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#within_window'
-  end
-
   def no_such_window_error
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#no_such_window_error'
   end
 
-
   ##
   #
   # Execute the block, and then accept the modal opened.
@@ -117,7 +113,7 @@ class Capybara::Driver::Base
   # @return [String]  the message shown in the modal
   # @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found
   #
-  def accept_modal(type, options={}, &blk)
+  def accept_modal(type, **options, &blk)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#accept_modal'
   end
 
@@ -130,7 +126,7 @@ class Capybara::Driver::Base
   # @return [String]  the message shown in the modal
   # @raise [Capybara::ModalNotFound]  if modal dialog hasn't been found
   #
-  def dismiss_modal(type, options={}, &blk)
+  def dismiss_modal(type, **options, &blk)
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#dismiss_modal'
   end
 
@@ -142,8 +138,7 @@ class Capybara::Driver::Base
     false
   end
 
-  def reset!
-  end
+  def reset!; end
 
   def needs_server?
     false
@@ -152,10 +147,4 @@ class Capybara::Driver::Base
   def session_options
     (@session && @session.config) || Capybara.session_options
   end
-
-  # @deprecated This method is being removed
-  def browser_initialized?
-    warn "DEPRECATED: #browser_initialized? is deprecated and will be removed in the next version of Capybara"
-    true
-  end
 end