selenium-webdriver 2.53.3 → 3.142.7

data/lib/selenium/webdriver/common/interactions/input_device.rb

@@ -0,0 +1,54 @@
+# 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.
+
+require 'securerandom'
+
+module Selenium
+  module WebDriver
+    module Interactions
+      class InputDevice
+        attr_reader :name, :actions
+
+        def initialize(name = nil)
+          @name = name || SecureRandom.uuid
+          @actions = []
+        end
+
+        def add_action(action)
+          raise TypeError, "#{action.inspect} is not a valid action" unless action.class < Interaction
+
+          @actions << action
+        end
+
+        def clear_actions
+          @actions.clear
+        end
+
+        def create_pause(duration = 0)
+          add_action(Pause.new(self, duration))
+        end
+
+        def no_actions? # Determine if only pauses are present
+          actions = @actions.reject { |action| action.type == Interaction::PAUSE }
+          actions.empty?
+        end
+      end # InputDevice
+    end # Interactions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/interactions/interaction.rb

@@ -0,0 +1,53 @@
+# 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 Interaction
+        PAUSE = :pause
+
+        attr_reader :source
+
+        def initialize(source)
+          raise TypeError, "#{source.type} is not a valid input type" unless Interactions::SOURCE_TYPES.include? source.type
+
+          @source = source
+        end
+      end
+
+      class Pause < Interaction
+        def initialize(source, duration = nil)
+          super(source)
+          @duration = duration
+        end
+
+        def type
+          PAUSE
+        end
+
+        def encode
+          output = {type: type}
+          output[:duration] = (@duration * 1000).to_i if @duration
+          output
+        end
+      end # Interaction
+    end # Interactions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/{safari/browser.rb → common/interactions/interactions.rb}

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -19,22 +19,25 @@
 
 module Selenium
   module WebDriver
-    module Safari
+    module Interactions
+      KEY = :key
+      POINTER = :pointer
+      NONE = :none
+      SOURCE_TYPES = [KEY, POINTER, NONE].freeze
 
-      class Browser
-        def start(*args)
-          Platform.exit_hook { stop } # make sure we don't leave the browser running
-
-          @process = ChildProcess.new(Safari.path, *args)
-          @process.io.inherit! if $DEBUG
-          @process.start
+      class << self
+        def key(name)
+          KeyInput.new(name)
         end
 
-        def stop
-          @process.stop if @process
+        def pointer(kind, **kwargs)
+          PointerInput.new(kind, **kwargs)
         end
 
-      end # Browser
-    end # Safari
+        def none(name = nil)
+          NoneInput.new(name)
+        end
+      end
+    end # Interactions
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/interactions/key_actions.rb

@@ -0,0 +1,145 @@
+# 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 KeyActions
+      #
+      # Performs a key press. Does not release the key - subsequent interactions may assume it's kept pressed.
+      # Note that the key is never released implicitly - either W3CActionBuilder#key_up(key) or W3CActionBuilder#release_actions
+      # must be called to release the key.
+      #
+      # @example Press a key
+      #
+      #    driver.action.key_down(:control).perform
+      #
+      # @example Press a key on an element
+      #
+      #    el = driver.find_element(id: "some_id")
+      #    driver.action.key_down(el, :shift).perform
+      #
+      # @overload key_down(key, device: nil)
+      #   @param [Symbol, String] key The key to press
+      #   @param [Symbol, String] device Optional name of the KeyInput device to press the key on
+      # @overload key_down(element, key, device: nil)
+      #   @param [Element] element An optional element to move to first
+      #   @param [Symbol, String] key The key to press
+      #   @param [Symbol, String] device Optional name of the KeyInput device to press the key on
+      # @return [W3CActionBuilder] A self reference
+      #
+
+      def key_down(*args, device: nil)
+        key_action(*args, action: :create_key_down, device: device)
+      end
+
+      #
+      # Performs a key release.
+      # Releasing a non-depressed key will yield undefined behaviour.
+      #
+      # @example Release a key
+      #
+      #   driver.action.key_up(:shift).perform
+      #
+      # @example Release a key from an element
+      #
+      #   el = driver.find_element(id: "some_id")
+      #   driver.action.key_up(el, :alt).perform
+      #
+      # @overload key_up(key, device: nil)
+      #   @param [Symbol, String] key The key to press
+      #   @param [Symbol, String] device Optional name of the KeyInput device to press the key on
+      # @overload key_up(element, key, device: nil)
+      #   @param [Element] element An optional element to move to first
+      #   @param [Symbol, String] key The key to release
+      #   @param [Symbol, String] device Optional name of the KeyInput device to release the key on
+      # @return [W3CActionBuilder] A self reference
+      #
+
+      def key_up(*args, device: nil)
+        key_action(*args, action: :create_key_up, device: device)
+      end
+
+      #
+      # Sends keys to the active element. This differs from calling
+      # Element#send_keys(keys) on the active element in two ways:
+      #
+      # * The modifier keys included in this call are not released.
+      # * There is no attempt to re-focus the element - so send_keys(:tab) for switching elements should work.
+      #
+      # @example Send the text "help" to an element
+      #
+      #   el = driver.find_element(id: "some_id")
+      #   driver.action.send_keys(el, "help").perform
+      #
+      # @example Send the text "help" to the currently focused element
+      #
+      #   driver.action.send_keys("help").perform
+      #
+      # @overload send_keys(keys, device: nil)
+      #   @param [Array, Symbol, String] keys The key(s) to press and release
+      #   @param [Symbol, String] device Optional name of the KeyInput device to press and release the keys on
+      # @overload send_keys(element, keys, device: nil)
+      #   @param [Element] element An optional element to move to first
+      #   @param [Array, Symbol, String] keys The key(s) to press and release
+      #   @param [Symbol, String] device Optional name of the KeyInput device to press and release the keys on
+      # @return [W3CActionBuilder] A self reference
+      #
+
+      def send_keys(*args, device: nil)
+        click(args.shift) if args.first.is_a? Element
+        args.map { |x| x.is_a?(String) ? x.chars : x }.flatten.each do |arg|
+          key_down(arg, device: device)
+          key_up(arg, device: device)
+        end
+        self
+      end
+
+      private
+
+      #
+      # @api private
+      #
+      # @overload key_down(key, action: nil, device: nil)
+      #   @param [Symbol, String] key The key to press
+      #   @param [Symbol] action The name of the key action to perform
+      #   @param [Symbol, String] device Optional name of the KeyInput device to press the key on
+      # @overload key_down(element, key, action: nil, device: nil)
+      #   @param [Element] element An optional element to move to first
+      #   @param [Symbol, String] key The key to press
+      #   @param [Symbol] action The name of the key action to perform
+      #   @param [Symbol, String] device Optional name of the KeyInput device to press the key on
+      #
+      # @param [Array] args
+      # @option args [Element] element An optional element to move to first
+      # @option args [Symbol, String] key The key to perform the action with
+      # @param [Symbol] action The name of the key action to perform
+      # @param [Symbol, String] device optional name of the KeyInput device to press the key on
+      # @return [W3CActionBuilder] A self reference
+      #
+
+      def key_action(*args, action: nil, device: nil)
+        key_input = get_device(device) || key_inputs.first
+        click(args.shift) if args.first.is_a? Element
+        key_input.send(action, args.last)
+        tick(key_input)
+        self
+      end
+    end # KeyActions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/interactions/key_input.rb

@@ -0,0 +1,66 @@
+# 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 KeyInput < InputDevice
+        SUBTYPES = {down: :keyDown, up: :keyUp, pause: :pause}.freeze
+
+        def type
+          Interactions::KEY
+        end
+
+        def encode
+          return nil if no_actions?
+
+          {type: type, id: name, actions: @actions.map(&:encode)}
+        end
+
+        def create_key_down(key)
+          add_action(TypingInteraction.new(self, :down, key))
+        end
+
+        def create_key_up(key)
+          add_action(TypingInteraction.new(self, :up, key))
+        end
+
+        class TypingInteraction < Interaction
+          attr_reader :type
+
+          def initialize(source, type, key)
+            super(source)
+            @type = assert_type(type)
+            @key = Keys.encode_key(key)
+          end
+
+          def assert_type(type)
+            raise TypeError, "#{type.inspect} is not a valid key subtype" unless KeyInput::SUBTYPES.key? type
+
+            KeyInput::SUBTYPES[type]
+          end
+
+          def encode
+            {type: @type, value: @key}
+          end
+        end # TypingInteraction
+      end # KeyInput
+    end # Interactions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/{android.rb → common/interactions/none_input.rb}

@@ -1,5 +1,5 @@
-# encoding: utf-8
-#
+# 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
@@ -19,10 +19,18 @@
 
 module Selenium
   module WebDriver
-    module Android
+    module Interactions
+      class NoneInput < InputDevice
+        def type
+          Interactions::NONE
+        end
 
-    end # Android
+        def encode
+          return nil if no_actions?
+
+          {type: type, id: name, actions: @actions.map(&:encode)}
+        end
+      end # NoneInput
+    end # Interactions
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/android/bridge'