capybara 2.13.0 → 2.14.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 266938107d80bacdd4f95cc21e79fe6b7af2e131
-  data.tar.gz: dac8ea7395988fc218da8a556df246db661125b0
+  metadata.gz: 95059b9953d4a957739d739dadd55c294e39046b
+  data.tar.gz: fd4c944ff4a42c21661a1b6d39a243032b4ea7a8
 SHA512:
-  metadata.gz: a548da527db279933776ebd86daa6ddf1d7e714bc9b22225959d58b67bbecfa8458f503cde377fc262f0d4442ef6d0f47a88a1bcf66efd58bc5014d80b80f87d
-  data.tar.gz: f040e322ba5e591dbc3546b0e5c7672f21b6e9eab99ff848780f42e1e1d9e5ce87bdfe242ae0dbb7a45b4ecb37611d3c1c1a202cedcc1e16cc00040114422213
+  metadata.gz: b3bfd9f5c365c483b058461d58abe63e58f162b051e739794d30f69ea84e93ed7993245dfffc9ca48f96270022aa40df5e32a60bb6df29bbc93d85c0a7f714d3
+  data.tar.gz: bdb337934a2477819f03e9cfbbd683832a4d69775f6a688e5098079b48fc0ef630de10a8a5e7e78198ac9144cc2afe063dfeb9b73a15d73204688b789358d4a8

data/History.md

@@ -1,4 +1,24 @@
-#Version 2.13.0
+# Version 2.14.0
+
+Release date: 2017-05-01
+
+### Added
+
+* "threadsafe" mode that allows per-session configuration
+* `:type` filter added to the `:fillable_field` selector
+* Proxy methods when using RSpec for `all`/`within` that call either the Capybara::DSL or RSpec matchers
+  depending on arguments passed
+* Support for the new errors in selenium-webdriver 3.4
+
+### Fixed
+
+* Element#inspect doesn't raise an error on obsolete elements
+* Setting a contenteditable element with Selenium and Chrome 59
+* Workaround a hang while setting the window size when using geckodriver 0.16 and Firefox 53
+* Clicking on url with a blank href goes to the current url when using the RackTest driver
+
+# Version 2.13.0
+
 Release date: 2017-03-16
 
 ### Added
@@ -7,16 +27,19 @@ Release date: 2017-03-16
 * rack_test driver supports click on checkboxes and radio buttons to change their states [Thomas Walpole]
 * Support RSpec equivalent assertions and expectations for MiniTest [Thomas Walpole]
 
-### Foxed
+### Fixed
+
 * Editing of content editable children with selenium
 
-#Version 2.12.1
+# Version 2.12.1
+
 Release date: 2017-02-16
 
 ### Fixed
 *  Disable lazy Capybara::Results evaluation for JRuby due to ongoing issues
 
-#Version 2.12.0
+# Version 2.12.0
+
 Release date: 2017-01-22
 
 ### Added
@@ -35,6 +58,7 @@ Release date: 2017-01-22
 * `within_element` as an alias of `within` due to RSpec collision
 
 ### Fixed
+
 *  Fields inside a disabled fieldset are now correctly considered disabled - Issue #1816 [Thomas Walpole]
 *  Lazy Capybara::Results evaluation enabled for JRuby 9.1.6.0+
 *  A driver returning nil for #current_url won't raise an exception when calling #current_path [Dylan Reichstadt]
@@ -42,10 +66,12 @@ Release date: 2017-01-22
 *  RackTest driver no longer modifies the text content of textarea elements in order to behave more like a real browser [Thomas Walpole]
 *  TextQuery (assert_text/have_text/etc) now ignores errors when trying to generate more helpful errors messages so the original error isn't hidden [Thomas Walpole]
 
-#Version 2.11.0
+# Version 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
@@ -54,17 +80,21 @@ Release date: 2016-12-05
 * 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]
 
-#Version 2.10.2
+# Version 2.10.2
+
 Release date: 2016-11-30
 
 ### Fixed
+
 * App exceptions with multiple parameter initializers now re-raised correctly - Issue #1785 [Michael Lutsiuk]
 * Use Addressable::URI when parsing current_path since it's more lenient of technically invalid URLs - Issue #1801 [Marcos Duque, Thomas Walpole]
 
-#Version 2.10.1
+# Version 2.10.1
+
 Release date: 2016-10-08
 
 ### Fixed
@@ -72,52 +102,64 @@ Release date: 2016-10-08
 * Capybara::Result optimization disabled in JRuby due to issue with lazy enumerator evaluation [Thomas Walpole]
   See: https://github.com/jruby/jruby/issues/4212
 
-#Version 2.10.0
+# Version 2.10.0
+
 Release date: 2016-10-05
 
 ### Added
+
 * Select `<button>` elements with descendant images with `alt` attributes matching the locator [Ian Lesperance]
 * Locator string is optional in selector based matchers [Thomas Walpole]
 * Selectors can specify their default visible setting [Thomas Walpole]
 * Selector based finders and matchers can be passed a block to filter the results within the retry behavior [Thomas Walpole]
 
-#Version 2.9.2
+# Version 2.9.2
+
 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]
 
-#Version 2.9.1
+# Version 2.9.1
+
 Release date: 2016-09-23
 
 ### Fixed
+
 * allow_label_click option did not work in some cases with Poltergeist - Issue #1762 [Thomas Walpole]
 * matches_selector? should have access to all of a selectors options except the count options [Thomas Walpole]
 
-#Version 2.9.0
+# Version 2.9.0
+
 Release date: 2016-09-19
 
 ### Fixed
+
 * Issue with rack-test driver and obselete mime-types when using `#attach_file` - Issue #1756 [Thomas Walpole]
 
 ### Added
+
 * `:class` option to many of the built-in selectors [Thomas Walpole]
 * Removed need to specify value when creating `:boolean` filter type in custom selectors [Thomas Walpole]
 * Filters can now be implemented through the XPath/CSS expressions in custom selectors [Thomas Walpole]
 * `Element#matches_xpath?` and `Element#matches_css?` [Thomas Walpole]
 
-#Version 2.8.1
+# Version 2.8.1
+
 Release date: 2016-08-25
 
 ###Fixed
+
 * Fixed error message from have_text when text is not found but contains regex special characters [Ryunosuke Sato]
 * Warn when :exact option is passed that has no effect [Thomas Walpole]
 
 # Version 2.8.0
+
 Release date: 2016-08-16
 
 ### Fixed
+
 * Issue with modals present when closing the page using selenium - Issue #1696 [Jonas Nicklas, Thomas Walpole]
 * Server errors raised in test code have the cause set to an explanatory exception
   in rubies that support Exception#cause rather than a confusing ExpectationNotMet - Issue #1719 [Thomas Walpole]
@@ -125,6 +167,7 @@ Release date: 2016-08-16
 * Fixed setting of unexpectedAlertError now that Selenium will be freezing the Capabilities::DEFAULTS [Thomas Walpole]
 
 ### Added
+
 * 'check', 'uncheck', and 'choose' can now optionally click the associated label if the checkbox/radio button is not visible [Thomas Walpole]
 * Raise error if Capybara.app_host/default_host are specified incorrectly [Thomas Walpole]
 * Capybara::Selector::FilterSet allows for sharing filter definitions between selectors [Thomas Walpole]
@@ -136,19 +179,22 @@ Release date: 2016-08-16
 * Support matching on aria-label attribute when finding fields/links/buttons - Issue #1528 [Thomas Walpole]
 * Optimize Capybara::Result to only apply fields as necessary in common use-case of `.all[idx]` [Thomas Walpole]
 
-#Version 2.7.1
+# Version 2.7.1
+
 Release date: 2016-05-01
 
 ### Fixed
+
 * Issue where within_Frame would fail with Selenium if the frame is removed from within itself [Thomas Walpole]
 * Reset sessions in reverse order so sessions with active servers are reset last - Issue #1692 [Jonas Nicklas, Thomas Walpole]
 
 # Version 2.7.0
+
 Release date: 2016-04-07
 
 ### Fixed
-* Element#visible?/checked?/disabled?/selected? Now return boolean
-  as expected when using the rack_test driver [Thomas Walpole]
+
+* Element#visible?/checked?/disabled?/selected? Now return boolean as expected when using the rack_test driver [Thomas Walpole]
 * The rack_test driver now considers \<input type="hidden"> elements as non-visible [Thomas Walpole]
 * A nil locator passed to the built-in html type selectors now behaves consistently, and finds elements of the expected types [Thomas Walpole]
 * Capybara::Server now searches for available ports on the same interface it binds to [Aaron Stone]
@@ -156,6 +202,7 @@ Release date: 2016-04-07
 * Warning output if unused parameters are passed to a selector query [Thomas Walpole]
 
 ### Added
+
 * Capybara now waits for requests to Capybaras server to complete while restting the session [John Hawthorn, Thomas Walpole]
 * Capybara.reuse_server option to allow disabling of sharing server instance between sessions [Thomas Walpole]
 * :multiple filter added to relevant selectors [Thomas Walpole]
@@ -168,22 +215,28 @@ Release date: 2016-04-07
   save_page/save_screenshot [Thomas Walpole]
 * :label selector [Thomas Walpole]
 
-#Version 2.6.2
+# Version 2.6.2
+
 Relase date: 2016-01-27
 
 ### Fixed
+
 * support for more than just addressable 2.4.0 [Thomas Walpole]
 
 # Version 2.6.1
+
 Release date: 2016-01-27
 
 ### Fixed
+
 * Add missing require for addressable [Jorge Bejar]
 
 # Version 2.6.0
+
 Relase date: 2016-01-17
 
 ### Fixed
+
 * Fixed path escaping issue with current_path matchers [Thomas Walpole, Luke Rollans] (Issue #1611)
 * Fixed circular require [David Rodríguez]
 * Capybara::RackTest::Form no longer overrides Object#method [David Rodriguez]
@@ -192,6 +245,7 @@ Relase date: 2016-01-17
 
 
 ### Added
+
 * Capybara.modify_selector [Thomas Walpole]
 * xfeature and ffeature aliases added when using RSpec [Filip Bartuzi]
 * Selenium driver supports a :clear option to #set to handle different strategies for clearing a field [Thomas Walpole]
@@ -200,15 +254,18 @@ Relase date: 2016-01-17
 * Modal API methods now default wait time to Capybara.default_max_wait_time [Thomas Walpole]
 
 # Version 2.5.0
+
 Release date: 2015-08-25
 
 ### Fixed
+
 * Error message now raised correctly when invalid options passed to 'have_text'/'have_content' [Thomas Walpole]
 * Rack-test driver correctly gets document title when elements on the page have nested title elements (SVG) [Thomas Walpole]
 * 'save_page' no longer errors when using Capybara.asset_host if the page has no \<head> element [Travis Grathwell]
 * rack-test driver will ignore clicks on links with href starting with '#' or 'javascript:'
 
 ### Added
+
 * has_current_path? and associated asserts/matchers added [Thomas Walpole]
 * Implement Node#path in selenium driver [Soutaro Matsumoto]
 * 'using_session' is now nestable [Thomas Walpole]
@@ -226,25 +283,32 @@ Release date: 2015-08-25
 * Clear field using backspaces in Selenium driver by using `:fill_options => { :clear => :backspace }` [Joe Lencioni]
 
 ### Deprecated
+
 * Capybara.default_wait_time deprecated in favor of Capybara.default_max_wait_time to more clearly explain its purpose [Paul Pettengill]
 
-#Version 2.4.4
+# Version 2.4.4
+
 Release date: 2014-10-13
 
 ### Fixed
+
 * Test for visit behavior updated [Phil Baker]
 * Removed concurrency prevention in favor of a note in the README - due to load order issues
 
 # Version 2.4.3
+
 Relase date: 2014-09-21
 
 ### Fixed
+
 * Update concurrency prevention to match Rails 4.2 behavior
 
 # Version 2.4.2
+
 Release date: 2014-09-20
 
 ### Fixed
+
 * Prevent concurrency issue when testing Rails app with default test environment [Thomas Walpole]
 * Tags for windows API tests fixed [Dmitry Vorotilin]
 * Documentation Fixes [Andrey Botalov]
@@ -279,6 +343,7 @@ Release date: 2014-07-03
 Release date: 2014-06-02
 
 ### Added
+
 * New window management API [Andrey Botalov]
 * Speed improvement for visible text detection in RackTest [Thomas Walpole]
   Thanks to Phillipe Creux for instigating this

data/README.md

@@ -67,6 +67,7 @@ You can read more about the missing features [here](https://github.com/teamcapyb
 - [Beware the XPath // trap](#beware-the-xpath--trap)
 - [Configuring and adding drivers](#configuring-and-adding-drivers)
 - [Gotchas:](#gotchas)
+- ["Threadsafe" mode](#threadsafe)
 - [Development](#development)
 
 ## <a name="key-benefits"></a>Key benefits
@@ -241,6 +242,9 @@ RSpec.describe "todos/show.html.erb", type: :view do
 end
 ```
 
+**Note: When you require 'capybara/rspec' proxy methods are installed to work around name collisions between Capybara::DSL methods
+  `all`/`within` and the identically named built-in RSpec matchers. If you opt not to require 'capybara/rspec' you can install the proxy methods by requiring 'capybara/rspec/matcher_proxies' after requiring RSpec and 'capybara/dsl'**
+
 ## <a name="using-capybara-with-testunit"></a>Using Capybara with Test::Unit
 
 * If you are using `Test::Unit`, define a base class for your Capybara tests
@@ -1045,6 +1049,31 @@ 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
+
+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
+support for this type of usage Capybara now provides a "threadsafe" mode which can be enabled by setting
+
+    Capybara.threadsafe = true
+
+This setting can only be changed before any sessions have been created.  In "threadsafe" mode the following
+behaviors of Capybara change
+
+* Most options can now be set on a session.  These can either be set at session creation time or after, and
+  default to the global options at the time of session creation.  Options which are NOT session specific are
+  `app`, `reuse_server`, `default_driver`, `javascript_driver`, and (obviously) `threadsafe`.  Any drivers and servers
+  registered through `register_driver` and `register_server` are also global.
+
+      my_session = Capybara::Session.new(:driver, some_app) do |config|
+        config.automatic_label_click = true # only set for my_session
+      end
+      my_session.config.default_max_wait_time = 10 # only set for my_session
+      Capybara.default_max_wait_time = 2 # will not change the default_max_wait in my_session
+
+* `current_driver` and `session_name` are thread specific.  This means that `using_session' and
+  `using_driver` also only affect the current thread.
+
 ## <a name="development"></a>Development
 
 To set up a development environment, simply do:

data/lib/capybara.rb

@@ -2,6 +2,8 @@
 require 'timeout'
 require 'nokogiri'
 require 'xpath'
+require 'forwardable'
+require 'capybara/config'
 
 module Capybara
   class CapybaraError < StandardError; end
@@ -19,18 +21,41 @@ module Capybara
   class WindowError < CapybaraError; end
   class ReadOnlyElementError < CapybaraError; end
 
+
   class << self
-    attr_reader :app_host, :default_host
-    attr_accessor :asset_host, :run_server, :always_include_port
-    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_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 :exact_text
-    attr_accessor :app
+    extend Forwardable
+
+    # DelegateCapybara global configurations
+    # @!method app
+    #   See {Capybara#configure}
+    # @!method reuse_server
+    #   See {Capybara#configure}
+    # @!method threadsafe
+    #   See {Capybara#configure}
+    # @!method server
+    #   See {Capybara#configure}
+    # @!method default_driver
+    #   See {Capybara#configure}
+    # @!method javascript_driver
+    #   See {Capybara#configure}
+    Config::OPTIONS.each do |method|
+      def_delegators :config, method, "#{method}="
+    end
+
+    # Delegate Capybara global configurations
+    # @!method default_selector
+    #   See {Capybara#configure}
+    # @!method default_max_wait_time
+    #   See {Capybara#configure}
+    # @!method app_host
+    #   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
 
     ##
     #
@@ -58,6 +83,9 @@ module Capybara
     # [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)
+    # [threadsafe = Boolean]  Whether sessions can be configured individually (Default: false)
+    # [server = Symbol]  The name of the registered server to use when running the app under test (Default: :webrick)
+    #
     # === DSL Options
     #
     # when using capybara/dsl, the following options are also available:
@@ -66,7 +94,7 @@ module Capybara
     # [javascript_driver = Symbol]        The name of a driver to use for JavaScript enabled tests. (Default: :selenium)
     #
     def configure
-      yield self
+      yield ConfigureDeprecator.new(config)
     end
 
     ##
@@ -163,45 +191,6 @@ module Capybara
       @servers ||= {}
     end
 
-    ##
-    #
-    # Register a proc that Capybara will call to run the Rack application.
-    #
-    #     Capybara.server do |app, port, host|
-    #       require 'rack/handler/mongrel'
-    #       Rack::Handler::Mongrel.run(app, :Port => port)
-    #     end
-    #
-    # By default, Capybara will try to run webrick.
-    #
-    # @yield [app, port, host]      This block receives a rack app, port, and host/ip and should run a Rack handler
-    #
-    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
-
-    ##
-    #
-    # Set the server to use.
-    #
-    #     Capybara.server = :webrick
-    #
-    # @param [Symbol] name     Name of the server type to use
-    # @see register_server
-    #
-    def server=(name)
-      @server = if name.respond_to? :call
-        name
-      else
-        servers[name.to_sym]
-      end
-    end
-
     ##
     #
     # Wraps the given string, which should contain an HTML document or fragment
@@ -251,29 +240,25 @@ module Capybara
       servers[:webrick].call(app, port, server_host)
     end
 
-    ##
-    #
-    # @return [Symbol]    The name of the driver to use by default
-    #
-    def default_driver
-      @default_driver || :rack_test
-    end
-
     ##
     #
     # @return [Symbol]    The name of the driver currently in use
     #
     def current_driver
-      @current_driver || default_driver
+      if threadsafe
+        Thread.current['capybara_current_driver']
+      else
+        @current_driver
+      end || default_driver
     end
     alias_method :mode, :current_driver
 
-    ##
-    #
-    # @return [Symbol]    The name of the driver used when JavaScript is needed
-    #
-    def javascript_driver
-      @javascript_driver || :selenium
+    def current_driver=(name)
+      if threadsafe
+        Thread.current['capybara_current_driver'] = name
+      else
+        @current_driver = name
+      end
     end
 
     ##
@@ -281,7 +266,7 @@ module Capybara
     # Use the default driver as the current driver
     #
     def use_default_driver
-      @current_driver = nil
+      self.current_driver = nil
     end
 
     ##
@@ -293,15 +278,7 @@ module Capybara
       Capybara.current_driver = driver
       yield
     ensure
-      @current_driver = previous_driver
-    end
-
-    ##
-    #
-    # @return [String]    The IP address bound by default server
-    #
-    def server_host
-      @server_host || '127.0.0.1'
+      self.current_driver = previous_driver
     end
 
     ##
@@ -344,7 +321,19 @@ module Capybara
     # @return [Symbol]    The name of the currently used session.
     #
     def session_name
-      @session_name ||= :default
+      if threadsafe
+        Thread.current['capybara_session_name'] ||= :default
+      else
+        @session_name ||= :default
+      end
+    end
+
+    def session_name=(name)
+      if threadsafe
+        Thread.current['capybara_session_name'] = name
+      else
+        @session_name = name
+      end
     end
 
     ##
@@ -352,11 +341,19 @@ module Capybara
     # Yield a block using a specific session name.
     #
     def using_session(name)
-      previous_session_name = self.session_name
+      previous_session_info = {
+        session_name: session_name,
+        current_driver: current_driver,
+        app: app
+      }
       self.session_name = name
       yield
     ensure
-      self.session_name = previous_session_name
+      self.session_name = previous_session_info[:session_name]
+      if threadsafe
+        self.current_driver = previous_session_info[:current_driver]
+        self.app = previous_session_info[:app]
+      end
     end
 
     ##
@@ -374,32 +371,8 @@ module Capybara
       end
     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 save_and_open_page_path=(path)
-      warn "DEPRECATED: #save_and_open_page_path is deprecated, please use #save_path instead. \n"\
-           "Note: Behavior is slightly different with relative paths - see documentation" unless path.nil?
-      @save_and_open_page_path = path
-    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::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::Parser.new.make_regexp)
-      @default_host = url
+    def session_options
+      config.session_options
     end
 
     def included(base)
@@ -407,18 +380,10 @@ module Capybara
       warn "`include Capybara` is deprecated. Please use `include Capybara::DSL` instead."
     end
 
-    def reuse_server=(bool)
-      warn "Capybara.reuse_server == false is a BETA feature and may change in a future version" unless bool
-      @reuse_server = bool
-    end
-
-    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
-
   private
+    def config
+      @config ||= Capybara::Config.new
+    end
 
     def session_pool
       @session_pool ||= {}