class Capybara::Selenium::Node

Selenium specific implementation of the Capybara::Driver::Node API

Public Instance Methods

==(other) click to toggle source
# File lib/capybara/selenium/node.rb, line 154
def ==(other)
  native == other.native
end
[](name) click to toggle source
# File lib/capybara/selenium/node.rb, line 17
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 8
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 84
def click(keys = [], **options)
  click_options = ClickOptions.new(keys, options)
  return native.click if click_options.empty?
  click_with_options(click_options)
rescue StandardError => err
  if err.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) ||
     err.message =~ /Other element would receive the click/
    scroll_to_center
  end

  raise err
end
content_editable?() click to toggle source
# File lib/capybara/selenium/node.rb, line 142
def content_editable?
  native.attribute('isContentEditable')
end
disabled?() click to toggle source
# File lib/capybara/selenium/node.rb, line 136
def disabled?
  return true unless native.enabled?
  # WebDriver only defines `disabled?` for form controls but fieldset makes sense too
  tag_name == 'fieldset' && find_xpath('ancestor-or-self::fieldset[@disabled]').any?
end
double_click(keys = [], **options) click to toggle source
# File lib/capybara/selenium/node.rb, line 104
def double_click(keys = [], **options)
  click_options = ClickOptions.new(keys, options)
  click_with_options(click_options) do |action|
    click_options.coords? ? action.double_click : action.double_click(native)
  end
end
drag_to(element) click to toggle source
# File lib/capybara/selenium/node.rb, line 119
def drag_to(element)
  # Due to W3C spec compliance - The Actions API no longer scrolls to elements when necessary
  # which means Seleniums `drag_and_drop` is now broken - do it manually
  scroll_if_needed { browser_action.click_and_hold(native).perform }
  element.scroll_if_needed { browser_action.move_to(element.native).release.perform }
end
find_css(locator) click to toggle source
# File lib/capybara/selenium/node.rb, line 150
def find_css(locator)
  native.find_elements(:css, locator).map { |el| self.class.new(driver, el) }
end
find_xpath(locator) click to toggle source
# File lib/capybara/selenium/node.rb, line 146
def find_xpath(locator)
  native.find_elements(:xpath, locator).map { |el| self.class.new(driver, el) }
end
hover() click to toggle source
# File lib/capybara/selenium/node.rb, line 115
def hover
  scroll_if_needed { browser_action.move_to(native).perform }
end
multiple?() click to toggle source
# File lib/capybara/selenium/node.rb, line 132
def multiple?; boolean_attr(self[:multiple]); end
path() click to toggle source
# File lib/capybara/selenium/node.rb, line 158
def path
  path = find_xpath(XPath.ancestor_or_self).reverse

  result = []
  default_ns = path.last[:namespaceURI]
  while (node = path.shift)
    parent = path.first
    selector = node[:tagName]
    if node[:namespaceURI] != default_ns
      selector = XPath.child.where((XPath.local_name == selector) & (XPath.namespace_uri == node[:namespaceURI])).to_s
      selector
    end

    if parent
      siblings = parent.find_xpath(selector)
      selector += case siblings.size
      when 0
        '[ERROR]' # IE doesn't support full XPath (namespace-uri, etc)
      when 1
        '' # index not necessary when only one matching element
      else
        "[#{siblings.index(node) + 1}]"
      end
    end
    result.push selector
  end

  '/' + result.reverse.join('/')
end
readonly?() click to toggle source
# File lib/capybara/selenium/node.rb, line 131
def readonly?; boolean_attr(self[:readonly]); end
right_click(keys = [], **options) click to toggle source
# File lib/capybara/selenium/node.rb, line 97
def right_click(keys = [], **options)
  click_options = ClickOptions.new(keys, options)
  click_with_options(click_options) do |action|
    click_options.coords? ? action.context_click : action.context_click(native)
  end
end
select_option() click to toggle source
# File lib/capybara/selenium/node.rb, line 75
def select_option
  click unless selected? || disabled?
end
selected?() click to toggle source
# File lib/capybara/selenium/node.rb, line 133
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 111
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 48
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
style(styles) click to toggle source
# File lib/capybara/selenium/node.rb, line 31
def style(styles)
  styles.each_with_object({}) do |style, result|
    result[style] = native.css_value(style)
  end
end
tag_name() click to toggle source
# File lib/capybara/selenium/node.rb, line 126
def tag_name
  native.tag_name.downcase
end
unselect_option() click to toggle source
# File lib/capybara/selenium/node.rb, line 79
def unselect_option
  raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple?
  click if selected?
end
value() click to toggle source
# File lib/capybara/selenium/node.rb, line 23
def value
  if tag_name == 'select' && multiple?
    native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text }
  else
    native[:value]
  end
end
visible?() click to toggle source
# File lib/capybara/selenium/node.rb, line 130
def visible?; boolean_attr(native.displayed?); end
visible_text() click to toggle source
# File lib/capybara/selenium/node.rb, line 4
def visible_text
  native.text
end

Protected Instance Methods

scroll_if_needed() { || ... } click to toggle source
# File lib/capybara/selenium/node.rb, line 190
def scroll_if_needed
  yield
rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError
  scroll_to_center
  yield
end

Private Instance Methods

action_with_modifiers(click_options) { |actions| ... } click to toggle source
# File lib/capybara/selenium/node.rb, line 314
def action_with_modifiers(click_options)
  actions = browser_action.move_to(native, *click_options.coords)
  modifiers_down(actions, click_options.keys)
  yield actions
  modifiers_up(actions, click_options.keys)
  actions.perform
ensure
  act = browser_action
  act.release_actions if act.respond_to?(:release_actions)
end
boolean_attr(val) click to toggle source
# File lib/capybara/selenium/node.rb, line 199
def boolean_attr(val)
  val && (val != 'false')
end
browser_action() click to toggle source
# File lib/capybara/selenium/node.rb, line 333
def browser_action
  driver.browser.action
end
click_with_options(click_options) { |action| ... } click to toggle source
# File lib/capybara/selenium/node.rb, line 227
def click_with_options(click_options)
  scroll_if_needed do
    action_with_modifiers(click_options) do |action|
      if block_given?
        yield action
      else
        click_options.coords? ? action.click : action.click(native)
      end
    end
  end
end
each_key(keys) { |key| ... } click to toggle source
# File lib/capybara/selenium/node.rb, line 337
def each_key(keys)
  keys.each do |key|
    key = case key
    when :ctrl then :control
    when :command, :cmd then :meta
    else
      key
    end
    yield key
  end
end
modifiers_down(actions, keys) click to toggle source
# File lib/capybara/selenium/node.rb, line 325
def modifiers_down(actions, keys)
  each_key(keys) { |key| actions.key_down(key) }
end
modifiers_up(actions, keys) click to toggle source
# File lib/capybara/selenium/node.rb, line 329
def modifiers_up(actions, keys)
  each_key(keys) { |key| actions.key_up(key) }
end
scroll_to_center() click to toggle source
# File lib/capybara/selenium/node.rb, line 239
  def scroll_to_center
    script = <<-'JS'
      try {
        arguments[0].scrollIntoView({behavior: 'instant', block: 'center', inline: 'center'});
      } catch(e) {
        arguments[0].scrollIntoView(true);
      }
    JS
    begin
      driver.execute_script(script, self)
    rescue StandardError # rubocop:disable Lint/HandleExceptions
      # Swallow error if scrollIntoView with options isn't supported
    end
  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 204
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 293
  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)
    browser_action.send_keys(value.to_s).perform
  end
set_date(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 254
def set_date(value) # rubocop:disable Naming/AccessorMethodName
  value = SettableValue.new(value)
  return set_text(value) unless value.dateable?
  # TODO: this would be better if locale can be detected and correct keystrokes sent
  update_value_js(value.to_date_str)
end
set_datetime_local(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 268
def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName
  value = SettableValue.new(value)
  return set_text(value) unless value.timeable?
  # TODO: this would be better if locale can be detected and correct keystrokes sent
  update_value_js(value.to_datetime_str)
end
set_file(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 288
def set_file(value) # rubocop:disable Naming/AccessorMethodName
  path_names = value.to_s.empty? ? [] : value
  native.send_keys(Array(path_names).join("\n"))
end
set_text(value, clear: nil, **_unused) click to toggle source
# File lib/capybara/selenium/node.rb, line 208
def set_text(value, clear: nil, **_unused)
  value = value.to_s
  if value.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
    send_keys(*([:end] + backspaces + [value]))
  elsif clear.is_a? Array
    send_keys(*clear, value)
  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 unless clear == :none
    send_keys(value)
  end
end
set_time(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 261
def set_time(value) # rubocop:disable Naming/AccessorMethodName
  value = SettableValue.new(value)
  return set_text(value) unless value.timeable?
  # TODO: this would be better if locale can be detected and correct keystrokes sent
  update_value_js(value.to_time_str)
end
update_value_js(value) click to toggle source
# File lib/capybara/selenium/node.rb, line 275
  def update_value_js(value)
    driver.execute_script(<<-JS, self, value)
      if (document.activeElement !== arguments[0]){
        arguments[0].focus();
      }
      if (arguments[0].value != arguments[1]) {
        arguments[0].value = arguments[1]
        arguments[0].dispatchEvent(new InputEvent('input'));
        arguments[0].dispatchEvent(new Event('change', { bubbles: true }));
      }
    JS
  end