capybara 2.15.0 → 3.0.0

data/lib/capybara/selenium/node.rb

@@ -1,13 +1,30 @@
 # frozen_string_literal: true
+
 class Capybara::Selenium::Node < Capybara::Driver::Node
+  SET_FORMATS = Hash.new(date: '%Y-%m-%d', time: '%H:%M', datetime: "%m%d%Y\t%I%M%P").merge(
+    firefox: {
+      date: '%Y-%m-%d',
+      time: '%H:%M',
+      datetime: "%m%d%Y\t%I%M%P"
+    },
+    chrome: {
+      date: '%m%d%Y',
+      time: '%I%M%P',
+      datetime: "%m%d%Y\t%I%M%P"
+    }
+  )
+
   def visible_text
-    # Selenium doesn't normalize Unicode whitespace.
-    Capybara::Helpers.normalize_whitespace(native.text)
+    native.text
   end
 
   def all_text
     text = driver.execute_script("return arguments[0].textContent", self)
-    Capybara::Helpers.normalize_whitespace(text)
+    text.gsub(/[\u200b\u200e\u200f]/, '')
+        .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
+        .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
+        .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
+        .tr("\u00a0", ' ')
   end
 
   def [](name)
@@ -35,57 +52,31 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   #   :none =>  append the new value to the existing value <br/>
   #   :backspace => send backspace keystrokes to clear the field <br/>
   #   Array => an array of keys to send before the value being set, e.g. [[:command, 'a'], :backspace]
-  def set(value, options={})
-    tag_name = self.tag_name
-    type = self[:type]
-
-    if (Array === value) && !multiple?
-      raise ArgumentError.new "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}"
-    end
+  def set(value, **options)
+    raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}" if value.is_a?(Array) && !multiple?
 
     case tag_name
     when 'input'
-      case type
+      case self[:type]
       when 'radio'
         click
       when 'checkbox'
-        click if value ^ native.attribute('checked').to_s.eql?("true")
+        click if value ^ checked?
       when 'file'
-        path_names = value.to_s.empty? ? [] : value
-        if driver.chrome?
-          native.send_keys(Array(path_names).join("\n"))
-        else
-          native.send_keys(*path_names)
-        end
+        set_file(value)
+      when 'date'
+        set_date(value)
+      when 'time'
+        set_time(value)
+      when 'datetime-local'
+        set_datetime_local(value)
       else
         set_text(value, options)
       end
     when 'textarea'
       set_text(value, options)
     else
-      if content_editable?
-        #ensure we are focused on the element
-        click
-
-        script = <<-JS
-          var range = document.createRange();
-          var sel = window.getSelection();
-          arguments[0].focus();
-          range.selectNodeContents(arguments[0]);
-          sel.removeAllRanges();
-          sel.addRange(range);
-        JS
-        driver.execute_script script, self
-
-        if (driver.chrome?) || (driver.firefox? && !driver.marionette?)
-          # chromedriver raises a can't focus element for child elements if we use native.send_keys
-          # we've already focused it so just use action api
-          driver.browser.action.send_keys(value.to_s).perform
-        else
-          # action api is really slow here just use native.send_keys
-          native.send_keys(value.to_s)
-        end
-      end
+      set_content_editable(value) if content_editable?
     end
   end
 
@@ -94,20 +85,57 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def unselect_option
-    raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box." if !select_node.multiple?
+    raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box." unless select_node.multiple?
     native.click if selected?
   end
 
-  def click
-    native.click
+  def click(keys = [], options = {})
+    if keys.empty? && !(options[:x] && options[:y])
+      native.click
+    else
+      scroll_if_needed do
+        action_with_modifiers(keys, options) do |a|
+          if options[:x] && options[:y]
+            a.click
+          else
+            a.click(native)
+          end
+        end
+      end
+    end
+  rescue => e
+    if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
+       e.message =~ /Other element would receive the click/
+      begin
+        driver.execute_script("arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'})", self)
+      rescue # Swallow error if scrollIntoView with options isn't supported
+      end
+    end
+    raise e
   end
 
-  def right_click
-    driver.browser.action.context_click(native).perform
+  def right_click(keys = [], options = {})
+    scroll_if_needed do
+      action_with_modifiers(keys, options) do |a|
+        if options[:x] && options[:y]
+          a.context_click
+        else
+          a.context_click(native)
+        end
+      end
+    end
   end
 
-  def double_click
-    driver.browser.action.double_click(native).perform
+  def double_click(keys = [], options = {})
+    scroll_if_needed do
+      action_with_modifiers(keys, options) do |a|
+        if options[:x] && options[:y]
+          a.double_click
+        else
+          a.double_click(native)
+        end
+      end
+    end
   end
 
   def send_keys(*args)
@@ -115,51 +143,38 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def hover
-    driver.browser.action.move_to(native).perform
+    scroll_if_needed { driver.browser.action.move_to(native).perform }
   end
 
   def drag_to(element)
-    driver.browser.action.drag_and_drop(native, element.native).perform
+    scroll_if_needed { driver.browser.action.drag_and_drop(native, element.native).perform }
   end
 
   def tag_name
     native.tag_name.downcase
   end
 
-  def visible?
-    displayed = native.displayed?
-    displayed and displayed != "false"
-  end
-
-  def selected?
-    selected = native.selected?
-    selected and selected != "false"
-  end
+  def visible?; boolean_attr(native.displayed?); end
+  def readonly?; boolean_attr(self[:readonly]); end
+  def multiple?; boolean_attr(self[:multiple]); end
+  def selected?; boolean_attr(native.selected?); end
   alias :checked? :selected?
 
   def disabled?
+    return true unless native.enabled?
+
     # workaround for selenium-webdriver/geckodriver reporting elements as enabled when they are nested in disabling elements
     if driver.marionette?
-      if %w(option optgroup).include? tag_name
-        !native.enabled? || find_xpath("parent::*[self::optgroup or self::select]")[0].disabled?
+      if %w[option optgroup].include? tag_name
+        find_xpath("parent::*[self::optgroup or self::select]")[0].disabled?
       else
-        !native.enabled? || !find_xpath("parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]").empty?
+        !find_xpath("parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]").empty?
       end
     else
-      !native.enabled?
+      false
     end
   end
 
-  def readonly?
-    readonly = self[:readonly]
-    readonly and readonly != "false"
-  end
-
-  def multiple?
-    multiple = self[:multiple]
-    multiple and multiple != "false"
-  end
-
   def content_editable?
     native.attribute('isContentEditable')
   end
@@ -177,56 +192,155 @@ class Capybara::Selenium::Node < Capybara::Driver::Node
   end
 
   def path
-    path = find_xpath('ancestor::*').reverse
-    path.unshift self
+    path = find_xpath(XPath.ancestor_or_self).reverse
 
     result = []
-    while node = path.shift
+    while (node = path.shift)
       parent = path.first
-
+      selector = node.tag_name
       if parent
         siblings = parent.find_xpath(node.tag_name)
-        if siblings.size == 1
-          result.unshift node.tag_name
-        else
-          index = siblings.index(node)
-          result.unshift "#{node.tag_name}[#{index+1}]"
-        end
-      else
-        result.unshift node.tag_name
+        selector += "[#{siblings.index(node) + 1}]" unless siblings.size == 1
       end
+      result.push selector
     end
 
-    '/' + result.join('/')
+    '/' + result.reverse.join('/')
   end
 
 private
+
+  def boolean_attr(val)
+    val and val != "false"
+  end
+
   # a reference to the select node if this is an option node
   def select_node
-    find_xpath('./ancestor::select[1]').first
+    find_xpath(XPath.ancestor(:select)[1]).first
+  end
+
+  def set_text(value, clear: nil, **_unused)
+    if value.to_s.empty? && clear.nil?
+      native.clear
+    elsif clear == :backspace
+      # Clear field by sending the correct number of backspace keys.
+      backspaces = [:backspace] * self.value.to_s.length
+      native.send_keys(*(backspaces + [value.to_s]))
+    elsif clear == :none
+      native.send_keys(value.to_s)
+    elsif clear.is_a? Array
+      native.send_keys(*clear, value.to_s)
+    else
+      # Clear field by JavaScript assignment of the value property.
+      # Script can change a readonly element which user input cannot, so
+      # don't execute if readonly.
+      driver.execute_script "arguments[0].value = ''", self
+      native.send_keys(value.to_s)
+    end
+  end
+
+  def scroll_if_needed
+    yield
+  rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
+    script = <<-'JS'
+      try {
+        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
+      } catch(e) {
+        arguments[0].scrollIntoView(true);
+      }
+    JS
+    driver.execute_script(script, self)
+    yield
+  end
+
+  def set_date(value) # rubocop:disable Naming/AccessorMethodName
+    if value.respond_to?(:to_date)
+      set_text(value.to_date.strftime(SET_FORMATS[driver.options[:browser].to_sym][:date]))
+    else
+      set_text(value)
+    end
+  end
+
+  def set_time(value) # rubocop:disable Naming/AccessorMethodName
+    if value.respond_to?(:to_time)
+      set_text(value.to_time.strftime(SET_FORMATS[driver.options[:browser].to_sym][:time]))
+    else
+      set_text(value)
+    end
+  end
+
+  def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName
+    if value.respond_to?(:to_time)
+      set_text(value.to_time.strftime(SET_FORMATS[driver.options[:browser].to_sym][:datetime]))
+    else
+      set_text(value)
+    end
   end
 
-  def set_text(value, options)
-    if readonly?
-      warn "Attempt to set readonly element with value: #{value} \n *This will raise an exception in a future version of Capybara"
-    elsif value.to_s.empty?
+  def set_file(value) # rubocop:disable Naming/AccessorMethodName
+    path_names = value.to_s.empty? ? [] : value
+    if driver.marionette?
       native.clear
+      Array(path_names).each { |p| native.send_keys(p) }
     else
-      if options[:clear] == :backspace
-        # Clear field by sending the correct number of backspace keys.
-        backspaces = [:backspace] * self.value.to_s.length
-        native.send_keys(*(backspaces + [value.to_s]))
-      elsif options[:clear] == :none
-        native.send_keys(value.to_s)
-      elsif options[:clear].is_a? Array
-        native.send_keys(*options[:clear], value.to_s)
+      native.send_keys(Array(path_names).join("\n"))
+    end
+  end
+
+  def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName
+    # Ensure we are focused on the element
+    click
+
+    script = <<-JS
+      var range = document.createRange();
+      var sel = window.getSelection();
+      arguments[0].focus();
+      range.selectNodeContents(arguments[0]);
+      sel.removeAllRanges();
+      sel.addRange(range);
+    JS
+    driver.execute_script script, self
+
+    # The action api has a speed problem but both chrome and firefox 58 raise errors
+    # if we use the faster direct send_keys.  For now just send_keys to the element
+    # we've already focused.
+    # native.send_keys(value.to_s)
+    driver.browser.action.send_keys(value.to_s).perform
+  end
+
+  def action_with_modifiers(keys, x: nil, y: nil)
+    actions = driver.browser.action
+    actions.move_to(native, x, y)
+    modifiers_down(actions, keys)
+    yield actions
+    modifiers_up(actions, keys)
+    actions.perform
+  ensure
+    a = driver.browser.action
+    a.release_actions if a.respond_to?(:release_actions)
+  end
+
+  def modifiers_down(actions, keys)
+    keys.each do |key|
+      key = case key
+      when :ctrl then :control
+      when :command, :cmd then :meta
+      else
+        key
+      end
+      actions.key_down(key)
+    end
+  end
+
+  def modifiers_up(actions, keys)
+    keys.each do |key|
+      key = case key
+      when :ctrl then :control
+      when :command, :cmd then :meta
       else
-        # Clear field by JavaScript assignment of the value property.
-        # Script can change a readonly element which user input cannot, so
-        # don't execute if readonly.
-        driver.execute_script "arguments[0].value = ''", self
-        native.send_keys(value.to_s)
+        key
       end
+      actions.key_up(key)
     end
   end
 end

data/lib/capybara/server.rb

@@ -1,4 +1,5 @@
 # frozen_string_literal: true
+
 require 'uri'
 require 'net/http'
 require 'rack'
@@ -43,7 +44,7 @@ module Capybara
           begin
             @app.call(env)
           rescue *@server_errors => e
-            @error = e unless @error
+            @error ||= e
             raise e
           ensure
             @counter.decrement
@@ -60,7 +61,7 @@ module Capybara
 
     attr_reader :app, :port, :host
 
-    def initialize(app, port=Capybara.server_port, host=Capybara.server_host, server_errors=Capybara.server_errors)
+    def initialize(app, port = Capybara.server_port, host = Capybara.server_host, server_errors = Capybara.server_errors)
       @app = app
       @server_thread = nil # suppress warnings
       @host, @port, @server_errors = host, port, server_errors

data/lib/capybara/session/config.rb

@@ -1,60 +1,55 @@
 # frozen_string_literal: true
+
 require 'delegate'
 
 module Capybara
   class SessionConfig
-    OPTIONS = [:always_include_port, :run_server, :default_selector, :default_max_wait_time, :ignore_hidden_elements,
-               :automatic_reload, :match, :exact, :exact_text, :raise_server_errors, :visible_text_only, :wait_on_first_by_default,
-               :automatic_label_click, :enable_aria_label, :save_path, :exact_options, :asset_host, :default_host, :app_host,
-               :save_and_open_page_path, :server_host, :server_port, :server_errors]
+    OPTIONS = %i[always_include_port run_server default_selector default_max_wait_time ignore_hidden_elements
+                 automatic_reload match exact exact_text raise_server_errors visible_text_only
+                 automatic_label_click enable_aria_label save_path asset_host default_host app_host
+                 server_host server_port server_errors].freeze
 
     attr_accessor(*OPTIONS)
 
     ##
-    #@!method always_include_port
-    #  See {Capybara.configure}
-    #@!method run_server
-    #  See {Capybara.configure}
-    #@!method default_selector
-    #  See {Capybara.configure}
-    #@!method default_max_wait_time
-    #  See {Capybara.configure}
-    #@!method ignore_hidden_elements
-    #  See {Capybara.configure}
-    #@!method automatic_reload
-    #  See {Capybara.configure}
-    #@!method match
-    #  See {Capybara.configure}
-    #@!method exact
-    #  See {Capybara.configure}
-    #@!method raise_server_errors
-    #  See {Capybara.configure}
-    #@!method visible_text_only
-    #  See {Capybara.configure}
-    #@!method wait_on_first_by_default
-    #  See {Capybara.configure}
-    #@!method automatic_label_click
-    #  See {Capybara.configure}
-    #@!method enable_aria_label
-    #  See {Capybara.configure}
-    #@!method save_path
-    #  See {Capybara.configure}
-    #@!method exact_options
-    #  See {Capybara.configure}
-    #@!method asset_host
-    #  See {Capybara.configure}
-    #@!method default_host
-    #  See {Capybara.configure}
-    #@!method app_host
-    #  See {Capybara.configure}
-    #@!method save_and_open_page_path
-    #  See {Capybara.configure}
-    #@!method server_host
-    #  See {Capybara.configure}
-    #@!method server_port
-    #  See {Capybara.configure}
-    #@!method server_errors
-    #  See {Capybara.configure}
+    # @!method always_include_port
+    #   See {Capybara.configure}
+    # @!method run_server
+    #   See {Capybara.configure}
+    # @!method default_selector
+    #   See {Capybara.configure}
+    # @!method default_max_wait_time
+    #   See {Capybara.configure}
+    # @!method ignore_hidden_elements
+    #   See {Capybara.configure}
+    # @!method automatic_reload
+    #   See {Capybara.configure}
+    # @!method match
+    #   See {Capybara.configure}
+    # @!method exact
+    #   See {Capybara.configure}
+    # @!method raise_server_errors
+    #   See {Capybara.configure}
+    # @!method visible_text_only
+    #   See {Capybara.configure}
+    # @!method automatic_label_click
+    #   See {Capybara.configure}
+    # @!method enable_aria_label
+    #   See {Capybara.configure}
+    # @!method save_path
+    #   See {Capybara.configure}
+    # @!method asset_host
+    #   See {Capybara.configure}
+    # @!method default_host
+    #   See {Capybara.configure}
+    # @!method app_host
+    #   See {Capybara.configure}
+    # @!method server_host
+    #   See {Capybara.configure}
+    # @!method server_port
+    #   See {Capybara.configure}
+    # @!method server_errors
+    #   See {Capybara.configure}
 
     remove_method :server_host
 
@@ -73,23 +68,16 @@ module Capybara
 
     remove_method :app_host=
     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)
+      raise ArgumentError, "Capybara.app_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." if url && url !~ URI::DEFAULT_PARSER.make_regexp
       @app_host = url
     end
 
     remove_method :default_host=
     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)
+      raise ArgumentError, "Capybara.default_host should be set to a url (http://www.example.com). Attempted to set #{url.inspect}." if url && url !~ URI::DEFAULT_PARSER.make_regexp
       @default_host = url
     end
 
-    remove_method :save_and_open_page_path=
-    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 initialize_copy(other)
       super
       @server_errors = @server_errors.dup
@@ -98,9 +86,9 @@ module Capybara
 
   class ReadOnlySessionConfig < SimpleDelegator
     SessionConfig::OPTIONS.each do |m|
-      define_method "#{m}=" do |val|
+      define_method "#{m}=" do |_|
         raise "Per session settings are only supported when Capybara.threadsafe == true"
       end
     end
   end
-end
+end

data/lib/capybara/session/matchers.rb

@@ -1,45 +1,52 @@
 # frozen_string_literal: true
+
 module Capybara
   module SessionMatchers
     ##
     # Asserts that the page has the given path.
-    # By default this will compare against the path+query portion of the full url
+    # By default, if passed a full url this will compare against the full url,
+    # if passed a path only the path+query portion will be compared, if passed a regexp
+    # the comparison will depend on the :url option
     #
     # @!macro current_path_query_params
     #   @overload $0(string, options = {})
     #     @param string [String]           The string that the current 'path' should equal
     #   @overload $0(regexp, options = {})
     #     @param regexp [Regexp]           The regexp that the current 'path' should match to
-    #   @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for the current path to eq/match given string/regexp argument
-    #   @option options [Boolean] :url  (false)  Whether the compare should be done against the full url
-    #   @option options [Boolean] :only_path (false)  Whether the compare should be done against just the path protion of the url
+    #   @option options [Boolean] :url (true if `string` ia a full url, otherwise false) Whether the compare should be done against the full current url or just the path
+    #   @option options [Boolean] :ignore_query (false)  Whether the query portion of the current url/path should be ignored
+    #   @option options [Numeric] :wait (Capybara.default_max_wait_time) Maximum time that Capybara will wait for the current url/path to eq/match given string/regexp argument
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_current_path(path, options={})
-      _verify_current_path(path,options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
+    def assert_current_path(path, **options)
+      _verify_current_path(path, options) { |query| raise Capybara::ExpectationNotMet, query.failure_message unless query.resolves_for?(self) }
     end
 
     ##
     # Asserts that the page doesn't have the given path.
-    # By default this will compare against the path+query portion of the full url
+    # By default, if passed a full url this will compare against the full url,
+    # if passed a path only the path+query portion will be compared, if passed a regexp
+    # the comparison will depend on the :url option
     #
     # @macro current_path_query_params
     # @raise [Capybara::ExpectationNotMet] if the assertion hasn't succeeded during wait time
     # @return [true]
     #
-    def assert_no_current_path(path, options={})
-      _verify_current_path(path,options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
+    def assert_no_current_path(path, **options)
+      _verify_current_path(path, options) { |query| raise Capybara::ExpectationNotMet, query.negative_failure_message if query.resolves_for?(self) }
     end
 
     ##
     # Checks if the page has the given path.
-    # By default this will compare against the path+query portion of the full url
+    # By default, if passed a full url this will compare against the full url,
+    # if passed a path only the path+query portion will be compared, if passed a regexp
+    # the comparison will depend on the :url option
     #
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_current_path?(path, options={})
+    def has_current_path?(path, **options)
       assert_current_path(path, options)
     rescue Capybara::ExpectationNotMet
       return false
@@ -47,18 +54,20 @@ module Capybara
 
     ##
     # Checks if the page doesn't have the given path.
-    # By default this will compare against the path+query portion of the full url
+    # By default, if passed a full url this will compare against the full url,
+    # if passed a path only the path+query portion will be compared, if passed a regexp
+    # the comparison will depend on the :url option
     #
     # @macro current_path_query_params
     # @return [Boolean]
     #
-    def has_no_current_path?(path, options={})
+    def has_no_current_path?(path, **options)
       assert_no_current_path(path, options)
     rescue Capybara::ExpectationNotMet
       return false
     end
 
-    private
+  private
 
     def _verify_current_path(path, options)
       query = Capybara::Queries::CurrentPathQuery.new(path, options)