[rb] each action interaction class validates its own source

titusfortner · titusfortner · commit ab4e01086c2c · 2021-12-01T00:15:26.000-06:00
This allows users to extend ActionBuilder by creating their own device subclasses
diff --git a/rb/lib/selenium/webdriver/common/interactions/input_device.rb b/rb/lib/selenium/webdriver/common/interactions/input_device.rb
@@ -45,7 +45,7 @@ def create_pause(duration = 0)
         end
 
         def no_actions? # Determine if only pauses are present
-          actions = @actions.reject { |action| action.type == Interaction::PAUSE }
+          actions = @actions.reject { |action| action.type == :pause }
           actions.empty?
         end
       end # InputDevice
diff --git a/rb/lib/selenium/webdriver/common/interactions/interaction.rb b/rb/lib/selenium/webdriver/common/interactions/interaction.rb
@@ -21,17 +21,14 @@ module Selenium
   module WebDriver
     module Interactions
       class Interaction
-        PAUSE = :pause
-
-        attr_reader :source
+        attr_reader :type
 
         def initialize(source)
-          unless Interactions::SOURCE_TYPES.include? source.type
-            raise TypeError,
-                  "#{source.type} is not a valid input type"
-          end
+          assert_source(source)
+        end
 
-          @source = source
+        def assert_source(_source)
+          raise NotImplementedError, 'subclass responsibility'
         end
       end
     end # Interactions
diff --git a/rb/lib/selenium/webdriver/common/interactions/pause.rb b/rb/lib/selenium/webdriver/common/interactions/pause.rb
@@ -24,10 +24,11 @@ class Pause < Interaction
         def initialize(source, duration = nil)
           super(source)
           @duration = duration
+          @type = :pause
         end
 
-        def type
-          PAUSE
+        def assert_source(source)
+          raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? InputDevice
         end
 
         def encode
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_cancel.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_cancel.rb
@@ -21,8 +21,13 @@ module Selenium
   module WebDriver
     module Interactions
       class PointerCancel < Interaction
-        def type
-          :pointerCancel
+        def initialize(source)
+          super(source)
+          @type = :pointerCancel
+        end
+
+        def assert_source(source)
+          raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? PointerInput
         end
 
         def encode
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_move.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_move.rb
@@ -31,10 +31,11 @@ def initialize(source, duration, x, y, element: nil, origin: nil)
           @x_offset = x
           @y_offset = y
           @origin = element || origin || :viewport
+          @type = :pointerMove
         end
 
-        def type
-          :pointerMove
+        def assert_source(source)
+          raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? PointerInput
         end
 
         def encode
diff --git a/rb/lib/selenium/webdriver/common/interactions/pointer_press.rb b/rb/lib/selenium/webdriver/common/interactions/pointer_press.rb
@@ -28,10 +28,11 @@ def initialize(source, direction, button)
           super(source)
           @direction = assert_direction(direction)
           @button = assert_button(button)
+          @type = @direction
         end
 
-        def type
-          @direction
+        def assert_source(source)
+          raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? PointerInput
         end
 
         def assert_button(button)
diff --git a/rb/lib/selenium/webdriver/common/interactions/typing_interaction.rb b/rb/lib/selenium/webdriver/common/interactions/typing_interaction.rb
@@ -29,6 +29,10 @@ def initialize(source, type, key)
           @key = Keys.encode_key(key)
         end
 
+        def assert_source(source)
+          raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? KeyInput
+        end
+
         def assert_type(type)
           raise TypeError, "#{type.inspect} is not a valid key subtype" unless KeyInput::SUBTYPES.key? type
 
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/interaction_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/interaction_spec.rb
@@ -22,17 +22,73 @@
 module Selenium
   module WebDriver
     module Interactions
+      class NewDevice < InputDevice
+        def type
+          :special
+        end
+
+        def encode
+          {type: type, name: name, actions: @actions.map(&:encode)}
+        end
+
+        def create_special(val)
+          add_action(NewInteraction.new(self, val))
+        end
+      end
+
+      class NewInteraction < Interaction
+        def initialize(source, special)
+          super(source)
+          @special = special
+          @type = :newType
+        end
+
+        def assert_source(source)
+          raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? NewDevice
+        end
+
+        def encode
+          {type: type, special: @special}
+        end
+      end
+
+      class SubActionBuilder < ActionBuilder
+        def initialize(bridge, mouse, keyboard, async = nil)
+          super
+          @devices << NewDevice.new('new')
+        end
+
+        def special_action(special, device: nil)
+          special_input(device).create_special(special)
+          self
+        end
+
+        def special_inputs
+          @devices.select { |device| device.is_a? NewDevice }
+        end
+
+        private
+
+        def special_input(device = nil)
+          device ? get_device(device) : special_inputs.first
+        end
+      end
+
       describe Interaction do
-        let(:source) { NoneInput.new }
-        let(:interaction) { Interaction.new(source) }
+        it 'can create subclass' do
+          bridge = instance_double(Remote::Bridge)
+          allow(bridge).to receive(:send_actions)
+          sub_action_builder = SubActionBuilder.new(bridge, Interactions.pointer(:mouse), Interactions.key('key'))
+          sub_action_builder.special_action('special').perform
 
-        it 'returns valid source when provided' do
-          expect(interaction.source).to eq source
+          expect(bridge).to have_received(:send_actions).with([{type: :special,
+                                                                name: 'new',
+                                                                actions: [{type: :newType,
+                                                                           special: 'special'}]}])
         end
 
-        it 'raises a TypeError if the provided source is invalid' do
-          allow(source).to receive(:type).and_return(:no_type)
-          expect { interaction }.to raise_error(TypeError)
+        it 'raises a NotImplementedError if not a subclass' do
+          expect { Interaction.new(NoneInput.new) }.to raise_error(NotImplementedError)
         end
       end
     end # Interactions
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/pause_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/pause_spec.rb
@@ -27,6 +27,18 @@ module Interactions
         let(:pause) { Pause.new(source) }
         let(:duration) { 5 }
 
+        describe '#initialize' do
+          it 'accepts key input' do
+            key = Interactions.key('key')
+            expect { Pause.new(key) }.not_to raise_error
+          end
+
+          it 'accepts pointer input' do
+            mouse = Interactions.pointer(:mouse)
+            expect { Pause.new(mouse) }.not_to raise_error
+          end
+        end
+
         describe '#type' do
           it 'returns :pause' do
             expect(pause.type).to eq(:pause)
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/pointer_cancel_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/pointer_cancel_spec.rb
@@ -25,6 +25,13 @@ module Interactions
       describe PointerCancel do
         let(:pointer_cancel) { PointerCancel.new(Interactions.pointer(:mouse)) }
 
+        describe '#initialize' do
+          it 'raises a TypeError if source is not a PointerInput' do
+            key = Interactions.key('key')
+            expect { PointerCancel.new(key) }.to raise_error(TypeError)
+          end
+        end
+
         describe '#type' do
           it 'equals :pointerCancel' do
             expect(pointer_cancel.type).to eq(:pointerCancel)
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/pointer_move_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/pointer_move_spec.rb
@@ -30,6 +30,13 @@ module Interactions
         let(:x) { 25 }
         let(:y) { 50 }
 
+        describe '#initialize' do
+          it 'raises a TypeError if source is not a PointerInput' do
+            key = Interactions.key('key')
+            expect { PointerMove.new(key, duration, x, y) }.to raise_error(TypeError)
+          end
+        end
+
         describe '#type' do
           it 'equals :pointerMove' do
             move = PointerMove.new(source, duration, x, y)
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/pointer_press_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/pointer_press_spec.rb
@@ -33,7 +33,12 @@ module Interactions
             expect { PointerPress.new(source, direction, :none) }.to raise_error(ArgumentError)
           end
 
-          it 'raises an TypeError if button is not a symbol or integer' do
+          it 'raises a TypeError if source is not a PointerInput' do
+            key = Interactions.key('key')
+            expect { PointerPress.new(key, direction, 'wrong') }.to raise_error(TypeError)
+          end
+
+          it 'raises a TypeError if button is not a Symbol or Integer' do
             expect { PointerPress.new(source, direction, 'wrong') }.to raise_error(TypeError)
           end
 
diff --git a/rb/spec/unit/selenium/webdriver/common/interactions/typing_interactions_spec.rb b/rb/spec/unit/selenium/webdriver/common/interactions/typing_interactions_spec.rb
@@ -28,12 +28,21 @@ module Interactions
         let(:typing) { TypingInteraction.new(source, type, key) }
         let(:key) { 'a' }
 
-        it 'stores type as KeyInput::SUBTYPES' do
-          expect(typing.type).to eq KeyInput::SUBTYPES[type]
+        describe '#initialize' do
+          it 'raises a TypeError if the passed source is not a KeyInput' do
+            mouse = Interactions.pointer(:mouse)
+            expect { TypingInteraction.new(mouse, type, key) }.to raise_error(TypeError)
+          end
+
+          it 'raises a TypeError if the passed type is not a key in KeyInput::SUBTYPES' do
+            expect { TypingInteraction.new(source, :none, key) }.to raise_error(TypeError)
+          end
         end
 
-        it 'raises a TypeError if the passed type is not a key in KeyInput::SUBTYPES' do
-          expect { TypingInteraction.new(source, :none, key) }.to raise_error(TypeError)
+        describe '#type' do
+          it 'stores type as KeyInput::SUBTYPES' do
+            expect(typing.type).to eq KeyInput::SUBTYPES[type]
+          end
         end
 
         describe '#encode' do
