capybara 3.1.1 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 294999a4d7d2baafd5a28b5114cfacc88effd615c606df0a7d6d57156bcf8212
-  data.tar.gz: 86c49647f46da133b88c48c0049410300dad35642f7d1f1b4306fa4b73e9212b
+  metadata.gz: 3f4ca4591c94a37a0a1c69adceb5165923d98c18d12f5522c709461d566ee1b2
+  data.tar.gz: a81064c22b5ad8a3c3967a155a481fc1c25c154056377c1d08188c15de5afe67
 SHA512:
-  metadata.gz: 6b945e8d068713cd24b7aec8a3f9602c4dd19d23a5b5eee689d7670e9f2adf8e78b33a00da06bf218c5299a0513b7cd628d366c34494e3795c28dd505421af89
-  data.tar.gz: b4e692f08ba961d662f21d7d5ce01a811ed1e0dc025beca4306d1637f02e526920288aac6b7a35a08481d3069234e4576a246d24ba43580d05cc2d5d0d53c996
+  metadata.gz: bcdf15351d765a4c3112db4744b85ba02770cd8367fcb28970f89d2971a07e6643efd949458e124bf634f9d27204e5a2f6c582a0ef183ceeb59cf6f05d3bd826
+  data.tar.gz: 1b798cb089ce2a0524633345f61ff6471041418ae9b4d561f1be50b27b32946d61ebcf62fe4f6f34f0ff699cff9465baf933c7292256fb08d962aa244007eed4

data/History.md

@@ -1,3 +1,22 @@
+# Version 3.2.0
+Release date: 2018-06-01
+
+### Changed
+
+* Ruby 2.3.0+ is now required
+* `ElementNotFound` errors raised in selector filters are interpreted as non-matches
+
+### Added
+
+* New global configuration `default_set_options` used in `Capybara::Node::Element#set` as default `options` hash [Champier Cyril]
+* `execute_javascript` and `evaluate_javascript` can now be called on elements to run the JS in the context of the element [Thomas Walpole]
+* Filters in custom selectors now support a `matcher` Regexp to handle multiple filter options [Thomas Walpole]
+* `:element` selector type which will match on any attribute (other than the reserved names) passed as a filter option [Thomas Walpole]
+* `:class` filter option now supports preceding class names with `!` to indicate not having that class [Thomas Walpole]
+* `:class` and `:id` filter options now accept `XPath::Expression` objects to allow for more flexibility in matching [Thomas Walpole]
+* `Capybara.disable_animation` setting which triggers loading of a middleware that attempts to disable animations in pages.
+  This is very much a beta feature and may change/disappear in the future. [Thomas Walpole]
+
 # Version 3.1.1
 Release date: 2018-05-25
 

data/README.md

@@ -7,7 +7,7 @@
 [![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.1_stable/README.md
+you can find the README at https://github.com/teamcapybara/capybara/blob/3.2_stable/README.md
 
 
 Capybara helps you test web applications by simulating how a real user would

data/lib/capybara.rb

@@ -82,6 +82,7 @@ module Capybara
     # [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)
+    # [default_set_options = Hash]  The default options passed to Node::set (Default: {})
     #
     # === DSL Options
     #
@@ -479,6 +480,7 @@ Capybara.configure do |config|
   config.automatic_label_click = false
   config.enable_aria_label = false
   config.reuse_server = true
+  config.default_set_options = {}
 end
 
 Capybara.register_driver :rack_test do |app|

data/lib/capybara/config.rb

@@ -20,6 +20,7 @@ module Capybara
 
     def initialize
       @session_options = Capybara::SessionConfig.new
+      @javascript_driver = nil
     end
 
     attr_writer :reuse_server
@@ -80,7 +81,7 @@ module Capybara
 
     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]
+      warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" unless once && @deprecation_notified[method]
       @deprecation_notified[method] = true
     end
   end

data/lib/capybara/driver/base.rb

@@ -155,6 +155,6 @@ class Capybara::Driver::Base
   end
 
   def session_options
-    (@session && @session.config) || Capybara.session_options
+    @session&.config || Capybara.session_options
   end
 end

data/lib/capybara/driver/node.rb

@@ -40,15 +40,15 @@ module Capybara
         raise NotImplementedError
       end
 
-      def click(keys = [], options = {})
+      def click(keys = [], **options)
         raise NotImplementedError
       end
 
-      def right_click(keys = [], options = {})
+      def right_click(keys = [], **options)
         raise NotImplementedError
       end
 
-      def double_click(keys = [], options = {})
+      def double_click(keys = [], **options)
         raise NotImplementedError
       end
 

data/lib/capybara/node/actions.rb

@@ -50,7 +50,7 @@ module Capybara
       #
       # @macro waiting_behavior
       #
-      # @overload click_button([locator], options)
+      # @overload click_button([locator], **options)
       #   @param [String] locator      Which button to find
       #   @param options     See {Capybara::Node::Finders#find_button}
       # @return [Capybara::Node::Element]  The element clicked
@@ -66,18 +66,18 @@ module Capybara
       #     page.fill_in 'Name', with: 'Bob'
       #
       #
-      # @overload fill_in([locator], options={})
+      # @overload fill_in([locator], with:, **options)
       #   @param [String] locator                 Which field to fill in
       #   @param [Hash] options
+      #   @param with: [String]                  The value to fill_in
       #   @macro waiting_behavior
-      #   @option options [String] :with          The value to fill in - required
-      #   @option options [Hash] :fill_options    Driver specific options regarding how to fill fields
-      #   @option options [String] :currently_with The current value property of the field to fill in
-      #   @option options [Boolean] :multiple      Match fields that can have multiple values?
-      #   @option options [String] :id             Match fields that match the id attribute
-      #   @option options [String] :name           Match fields that match the name attribute
-      #   @option options [String] :placeholder    Match fields that match the placeholder attribute
-      #   @option options [String, Array<String>] :class    Match fields that match the class(es) provided
+      #   @option options [String] currently_with The current value property of the field to fill in
+      #   @option options [Boolean] multiple      Match fields that can have multiple values?
+      #   @option options [String] id             Match fields that match the id attribute
+      #   @option options [String] name           Match fields that match the name attribute
+      #   @option options [String] placeholder    Match fields that match the placeholder attribute
+      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
+      #   @option options [Hash] fill_options     Driver specific options regarding how to fill fields (Defaults come from Capybara.default_set_options)
       #
       # @return [Capybara::Node::Element]  The element filled_in
       def fill_in(locator = nil, with:, fill_options: {}, **options)
@@ -86,7 +86,7 @@ module Capybara
       end
 
       # @!macro label_click
-      #   @option options [Boolean] :allow_label_click (Capybara.automatic_label_click) Attempt to click the label to toggle state if element is non-visible.
+      #   @option options [Boolean] allow_label_click (Capybara.automatic_label_click) Attempt to click the label to toggle state if element is non-visible.
 
       ##
       #
@@ -95,19 +95,19 @@ module Capybara
       #
       #     page.choose('Male')
       #
-      # @overload choose([locator], options)
+      # @overload choose([locator], **options)
       #   @param [String] locator           Which radio button to choose
       #
-      #   @option options [String] :option  Value of the radio_button to choose
-      #   @option options [String] :id             Match fields that match the id attribute
-      #   @option options [String] :name           Match fields that match the name attribute
-      #   @option options [String, Array<String>] :class    Match fields that match the class(es) provided
+      #   @option options [String] option  Value of the radio_button to choose
+      #   @option options [String] id             Match fields that match the id attribute
+      #   @option options [String] name           Match fields that match the name attribute
+      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
       #   @macro waiting_behavior
       #   @macro label_click
       #
       # @return [Capybara::Node::Element]  The element chosen or the label clicked
       def choose(locator = nil, **options)
-        _check_with_label(:radio_button, true, locator, **options)
+        _check_with_label(:radio_button, true, locator, options)
       end
 
       ##
@@ -118,19 +118,19 @@ module Capybara
       #     page.check('German')
       #
       #
-      # @overload check([locator], options)
+      # @overload check([locator], **options)
       #   @param [String] locator           Which check box to check
       #
-      #   @option options [String] :option  Value of the checkbox to select
+      #   @option options [String] option  Value of the checkbox to select
       #   @option options [String] id       Match fields that match the id attribute
       #   @option options [String] name     Match fields that match the name attribute
-      #   @option options [String, Array<String>] :class    Match fields that match the class(es) provided
+      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
       #   @macro label_click
       #   @macro waiting_behavior
       #
       # @return [Capybara::Node::Element]  The element checked or the label clicked
       def check(locator = nil, **options)
-        _check_with_label(:checkbox, true, locator, **options)
+        _check_with_label(:checkbox, true, locator, options)
       end
 
       ##
@@ -141,19 +141,19 @@ module Capybara
       #     page.uncheck('German')
       #
       #
-      # @overload uncheck([locator], options)
+      # @overload uncheck([locator], **options)
       #   @param [String] locator           Which check box to uncheck
       #
-      #   @option options [String] :option  Value of the checkbox to deselect
+      #   @option options [String] option  Value of the checkbox to deselect
       #   @option options [String] id       Match fields that match the id attribute
       #   @option options [String] name     Match fields that match the name attribute
-      #   @option options [String, Array<String>] :class    Match fields that match the class(es) provided
+      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
       #   @macro label_click
       #   @macro waiting_behavior
       #
       # @return [Capybara::Node::Element]  The element unchecked or the label clicked
       def uncheck(locator = nil, **options)
-        _check_with_label(:checkbox, false, locator, **options)
+        _check_with_label(:checkbox, false, locator, options)
       end
 
       ##
@@ -169,46 +169,17 @@ module Capybara
       #
       # @macro waiting_behavior
       #
-      # @param [String] value           Which option to select
-      # @option options [String] :from  The id, name or label of the select box
+      # @param value [String] Which option to select
+      # @param from: [String]  The id, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element selected
       def select(value = nil, from: nil, **options)
-        scope = if from
-          synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
-            begin
-              find(:select, from, options)
-            rescue Capybara::ElementNotFound => select_error
-              raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }
-              begin
-                find(:datalist_input, from, options)
-              rescue Capybara::ElementNotFound => dlinput_error
-                raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
-              end
-            end
-          end
-        else
-          self
-        end
+        el = from ? find_select_or_datalist_input(from, options) : self
 
-        if scope.respond_to?(:tag_name) && scope.tag_name == "input"
-          begin
-            # TODO: this is a more efficient but won't work with non-JS drivers
-            # datalist_options = session.evaluate_script('Array.prototype.slice.call((arguments[0].list||{}).options || []).filter(function(el){ return !el.disabled }).map(function(el){ return { "value": el.value, "label": el.label} })', scope)
-            datalist_options = session.evaluate_script(DATALIST_OPTIONS_SCRIPT, scope)
-            if (option = datalist_options.find { |o| o['value'] == value || o['label'] == value })
-              scope.set(option["value"])
-            else
-              raise ::Capybara::ElementNotFound, "Unable to find datalist option \"#{value}\""
-            end
-          rescue ::Capybara::NotSupportedByDriverError
-            # Implement for drivers that don't support JS
-            datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == scope[:list]], visible: false)
-            option = datalist.find(:datalist_option, value, disabled: false)
-            scope.set(option.value)
-          end
+        if el.respond_to?(:tag_name) && (el.tag_name == "input")
+          select_datalist_option(el, value)
         else
-          scope.find(:option, value, options).select_option
+          el.find(:option, value, options).select_option
         end
       end
 
@@ -222,8 +193,8 @@ module Capybara
       #
       # @macro waiting_behavior
       #
-      # @param [String] value                   Which option to unselect
-      # @param [Hash{:from => String}] options  The id, name or label of the select box
+      # @param value [String]      Which option to unselect
+      # @param from: [String]      The id, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element unselected
       def unselect(value = nil, from: nil, **options)
@@ -238,20 +209,21 @@ module Capybara
       #
       #     page.attach_file(locator, '/path/to/file.png')
       #
-      # @macro waiting_behavior
+      # @overload attach_file([locator], path, **options)
+      #   @macro waiting_behavior
       #
-      # @param [String] locator       Which field to attach the file to
-      # @param [String] path          The path of the file that will be attached, or an array of paths
+      #   @param [String] locator       Which field to attach the file to
+      #   @param [String] path          The path of the file that will be attached, or an array of paths
       #
-      # @option options [Symbol] match (Capybara.match)     The matching strategy to use (:one, :first, :prefer_exact, :smart).
-      # @option options [Boolean] exact (Capybara.exact)    Match the exact label name/contents or accept a partial match.
-      # @option options [Boolean] multiple Match field which allows multiple file selection
-      # @option options [String] id             Match fields that match the id attribute
-      # @option options [String] name           Match fields that match the name attribute
-      # @option options [String, Array<String>] :class    Match fields that match the class(es) provided
-      # @option options [true, Hash] make_visible   A Hash of CSS styles to change before attempting to attach the file, if `true` { opacity: 1, display: 'block', visibility: 'visible' } is used (may not be supported by all drivers)
+      #   @option options [Symbol] match (Capybara.match)     The matching strategy to use (:one, :first, :prefer_exact, :smart).
+      #   @option options [Boolean] exact (Capybara.exact)    Match the exact label name/contents or accept a partial match.
+      #   @option options [Boolean] multiple Match field which allows multiple file selection
+      #   @option options [String] id             Match fields that match the id attribute
+      #   @option options [String] name           Match fields that match the name attribute
+      #   @option options [String, Array<String>] class    Match fields that match the class(es) provided
+      #   @option options [true, Hash] make_visible   A Hash of CSS styles to change before attempting to attach the file, if `true` { opacity: 1, display: 'block', visibility: 'visible' } is used (may not be supported by all drivers)
       #
-      # @return [Capybara::Node::Element]  The file field element
+      #   @return [Capybara::Node::Element]  The file field element
       def attach_file(locator = nil, path, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments
         Array(path).each do |p|
           raise Capybara::FileNotFound, "cannot attach file, #{p} does not exist" unless File.exist?(p.to_s)
@@ -267,6 +239,35 @@ module Capybara
 
     private
 
+      def find_select_or_datalist_input(from, options)
+        synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
+          begin
+            find(:select, from, options)
+          rescue Capybara::ElementNotFound => select_error
+            raise if %i[selected with_selected multiple].any? { |option| options.key?(option) }
+            begin
+              find(:datalist_input, from, options)
+            rescue Capybara::ElementNotFound => dlinput_error
+              raise Capybara::ElementNotFound, "#{select_error.message} and #{dlinput_error.message}"
+            end
+          end
+        end
+      end
+
+      def select_datalist_option(input, value)
+        datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT)
+        if (option = datalist_options.find { |o| o['value'] == value || o['label'] == value })
+          input.set(option['value'])
+        else
+          raise ::Capybara::ElementNotFound, %(Unable to find datalist option "#{value}")
+        end
+      rescue ::Capybara::NotSupportedByDriverError
+        # Implement for drivers that don't support JS
+        datalist = find(:xpath, XPath.descendant(:datalist)[XPath.attr(:id) == input[:list]], visible: false)
+        option = datalist.find(:datalist_option, value, disabled: false)
+        input.set(option.value)
+      end
+
       def while_visible(element, visible_css)
         visible_css = { opacity: 1, display: 'block', visibility: 'visible' } if visible_css == true
         _update_style(element, visible_css)
@@ -279,14 +280,14 @@ module Capybara
       end
 
       def _update_style(element, style)
-        session.execute_script(UPDATE_STYLE_SCRIPT, element, style)
+        element.execute_script(UPDATE_STYLE_SCRIPT, style)
       rescue Capybara::NotSupportedByDriverError
         warn "The :make_visible option is not supported by the current driver - ignoring"
       end
 
       def _reset_style(element)
-        session.execute_script(RESET_STYLE_SCRIPT, element)
-      rescue # swallow extra errors
+        element.execute_script(RESET_STYLE_SCRIPT)
+      rescue StandardError # rubocop:disable Lint/HandleExceptions swallow extra errors
       end
 
       def _check_with_label(selector, checked, locator, allow_label_click: session_options.automatic_label_click, **options)
@@ -294,40 +295,37 @@ module Capybara
           begin
             el = find(selector, locator, options)
             el.set(checked)
-          rescue => e
+          rescue StandardError => e
             raise unless allow_label_click && catch_error?(e)
             begin
               el ||= find(selector, locator, options.merge(visible: :all))
-              res = find(:label, for: el, visible: true).click unless el.checked? == checked
-              res
-            rescue # swallow extra errors - raise original
+              find(:label, for: el, visible: true).click unless el.checked? == checked
+            rescue StandardError # swallow extra errors - raise original
               raise e
             end
           end
         end
       end
 
-      UPDATE_STYLE_SCRIPT = <<-'JS'.freeze
-        var el = arguments[0];
-        el.capybara_style_cache = el.style.cssText;
-        var css = arguments[1];
+      UPDATE_STYLE_SCRIPT = <<~'JS'
+        this.capybara_style_cache = this.style.cssText;
+        var css = arguments[0];
         for (var prop in css){
           if (css.hasOwnProperty(prop)) {
-            el.style[prop] = css[prop]
+            this.style[prop] = css[prop]
           }
         }
       JS
 
-      RESET_STYLE_SCRIPT = <<-'JS'.freeze
-        var el = arguments[0];
-        if (el.hasOwnProperty('capybara_style_cache')) {
-          el.style.cssText = el.capybara_style_cache;
-          delete el.capybara_style_cache;
+      RESET_STYLE_SCRIPT = <<~'JS'
+        if (this.hasOwnProperty('capybara_style_cache')) {
+          this.style.cssText = this.capybara_style_cache;
+          delete this.capybara_style_cache;
         }
       JS
 
-      DATALIST_OPTIONS_SCRIPT = <<-'JS'.freeze
-        Array.prototype.slice.call((arguments[0].list||{}).options || []).
+      DATALIST_OPTIONS_SCRIPT = <<~'JS'
+        Array.prototype.slice.call((this.list||{}).options || []).
           filter(function(el){ return !el.disabled }).
           map(function(el){ return { "value": el.value, "label": el.label} })
       JS

data/lib/capybara/node/base.rb

@@ -81,12 +81,12 @@ module Capybara
           start_time = Capybara::Helpers.monotonic_time
           begin
             yield
-          rescue => e
+          rescue StandardError => e
             session.raise_server_error!
             raise e unless driver.wait? && catch_error?(e, errors)
             raise e if (Capybara::Helpers.monotonic_time - start_time) >= seconds
             sleep(0.05)
-            raise Capybara::FrozenInTime, "time appears to be frozen, Capybara does not work with libraries which freeze time, consider using time travelling instead" if Capybara::Helpers.monotonic_time == start_time
+            raise Capybara::FrozenInTime, "Time appears to be frozen. Capybara does not work with libraries which freeze time, consider using time travelling instead" if Capybara::Helpers.monotonic_time == start_time
             reload if session_options.automatic_reload
             retry
           ensure

data/lib/capybara/node/document_matchers.rb

@@ -7,9 +7,9 @@ module Capybara
       # Asserts that the page has the given title.
       #
       # @!macro title_query_params
-      #   @overload $0(string, options = {})
+      #   @overload $0(string, **options)
       #     @param string [String]           The string that title should include
-      #   @overload $0(regexp, options = {})
+      #   @overload $0(regexp, **options)
       #     @param regexp [Regexp]           The regexp that title should match to
       #   @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for title to eq/match given string/regexp argument
       #   @option options [Boolean] :exact (false) When passed a string should the match be exact or just substring
@@ -40,7 +40,7 @@ module Capybara
       def has_title?(title, **options)
         assert_title(title, options)
       rescue Capybara::ExpectationNotMet
-        return false
+        false
       end
 
       ##
@@ -52,7 +52,7 @@ module Capybara
       def has_no_title?(title, **options)
         assert_no_title(title, options)
       rescue Capybara::ExpectationNotMet
-        return false
+        false
       end
 
     private
@@ -62,7 +62,7 @@ module Capybara
         synchronize(query.wait) do
           yield(query)
         end
-        return true
+        true
       end
     end
   end