class Capybara::Selenium::Node
def [](name)
def [](name) native.attribute(name.to_s) rescue Selenium::WebDriver::Error::WebDriverError nil end
def action_pause(action, duration)
def action_pause(action, duration) action.pause(device: action.pointer_inputs.first, duration: duration) end
def action_with_modifiers(click_options)
def action_with_modifiers(click_options) actions = browser_action.tap do |acts| if click_options.coords? if click_options.center_offset? acts.move_to(native, *click_options.coords) else right_by, down_by = *click_options.coords size = native.size left_offset = (size[:width] / 2).to_i top_offset = (size[:height] / 2).to_i left = -left_offset + right_by top = -top_offset + down_by acts.move_to(native, left, top) end else acts.move_to(native) end end 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
def all_text
def all_text text = driver.evaluate_script('arguments[0].textContent', self) || '' normalize_spacing(text) end
def attrs(*attr_names)
def attrs(*attr_names) return attr_names.map { |name| self[name.to_s] } if ENV['CAPYBARA_THOROUGH'] driver.evaluate_script <<~JS, self, attr_names.map(&:to_s) (function(el, names){ return names.map(function(name){ return el[name] }); })(arguments[0], arguments[1]); JS end
def auto_rapid_set_length
def auto_rapid_set_length 30 end
def boolean_attr(val)
def boolean_attr(val) val && (val != 'false') end
def bridge
def bridge browser.send(:bridge) end
def browser
def browser driver.browser end
def browser_action
def browser_action browser.action end
def build_node(native_node, initial_cache = {})
def build_node(native_node, initial_cache = {}) self.class.new(driver, native_node, initial_cache) end
def capabilities
def capabilities browser.capabilities end
def click(keys = [], **options)
def click(keys = [], **options) click_options = ClickOptions.new(keys, options) return native.click if click_options.empty? perform_with_options(click_options) do |action| target = click_options.coords? ? nil : native if click_options.delay.zero? action.click(target) else action.click_and_hold(target) action_pause(action, click_options.delay) action.release end end rescue StandardError => e if e.is_a?(::Selenium::WebDriver::Error::ElementClickInterceptedError) || e.message.include?('Other element would receive the click') scroll_to_center end raise e end
def content_editable?
def content_editable? native.attribute('isContentEditable') == 'true' end
def disabled?
def disabled? return true unless native.enabled? # WebDriver only defines `disabled?` for form controls but fieldset makes sense too find_xpath('self::fieldset/ancestor-or-self::fieldset[@disabled]').any? end
def double_click(keys = [], **options)
def double_click(keys = [], **options) click_options = ClickOptions.new(keys, options) raise ArgumentError, "double_click doesn't support a delay option" unless click_options.delay.zero? perform_with_options(click_options) do |action| click_options.coords? ? action.double_click : action.double_click(native) end end
def drag_to(element, drop_modifiers: [], **)
def drag_to(element, drop_modifiers: [], **) drop_modifiers = Array(drop_modifiers) # 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 } element.scroll_if_needed do keys_down = modifiers_down(browser_action, drop_modifiers) keys_up = modifiers_up(keys_down.move_to(element.native).release, drop_modifiers) keys_up.perform end end
def drop(*_)
def drop(*_) raise NotImplementedError, 'Out of browser drop emulation is not implemented for the current browser' end
def each_key(keys, &block)
def each_key(keys, &block) normalize_keys(keys).each(&block) end
def find_context
def find_context native end
def hover
def hover scroll_if_needed { browser_action.move_to(native).perform } end
def modifiers_down(actions, keys)
def modifiers_down(actions, keys) each_key(keys) { |key| actions.key_down(key) } actions end
def modifiers_up(actions, keys)
def modifiers_up(actions, keys) each_key(keys) { |key| actions.key_up(key) } actions end
def multiple?; boolean_attr(self[:multiple]); end
def multiple?; boolean_attr(self[:multiple]); end
def native_id
def native_id # Selenium 3 -> 4 changed the return of ref type_or_id, id = native.ref id || type_or_id end
def normalize_keys(keys)
def normalize_keys(keys) keys.map do |key| case key when :ctrl then :control when :command, :cmd then :meta else key end end end
def obscured?(x: nil, y: nil)
def obscured?(x: nil, y: nil) res = driver.evaluate_script(OBSCURED_OR_OFFSET_SCRIPT, self, x, y) return true if res == true driver.frame_obscured_at?(x: res['x'], y: res['y']) end
def path
def path driver.evaluate_script GET_XPATH_SCRIPT, self end
def perform_with_options(click_options, &block)
def perform_with_options(click_options, &block) raise ArgumentError, 'A block must be provided' unless block scroll_if_needed do action_with_modifiers(click_options) do |action| if block yield action else click_options.coords? ? action.click : action.click(native) end end end end
def readonly?; boolean_attr(self[:readonly]); end
def readonly?; boolean_attr(self[:readonly]); end
def rect
def rect native.rect end
def right_click(keys = [], **options)
def right_click(keys = [], **options) click_options = ClickOptions.new(keys, options) perform_with_options(click_options) do |action| target = click_options.coords? ? nil : native if click_options.delay.zero? action.context_click(target) else action.move_to(target) if target action.pointer_down(:right).then do |act| action_pause(act, click_options.delay) end.pointer_up(:right) end end end
def scroll_if_needed
def scroll_if_needed yield rescue ::Selenium::WebDriver::Error::MoveTargetOutOfBoundsError scroll_to_center yield end
def scroll_to_center
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 # Swallow error if scrollIntoView with options isn't supported end end
def select_node
def select_node find_xpath(XPath.ancestor(:select)[1]).first end
def select_option
def select_option click unless selected? || disabled? end
def selected?; boolean_attr(native.selected?); end
def selected?; boolean_attr(native.selected?); end
def send_keys(*args)
def send_keys(*args) native.send_keys(*args) end
def set(value, **options)
(**options)
-
:rapid
(Boolean
) -- Whether setting text inputs should use a faster "rapid" mode
-
:clear
(Symbol, Array
) -- The method used to clear the previous value
Parameters:
-
options
(Hash{}
) -- Driver specific options for how to set the value -
value
(String
) -- The new value
def set(value, **options) if value.is_a?(Array) && !multiple? raise ArgumentError, "Value cannot be an Array when 'multiple' attribute is not present. Not a #{value.class}" end tag_name, type = attrs(:tagName, :type).map { |val| val&.downcase } @tag_name ||= tag_name case tag_name when 'input' case 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) when 'color' set_color(value) when 'range' set_range(value) else set_text(value, **options) end when 'textarea' set_text(value, **options) else set_content_editable(value) end end
def set_color(value) # rubocop:disable Naming/AccessorMethodName
def set_color(value) # rubocop:disable Naming/AccessorMethodName update_value_js(value) end
def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName
def set_content_editable(value) # rubocop:disable Naming/AccessorMethodName # Ensure we are focused on the element click editable = driver.execute_script <<-JS, self if (arguments[0].isContentEditable) { var range = document.createRange(); var sel = window.getSelection(); arguments[0].focus(); range.selectNodeContents(arguments[0]); sel.removeAllRanges(); sel.addRange(range); return true; } return false; JS # 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 if editable end
def set_date(value) # rubocop:disable Naming/AccessorMethodName
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
def set_datetime_local(value) # rubocop:disable Naming/AccessorMethodName
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
def set_file(value) # rubocop:disable Naming/AccessorMethodName
def set_file(value) # rubocop:disable Naming/AccessorMethodName with_file_detector do path_names = value.to_s.empty? ? [] : value file_names = Array(path_names).map do |pn| Pathname.new(pn).absolute? ? pn : File.expand_path(pn) end.join("\n") native.send_keys(file_names) end end
def set_range(value) # rubocop:disable Naming/AccessorMethodName
def set_range(value) # rubocop:disable Naming/AccessorMethodName update_value_js(value) end
def set_text(value, clear: nil, rapid: nil, **_unused)
def set_text(value, clear: nil, rapid: 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 driver.execute_script 'arguments[0].select()', self unless clear == :none if rapid == true || ((value.length > auto_rapid_set_length) && rapid != false) send_keys(value[0..3]) driver.execute_script RAPID_APPEND_TEXT, self, value[4...-3] send_keys(value[-3..]) else send_keys(value) end end end
def set_time(value) # rubocop:disable Naming/AccessorMethodName
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
def shadow_root
def shadow_root root = native.shadow_root root && build_node(native.shadow_root) end
def shadow_root?
def shadow_root? defined?(::Selenium::WebDriver::ShadowRoot) && native.is_a?(::Selenium::WebDriver::ShadowRoot) end
def sibling_index(parent, node, selector)
def sibling_index(parent, node, selector) siblings = parent.find_xpath(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 idx = siblings.index(node) # Element may not be found in the siblings if it has gone away idx.nil? ? '[ERROR]' : "[#{idx + 1}]" end end
def style(styles)
def style(styles) styles.to_h { |style| [style, native.css_value(style)] } end
def tag_name
def tag_name @tag_name ||= if native.respond_to? :tag_name native.tag_name.downcase else shadow_root? ? 'ShadowRoot' : 'Unknown' end end
def unselect_option
def unselect_option raise Capybara::UnselectNotAllowed, 'Cannot unselect option from single select box.' unless select_node.multiple? click if selected? end
def update_value_js(value)
def update_value_js(value) driver.execute_script(<<-JS, self, value) if (arguments[0].readOnly) { return }; 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
def value
def value if tag_name == 'select' && multiple? native.find_elements(:css, 'option:checked').map { |el| el[:value] || el.text } else native[:value] end end
def visible?; boolean_attr(native.displayed?); end
def visible?; boolean_attr(native.displayed?); end
def visible_text
def visible_text raise NotImplementedError, 'Getting visible text is not currently supported directly on shadow roots' if shadow_root? native.text end
def with_file_detector
def with_file_detector if driver.options[:browser] == :remote && bridge.respond_to?(:file_detector) && bridge.file_detector.nil? begin bridge.file_detector = lambda do |(fn, *)| str = fn.to_s str if File.exist?(str) end yield ensure bridge.file_detector = nil end else yield end end