class Selenium::WebDriver::W3CActionBuilder

Initialize a W3C Action Builder. Differs from previous by requiring a bridge and allowing asynchronous actions. The W3C implementation allows asynchronous actions per device. e.g. A key can be pressed at the same time that the mouse is moving. Keep in mind that pauses must be added for other devices in order to line up the actions correctly when using asynchronous.

@param [Selenium::WebDriver::Remote::W3CBridge] bridge the bridge for the current driver instance @param [Selenium::WebDriver::Interactions::PointerInput] mouse PointerInput for the mouse. @param [Selenium::WebDriver::Interactions::KeyInput] keyboard KeyInput for the keyboard. @param [Boolean] async Whether to perform the actions asynchronously per device. Defaults to false for

backwards compatibility.

@return [W3CActionBuilder] A self reference.

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 39
def initialize(bridge, mouse, keyboard, async = false)
  # For backwards compatibility, automatically include mouse & keyboard
  @bridge = bridge
  @devices = [mouse, keyboard]
  @async = async
end

Adds a KeyInput device

@example Add a key input device

builder = device.action
builder.add_key_input('keyboard2')

@param [String] name name for the device @return [Interactions::KeyInput] The key input added

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 78
def add_key_input(name)
  new_input = Interactions.key(name)
  add_input(new_input)
  new_input
end

Adds a PointerInput device of the given kind

@example Add a touch pointer input device

builder = device.action
builder.add_pointer_input('touch', :touch)

@param [String] name name for the device @param [Symbol] kind kind of pointer device to create @return [Interactions::PointerInput] The pointer input added

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 60
def add_pointer_input(kind, name)
  new_input = Interactions.pointer(kind, name: name)
  add_input(new_input)
  new_input
end

Clears all actions from the builder.

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 171
def clear_all_actions
  @devices.each(&:clear_actions)
end

Retrieves the input device for the given name

@param [String] name name of the input device @return [Selenium::WebDriver::Interactions::InputDevice] input device with given name

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 91
def get_device(name)
  @devices.find { |device| device.name == name.to_s }
end

Retrieves the current KeyInput device

@return [Selenium::WebDriver::Interactions::InputDevice] current KeyInput device

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 111
def key_inputs
  @devices.select { |device| device.type == Interactions::KEY }
end

Creates a pause for the given device of the given duration. If no duration is given, the pause will only wait for all actions to complete in that tick.

@example Send keys to an element

action_builder = driver.action
keyboard = action_builder.key_input
el = driver.find_element(id: "some_id")
driver.action.click(el).pause(keyboard).pause(keyboard).pause(keyboard).send_keys('keys').perform

@param [InputDevice] device Input device to pause @param [Float] duration Duration to pause @return [W3CActionBuilder] A self reference.

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 131
def pause(device, duration = nil)
  device.create_pause(duration)
  self
end

Creates multiple pauses for the given device of the given duration.

@example Send keys to an element

action_builder = driver.action
keyboard = action_builder.key_input
el = driver.find_element(id: "some_id")
driver.action.click(el).pauses(keyboard, 3).send_keys('keys').perform

@param [InputDevice] device Input device to pause @param [Integer] number of pauses to add for the device @param [Float] duration Duration to pause @return [W3CActionBuilder] A self reference.

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 152
def pauses(device, number, duration = nil)
  number.times { device.create_pause(duration) }
  self
end

Executes the actions added to the builder.

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 161
def perform
  @bridge.send_actions @devices.map(&:encode).compact
  clear_all_actions
  nil
end

Retrieves the current PointerInput devices

@return [Array] array of current PointerInput devices

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 101
def pointer_inputs
  @devices.select { |device| device.type == Interactions::POINTER }
end

Releases all action states from the browser.

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 179
def release_actions
  @bridge.release_actions
end

Adds an InputDevice

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 200
def add_input(device)
  unless @async
    max_device = @devices.max { |a, b| a.actions.length <=> b.actions.length }
    pauses(device, max_device.actions.length)
  end
  @devices << device
end

Adds pauses for all devices but the given devices

@param [Array] action_devices Array of Input Devices performing an action in this tick.

# File lib/selenium/webdriver/common/w3c_action_builder.rb, line 191
def tick(*action_devices)
  return if @async
  @devices.each { |device| device.create_pause unless action_devices.include? device }
end