capybara 2.18.0 → 3.0.0

data/lib/capybara/minitest.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'minitest'
 require 'capybara/dsl'
 
@@ -41,17 +42,16 @@ module Capybara
       # @!method assert_no_current_path
       #   see {Capybara::SessionMatchers#assert_no_current_path}
 
-
-      %w(assert_text assert_no_text assert_title assert_no_title assert_current_path assert_no_current_path).each do |assertion_name|
-        self.class_eval <<-EOM, __FILE__, __LINE__ + 1
+      %w[assert_text assert_no_text assert_title assert_no_title assert_current_path assert_no_current_path].each do |assertion_name|
+        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
           def #{assertion_name} *args
             self.assertions +=1
-            subject, *args = determine_subject(args)
+            subject, args = determine_subject(args)
             subject.#{assertion_name}(*args)
           rescue Capybara::ExpectationNotMet => e
             raise ::Minitest::Assertion, e.message
           end
-        EOM
+        ASSERTION
       end
 
       alias_method :refute_title, :assert_no_title
@@ -81,190 +81,191 @@ module Capybara
       # @!method assert_xpath
       #   see {Capybara::Node::Matchers#assert_not_matches_selector}
 
-      %w(assert_selector assert_no_selector
+      %w[assert_selector assert_no_selector
          assert_all_of_selectors assert_none_of_selectors
-         assert_matches_selector assert_not_matches_selector).each do |assertion_name|
-        self.class_eval <<-EOM, __FILE__, __LINE__ + 1
+         assert_matches_selector assert_not_matches_selector].each do |assertion_name|
+        class_eval <<-ASSERTION, __FILE__, __LINE__ + 1
           def #{assertion_name} *args, &optional_filter_block
             self.assertions +=1
-            subject, *args = determine_subject(args)
+            subject, args = determine_subject(args)
             subject.#{assertion_name}(*args, &optional_filter_block)
           rescue Capybara::ExpectationNotMet => e
             raise ::Minitest::Assertion, e.message
           end
-        EOM
+        ASSERTION
       end
 
       alias_method :refute_selector, :assert_no_selector
       alias_method :refute_matches_selector, :assert_not_matches_selector
 
-      %w(xpath css link button field select table).each do |selector_type|
+      %w[xpath css link button field select table].each do |selector_type|
         define_method "assert_#{selector_type}" do |*args, &optional_filter_block|
-          subject, *args = determine_subject(args)
+          subject, args = determine_subject(args)
           locator, options = extract_locator(args)
           assert_selector(subject, selector_type.to_sym, locator, options, &optional_filter_block)
         end
 
         define_method "assert_no_#{selector_type}" do |*args, &optional_filter_block|
-          subject, *args = determine_subject(args)
+          subject, args = determine_subject(args)
           locator, options = extract_locator(args)
           assert_no_selector(subject, selector_type.to_sym, locator, options, &optional_filter_block)
         end
         alias_method "refute_#{selector_type}", "assert_no_#{selector_type}"
       end
 
-      %w(checked unchecked).each do |field_type|
+      %w[checked unchecked].each do |field_type|
         define_method "assert_#{field_type}_field" do |*args, &optional_filter_block|
-          subject, *args = determine_subject(args)
+          subject, args = determine_subject(args)
           locator, options = extract_locator(args)
           assert_selector(subject, :field, locator, options.merge(field_type.to_sym => true), &optional_filter_block)
         end
 
         define_method "assert_no_#{field_type}_field" do |*args, &optional_filter_block|
-          subject, *args = determine_subject(args)
+          subject, args = determine_subject(args)
           locator, options = extract_locator(args)
           assert_no_selector(subject, :field, locator, options.merge(field_type.to_sym => true), &optional_filter_block)
         end
         alias_method "refute_#{field_type}_field", "assert_no_#{field_type}_field"
       end
 
-      %w(xpath css).each do |selector_type|
+      %w[xpath css].each do |selector_type|
         define_method "assert_matches_#{selector_type}" do |*args, &optional_filter_block|
-          subject, *args = determine_subject(args)
+          subject, args = determine_subject(args)
           assert_matches_selector(subject, selector_type.to_sym, *args, &optional_filter_block)
         end
 
         define_method "assert_not_matches_#{selector_type}" do |*args, &optional_filter_block|
-          subject, *args = determine_subject(args)
+          subject, args = determine_subject(args)
           assert_not_matches_selector(subject, selector_type.to_sym, *args, &optional_filter_block)
         end
         alias_method "refute_matches_#{selector_type}", "assert_not_matches_#{selector_type}"
       end
 
-
-      ##
-      # Assertion that there is xpath
-      #
-      # @!method assert_xpath
-      #   see Capybara::Node::Matchers#has_xpath?
-
-      ##
-      # Assertion that there is no xpath
-      #
-      # @!method refute_xpath
-      # @!method assert_no_xpath
-      #   see Capybara::Node::Matchers#has_no_xpath?
-
-      ##
-      # Assertion that there is css
-      #
-      # @!method assert_css
-      #   see Capybara::Node::Matchers#has_css?
-
-      ##
-      # Assertion that there is no css
-      #
-      # @!method refute_css
-      # @!method assert_no_css
-      #   see Capybara::Node::Matchers#has_no_css?
-
-      ##
-      # Assertion that there is link
-      #
-      # @!method assert_link
-      #   see {Capybara::Node::Matchers#has_link?}
-
-      ##
-      # Assertion that there is no link
-      #
-      # @!method assert_no_link
-      # @!method refute_link
-      # see {Capybara::Node::Matchers#has_no_link?}
-
-      ##
-      # Assertion that there is button
-      #
-      # @!method assert_button
-      #   see {Capybara::Node::Matchers#has_button?}
-
-      ##
-      # Assertion that there is no button
-      #
-      # @!method refute_button
-      # @!method assert_no_button
-      #   see {Capybara::Node::Matchers#has_no_button?}
-
-      ##
-      # Assertion that there is field
-      #
-      # @!method assert_field
-      #   see {Capybara::Node::Matchers#has_field?}
-
-      ##
-      # Assertion that there is no field
-      #
-      # @!method refute_field
-      # @!method assert_no_field
-      #   see {Capybara::Node::Matchers#has_no_field?}
-
-      ##
-      # Assertion that there is checked_field
-      #
-      # @!method assert_checked_field
-      #   see {Capybara::Node::Matchers#has_checked_field?}
-
-      ##
-      # Assertion that there is no checked_field
-      #
-      # @!method assert_no_checked_field
-      # @!method refute_checked_field
-
-      ##
-      # Assertion that there is unchecked_field
-      #
-      # @!method assert_unchecked_field
-      #   see {Capybara::Node::Matchers#has_unchecked_field?}
-
-      ##
-      # Assertion that there is no unchecked_field
-      #
-      # @!method assert_no_unchecked_field
-      # @!method refute_unchecked_field
-
-      ##
-      # Assertion that there is select
-      #
-      # @!method assert_select
-      #   see {Capybara::Node::Matchers#has_select?}
-
-      ##
-      # Assertion that there is no select
-      #
-      # @!method refute_select
-      # @!method assert_no_select
-      #   see {Capybara::Node::Matchers#has_no_select?}
-
-      ##
-      # Assertion that there is table
-      #
-      # @!method assert_table
-      #   see {Capybara::Node::Matchers#has_table?}
-
-      ##
-      # Assertion that there is no table
-      #
-      # @!method refute_table
-      # @!method assert_no_table
-      #   see {Capybara::Node::Matchers#has_no_table?}
-
-      private
+    ##
+    # Assertion that there is xpath
+    #
+    # @!method assert_xpath
+    #   see Capybara::Node::Matchers#has_xpath?
+
+    ##
+    # Assertion that there is no xpath
+    #
+    # @!method refute_xpath
+    # @!method assert_no_xpath
+    #   see Capybara::Node::Matchers#has_no_xpath?
+
+    ##
+    # Assertion that there is css
+    #
+    # @!method assert_css
+    #   see Capybara::Node::Matchers#has_css?
+
+    ##
+    # Assertion that there is no css
+    #
+    # @!method refute_css
+    # @!method assert_no_css
+    #   see Capybara::Node::Matchers#has_no_css?
+
+    ##
+    # Assertion that there is link
+    #
+    # @!method assert_link
+    #   see {Capybara::Node::Matchers#has_link?}
+
+    ##
+    # Assertion that there is no link
+    #
+    # @!method assert_no_link
+    # @!method refute_link
+    # see {Capybara::Node::Matchers#has_no_link?}
+
+    ##
+    # Assertion that there is button
+    #
+    # @!method assert_button
+    #   see {Capybara::Node::Matchers#has_button?}
+
+    ##
+    # Assertion that there is no button
+    #
+    # @!method refute_button
+    # @!method assert_no_button
+    #   see {Capybara::Node::Matchers#has_no_button?}
+
+    ##
+    # Assertion that there is field
+    #
+    # @!method assert_field
+    #   see {Capybara::Node::Matchers#has_field?}
+
+    ##
+    # Assertion that there is no field
+    #
+    # @!method refute_field
+    # @!method assert_no_field
+    #   see {Capybara::Node::Matchers#has_no_field?}
+
+    ##
+    # Assertion that there is checked_field
+    #
+    # @!method assert_checked_field
+    #   see {Capybara::Node::Matchers#has_checked_field?}
+
+    ##
+    # Assertion that there is no checked_field
+    #
+    # @!method assert_no_checked_field
+    # @!method refute_checked_field
+
+    ##
+    # Assertion that there is unchecked_field
+    #
+    # @!method assert_unchecked_field
+    #   see {Capybara::Node::Matchers#has_unchecked_field?}
+
+    ##
+    # Assertion that there is no unchecked_field
+    #
+    # @!method assert_no_unchecked_field
+    # @!method refute_unchecked_field
+
+    ##
+    # Assertion that there is select
+    #
+    # @!method assert_select
+    #   see {Capybara::Node::Matchers#has_select?}
+
+    ##
+    # Assertion that there is no select
+    #
+    # @!method refute_select
+    # @!method assert_no_select
+    #   see {Capybara::Node::Matchers#has_no_select?}
+
+    ##
+    # Assertion that there is table
+    #
+    # @!method assert_table
+    #   see {Capybara::Node::Matchers#has_table?}
+
+    ##
+    # Assertion that there is no table
+    #
+    # @!method refute_table
+    # @!method assert_no_table
+    #   see {Capybara::Node::Matchers#has_no_table?}
+
+    private
 
       def determine_subject(args)
         case args.first
         when Capybara::Session, Capybara::Node::Base, Capybara::Node::Simple
-          args
+          [args.shift, args]
+        when ->(arg) { arg.respond_to?(:to_capybara_node) }
+          [args.shift.to_capybara_node, args]
         else
-          [page, *args]
+          [page, args]
         end
       end
 

data/lib/capybara/node/actions.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
+
 module Capybara
   module Node
     module Actions
-
       ##
       #
       # Finds a button or link and clicks it.  See {Capybara::Node::Actions#click_button} and
@@ -20,8 +20,7 @@ module Capybara
       #
       # @return [Capybara::Node::Element]  The element clicked
       #
-      def click_link_or_button(locator=nil, options={})
-        locator, options = nil, locator if locator.is_a? Hash
+      def click_link_or_button(locator = nil, **options)
         find(:link_or_button, locator, options).click
       end
       alias_method :click_on, :click_link_or_button
@@ -38,8 +37,7 @@ module Capybara
       #   @param options                  See {Capybara::Node::Finders#find_link}
       #
       # @return [Capybara::Node::Element]  The element clicked
-      def click_link(locator=nil, options={})
-        locator, options = nil, locator if locator.is_a? Hash
+      def click_link(locator = nil, **options)
         find(:link, locator, options).click
       end
 
@@ -56,8 +54,7 @@ module Capybara
       #   @param [String] locator      Which button to find
       #   @param options     See {Capybara::Node::Finders#find_button}
       # @return [Capybara::Node::Element]  The element clicked
-      def click_button(locator=nil, options={})
-        locator, options = nil, locator if locator.is_a? Hash
+      def click_button(locator = nil, **options)
         find(:button, locator, options).click
       end
 
@@ -83,12 +80,8 @@ module Capybara
       #   @option options [String, Array<String>] :class    Match fields that match the class(es) provided
       #
       # @return [Capybara::Node::Element]  The element filled_in
-      def fill_in(locator, options={})
-        locator, options = nil, locator if locator.is_a? Hash
-        raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with)
-        with = options.delete(:with)
-        fill_options = options.delete(:fill_options)
-        options[:with] = options.delete(:currently_with) if options.has_key?(:currently_with)
+      def fill_in(locator = nil, with:, fill_options: {}, **options)
+        options[:with] = options.delete(:currently_with) if options.key?(:currently_with)
         find(:fillable_field, locator, options).set(with, fill_options)
       end
 
@@ -113,8 +106,8 @@ module Capybara
       #   @macro label_click
       #
       # @return [Capybara::Node::Element]  The element chosen or the label clicked
-      def choose(locator, options={})
-        _check_with_label(:radio_button, true, locator, options)
+      def choose(locator = nil, **options)
+        _check_with_label(:radio_button, true, locator, **options)
       end
 
       ##
@@ -136,8 +129,8 @@ module Capybara
       #   @macro waiting_behavior
       #
       # @return [Capybara::Node::Element]  The element checked or the label clicked
-      def check(locator, options={})
-        _check_with_label(:checkbox, true, locator, options)
+      def check(locator, **options)
+        _check_with_label(:checkbox, true, locator, **options)
       end
 
       ##
@@ -159,8 +152,8 @@ module Capybara
       #   @macro waiting_behavior
       #
       # @return [Capybara::Node::Element]  The element unchecked or the label clicked
-      def uncheck(locator, options={})
-        _check_with_label(:checkbox, false, locator, options)
+      def uncheck(locator = nil, **options)
+        _check_with_label(:checkbox, false, locator, **options)
       end
 
       ##
@@ -180,13 +173,9 @@ module Capybara
       # @option options [String] :from  The id, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element selected
-      def select(value, options={})
-        if options.has_key?(:from)
-          from = options.delete(:from)
-          find(:select, from, options).find(:option, value, options).select_option
-        else
-          find(:option, value, options).select_option
-        end
+      def select(value = nil, from: nil, **options)
+        scope = from ? find(:select, from, options) : self
+        scope.find(:option, value, options).select_option
       end
 
       ##
@@ -203,13 +192,9 @@ module Capybara
       # @param [Hash{:from => String}] options  The id, name or label of the select box
       #
       # @return [Capybara::Node::Element]  The option element unselected
-      def unselect(value, options={})
-        if options.has_key?(:from)
-          from = options.delete(:from)
-          find(:select, from, options).find(:option, value, options).unselect_option
-        else
-          find(:option, value, options).unselect_option
-        end
+      def unselect(value = nil, from: nil, **options)
+        scope = from ? find(:select, from, options) : self
+        scope.find(:option, value, options).unselect_option
       end
 
       ##
@@ -233,68 +218,44 @@ 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, path, options={})
-        locator, path, options = nil, locator, path if path.is_a? Hash
+      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)
         end
         # Allow user to update the CSS style of the file input since they are so often hidden on a page
-        if style = options.delete(:make_visible)
-          style = { opacity: 1, display: 'block', visibility: 'visible' } if style == true
-          ff = find(:file_field, locator, options.merge({visible: :all}))
-          _update_style(ff, style)
-          if ff.visible?
-            begin
-              ff.set(path)
-            ensure
-              _reset_style(ff)
-            end
-          else
-            raise ExpectationNotMet, "The style changes in :make_visible did not make the file input visible"
-          end
+        if make_visible
+          ff = find(:file_field, locator, options.merge(visible: :all))
+          while_visible(ff, make_visible) { |el| el.set(path) }
         else
           find(:file_field, locator, options).set(path)
         end
       end
 
     private
-      def _update_style(element, style)
-        script = <<-JS
-          var el = arguments[0];
-          el.capybara_style_cache = el.style.cssText;
-          var css = arguments[1];
-          for (var prop in css){
-            if (css.hasOwnProperty(prop)) {
-              el.style[prop] = css[prop]
-            }
-          }
-        JS
-        begin
-          session.execute_script(script, element, style)
-        rescue Capybara::NotSupportedByDriverError
-          warn "The :make_visible option is not supported by the current driver - ignoring"
-        end
-      end
 
-      def _reset_style(element)
-        script = <<-JS
-          var el = arguments[0];
-          if (el.hasOwnProperty('capybara_style_cache')) {
-            el.style.cssText = el.capybara_style_cache;
-            delete el.capybara_style_cache;
-          }
-        JS
+      def while_visible(element, visible_css)
+        visible_css = { opacity: 1, display: 'block', visibility: 'visible' } if visible_css == true
+        _update_style(element, visible_css)
+        raise ExpectationNotMet, "The style changes in :make_visible did not make the file input visible" unless element.visible?
         begin
-          session.execute_script(script, element)
-        rescue
+          yield element
+        ensure
+          _reset_style(element)
         end
       end
 
+      def _update_style(element, style)
+        session.execute_script(UPDATE_STYLE_SCRIPT, element, style)
+      rescue Capybara::NotSupportedByDriverError
+        warn "The :make_visible option is not supported by the current driver - ignoring"
+      end
 
-      def _check_with_label(selector, checked, locator, options)
-        locator, options = nil, locator if locator.is_a? Hash
-        allow_label_click = options.delete(:allow_label_click) { session_options.automatic_label_click }
+      def _reset_style(element)
+        session.execute_script(RESET_STYLE_SCRIPT, element)
+      rescue # swallow extra errors
+      end
 
+      def _check_with_label(selector, checked, locator, allow_label_click: session_options.automatic_label_click, **options)
         synchronize(Capybara::Queries::BaseQuery.wait(options, session_options.default_max_wait_time)) do
           begin
             el = find(selector, locator, options)
@@ -303,15 +264,33 @@ module Capybara
             raise unless allow_label_click && catch_error?(e)
             begin
               el ||= find(selector, locator, options.merge(visible: :all))
-              label = find(:label, for: el, visible: true)
-              label.click unless (el.checked? == checked)
-            rescue
+              res = find(:label, for: el, visible: true).click unless el.checked? == checked
+              res
+            rescue # 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];
+        for (var prop in css){
+          if (css.hasOwnProperty(prop)) {
+            el.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;
+        }
+      JS
     end
   end
 end

data/lib/capybara/node/base.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
+
 module Capybara
   module Node
-
     ##
     #
     # A {Capybara::Node::Base} represents either an element on a page through the subclass
@@ -67,26 +67,23 @@ module Capybara
       # time has passed. On rubies/platforms which don't support access to a monotonic process clock
       # if the return value of `Time.now` is stubbed out, Capybara will raise `Capybara::FrozenInTime`.
       #
-      # @param  [Integer] seconds         Number of seconds to retry this block
-      # @param options [Hash]
-      # @option options [Array<Exception>] :errors (driver.invalid_element_errors +
+      # @param  [Integer] seconds  (current sessions default_max_wait_time) Maximum number of seconds to retry this block
+      # @param  [Array<Exception>] errors (driver.invalid_element_errors +
       #   [Capybara::ElementNotFound]) exception types that cause the block to be rerun
       # @return [Object]                  The result of the given block
       # @raise  [Capybara::FrozenInTime]  If the return value of `Time.now` appears stuck
       #
-      def synchronize(seconds=session_options.default_max_wait_time, options = {})
-        start_time = Capybara::Helpers.monotonic_time
-
+      def synchronize(seconds = session_options.default_max_wait_time, errors: nil)
         if session.synchronized
           yield
         else
           session.synchronized = true
+          start_time = Capybara::Helpers.monotonic_time
           begin
             yield
           rescue => e
             session.raise_server_error!
-            raise e unless driver.wait?
-            raise e unless catch_error?(e, options[:errors])
+            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
@@ -108,24 +105,20 @@ module Capybara
         base.find_xpath(xpath)
       end
 
-      # @deprecated Use query_scope instead
-      def parent
-        warn "DEPRECATED: #parent is deprecated in favor of #query_scope - Note: #parent was not the elements parent in the document so it's most likely not what you wanted anyway"
-        query_scope
-      end
-
       # @api private
       def session_options
         session.config
       end
 
+      def to_capybara_node
+        self
+      end
+
     protected
 
       def catch_error?(error, errors = nil)
         errors ||= (driver.invalid_element_errors + [Capybara::ElementNotFound])
-        errors.any? do |type|
-          error.is_a?(type)
-        end
+        errors.any? { |type| error.is_a?(type) }
       end
 
       def driver