class Capybara::Selenium::Node

Constants

SET_FORMATS

Public Instance Methods

==(other) click to toggle source
# File lib/capybara/selenium/node.rb, line 190
def ==(other)
  native == other.native
end
[](name) click to toggle source
# File lib/capybara/selenium/node.rb, line 30
def [](name)
  native.attribute(name.to_s)
rescue Selenium::WebDriver::Error::WebDriverError
  nil
end
all_text() click to toggle source
# File lib/capybara/selenium/node.rb, line 21
def all_text
  text = driver.execute_script("return arguments[0].textContent", self)
  text.gsub(/[\u200b\u200e\u200f]/, '')
      .gsub(/[\ \n\f\t\v\u2028\u2029]+/, ' ')
      .gsub(/\A[[:space:]&&[^\u00a0]]+/, "")
      .gsub(/[[:space:]&&[^\u00a0]]+\z/, "")
      .tr("\u00a0", ' ')
end
checked?()
Alias for: selected?
click(keys = [], options = {}) click to toggle source
# File lib/capybara/selenium/node.rb, line 92
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
content_editable?() click to toggle source
# File lib/capybara/selenium/node.rb, line 178
def content_editable?
  native.attribute('isContentEditable')
end
disabled?() click to toggle source
# File lib/capybara/selenium/node.rb, line 163
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
      find_xpath("parent::*[self::optgroup or self::select]")[0].disabled?
    else
      !find_xpath("parent::fieldset[@disabled] | ancestor::*[not(self::legend) or preceding-sibling::legend][parent::fieldset[@disabled]]").empty?
    end
  else
    false
  end
end
double_click(keys = [], options = {}) click to toggle source
# File lib/capybara/selenium/node.rb, line 129
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
drag_to(element) click to toggle source
# File lib/capybara/selenium/node.rb, line 149
def drag_to(element)
  scroll_if_needed { driver.browser.action.drag_and_drop(native, element.native).perform }
end
find_css(locator) click to toggle source
# File lib/capybara/selenium/node.rb, line 186
def find_css(locator)
  native.find_elements(:css, locator).map { |n| self.class.new(driver, n) }
end
find_xpath(locator) click to toggle source
# File lib/capybara/selenium/node.rb, line 182
def find_xpath(locator)
  native.find_elements(:xpath, locator).map { |n| self.class.new(driver, n) }
end
hover() click to toggle source
# File lib/capybara/selenium/node.rb, line 145
def hover
  scroll_if_needed { driver.browser.action.move_to(native).perform }
end
multiple?() click to toggle source
# File lib/capybara/selenium/node.rb, line 159
def multiple?; boolean_attr(self[:multiple]); end
path() click to toggle source
# File lib/capybara/selenium/node.rb, line 194
def path
  path = find_xpath(XPath.ancestor_or_self).reverse

  result = []
  while (node = path.shift)
    parent = path.first
    selector = node.tag_name
    if parent
      siblings = parent.find_xpath(node.tag_name)
      selector += "[#{siblings.index(node) + 1}]" unless siblings.size == 1
    end
    result.push selector
  end

  '/' + result.reverse.join('/')
end
readonly?() click to toggle source
# File lib/capybara/selenium/node.rb, line 158
def readonly?; boolean_attr(self[:readonly]); end
right_click(keys = [], options = {}) click to toggle source
# File lib/capybara/selenium/node.rb, line 117
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
select_option() click to toggle source
# File lib/capybara/selenium/node.rb, line 83
def select_option
  native.click unless selected? || disabled?
end
selected?() click to toggle source
# File lib/capybara/selenium/node.rb, line 160
def selected?; boolean_attr(native.selected?); end
Also aliased as: checked?
send_keys(*args) click to toggle source
# File lib/capybara/selenium/node.rb, line 141
def send_keys(*args)
  native.send_keys(*args)
end
set(value, **options) click to toggle source

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 @option options [Symbol,Array] :clear (nil) The method used to clear the previous value <br/>

nil => clear via javascript <br/>
: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]
# File lib/capybara/selenium/node.rb, line 55
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 self[:type]
    when 'radio'
      click
    when 'checkbox'
      click if value ^ checked?
    when 'file'
      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
    set_content_editable(value) if content_editable?
  end
end
tag_name() click to toggle source
# File lib/capybara/selenium/node.rb, line 153
def tag_name
  native.tag_name.downcase
end
unselect_option() click to toggle source
# File lib/capybara/selenium/node.rb, line 87
def unselect_option
  raise Capybara::UnselectNotAllowed, "Cannot unselect option from single select box." unless select_node.multiple?
  native.click if selected?
end
value() click to toggle source
# File lib/capybara/selenium/node.rb, line 36
def value
  if tag_name == "select" and multiple?
    native.find_elements(:css, "option:checked").map { |n| n[:value] || n.text }
  else
    native[:value]
  end
end
visible?() click to toggle source
# File lib/capybara/selenium/node.rb, line 157
def visible?; boolean_attr(native.displayed?); end
visible_text() click to toggle source
# File lib/capybara/selenium/node.rb, line 17
def visible_text
  native.text
end

Private Instance Methods

action_with_modifiers(keys, x: nil, y: nil) { |actions| ... } click to toggle source
# File lib/capybara/selenium/node.rb, line 311
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
boolean_attr(val) click to toggle source
# File lib/capybara/selenium/node.rb, line 213
def boolean_attr(val)
  val and val != "false"
end
modifiers_down(actions, keys) click to toggle source
# File lib/capybara/selenium/node.rb, line 323
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
modifiers_up(actions, keys) click to toggle source
# File lib/capybara/selenium/node.rb, line 335
def modifiers_up(actions, keys)
  keys.each do |key|
    key = case key
    when :ctrl then :control
    when :command, :cmd then :meta
    else
      key
    end
    actions.key_up(key)
  end
end
scroll_if_needed() { || ... } click to toggle source
# File lib/capybara/selenium/node.rb, line 242
  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
select_node() click to toggle source

a reference to the select node if this is an option node

# File lib/capybara/selenium/node.rb, line 218
def select_node
  find_xpath(XPath.ancestor(:select)[1]).first
end
set_content_editable(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 290
  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
set_date(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 256
def set_date(value) # rubocop:disable Naming/AccessorMethodName
  if value.respond_to?(:to_date)
    set_text(value.to_date.strftime(SET_FORMATS[driver.browser.browser][:date]))
  else
    set_text(value)
  end
end
set_datetime_local(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 272
def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName
  if value.respond_to?(:to_time)
    set_text(value.to_time.strftime(SET_FORMATS[driver.browser.browser][:datetime]))
  else
    set_text(value)
  end
end
set_file(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 280
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
    native.send_keys(Array(path_names).join("\n"))
  end
end
set_text(value, clear: nil, **_unused) click to toggle source
# File lib/capybara/selenium/node.rb, line 222
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
set_time(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 264
def set_time(value) # rubocop:disable Naming/AccessorMethodName
  if value.respond_to?(:to_time)
    set_text(value.to_time.strftime(SET_FORMATS[driver.browser.browser][:time]))
  else
    set_text(value)
  end
end