selenium-webdriver 4.1.0 → 4.3.0

Sign up to get free protection for your applications and to get access to all the features.
Files changed (73) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGES +70 -1
  3. data/LICENSE +1 -1
  4. data/NOTICE +1 -1
  5. data/lib/selenium/server.rb +14 -9
  6. data/lib/selenium/webdriver/bidi/session.rb +38 -0
  7. data/lib/selenium/webdriver/bidi.rb +55 -0
  8. data/lib/selenium/webdriver/chrome/features.rb +5 -0
  9. data/lib/selenium/webdriver/chrome/options.rb +19 -19
  10. data/lib/selenium/webdriver/chrome.rb +0 -14
  11. data/lib/selenium/webdriver/common/action_builder.rb +108 -21
  12. data/lib/selenium/webdriver/common/driver.rb +13 -55
  13. data/lib/selenium/webdriver/common/driver_extensions/{has_remote_status.rb → has_bidi.rb} +12 -5
  14. data/lib/selenium/webdriver/common/driver_extensions/has_casting.rb +10 -0
  15. data/lib/selenium/webdriver/common/driver_extensions/has_context.rb +1 -2
  16. data/lib/selenium/webdriver/common/driver_extensions/has_log_events.rb +1 -1
  17. data/lib/selenium/webdriver/common/driver_extensions/has_pinned_scripts.rb +1 -1
  18. data/lib/selenium/webdriver/common/element.rb +1 -1
  19. data/lib/selenium/webdriver/common/error.rb +1 -1
  20. data/lib/selenium/webdriver/common/interactions/input_device.rb +10 -4
  21. data/lib/selenium/webdriver/common/interactions/interaction.rb +12 -25
  22. data/lib/selenium/webdriver/common/interactions/interactions.rb +24 -4
  23. data/lib/selenium/webdriver/common/interactions/key_actions.rb +5 -1
  24. data/lib/selenium/webdriver/common/interactions/key_input.rb +11 -27
  25. data/lib/selenium/webdriver/common/interactions/none_input.rb +10 -8
  26. data/lib/selenium/webdriver/common/interactions/pause.rb +49 -0
  27. data/lib/selenium/webdriver/common/interactions/pointer_actions.rb +56 -66
  28. data/lib/selenium/webdriver/common/interactions/pointer_cancel.rb +45 -0
  29. data/lib/selenium/webdriver/common/interactions/pointer_event_properties.rb +63 -0
  30. data/lib/selenium/webdriver/common/interactions/pointer_input.rb +15 -84
  31. data/lib/selenium/webdriver/common/interactions/pointer_move.rb +60 -0
  32. data/lib/selenium/webdriver/common/interactions/pointer_press.rb +85 -0
  33. data/lib/selenium/webdriver/common/interactions/scroll.rb +57 -0
  34. data/lib/selenium/webdriver/common/interactions/scroll_origin.rb +48 -0
  35. data/lib/selenium/webdriver/common/interactions/typing_interaction.rb +54 -0
  36. data/lib/selenium/webdriver/common/interactions/wheel_actions.rb +113 -0
  37. data/lib/selenium/webdriver/common/interactions/wheel_input.rb +42 -0
  38. data/lib/selenium/webdriver/common/keys.rb +1 -0
  39. data/lib/selenium/webdriver/common/manager.rb +0 -27
  40. data/lib/selenium/webdriver/common/options.rb +2 -9
  41. data/lib/selenium/webdriver/common/platform.rb +4 -4
  42. data/lib/selenium/webdriver/common/search_context.rb +0 -6
  43. data/lib/selenium/webdriver/common/service_manager.rb +2 -3
  44. data/lib/selenium/webdriver/common/shadow_root.rb +1 -1
  45. data/lib/selenium/webdriver/common/socket_poller.rb +1 -1
  46. data/lib/selenium/webdriver/common/websocket_connection.rb +149 -0
  47. data/lib/selenium/webdriver/common.rb +14 -3
  48. data/lib/selenium/webdriver/devtools/request.rb +1 -1
  49. data/lib/selenium/webdriver/devtools/response.rb +1 -1
  50. data/lib/selenium/webdriver/devtools.rb +5 -112
  51. data/lib/selenium/webdriver/edge/features.rb +1 -0
  52. data/lib/selenium/webdriver/firefox/driver.rb +1 -0
  53. data/lib/selenium/webdriver/firefox/features.rb +2 -5
  54. data/lib/selenium/webdriver/firefox/options.rb +3 -1
  55. data/lib/selenium/webdriver/firefox/profile.rb +1 -5
  56. data/lib/selenium/webdriver/firefox/util.rb +46 -0
  57. data/lib/selenium/webdriver/firefox.rb +1 -14
  58. data/lib/selenium/webdriver/ie.rb +0 -14
  59. data/lib/selenium/webdriver/remote/bridge.rb +21 -19
  60. data/lib/selenium/webdriver/remote/commands.rb +0 -5
  61. data/lib/selenium/webdriver/remote/driver.rb +0 -1
  62. data/lib/selenium/webdriver/remote/http/default.rb +6 -12
  63. data/lib/selenium/webdriver/remote/response.rb +2 -2
  64. data/lib/selenium/webdriver/safari.rb +0 -14
  65. data/lib/selenium/webdriver/support/cdp_client_generator.rb +4 -4
  66. data/lib/selenium/webdriver/support/color.rb +7 -7
  67. data/lib/selenium/webdriver/support/guards/guard_condition.rb +1 -1
  68. data/lib/selenium/webdriver/support/guards.rb +1 -1
  69. data/lib/selenium/webdriver/version.rb +1 -1
  70. data/lib/selenium/webdriver.rb +1 -0
  71. data/selenium-webdriver.gemspec +7 -4
  72. metadata +56 -8
  73. data/lib/selenium/webdriver/remote/http/persistent.rb +0 -65
@@ -0,0 +1,63 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to the Software Freedom Conservancy (SFC) under one
4
+ # or more contributor license agreements. See the NOTICE file
5
+ # distributed with this work for additional information
6
+ # regarding copyright ownership. The SFC licenses this file
7
+ # to you under the Apache License, Version 2.0 (the
8
+ # "License"); you may not use this file except in compliance
9
+ # with the License. You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Selenium
21
+ module WebDriver
22
+ module Interactions
23
+ module PointerEventProperties
24
+ VALID = {width: {'width' => {min: 0.0}},
25
+ height: {'height' => {min: 0.0}},
26
+ pressure: {'pressure' => {min: 0.0, max: 1.0}},
27
+ tangential_pressure: {'tangentialPressure' => {min: -1.0, max: 1.0}},
28
+ tilt_x: {'tiltX' => {min: -90, max: 90}},
29
+ tilt_y: {'tiltY' => {min: -90, max: 90}},
30
+ twist: {'twist' => {min: 0, max: 359}},
31
+ altitude_angle: {'altitudeAngle' => {min: 0.0, max: (Math::PI / 2)}},
32
+ azimuth_angle: {'azimuthAngle' => {min: 0.0, max: (Math::PI * 2)}}}.freeze
33
+
34
+ def process_opts
35
+ raise ArgumentError, "Unknown options found: #{@opts.inspect}" unless (@opts.keys - VALID.keys).empty?
36
+
37
+ VALID.each_with_object({}) do |(key, val), hash|
38
+ next unless @opts.key?(key)
39
+
40
+ name = val.keys.first
41
+ values = val.values.first
42
+ hash[name] = assert_number(@opts[key], values[:min], values[:max])
43
+ end
44
+ end
45
+
46
+ private
47
+
48
+ def assert_number(num, min, max = nil)
49
+ return if num.nil?
50
+
51
+ klass = min.is_a?(Integer) ? Integer : Numeric
52
+ raise TypeError, "#{num} is not a #{klass}" unless num.is_a?(klass)
53
+
54
+ raise ArgumentError, "#{num} is not greater than or equal to #{min}" if num < min
55
+
56
+ raise ArgumentError, "#{num} is not less than or equal to #{max}" if max && num > max
57
+
58
+ num
59
+ end
60
+ end # PointerEventProperties
61
+ end # Interactions
62
+ end # WebDriver
63
+ end # Selenium
@@ -20,6 +20,12 @@
20
20
  module Selenium
21
21
  module WebDriver
22
22
  module Interactions
23
+ #
24
+ # Creates actions specific to Pointer Input devices
25
+ #
26
+ # @api private
27
+ #
28
+
23
29
  class PointerInput < InputDevice
24
30
  KIND = {mouse: :mouse, pen: :pen, touch: :touch}.freeze
25
31
 
@@ -28,17 +34,12 @@ module Selenium
28
34
  def initialize(kind, name: nil)
29
35
  super(name)
30
36
  @kind = assert_kind(kind)
31
- end
32
-
33
- def type
34
- Interactions::POINTER
37
+ @type = Interactions::POINTER
35
38
  end
36
39
 
37
40
  def encode
38
- return nil if no_actions?
39
-
40
- output = {type: type, id: name, actions: @actions.map(&:encode)}
41
- output[:parameters] = {pointerType: kind}
41
+ output = super
42
+ output[:parameters] = {pointerType: kind} if output
42
43
  output
43
44
  end
44
45
 
@@ -48,92 +49,22 @@ module Selenium
48
49
  KIND[pointer]
49
50
  end
50
51
 
51
- def create_pointer_move(duration: 0, x: 0, y: 0, element: nil, origin: nil)
52
- add_action(PointerMove.new(self, duration, x, y, element: element, origin: origin))
52
+ def create_pointer_move(duration: 0, x: 0, y: 0, origin: nil, **opts)
53
+ add_action(PointerMove.new(self, duration, x, y, origin: origin, **opts))
53
54
  end
54
55
 
55
- def create_pointer_down(button)
56
- add_action(PointerPress.new(self, :down, button))
56
+ def create_pointer_down(button, **opts)
57
+ add_action(PointerPress.new(self, :down, button, **opts))
57
58
  end
58
59
 
59
- def create_pointer_up(button)
60
- add_action(PointerPress.new(self, :up, button))
60
+ def create_pointer_up(button, **opts)
61
+ add_action(PointerPress.new(self, :up, button, **opts))
61
62
  end
62
63
 
63
64
  def create_pointer_cancel
64
65
  add_action(PointerCancel.new(self))
65
66
  end
66
67
  end # PointerInput
67
-
68
- class PointerPress < Interaction
69
- BUTTONS = {left: 0, middle: 1, right: 2}.freeze
70
- DIRECTIONS = {down: :pointerDown, up: :pointerUp}.freeze
71
-
72
- def initialize(source, direction, button)
73
- super(source)
74
- @direction = assert_direction(direction)
75
- @button = assert_button(button)
76
- end
77
-
78
- def type
79
- @direction
80
- end
81
-
82
- def assert_button(button)
83
- if button.is_a? Symbol
84
- raise TypeError, "#{button.inspect} is not a valid button!" unless BUTTONS.key? button
85
-
86
- button = BUTTONS[button]
87
- end
88
- raise ArgumentError, 'Button number cannot be negative!' unless button >= 0
89
-
90
- button
91
- end
92
-
93
- def assert_direction(direction)
94
- raise TypeError, "#{direction.inspect} is not a valid button direction" unless DIRECTIONS.key? direction
95
-
96
- DIRECTIONS[direction]
97
- end
98
-
99
- def encode
100
- {type: type, button: @button}
101
- end
102
- end # PointerPress
103
-
104
- class PointerMove < Interaction
105
- VIEWPORT = :viewport
106
- POINTER = :pointer
107
- ORIGINS = [VIEWPORT, POINTER].freeze
108
-
109
- def initialize(source, duration, x, y, element: nil, origin: nil)
110
- super(source)
111
- @duration = duration * 1000
112
- @x_offset = x
113
- @y_offset = y
114
- @origin = element || origin
115
- end
116
-
117
- def type
118
- :pointerMove
119
- end
120
-
121
- def encode
122
- output = {type: type, duration: @duration.to_i, x: @x_offset, y: @y_offset}
123
- output[:origin] = @origin
124
- output
125
- end
126
- end # Move
127
-
128
- class PointerCancel < Interaction
129
- def type
130
- :pointerCancel
131
- end
132
-
133
- def encode
134
- {type: type}
135
- end
136
- end # Cancel
137
68
  end # Interactions
138
69
  end # WebDriver
139
70
  end # Selenium
@@ -0,0 +1,60 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to the Software Freedom Conservancy (SFC) under one
4
+ # or more contributor license agreements. See the NOTICE file
5
+ # distributed with this work for additional information
6
+ # regarding copyright ownership. The SFC licenses this file
7
+ # to you under the Apache License, Version 2.0 (the
8
+ # "License"); you may not use this file except in compliance
9
+ # with the License. You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Selenium
21
+ module WebDriver
22
+ module Interactions
23
+ #
24
+ # Action related to moving the pointer.
25
+ #
26
+ # @api private
27
+ #
28
+
29
+ class PointerMove < Interaction
30
+ include PointerEventProperties
31
+
32
+ VIEWPORT = :viewport
33
+ POINTER = :pointer
34
+ ORIGINS = [VIEWPORT, POINTER].freeze
35
+
36
+ def initialize(source, duration, x, y, element: nil, origin: nil, **opts)
37
+ super(source)
38
+ @duration = duration * 1000
39
+ @x_offset = x
40
+ @y_offset = y
41
+ @origin = element || origin || :viewport
42
+ @type = :pointerMove
43
+ @opts = opts
44
+ end
45
+
46
+ def assert_source(source)
47
+ raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? PointerInput
48
+ end
49
+
50
+ def encode
51
+ process_opts.merge('type' => type.to_s,
52
+ 'duration' => @duration.to_i,
53
+ 'x' => @x_offset,
54
+ 'y' => @y_offset,
55
+ 'origin' => @origin)
56
+ end
57
+ end # PointerMove
58
+ end # Interactions
59
+ end # WebDriver
60
+ end # Selenium
@@ -0,0 +1,85 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to the Software Freedom Conservancy (SFC) under one
4
+ # or more contributor license agreements. See the NOTICE file
5
+ # distributed with this work for additional information
6
+ # regarding copyright ownership. The SFC licenses this file
7
+ # to you under the Apache License, Version 2.0 (the
8
+ # "License"); you may not use this file except in compliance
9
+ # with the License. You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Selenium
21
+ module WebDriver
22
+ module Interactions
23
+ #
24
+ # Actions related to clicking, tapping or pressing the pointer.
25
+ #
26
+ # @api private
27
+ #
28
+
29
+ class PointerPress < Interaction
30
+ include PointerEventProperties
31
+
32
+ BUTTONS = {left: 0,
33
+ touch: 0,
34
+ pen_contact: 0,
35
+ middle: 1,
36
+ right: 2,
37
+ pen_barrel: 2,
38
+ x1: 3,
39
+ back: 3,
40
+ x2: 4,
41
+ forward: 4}.freeze
42
+ DIRECTIONS = {down: :pointerDown, up: :pointerUp}.freeze
43
+
44
+ def initialize(source, direction, button, **opts)
45
+ super(source)
46
+ @direction = assert_direction(direction)
47
+ @button = assert_button(button)
48
+ @type = @direction
49
+ @opts = opts
50
+ end
51
+
52
+ def encode
53
+ process_opts.merge('type' => type.to_s, 'button' => @button)
54
+ end
55
+
56
+ private
57
+
58
+ def assert_source(source)
59
+ raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? PointerInput
60
+ end
61
+
62
+ def assert_button(button)
63
+ case button
64
+ when Symbol
65
+ raise ArgumentError, "#{button} is not a valid button!" unless BUTTONS.key? button
66
+
67
+ BUTTONS[button]
68
+ when Integer
69
+ raise ArgumentError, 'Button number cannot be negative!' if button.negative?
70
+
71
+ button
72
+ else
73
+ raise TypeError, "button must be a positive integer or one of #{BUTTONS.keys}, not #{button.class}"
74
+ end
75
+ end
76
+
77
+ def assert_direction(direction)
78
+ raise ArgumentError, "#{direction.inspect} is not a valid button direction" unless DIRECTIONS.key? direction
79
+
80
+ DIRECTIONS[direction]
81
+ end
82
+ end # PointerPress
83
+ end # Interactions
84
+ end # WebDriver
85
+ end # Selenium
@@ -0,0 +1,57 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to the Software Freedom Conservancy (SFC) under one
4
+ # or more contributor license agreements. See the NOTICE file
5
+ # distributed with this work for additional information
6
+ # regarding copyright ownership. The SFC licenses this file
7
+ # to you under the Apache License, Version 2.0 (the
8
+ # "License"); you may not use this file except in compliance
9
+ # with the License. You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Selenium
21
+ module WebDriver
22
+ module Interactions
23
+ #
24
+ # Action related to scrolling a wheel.
25
+ #
26
+ # @api private
27
+ #
28
+
29
+ class Scroll < Interaction
30
+ def initialize(source:, x: 0, y: 0, delta_x: 0, delta_y: 0, origin: :viewport, duration: 0.25)
31
+ super(source)
32
+ @type = :scroll
33
+ @duration = duration * 1000
34
+ @origin = origin
35
+ @x_offset = x
36
+ @y_offset = y
37
+ @delta_x = delta_x
38
+ @delta_y = delta_y
39
+ end
40
+
41
+ def assert_source(source)
42
+ raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? WheelInput
43
+ end
44
+
45
+ def encode
46
+ {'type' => type.to_s,
47
+ 'duration' => @duration.to_i,
48
+ 'x' => @x_offset,
49
+ 'y' => @y_offset,
50
+ 'deltaX' => @delta_x,
51
+ 'deltaY' => @delta_y,
52
+ 'origin' => @origin.is_a?(Element) ? @origin : @origin.to_s}
53
+ end
54
+ end # PointerPress
55
+ end # Interactions
56
+ end # WebDriver
57
+ end # Selenium
@@ -0,0 +1,48 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to the Software Freedom Conservancy (SFC) under one
4
+ # or more contributor license agreements. See the NOTICE file
5
+ # distributed with this work for additional information
6
+ # regarding copyright ownership. The SFC licenses this file
7
+ # to you under the Apache License, Version 2.0 (the
8
+ # "License"); you may not use this file except in compliance
9
+ # with the License. You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Selenium
21
+ module WebDriver
22
+ module WheelActions
23
+ class ScrollOrigin
24
+ class << self
25
+ def element(element, x_offset = 0, y_offset = 0)
26
+ new(element, x_offset, y_offset)
27
+ end
28
+
29
+ def viewport(x_offset = 0, y_offset = 0)
30
+ new(:viewport, x_offset, y_offset)
31
+ end
32
+ end
33
+
34
+ attr_reader :origin, :x_offset, :y_offset
35
+
36
+ #
37
+ # Use a static method to access
38
+ # @api private
39
+ #
40
+ def initialize(origin, x_offset, y_offset)
41
+ @origin = origin
42
+ @x_offset = x_offset
43
+ @y_offset = y_offset
44
+ end
45
+ end # ScrollOrigin
46
+ end # WheelActions
47
+ end # WebDriver
48
+ end # Selenium
@@ -0,0 +1,54 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to the Software Freedom Conservancy (SFC) under one
4
+ # or more contributor license agreements. See the NOTICE file
5
+ # distributed with this work for additional information
6
+ # regarding copyright ownership. The SFC licenses this file
7
+ # to you under the Apache License, Version 2.0 (the
8
+ # "License"); you may not use this file except in compliance
9
+ # with the License. You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Selenium
21
+ module WebDriver
22
+ module Interactions
23
+ #
24
+ # Actions related to pressing keys.
25
+ #
26
+ # @api private
27
+ #
28
+
29
+ class TypingInteraction < Interaction
30
+ attr_reader :type
31
+
32
+ def initialize(source, type, key)
33
+ super(source)
34
+ @type = assert_type(type)
35
+ @key = Keys.encode_key(key)
36
+ end
37
+
38
+ def assert_source(source)
39
+ raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? KeyInput
40
+ end
41
+
42
+ def assert_type(type)
43
+ raise TypeError, "#{type.inspect} is not a valid key subtype" unless KeyInput::SUBTYPES.key? type
44
+
45
+ KeyInput::SUBTYPES[type]
46
+ end
47
+
48
+ def encode
49
+ {type: @type, value: @key}
50
+ end
51
+ end # TypingInteraction
52
+ end # Interactions
53
+ end # WebDriver
54
+ end # Selenium
@@ -0,0 +1,113 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to the Software Freedom Conservancy (SFC) under one
4
+ # or more contributor license agreements. See the NOTICE file
5
+ # distributed with this work for additional information
6
+ # regarding copyright ownership. The SFC licenses this file
7
+ # to you under the Apache License, Version 2.0 (the
8
+ # "License"); you may not use this file except in compliance
9
+ # with the License. You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Selenium
21
+ module WebDriver
22
+ module WheelActions
23
+ attr_writer :default_scroll_duration
24
+
25
+ #
26
+ # By default this is set to 250ms in the ActionBuilder constructor
27
+ # It can be overridden with default_scroll_duration=
28
+ #
29
+
30
+ def default_scroll_duration
31
+ @default_scroll_duration ||= @duration / 1000.0 # convert ms to seconds
32
+ end
33
+
34
+ #
35
+ # If the element is outside the viewport, scrolls the bottom of the element to the bottom of the viewport.
36
+ #
37
+ # @example Scroll to element
38
+ # el = driver.find_element(id: "some_id")
39
+ # driver.action.scroll_to(element).perform
40
+ #
41
+ # @param [Object] Which element to scroll into the viewport.
42
+ # @return [Selenium::WebDriver::WheelActions] A self reference.
43
+ def scroll_to(element, device: nil)
44
+ scroll(origin: element, device: device)
45
+ end
46
+
47
+ #
48
+ # Scrolls by provided amounts with the origin in the top left corner of the viewport.
49
+ #
50
+ # @example Scroll viewport by a specified amount
51
+ # el = driver.find_element(id: "some_id")
52
+ # driver.action.scroll_by(100, 200).perform
53
+ #
54
+ # @param [Integer] delta_x Distance along X axis to scroll using the wheel. A negative value scrolls left.
55
+ # @param [Integer] delta_y Distance along Y axis to scroll using the wheel. A negative value scrolls up.
56
+ # @return [Selenium::WebDriver::WheelActions] A self reference.
57
+ def scroll_by(delta_x, delta_y, device: nil)
58
+ scroll(delta_x: delta_x, delta_y: delta_y, device: device)
59
+ end
60
+
61
+ #
62
+ # Scrolls by provided amount based on a provided origin.
63
+ #
64
+ # The scroll origin is either the center of an element or the upper left of the viewport plus any offsets.
65
+ # If the origin is an element, and the element is not in the viewport, the bottom of the element will first
66
+ # be scrolled to the bottom of the viewport.
67
+ #
68
+ # @example Scroll from element by a specified amount
69
+ # el = driver.find_element(id: "some_id")
70
+ # origin = WheelActions::ScrollOrigin.element(el)
71
+ # driver.action.scroll_from(origin, 0, 200).perform
72
+ #
73
+ # @example Scroll from element by a specified amount with an offset
74
+ # el = driver.find_element(id: "some_id")
75
+ # origin = WheelActions::ScrollOrigin.element(el, 10, 10)
76
+ # driver.action.scroll_from(origin, 100, 200).perform
77
+ #
78
+ # @example Scroll viewport by a specified amount with an offset
79
+ # origin = WheelActions::ScrollOrigin.viewport(10, 10)
80
+ # driver.action.scroll_from(origin, 0, 200).perform
81
+ #
82
+ # @param [ScrollOrigin] scroll_origin Where scroll originates (viewport or element center) plus provided offsets.
83
+ # @param [Integer] delta_x Distance along X axis to scroll using the wheel. A negative value scrolls left.
84
+ # @param [Integer] delta_y Distance along Y axis to scroll using the wheel. A negative value scrolls up.
85
+ # @return [Selenium::WebDriver::WheelActions] A self reference.
86
+ # @raise [Error::MoveTargetOutOfBoundsError] If the origin with offset is outside the viewport.
87
+ def scroll_from(scroll_origin, delta_x, delta_y, device: nil)
88
+ raise TypeError, "#{scroll_origin.inspect} isn't a valid ScrollOrigin" unless scroll_origin.is_a?(ScrollOrigin)
89
+
90
+ scroll(x: scroll_origin.x_offset,
91
+ y: scroll_origin.y_offset,
92
+ delta_x: delta_x,
93
+ delta_y: delta_y,
94
+ origin: scroll_origin.origin,
95
+ device: device)
96
+ end
97
+
98
+ private
99
+
100
+ def scroll(**opts)
101
+ opts[:duration] = default_scroll_duration
102
+ wheel = wheel_input(opts.delete(:device))
103
+ wheel.create_scroll(**opts)
104
+ tick(wheel)
105
+ self
106
+ end
107
+
108
+ def wheel_input(name = nil)
109
+ device(name: name, type: Interactions::WHEEL) || add_wheel_input('wheel')
110
+ end
111
+ end # WheelActions
112
+ end # WebDriver
113
+ end # Selenium
@@ -0,0 +1,42 @@
1
+ # frozen_string_literal: true
2
+
3
+ # Licensed to the Software Freedom Conservancy (SFC) under one
4
+ # or more contributor license agreements. See the NOTICE file
5
+ # distributed with this work for additional information
6
+ # regarding copyright ownership. The SFC licenses this file
7
+ # to you under the Apache License, Version 2.0 (the
8
+ # "License"); you may not use this file except in compliance
9
+ # with the License. You may obtain a copy of the License at
10
+ #
11
+ # http://www.apache.org/licenses/LICENSE-2.0
12
+ #
13
+ # Unless required by applicable law or agreed to in writing,
14
+ # software distributed under the License is distributed on an
15
+ # "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16
+ # KIND, either express or implied. See the License for the
17
+ # specific language governing permissions and limitations
18
+ # under the License.
19
+
20
+ module Selenium
21
+ module WebDriver
22
+ module Interactions
23
+ #
24
+ # Creates actions specific to Pointer Input devices
25
+ #
26
+ # @api private
27
+ #
28
+
29
+ class WheelInput < InputDevice
30
+ def initialize(name = nil)
31
+ super(name)
32
+ @type = Interactions::WHEEL
33
+ end
34
+
35
+ def create_scroll(**opts)
36
+ opts[:source] = self
37
+ add_action(Scroll.new(**opts))
38
+ end
39
+ end # PointerInput
40
+ end # Interactions
41
+ end # WebDriver
42
+ end # Selenium
@@ -90,6 +90,7 @@ module Selenium
90
90
  meta: "\ue03D",
91
91
  command: "\ue03D", # alias
92
92
  left_meta: "\ue03D", # alias
93
+ zenkaku_hankaku: "\uE040",
93
94
  right_shift: "\ue050",
94
95
  right_control: "\ue051",
95
96
  right_alt: "\ue052",