capybara 2.18.0 → 3.0.0.rc1

data/lib/capybara/driver/node.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 module Capybara
   module Driver
     class Node
@@ -27,7 +28,7 @@ module Capybara
 
       # @param value String or Array. Array is only allowed if node has 'multiple' attribute
       # @param options [Hash{}] Driver specific options for how to set a value on a node
-      def set(value, options={})
+      def set(value, **options)
         raise NotImplementedError
       end
 
@@ -39,15 +40,15 @@ module Capybara
         raise NotImplementedError
       end
 
-      def click
+      def click(keys = [], options = {})
         raise NotImplementedError
       end
 
-      def right_click
+      def right_click(keys = [], options = {})
         raise NotImplementedError
       end
 
-      def double_click
+      def double_click(keys = [], options = {})
         raise NotImplementedError
       end
 

data/lib/capybara/dsl.rb

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

data/lib/capybara/helpers.rb

@@ -1,8 +1,6 @@
-# encoding: UTF-8
 # frozen_string_literal: true
 
 module Capybara
-
   # @api private
   module Helpers
     extend self
@@ -26,16 +24,16 @@ module Capybara
     # if text is not a regexp
     #
     # @param [String] text Text to escape
-    # @return [String]     Escaped text
+    # @param [Boolean] exact (false) Whether or not this should be an exact text match
+    # @param [Fixnum, Boolean, nil] options Options passed to Regexp.new when creating the Regexp
+    # @return [Regexp] Regexp to match the passed in text and options
     #
-    def to_regexp(text, regexp_options=nil, exact=false)
-      if text.is_a?(Regexp)
-        text
-      else
-        escaped = Regexp.escape(normalize_whitespace(text))
-        escaped = "\\A#{escaped}\\z" if exact
-        Regexp.new(escaped, regexp_options)
-      end
+    def to_regexp(text, exact: false, options: nil)
+      return text if text.is_a?(Regexp)
+
+      escaped = Regexp.escape(normalize_whitespace(text))
+      escaped = "\\A#{escaped}\\z" if exact
+      Regexp.new(escaped, options)
     end
 
     ##
@@ -44,16 +42,14 @@ module Capybara
     # `Capybara.asset_host`.
     #
     # @param [String] html     HTML code to inject into
+    # @param [URL] host (Capybara.asset_host) The host from which assets should be loaded
     # @return [String]         The modified HTML code
     #
-    def inject_asset_host(html, asset_host = Capybara.asset_host)
-      if asset_host && Nokogiri::HTML(html).css("base").empty?
+    def inject_asset_host(html, host: Capybara.asset_host)
+      if host && Nokogiri::HTML(html).css("base").empty?
         match = html.match(/<head[^<]*?>/)
-        if match
-          return html.clone.insert match.end(0), "<base href='#{asset_host}' />"
-        end
+        return html.clone.insert match.end(0), "<base href='#{host}' />" if match
       end
-
       html
     end
 
@@ -68,21 +64,13 @@ module Capybara
     # @param [Integer] count       The number of items
     #
     def declension(singular, plural, count)
-      if count == 1
-        singular
-      else
-        plural
-      end
+      count == 1 ? singular : plural
     end
 
     if defined?(Process::CLOCK_MONOTONIC)
-      def monotonic_time
-        Process.clock_gettime Process::CLOCK_MONOTONIC
-      end
+      def monotonic_time; Process.clock_gettime Process::CLOCK_MONOTONIC; end
     else
-      def monotonic_time
-        Time.now.to_f
-      end
+      def monotonic_time; Time.now.to_f; end
     end
   end
 end

data/lib/capybara/minitest.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