/
pointer_actions.rb
351 lines (320 loc) · 13.3 KB
/
pointer_actions.rb
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# frozen_string_literal: true
# Licensed to the Software Freedom Conservancy (SFC) under one
# or more contributor license agreements. See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership. The SFC licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License. You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied. See the License for the
# specific language governing permissions and limitations
# under the License.
module Selenium
module WebDriver
module PointerActions
attr_writer :default_move_duration
#
# By default this is set to 250ms in the ActionBuilder constructor
# It can be overridden with default_move_duration=
#
def default_move_duration
@default_move_duration ||= @duration / 1000.0 # convert ms to seconds
end
#
# Presses (without releasing) at the current location of the PointerInput device. This is equivalent to:
#
# driver.action.click_and_hold(nil)
#
# @example Clicking and holding at the current location
#
# driver.action.pointer_down(:left).perform
#
# @param [Selenium::WebDriver::Interactions::PointerPress::BUTTONS] button the button to press.
# @param [Symbol || String] device optional name of the PointerInput device with the button
# that will be pressed
# @return [ActionBuilder] A self reference.
#
def pointer_down(button = :left, device: nil, **opts)
button_action(button, :create_pointer_down, device: device, **opts)
end
#
# Releases the pressed mouse button at the current mouse location of the PointerInput device.
#
# @example Releasing a button after clicking and holding
#
# driver.action.pointer_down(:left).pointer_up(:left).perform
#
# @param [Selenium::WebDriver::Interactions::PointerPress::BUTTONS] button the button to release.
# @param [Symbol || String] device optional name of the PointerInput device with the button that will
# be released
# @return [ActionBuilder] A self reference.
#
def pointer_up(button = :left, device: nil, **opts)
button_action(button, :create_pointer_up, device: device, **opts)
end
#
# Moves the pointer to the in-view center point of the given element.
# Then the pointer is moved to optional offset coordinates.
#
# The element is not scrolled into view.
# MoveTargetOutOfBoundsError will be raised if element with offset is outside the viewport
#
# When using offsets, both coordinates need to be passed.
#
# @example Move the pointer to element
#
# el = driver.find_element(id: "some_id")
# driver.action.move_to(el).perform
#
# @example
#
# el = driver.find_element(id: "some_id")
# driver.action.move_to(el, 100, 100).perform
#
# @param [Selenium::WebDriver::Element] element to move to.
# @param [Integer] right_by Optional offset from the in-view center of the
# element. A negative value means coordinates to the left of the center.
# @param [Integer] down_by Optional offset from the in-view center of the
# element. A negative value means coordinates to the top of the center.
# @return [ActionBuilder] A self reference.
#
def move_to(element, right_by = nil, down_by = nil, **opts)
pointer = pointer_input(opts.delete(:device))
pointer.create_pointer_move(duration: opts.delete(:duration) || default_move_duration,
x: right_by || 0,
y: down_by || 0,
origin: element,
**opts)
tick(pointer)
self
end
#
# Moves the pointer from its current position by the given offset.
#
# The viewport is not scrolled if the coordinates provided are outside the viewport.
# MoveTargetOutOfBoundsError will be raised if the offsets are outside the viewport
#
# @example Move the pointer to a certain offset from its current position
#
# driver.action.move_by(100, 100).perform
#
# @param [Integer] right_by horizontal offset. A negative value means moving the pointer left.
# @param [Integer] down_by vertical offset. A negative value means moving the pointer up.
# @param [Symbol || String] device optional name of the PointerInput device to move
# @return [ActionBuilder] A self reference.
# @raise [MoveTargetOutOfBoundsError] if the provided offset is outside the document's boundaries.
#
def move_by(right_by, down_by, device: nil, duration: default_move_duration, **opts)
pointer = pointer_input(device)
pointer.create_pointer_move(duration: duration,
x: Integer(right_by),
y: Integer(down_by),
origin: Interactions::PointerMove::POINTER,
**opts)
tick(pointer)
self
end
#
# Moves the pointer to a given location in the viewport.
#
# The viewport is not scrolled if the coordinates provided are outside the viewport.
# MoveTargetOutOfBoundsError will be raised if the offsets are outside the viewport
#
# @example Move the pointer to a certain position in the viewport
#
# driver.action.move_to_location(100, 100).perform
#
# @param [Integer] x horizontal position. Equivalent to a css 'left' value.
# @param [Integer] y vertical position. Equivalent to a css 'top' value.
# @param [Symbol || String] device optional name of the PointerInput device to move
# @return [ActionBuilder] A self reference.
# @raise [MoveTargetOutOfBoundsError] if the provided x or y value is outside the document's boundaries.
#
def move_to_location(x, y, device: nil, duration: default_move_duration, **opts)
pointer = pointer_input(device)
pointer.create_pointer_move(duration: duration,
x: Integer(x),
y: Integer(y),
origin: Interactions::PointerMove::VIEWPORT,
**opts)
tick(pointer)
self
end
#
# Clicks (without releasing) in the middle of the given element. This is
# equivalent to:
#
# driver.action.move_to(element).click_and_hold
#
# @example Clicking and holding on some element
#
# el = driver.find_element(id: "some_id")
# driver.action.click_and_hold(el).perform
#
# @param [Selenium::WebDriver::Element] element the element to move to and click.
# @param [Symbol || String] device optional name of the PointerInput device to click with
# @return [ActionBuilder] A self reference.
#
def click_and_hold(element = nil, button: nil, device: nil)
move_to(element, device: device) if element
pointer_down(button || :left, device: device)
self
end
#
# Releases the depressed left mouse button at the current mouse location.
#
# @example Releasing an element after clicking and holding it
#
# el = driver.find_element(id: "some_id")
# driver.action.click_and_hold(el).release.perform
#
# @param [Symbol || String] device optional name of the PointerInput device with the button
# that will be released
# @return [ActionBuilder] A self reference.
#
def release(button: nil, device: nil)
pointer_up(button || :left, device: device)
self
end
#
# Clicks in the middle of the given element. Equivalent to:
#
# driver.action.move_to(element).click
#
# When no element is passed, the current mouse position will be clicked.
#
# @example Clicking on an element
#
# el = driver.find_element(id: "some_id")
# driver.action.click(el).perform
#
# @example Clicking at the current mouse position
#
# driver.action.click.perform
#
# @param [Selenium::WebDriver::Element] element An optional element to click.
# @param [Symbol || String] device optional name of the PointerInput device with the button
# that will be clicked
# @return [ActionBuilder] A self reference.
#
def click(element = nil, button: nil, device: nil)
move_to(element, device: device) if element
pointer_down(button || :left, device: device)
pointer_up(button || :left, device: device)
self
end
#
# Performs a double-click at middle of the given element. Equivalent to:
#
# driver.action.move_to(element).double_click
#
# When no element is passed, the current mouse position will be double-clicked.
#
# @example Double-click an element
#
# el = driver.find_element(id: "some_id")
# driver.action.double_click(el).perform
#
# @example Double-clicking at the current mouse position
#
# driver.action.double_click.perform
#
# @param [Selenium::WebDriver::Element] element An optional element to move to.
# @param [Symbol || String] device optional name of the PointerInput device with the button
# that will be double-clicked
# @return [ActionBuilder] A self reference.
#
def double_click(element = nil, device: nil)
move_to(element, device: device) if element
click(device: device)
click(device: device)
self
end
#
# Performs a context-click at middle of the given element. First performs
# a move_to to the location of the element.
#
# When no element is passed, the current mouse position will be context-clicked.
#
# @example Context-click at middle of given element
#
# el = driver.find_element(id: "some_id")
# driver.action.context_click(el).perform
#
# @example Context-clicking at the current mouse position
#
# driver.action.context_click.perform
#
# @param [Selenium::WebDriver::Element] element An element to context click.
# @param [Symbol || String] device optional name of the PointerInput device with the button
# that will be context-clicked
# @return [ActionBuilder] A self reference.
#
def context_click(element = nil, device: nil)
click(element, button: :right, device: device)
end
#
# A convenience method that performs click-and-hold at the location of the
# source element, moves to the location of the target element, then
# releases the mouse.
#
# @example Drag and drop one element onto another
#
# el1 = driver.find_element(id: "some_id1")
# el2 = driver.find_element(id: "some_id2")
# driver.action.drag_and_drop(el1, el2).perform
#
# @param [Selenium::WebDriver::Element] source element to emulate button down at.
# @param [Selenium::WebDriver::Element] target element to move to and release the
# mouse at.
# @param [Symbol || String] device optional name of the PointerInput device with the button
# that will perform the drag and drop
# @return [ActionBuilder] A self reference.
#
def drag_and_drop(source, target, device: nil)
click_and_hold(source, device: device)
move_to(target, device: device)
release(device: device)
self
end
#
# A convenience method that performs click-and-hold at the location of
# the source element, moves by a given offset, then releases the mouse.
#
# @example Drag and drop an element by offset
#
# el = driver.find_element(id: "some_id1")
# driver.action.drag_and_drop_by(el, 100, 100).perform
#
# @param [Selenium::WebDriver::Element] source Element to emulate button down at.
# @param [Integer] right_by horizontal move offset.
# @param [Integer] down_by vertical move offset.
# @param [Symbol || String] device optional name of the PointerInput device with the button
# that will perform the drag and drop
# @return [ActionBuilder] A self reference.
#
def drag_and_drop_by(source, right_by, down_by, device: nil)
click_and_hold(source, device: device)
move_by(right_by, down_by, device: device)
release(device: device)
self
end
private
def button_action(button, action, device: nil, **opts)
pointer = pointer_input(device)
pointer.send(action, button, **opts)
tick(pointer)
self
end
def pointer_input(name = nil)
device(name: name, type: Interactions::POINTER) || add_pointer_input(:mouse, 'mouse')
end
end # PointerActions
end # WebDriver
end # Selenium