selenium-webdriver 3.0.8 → 3.1.0

data/lib/selenium/webdriver/common/keys.rb

@@ -88,7 +88,22 @@ module Selenium
         f11: "\ue03B",
         f12: "\ue03C",
         meta: "\ue03D",
-        command: "\ue03D" # alias
+        command: "\ue03D", # alias
+        left_meta: "\ue03D", # alias
+        right_shift: "\ue050",
+        right_control: "\ue051",
+        right_alt: "\ue052",
+        right_meta: "\ue053",
+        numpad_page_up: "\ue054",
+        numpad_page_down: "\ue055",
+        numpad_end: "\ue056",
+        numpad_home: "\ue057",
+        numpad_left: "\ue058",
+        numpad_up: "\ue059",
+        numpad_right: "\ue05A",
+        numpad_down: "\ue05B",
+        numpad_insert: "\ue05C",
+        numpad_delete: "\ue05D"
       }.freeze
 
       #
@@ -105,18 +120,24 @@ module Selenium
       #
 
       def self.encode(keys)
-        keys.map do |arg|
-          case arg
-          when Symbol
-            Keys[arg]
-          when Array
-            arg = arg.map { |e| e.is_a?(Symbol) ? Keys[e] : e }.join
-            arg << Keys[:null]
+        keys.map { |key| encode_key(key) }
+      end
+
+      #
+      # @api private
+      #
+
+      def self.encode_key(key)
+        case key
+        when Symbol
+          Keys[key]
+        when Array
+          key = key.map { |e| e.is_a?(Symbol) ? Keys[e] : e }.join
+          key << Keys[:null]
 
-            arg
-          else
-            arg.to_s
-          end
+          key
+        else
+          key.to_s
         end
       end
     end # Keys

data/lib/selenium/webdriver/common/w3c_action_builder.rb

@@ -0,0 +1,211 @@
+# encoding: utf-8
+#
+# 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
+    class W3CActionBuilder
+      include KeyActions # Actions specific to key inputs
+      include PointerActions # Actions specific to pointer inputs
+      attr_reader :devices
+
+      #
+      # Initialize a W3C Action Builder. Differs from previous by requiring a bridge and allowing asynchronous actions.
+      # The W3C implementation allows asynchronous actions per device. e.g. A key can be pressed at the same time that
+      # the mouse is moving. Keep in mind that pauses must be added for other devices in order to line up the actions
+      # correctly when using asynchronous.
+      #
+      # @param [Selenium::WebDriver::Remote::W3CBridge] bridge the bridge for the current driver instance
+      # @param [Selenium::WebDriver::Interactions::PointerInput] mouse PointerInput for the mouse.
+      # @param [Selenium::WebDriver::Interactions::KeyInput] keyboard KeyInput for the keyboard.
+      # @param [Boolean] async Whether to perform the actions asynchronously per device. Defaults to false for
+      #   backwards compatibility.
+      # @return [W3CActionBuilder] A self reference.
+      #
+
+      def initialize(bridge, mouse, keyboard, async = false)
+        # For backwards compatibility, automatically include mouse & keyboard
+        @bridge = bridge
+        @devices = [mouse, keyboard]
+        @async = async
+      end
+
+      #
+      # Adds a PointerInput device of the given kind
+      #
+      # @example Add a touch pointer input device
+      #
+      #    builder = device.action
+      #    builder.add_pointer_input('touch', :touch)
+      #
+      # @param [String] name name for the device
+      # @param [Symbol] kind kind of pointer device to create
+      # @return [Interactions::PointerInput] The pointer input added
+      #
+      #
+
+      def add_pointer_input(kind, name)
+        new_input = Interactions.pointer(kind, name: name)
+        add_input(new_input)
+        new_input
+      end
+
+      #
+      # Adds a KeyInput device
+      #
+      # @example Add a key input device
+      #
+      #    builder = device.action
+      #    builder.add_key_input('keyboard2')
+      #
+      # @param [String] name name for the device
+      # @return [Interactions::KeyInput] The key input added
+      #
+
+      def add_key_input(name)
+        new_input = Interactions.key(name)
+        add_input(new_input)
+        new_input
+      end
+
+      #
+      # Retrieves the input device for the given name
+      #
+      # @param [String] name name of the input device
+      # @return [Selenium::WebDriver::Interactions::InputDevice] input device with given name
+      #
+
+      def get_device(name)
+        @devices.find { |device| device.name == name.to_s }
+      end
+
+      #
+      # Retrieves the current PointerInput devices
+      #
+      # @return [Array] array of current PointerInput devices
+      #
+
+      def pointer_inputs
+        @devices.select { |device| device.type == Interactions::POINTER }
+      end
+
+      #
+      # Retrieves the current KeyInput device
+      #
+      # @return [Selenium::WebDriver::Interactions::InputDevice] current KeyInput device
+      #
+
+      def key_inputs
+        @devices.select { |device| device.type == Interactions::KEY }
+      end
+
+      #
+      # Creates a pause for the given device of the given duration. If no duration is given, the pause will only wait
+      # for all actions to complete in that tick.
+      #
+      # @example Send keys to an element
+      #
+      #   action_builder = driver.action
+      #   keyboard = action_builder.key_input
+      #   el = driver.find_element(id: "some_id")
+      #   driver.action.click(el).pause(keyboard).pause(keyboard).pause(keyboard).send_keys('keys').perform
+      #
+      # @param [InputDevice] device Input device to pause
+      # @param [Float] duration Duration to pause
+      # @return [W3CActionBuilder] A self reference.
+      #
+
+      def pause(device, duration = nil)
+        device.create_pause(duration)
+        self
+      end
+
+      #
+      # Creates multiple pauses for the given device of the given duration.
+      #
+      # @example Send keys to an element
+      #
+      #   action_builder = driver.action
+      #   keyboard = action_builder.key_input
+      #   el = driver.find_element(id: "some_id")
+      #   driver.action.click(el).pauses(keyboard, 3).send_keys('keys').perform
+      #
+      # @param [InputDevice] device Input device to pause
+      # @param [Integer] number of pauses to add for the device
+      # @param [Float] duration Duration to pause
+      # @return [W3CActionBuilder] A self reference.
+      #
+
+      def pauses(device, number, duration = nil)
+        number.times { device.create_pause(duration) }
+        self
+      end
+
+      #
+      # Executes the actions added to the builder.
+      #
+
+      def perform
+        @bridge.send_actions @devices.map(&:encode).compact
+        clear_all_actions
+        nil
+      end
+
+      #
+      # Clears all actions from the builder.
+      #
+
+      def clear_all_actions
+        @devices.each(&:clear_actions)
+      end
+
+      #
+      # Releases all action states from the browser.
+      #
+
+      def release_actions
+        @bridge.release_actions
+      end
+
+      private
+
+      #
+      # Adds pauses for all devices but the given devices
+      #
+      # @param [Array[InputDevice]] action_devices Array of Input Devices performing an action in this tick.
+      #
+
+      def tick(*action_devices)
+        return if @async
+        @devices.each { |device| device.create_pause unless action_devices.include? device }
+      end
+
+      #
+      # Adds an InputDevice
+      #
+
+      def add_input(device)
+        unless @async
+          max_device = @devices.max { |a, b| a.actions.length <=> b.actions.length }
+          pauses(device, max_device.actions.length)
+        end
+        @devices << device
+      end
+    end # W3CActionBuilder
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/edge/bridge.rb

@@ -47,10 +47,7 @@ module Selenium
         end
 
         def driver_extensions
-          [
-            DriverExtensions::TakesScreenshot,
-            DriverExtensions::HasInputDevices
-          ]
+          [DriverExtensions::TakesScreenshot]
         end
 
         def commands(command)

data/lib/selenium/webdriver/firefox/bridge.rb

@@ -48,8 +48,7 @@ module Selenium
 
         def driver_extensions
           [
-            DriverExtensions::TakesScreenshot,
-            DriverExtensions::HasInputDevices
+            DriverExtensions::TakesScreenshot
           ]
         end
 

data/lib/selenium/webdriver/firefox/w3c_bridge.rb

@@ -42,7 +42,6 @@ module Selenium
         def driver_extensions
           [
             DriverExtensions::TakesScreenshot,
-            DriverExtensions::HasInputDevices,
             DriverExtensions::HasWebStorage
           ]
         end

data/lib/selenium/webdriver/ie/bridge.rb

@@ -47,7 +47,7 @@ module Selenium
         end
 
         def driver_extensions
-          [DriverExtensions::TakesScreenshot, DriverExtensions::HasInputDevices]
+          [DriverExtensions::TakesScreenshot]
         end
 
         def quit

data/lib/selenium/webdriver/phantomjs/bridge.rb

@@ -45,10 +45,7 @@ module Selenium
         end
 
         def driver_extensions
-          [
-            DriverExtensions::TakesScreenshot,
-            DriverExtensions::HasInputDevices
-          ]
+          [DriverExtensions::TakesScreenshot]
         end
 
         def capabilities

data/lib/selenium/webdriver/remote/bridge.rb

@@ -80,7 +80,6 @@ module Selenium
 
         def driver_extensions
           [
-            DriverExtensions::HasInputDevices,
             DriverExtensions::UploadsFiles,
             DriverExtensions::TakesScreenshot,
             DriverExtensions::HasSessionId,
@@ -374,6 +373,31 @@ module Selenium
         # actions
         #
 
+        #
+        # @return [ActionBuilder]
+        # @api public
+        #
+
+        def action
+          ActionBuilder.new Mouse.new(self), Keyboard.new(self)
+        end
+
+        def mouse
+          warn <<-DEPRECATE.gsub(/\n +| {2,}/, ' ').freeze
+            [DEPRECATION] `Driver#mouse` is deprecated with w3c implementation. Instead use 
+            driver.action.<command>.perform
+          DEPRECATE
+          Mouse.new self
+        end
+
+        def keyboard
+          warn <<-DEPRECATE.gsub(/\n +| {2,}/, ' ').freeze
+            [DEPRECATION] `Driver#keyboard` is deprecated with w3c implementation. Instead use 
+            driver.action.<command>.perform
+          DEPRECATE
+          Keyboard.new self
+        end
+
         def click_element(element)
           execute :click_element, id: element
         end

data/lib/selenium/webdriver/remote/w3c_bridge.rb

@@ -79,12 +79,10 @@ module Selenium
 
         def driver_extensions
           [
-            DriverExtensions::HasInputDevices,
             DriverExtensions::UploadsFiles,
             DriverExtensions::TakesScreenshot,
             DriverExtensions::HasSessionId,
             DriverExtensions::Rotatable,
-            DriverExtensions::HasTouchScreen,
             DriverExtensions::HasRemoteStatus,
             DriverExtensions::HasWebStorage
           ]
@@ -381,43 +379,32 @@ module Selenium
         # actions
         #
 
-        def click_element(element)
-          execute :element_click, id: element
-        end
-
-        def click
-          execute :click, {}, {button: 0}
+        def action(async = false)
+          W3CActionBuilder.new self,
+                               Interactions.pointer(:mouse, name: 'mouse'),
+                               Interactions.key('keyboard'),
+                               async
         end
+        alias_method :actions, :action
 
-        def double_click
-          execute :double_click
+        def mouse
+          raise Error::UnsupportedOperationError, '#mouse is no longer supported, use #action instead'
         end
 
-        def context_click
-          execute :click, {}, {button: 2}
+        def keyboard
+          raise Error::UnsupportedOperationError, '#keyboard is no longer supported, use #action instead'
         end
 
-        def mouse_down
-          execute :mouse_down
+        def send_actions(data)
+          execute :actions, {}, {actions: data}
         end
 
-        def mouse_up
-          execute :mouse_up
+        def release_actions
+          execute :release_actions
         end
 
-        def mouse_move_to(element, x = nil, y = nil)
-          params = {element: element}
-
-          if x && y
-            params[:xoffset] = x
-            params[:yoffset] = y
-          end
-
-          execute :mouse_move_to, {}, params
-        end
-
-        def send_keys_to_active_element(keys)
-          send_keys_to_element(active_element, keys)
+        def click_element(element)
+          execute :element_click, id: element
         end
 
         # TODO: - Implement file verification

data/lib/selenium/webdriver/remote/w3c_commands.rb

@@ -109,6 +109,7 @@ module Selenium
             #
 
             actions: [:post, 'session/:session_id/actions'.freeze],
+            release_actions: [:delete, 'session/:session_id/actions'.freeze],
 
             #
             # Element Operations