File: pointer_input.rb

package info (click to toggle)
ruby-selenium-webdriver 3.142.7%2Bdfsg-2
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 1,592 kB
  • sloc: ruby: 6,740; javascript: 85; makefile: 3
file content (139 lines) | stat: -rw-r--r-- 3,963 bytes parent folder | download
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
# 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 Interactions
      class PointerInput < InputDevice
        KIND = {mouse: :mouse, pen: :pen, touch: :touch}.freeze

        attr_reader :kind

        def initialize(kind, name: nil)
          super(name)
          @kind = assert_kind(kind)
        end

        def type
          Interactions::POINTER
        end

        def encode
          return nil if no_actions?

          output = {type: type, id: name, actions: @actions.map(&:encode)}
          output[:parameters] = {pointerType: kind}
          output
        end

        def assert_kind(pointer)
          raise TypeError, "#{pointer.inspect} is not a valid pointer type" unless KIND.key? pointer

          KIND[pointer]
        end

        def create_pointer_move(duration: 0, x: 0, y: 0, element: nil, origin: nil)
          add_action(PointerMove.new(self, duration, x, y, element: element, origin: origin))
        end

        def create_pointer_down(button)
          add_action(PointerPress.new(self, :down, button))
        end

        def create_pointer_up(button)
          add_action(PointerPress.new(self, :up, button))
        end

        def create_pointer_cancel
          add_action(PointerCancel.new(self))
        end
      end # PointerInput

      class PointerPress < Interaction
        BUTTONS = {left: 0, middle: 1, right: 2}.freeze
        DIRECTIONS = {down: :pointerDown, up: :pointerUp}.freeze

        def initialize(source, direction, button)
          super(source)
          @direction = assert_direction(direction)
          @button = assert_button(button)
        end

        def type
          @direction
        end

        def assert_button(button)
          if button.is_a? Symbol
            raise TypeError, "#{button.inspect} is not a valid button!" unless BUTTONS.key? button

            button = BUTTONS[button]
          end
          raise ArgumentError, 'Button number cannot be negative!' unless button >= 0

          button
        end

        def assert_direction(direction)
          raise TypeError, "#{direction.inspect} is not a valid button direction" unless DIRECTIONS.key? direction

          DIRECTIONS[direction]
        end

        def encode
          {type: type, button: @button}
        end
      end # PointerPress

      class PointerMove < Interaction
        VIEWPORT = :viewport
        POINTER = :pointer
        ORIGINS = [VIEWPORT, POINTER].freeze

        def initialize(source, duration, x, y, element: nil, origin: nil)
          super(source)
          @duration = duration * 1000
          @x_offset = x
          @y_offset = y
          @origin = element || origin
        end

        def type
          :pointerMove
        end

        def encode
          output = {type: type, duration: @duration.to_i, x: @x_offset, y: @y_offset}
          output[:origin] = @origin
          output
        end
      end # Move

      class PointerCancel < Interaction
        def type
          :pointerCancel
        end

        def encode
          {type: type}
        end
      end # Cancel
    end # Interactions
  end # WebDriver
end # Selenium