capybara 2.18.0 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fb46b7bc5ae7408ca3870b781d015a84bd84abd0a9c7e3ea2bcdf3d8fff85ce8
-  data.tar.gz: 1865dc1efa384c3792161a134bc536c56dca3aa0670ca298ad9f3aa12b49830d
+  metadata.gz: 8389b150e2b44270ed1d94b8f6e0f48af613f1a2f28b8ad772e35cb7db635ad7
+  data.tar.gz: bace2657813bc0681e4586ba2c96a66e824e12651f0e839a8649ed491f0eafa1
 SHA512:
-  metadata.gz: 9bc2cb739af408323d977b7ca829aa0862ef68ab7d1778c5ae67fb127a47a09258c1f5b53f9d7955bcfcd2892c869a136d7a5346b9115a9e55713ea47c95ebb3
-  data.tar.gz: e8d234ded45305e026b615c60e4eb8597e31fd67b7daefff51d13ab3d79868745e21668a6b45452366ac5a552b38e8c01dc669e73dbe45a9b38ecf8363b54e83
+  metadata.gz: 5ffed0a0be90e5d8bf022b48d261aa160646562095114ca383a446431ab57403d67a6ccf252129a477484a6ea1bdc1edfefa6930571961e6307b5ce180c6aa30
+  data.tar.gz: e5956efba3a7e4a6833a9b63e61c6f136a3210eb77ac44d8b1603b81b6e5bea7bde1ea3fd4c76b8eda6a10f61c1e0e805aef7f8aa4bcf801061c46a7fded1c02

data/History.md

@@ -1,4 +1,56 @@
-#Version 2.18.0
+# Version 3.0.0
+Release date: 2018-04-05
+
+### Changed
+
+* Selenium driver only closes extra windows for browsers where that is known to work (Firefox, Chrome)
+* "threadsafe" mode is no longer considered beta
+
+### Fixes
+
+* Multiple file attach_file with Firefox
+* Use Puma::Server directly rather than Rack::Handler::Puma so signal handlers don't prevent test quitting
+
+# Version 3.0.0.rc2
+Release date: 2018-03-23
+
+### Changed
+
+* Drivers are now expected to return visible text more in line with the WebDriver spec for visible text
+* Drivers are expected to close extra windows when resetting the session
+* Selenium driver supports Date/Time when filling in date/time/datetime-local inputs
+* `current_url` returns the url for the top level browsing context
+* `title` returns the title for the top level browsing context
+
+### Added
+
+* `Driver#frame_url` returns the url for the current frame
+* `Driver#frame_title` returns the title for the current frame
+
+# 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` alias for `find_field`
+
+# Version 2.18.0
 Release date: 2018-02-12
 
 ### Fixed
@@ -10,6 +62,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 +306,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

@@ -1,10 +1,15 @@
 # Capybara
 
 [![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)
 [![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)
 
+**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.0_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 +76,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.2 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,26 +140,26 @@ 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`.
+Capybara with `type: :feature`.
 
 You can now write your specs like so:
 
 ```ruby
-describe "the signin process", :type => :feature do
+describe "the signin process", type: :feature do
   before :each do
     User.make(email: 'user@example.com', password: 'password')
   end
@@ -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: :webkit
 end
 ```
 
@@ -219,11 +219,11 @@ 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.
 
-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 +742,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
@@ -1047,7 +1047,7 @@ 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)
 
-## <a name="threadsafe"></a>"Threadsafe" mode - BETA - may change
+## <a name="threadsafe"></a>"Threadsafe" mode
 
 In normal mode most of Capybara's configuration options are global settings which can cause issues
 if using multiple sessions and wanting to change a setting for only one of the sessions.  To provide
@@ -1082,7 +1082,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/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,12 +22,9 @@ 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
       raise "Threadsafe setting cannot be changed once a session is created" if (bool != threadsafe) && Session.instance_created?
       @threadsafe = bool
     end
@@ -35,16 +33,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 +53,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 +76,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
 
@@ -66,6 +67,16 @@ class Capybara::Driver::Base
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#switch_to_frame'
   end
 
+  def frame_title
+    find_xpath('/html/head/title').map(&:all_text).first.to_s
+  end
+
+  def frame_url
+    evaluate_script('document.location.href')
+  rescue Capybara::NotSupportedByDriverError
+    raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#frame_title'
+  end
+
   def current_window_handle
     raise Capybara::NotSupportedByDriverError, 'Capybara::Driver::Base#current_window_handle'
   end
@@ -98,15 +109,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 +123,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 +136,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 +148,7 @@ class Capybara::Driver::Base
     false
   end
 
-  def reset!
-  end
+  def reset!; end
 
   def needs_server?
     false
@@ -152,10 +157,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

data/lib/capybara/driver/node.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Capybara
   module Driver
     class Node
@@ -27,7 +28,7 @@ module Capybara
 
       # @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
-      def set(value, options={})
+      def set(value, **options)
         raise NotImplementedError
       end
 
@@ -39,15 +40,15 @@ module Capybara
         raise NotImplementedError
       end
 
-      def click
+      def click(keys = [], options = {})
         raise NotImplementedError
       end
 
-      def right_click
+      def right_click(keys = [], options = {})
         raise NotImplementedError
       end
 
-      def double_click
+      def double_click(keys = [], options = {})
         raise NotImplementedError
       end
 

data/lib/capybara/dsl.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'capybara'
 
 module Capybara

data/lib/capybara/helpers.rb

@@ -1,14 +1,12 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 
 module Capybara
-
   # @api private
   module Helpers
     extend self
 
     ##
-    #
+    # @deprecated
     # Normalizes whitespace space by stripping leading and trailing
     # whitespace and replacing sequences of whitespace characters
     # with a single space.
@@ -17,6 +15,7 @@ module Capybara
     # @return [String]         Normalized text
     #
     def normalize_whitespace(text)
+      warn "DEPRECATED: Capybara::Helpers::normalize_whitespace is deprecated, please update your driver"
       text.to_s.gsub(/[[:space:]]+/, ' ').strip
     end
 
@@ -26,16 +25,17 @@ module Capybara
     # if text is not a regexp
     #
     # @param [String] text Text to escape
-    # @return [String]     Escaped text
+    # @param [Boolean] exact (false) Whether or not this should be an exact text match
+    # @param [Fixnum, Boolean, nil] options Options passed to Regexp.new when creating the Regexp
+    # @return [Regexp] Regexp to match the passed in text and options
     #
-    def to_regexp(text, regexp_options=nil, exact=false)
-      if text.is_a?(Regexp)
-        text
-      else
-        escaped = Regexp.escape(normalize_whitespace(text))
-        escaped = "\\A#{escaped}\\z" if exact
-        Regexp.new(escaped, regexp_options)
-      end
+    def to_regexp(text, exact: false, all_whitespace: false, options: nil)
+      return text if text.is_a?(Regexp)
+
+      escaped = Regexp.escape(text)
+      escaped = escaped.gsub("\\ ", "[[:blank:]]") if all_whitespace
+      escaped = "\\A#{escaped}\\z" if exact
+      Regexp.new(escaped, options)
     end
 
     ##
@@ -44,16 +44,14 @@ module Capybara
     # `Capybara.asset_host`.
     #
     # @param [String] html     HTML code to inject into
+    # @param [URL] host (Capybara.asset_host) The host from which assets should be loaded
     # @return [String]         The modified HTML code
     #
-    def inject_asset_host(html, asset_host = Capybara.asset_host)
-      if asset_host && Nokogiri::HTML(html).css("base").empty?
+    def inject_asset_host(html, host: Capybara.asset_host)
+      if host && Nokogiri::HTML(html).css("base").empty?
         match = html.match(/<head[^<]*?>/)
-        if match
-          return html.clone.insert match.end(0), "<base href='#{asset_host}' />"
-        end
+        return html.clone.insert match.end(0), "<base href='#{host}' />" if match
       end
-
       html
     end
 
@@ -68,21 +66,13 @@ module Capybara
     # @param [Integer] count       The number of items
     #
     def declension(singular, plural, count)
-      if count == 1
-        singular
-      else
-        plural
-      end
+      count == 1 ? singular : plural
     end
 
     if defined?(Process::CLOCK_MONOTONIC)
-      def monotonic_time
-        Process.clock_gettime Process::CLOCK_MONOTONIC
-      end
+      def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC; end
     else
-      def monotonic_time
-        Time.now.to_f
-      end
+      def monotonic_time; Time.now.to_f; end
     end
   end
 end

data/lib/capybara/minitest/spec.rb

@@ -3,32 +3,34 @@ require 'minitest/spec'
 module Capybara
   module Minitest
     module Expectations
-      %w(text content title current_path).each do |assertion|
+      %w[text content title current_path].each do |assertion|
         infect_an_assertion "assert_#{assertion}", "must_have_#{assertion}", :reverse
         infect_an_assertion "refute_#{assertion}", "wont_have_#{assertion}", :reverse
       end
 
-      (%w(selector xpath css link button field select table checked_field unchecked_field).flat_map do |assertion|
-        [["assert_#{assertion}", "must_have_#{assertion}"],
-         ["refute_#{assertion}", "wont_have_#{assertion}"]]
-      end + [["assert_all_of_selectors", "must_have_all_of_selectors"],
-             ["assert_none_of_selectors", "must_have_none_of_selectors"]] +
-      %w(selector xpath css).flat_map do |assertion|
-        [["assert_matches_#{assertion}", "must_match_#{assertion}"],
-         ["refute_matches_#{assertion}", "wont_match_#{assertion}"]]
+      # rubocop:disable Style/MultilineBlockChain
+      (%w[selector xpath css link button field select table checked_field unchecked_field].flat_map do |assertion|
+        [%W[assert_#{assertion} must_have_#{assertion}],
+         %W[refute_#{assertion} wont_have_#{assertion}]]
+      end + [%w[assert_all_of_selectors must_have_all_of_selectors],
+             %w[assert_none_of_selectors must_have_none_of_selectors]] +
+      %w[selector xpath css].flat_map do |assertion|
+        [%W[assert_matches_#{assertion} must_match_#{assertion}],
+         %W[refute_matches_#{assertion} wont_match_#{assertion}]]
       end).each do |(meth, new_name)|
-        self.class_eval <<-EOM, __FILE__, __LINE__ + 1
+        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
           def #{new_name} *args, &block
             ::Minitest::Expectation.new(self, ::Minitest::Spec.current).#{new_name}(*args, &block)
           end
-        EOM
+        ASSERTION
 
-        ::Minitest::Expectation.class_eval <<-EOM, __FILE__, __LINE__ + 1
+        ::Minitest::Expectation.class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
           def #{new_name} *args, &block
             ctx.#{meth}(target, *args, &block)
           end
-        EOM
+        ASSERTION
       end
+      # rubocop:enable Style/MultilineBlockChain
 
       ##
       # Expectation that there is xpath
@@ -159,7 +161,6 @@ module Capybara
       #
       # @!method wont_have_current_path
       #   see {Capybara::SessionMatchers#assert_no_current_path}
-
     end
   end
 end