capybara 3.6.0 → 3.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1f61329ea428004635c5d6768afcdc61fcc22a2dd3a4cb0f14bde2d3b05102cb
-  data.tar.gz: d9d3de632455c5a3a8eecbef2c2fccc7b8d301bb589dcd7a5a21c719e639a5f5
+  metadata.gz: e081025be98ae57e3e43ef0fb2a156b3bfb3ff4d54f8f25bfc09a4bcff2fc59c
+  data.tar.gz: 95e8d6fffe004d4802cd0f97d3bddeae5394041dc774d341c3ad10a60d0b04eb
 SHA512:
-  metadata.gz: 79e61c8494174a8006f158dc0b26d143a14525e4c0e77b4a1b5148f7f46c79207d4d5d89d0f5ef6f3ed3a8374bf2b54e915160770c6c254147c9aea52da48bf1
-  data.tar.gz: b329ae727a2c0d47903f9c992e8acd9e7e26e3bb280751fb8f681cb67c29650ad11d002ad9bfae627c1e767a00483e97a74667e564d4cec0bae2c529afc27452
+  metadata.gz: 93e42ca9e9ad0bde5911fe2c7e86ad2d0ac1c40428dfcd256aa01b21b6a8c2e1755df018a272f1917e0628c5c7e1a68b35eb930c3abdb5ffec4e9079187ca5b8
+  data.tar.gz: c7faa43983241d170cf725c22fcc595d2fde4572a71abcf3271d32993bbb6e2874a96c74b850090089598d277b8793b072315fc1e34c9e7a876daeb64a007f7e

data/History.md

@@ -1,3 +1,19 @@
+# Version 3.7.0
+Release date: 2018-09-02
+
+### Added
+
+* `Capybara.disable_animation` can be set to a CSS selector to identify which elements will have animation disabled [Michael Glass]
+* `Capybara.default_normalize_ws` option which sets whether or not text predicates and matchers (`has_text?`, `has_content?`, `assert_text`, etc) use `normalize_ws` option by default. Defaults to false. [Stegalin Ivan]
+* Selector based predicates, matchers, and finders now support the `:normalize_ws` option for the `:text`/`:exact_text` filters. Defaults to the `Capybara.default_normalize_ws`setting above.
+* Element `choose`/`check`/`uncheck`/`attach_file`/`fill_in` can now operate on the element they're called on or a descendant if no locator is passed.
+
+### Fixed
+
+* All CSS styles applied by the `Element#attach_file` `:make_visible` option will now have `!important` priority set to ensure they override any other specified style.
+* Firefox file inputs are only manually cleared when necessary.
+*
+
 # Version 3.6.0
 Release date: 2018-08-14
 

data/README.md

@@ -7,7 +7,7 @@
 [![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.6_stable/README.md
+you can find the README at https://github.com/teamcapybara/capybara/blob/3.7_stable/README.md
 
 
 Capybara helps you test web applications by simulating how a real user would
@@ -409,6 +409,8 @@ 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.
@@ -427,6 +429,8 @@ Capybara.javascript_driver = :webkit
 
 ### <a name="poltergeist"></a>Poltergeist
 
+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

data/lib/capybara.rb

@@ -85,6 +85,7 @@ module Capybara
     # [default_set_options = Hash]  The default options passed to Node::set (Default: {})
     # [test_id = Symbol/String/nil] Optional attribute to match locator aginst with builtin selectors along with id (Default: nil)
     # [predicates_wait = Boolean]  Whether Capybaras predicate matchers use waiting behavior by default (Default: true)
+    # [default_normalize_ws = Boolean] Whether text predicates and matchers use normalize whitespace behaviour (Default: false)
     #
     # === DSL Options
     #
@@ -486,6 +487,7 @@ Capybara.configure do |config|
   config.default_set_options = {}
   config.test_id = nil
   config.predicates_wait = true
+  config.default_normalize_ws = false
 end
 
 Capybara.register_driver :rack_test do |app|

data/lib/capybara/minitest/spec.rb

@@ -169,7 +169,7 @@ module Capybara
       # Expectation that element has style
       #
       # @!method must_have_style
-      #   see {Capybara::SessionMatchers#assert_style}
+      #   see {Capybara::Node::Matchers#assert_style}
     end
   end
 end

data/lib/capybara/node/actions.rb

@@ -62,6 +62,7 @@ module Capybara
       #
       # Locate a text field or text area and fill it in with the given text
       # The field can be found via its name, id, Capybara.test_id attribute, or label text.
+      # If no locator is provided will operate on self or a descendant
       #
       #     page.fill_in 'Name', with: 'Bob'
       #
@@ -82,6 +83,7 @@ module Capybara
       # @return [Capybara::Node::Element]  The element filled_in
       def fill_in(locator = nil, with:, currently_with: nil, fill_options: {}, **find_options)
         find_options[:with] = currently_with if currently_with
+        find_options[:allow_self] = true if locator.nil?
         find(:fillable_field, locator, find_options).set(with, fill_options)
       end
 
@@ -90,8 +92,9 @@ module Capybara
 
       ##
       #
-      # Find a radio button and mark it as checked. The radio button can be found
-      # via name, id or label text.
+      # Find a descendant radio button and mark it as checked. The radio button can be found
+      # via name, id or label text. If no locator is provided this will match against self or
+      # a descendant.
       #
       #     page.choose('Male')
       #
@@ -112,8 +115,9 @@ module Capybara
 
       ##
       #
-      # Find a check box and mark it as checked. The check box can be found
-      # via name, id or label text.
+      # Find a descendant check box and mark it as checked. The check box can be found
+      # via name, id or label text. If no locator is provided this will match against
+      # self or a descendant.
       #
       #     page.check('German')
       #
@@ -135,8 +139,9 @@ module Capybara
 
       ##
       #
-      # Find a check box and mark uncheck it. The check box can be found
-      # via name, id or label text.
+      # Find a descendant check box and mark uncheck it. The check box can be found
+      # via name, id or label text. If no locator is provided this will match against
+      # self or a descendant.
       #
       #     page.uncheck('German')
       #
@@ -170,7 +175,7 @@ module Capybara
       # @macro waiting_behavior
       #
       # @param value [String] Which option to select
-      # @param from: [String]  The id, Capybara.test_id atrtribute, name or label of the select box
+      # @param from [String]  The id, Capybara.test_id atrtribute, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element selected
       def select(value = nil, from: nil, **options)
@@ -193,8 +198,8 @@ module Capybara
       #
       # @macro waiting_behavior
       #
-      # @param value [String]      Which option to unselect
-      # @param from: [String]      The id, Capybara.test_id attribute, name or label of the select box
+      # @param value [String]     Which option to unselect
+      # @param from [String]      The id, Capybara.test_id attribute, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element unselected
       def unselect(value = nil, from: nil, **options)
@@ -204,18 +209,19 @@ module Capybara
 
       ##
       #
-      # Find a file field on the page and attach a file given its path. The file field can
+      # Find a descendant file field on the page and attach a file given its path. The file field can
       # be found via its name, id or label text. In the case of the file field being hidden for
       # styling reasons the `make_visible` option can be used to temporarily change the CSS of
-      # the file field, attach the file, and then revert the CSS back to original.
+      # the file field, attach the file, and then revert the CSS back to original. If no locator is
+      # passed this will match self or a descendant.
       #
       #     page.attach_file(locator, '/path/to/file.png')
       #
-      # @overload attach_file([locator], path, **options)
+      # @overload attach_file([locator], paths, **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, Array<String>] paths     The path(s) of the file(s) that will be attached
       #
       #   @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.
@@ -226,16 +232,17 @@ module Capybara
       #   @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
-      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)
+      def attach_file(locator = nil, paths, make_visible: nil, **options) # rubocop:disable Style/OptionalArguments
+        Array(paths).each do |path|
+          raise Capybara::FileNotFound, "cannot attach file, #{path} does not exist" unless File.exist?(path.to_s)
         end
+        options[:allow_self] = true if locator.nil?
         # Allow user to update the CSS style of the file input since they are so often hidden on a page
         if make_visible
           ff = find(:file_field, locator, options.merge(visible: :all))
-          while_visible(ff, make_visible) { |el| el.set(path) }
+          while_visible(ff, make_visible) { |el| el.set(paths) }
         else
-          find(:file_field, locator, options).set(path)
+          find(:file_field, locator, options).set(paths)
         end
       end
 
@@ -258,7 +265,7 @@ module Capybara
 
       def select_datalist_option(input, value)
         datalist_options = input.evaluate_script(DATALIST_OPTIONS_SCRIPT)
-        option = datalist_options.find { |o| o.values_at('value', 'label').include?(value) }
+        option = datalist_options.find { |opt| opt.values_at('value', 'label').include?(value) }
         raise ::Capybara::ElementNotFound, %(Unable to find datalist option "#{value}") unless option
         input.set(option['value'])
       rescue ::Capybara::NotSupportedByDriverError
@@ -291,17 +298,19 @@ module Capybara
       end
 
       def _check_with_label(selector, checked, locator, allow_label_click: session_options.automatic_label_click, **options)
+        options[:allow_self] = true if locator.nil?
+
         synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
           begin
             el = find(selector, locator, options)
             el.set(checked)
-          rescue StandardError => e
-            raise unless allow_label_click && catch_error?(e)
+          rescue StandardError => err
+            raise unless allow_label_click && catch_error?(err)
             begin
               el ||= find(selector, locator, options.merge(visible: :all))
-              find(:label, for: el, visible: true).click unless el.checked? == checked
+              el.session.find(:label, for: el, visible: true).click unless el.checked? == checked
             rescue StandardError # swallow extra errors - raise original
-              raise e
+              raise err
             end
           end
         end
@@ -312,7 +321,7 @@ module Capybara
         var css = arguments[0];
         for (var prop in css){
           if (css.hasOwnProperty(prop)) {
-            this.style[prop] = css[prop]
+            this.style.setProperty(prop, css[prop], "important");
           }
         }
       JS

data/lib/capybara/node/base.rb

@@ -74,24 +74,22 @@ module Capybara
       # @raise  [Capybara::FrozenInTime]  If the return value of `Time.now` appears stuck
       #
       def synchronize(seconds = session_options.default_max_wait_time, errors: nil)
-        if session.synchronized
+        return yield if session.synchronized
+
+        session.synchronized = true
+        timer = Capybara::Helpers.timer(expire_in: seconds)
+        begin
           yield
-        else
-          session.synchronized = true
-          timer = Capybara::Helpers.timer(expire_in: seconds)
-          begin
-            yield
-          rescue StandardError => e
-            session.raise_server_error!
-            raise e unless driver.wait? && catch_error?(e, errors)
-            raise e if timer.expired?
-            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 timer.stalled?
-            reload if session_options.automatic_reload
-            retry
-          ensure
-            session.synchronized = false
-          end
+        rescue StandardError => err
+          session.raise_server_error!
+          raise err unless driver.wait? && catch_error?(err, errors)
+          raise err if timer.expired?
+          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 timer.stalled?
+          reload if session_options.automatic_reload
+          retry
+        ensure
+          session.synchronized = false
         end
       end
 

data/lib/capybara/node/document_matchers.rb

@@ -55,9 +55,7 @@ module Capybara
 
       def _verify_title(title, options)
         query = Capybara::Queries::TitleQuery.new(title, options)
-        synchronize(query.wait) do
-          yield(query)
-        end
+        synchronize(query.wait) { yield(query) }
         true
       end
     end

data/lib/capybara/node/element.rb

@@ -55,8 +55,8 @@ module Capybara
       #
       def text(type = nil, normalize_ws: false)
         type ||= :all unless session_options.ignore_hidden_elements || session_options.visible_text_only
-        t = synchronize { type == :all ? base.all_text : base.visible_text }
-        normalize_ws ? t.gsub(/[[:space:]]+/, ' ').strip : t
+        txt = synchronize { type == :all ? base.all_text : base.visible_text }
+        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt
       end
 
       ##
@@ -78,19 +78,19 @@ module Capybara
       #
       #     element.style('color', 'font-size') # => Computed values of CSS 'color' and 'font-size' styles
       #
-      # @param [String]  Names of the desired CSS properties
-      # @return [Hash]   Hash of the CSS property names to computed values
+      # @param [Array<String>] styles   Names of the desired CSS properties
+      # @return [Hash]            Hash of the CSS property names to computed values
       #
       def style(*styles)
         styles = styles.flatten.map(&:to_s)
         raise ArgumentError, 'You must specify at least one CSS style' if styles.empty?
         begin
           synchronize { base.style(styles) }
-        rescue NotImplementedError => e
+        rescue NotImplementedError => err
           begin
             evaluate_script(STYLE_SCRIPT, *styles)
           rescue Capybara::NotSupportedByDriverError
-            raise e
+            raise err
           end
         end
       end
@@ -108,7 +108,7 @@ module Capybara
       # Set the value of the form element to the given value.
       #
       # @param [String] value    The new value
-      # @param [Hash{}] options  Driver specific options for how to set the value. Take default values from {Capybara#default_set_options}
+      # @param [Hash{}] options  Driver specific options for how to set the value. Take default values from `Capybara#default_set_options` - See {Capybara::configure}
       #
       # @return [Capybara::Node::Element]  The element
       def set(value, **options)
@@ -429,8 +429,8 @@ module Capybara
           begin
             reloaded = query_scope.reload.first(@query.name, @query.locator, @query.options)
             @base = reloaded.base if reloaded
-          rescue StandardError => e
-            raise e unless catch_error?(e)
+          rescue StandardError => err
+            raise err unless catch_error?(err)
           end
         end
         self
@@ -440,9 +440,8 @@ module Capybara
         %(#<Capybara::Node::Element tag="#{base.tag_name}" path="#{base.path}">)
       rescue NotSupportedByDriverError
         %(#<Capybara::Node::Element tag="#{base.tag_name}">)
-      rescue StandardError => e
-        raise unless session.driver.invalid_element_errors.any? { |et| e.is_a?(et) }
-
+      rescue StandardError => err
+        raise unless session.driver.invalid_element_errors.any? { |et| err.is_a?(et) }
         %(Obsolete #<Capybara::Node::Element>)
       end
 

data/lib/capybara/node/finders.rb

@@ -223,6 +223,7 @@ module Capybara
       # @param [String] locator                    The locator for the specified selector
       # @option options [String, Regexp] text      Only find elements which contain this text or match this regexp
       # @option options [String, Boolean] exact_text (Capybara.exact_text) When String the elements contained text must match exactly, when Boolean controls whether the :text option must match exactly
+      # @option options [Boolean] normalize_ws (Capybara.default_normalize_ws)  Whether the `text`/`exact_text` options are compared against elment text with whitespace normalized or as returned by the driver
       # @option options [Boolean, Symbol] visible  Only find elements with the specified visibility:
       #                                              * true - only finds visible elements.
       #                                              * false - finds invisible _and_ visible elements.
@@ -306,7 +307,7 @@ module Capybara
       end
 
       def options_include_minimum?(opts)
-        %i[count minimum between].any? { |k| opts.key?(k) }
+        %i[count minimum between].any? { |key| opts.key?(key) }
       end
     end
   end

data/lib/capybara/node/simple.rb

@@ -29,8 +29,8 @@ module Capybara
       # @return [String]    The text of the element
       #
       def text(_type = nil, normalize_ws: false)
-        t = native.text
-        normalize_ws ? t.gsub(/[[:space:]]+/, ' ').strip : t
+        txt = native.text
+        normalize_ws ? txt.gsub(/[[:space:]]+/, ' ').strip : txt
       end
 
       ##
@@ -79,11 +79,11 @@ module Capybara
         if tag_name == 'textarea'
           native['_capybara_raw_value']
         elsif tag_name == 'select'
+          selected_options = find_xpath('.//option[@selected]')
           if multiple?
-            native.xpath(".//option[@selected='selected']").map { |option| option[:value] || option.content }
+            selected_options.map(&method(:option_value))
           else
-            option = native.xpath(".//option[@selected='selected']").first || native.xpath('.//option').first
-            option[:value] || option.content if option
+            option_value(selected_options.first || find_xpath('.//option').first)
           end
         elsif tag_name == 'input' && %w[radio checkbox].include?(native[:type])
           native[:value] || 'on'
@@ -104,7 +104,7 @@ module Capybara
         return false if (tag_name == 'input') && (native[:type] == 'hidden')
 
         if check_ancestors
-          !native.xpath("boolean(./ancestor-or-self::*[contains(@style, 'display:none') or contains(@style, 'display: none') or @hidden or name()='script' or name()='head'])")
+          !find_xpath("boolean(./ancestor-or-self::*[contains(@style, 'display:none') or contains(@style, 'display: none') or @hidden or name()='script' or name()='head'])")
         else
           # No need for an xpath if only checking the current element
           !(native.has_attribute?('hidden') || (native[:style] =~ /display:\s?none/) || %w[script head].include?(tag_name))
@@ -177,6 +177,13 @@ module Capybara
       def session_options
         Capybara.session_options
       end
+
+    private
+
+      def option_value(option)
+        return nil if option.nil?
+        option[:value] || option.content
+      end
     end
   end
 end

data/lib/capybara/queries/base_query.rb

@@ -23,9 +23,9 @@ module Capybara
 
       def self.wait(options, default = Capybara.default_max_wait_time)
         # if no value or nil for the :wait option is passed it should default to the default
-        w = options.fetch(:wait, nil)
-        w = default if w.nil?
-        w || 0
+        wait = options.fetch(:wait, nil)
+        wait = default if wait.nil?
+        wait || 0
       end
 
       ##
@@ -69,7 +69,7 @@ module Capybara
     private
 
       def count_specified?
-        COUNT_KEYS.any? { |k| options.key? k }
+        COUNT_KEYS.any? { |key| options.key? key }
       end
 
       def count_message