selenium-webdriver 3.0.8 → 3.1.0

data/CHANGES

@@ -1,16 +1,22 @@
-3.0.8 (2016-02-08)
+3.1.0 (2017-02-14)
+===================
+
+Firefox:
+  * implement W3C actions endpoint
+
+3.0.8 (2017-02-08)
 ===================
 
 Firefox:
   * Fix signature of element returned from #active_element
 
-3.0.7 (2016-02-06)
+3.0.7 (2017-02-06)
 ===================
 
 Firefox:
   * Fix signature of element arrays returned from #find_elements (issue 3471)
 
-3.0.6 (2016-02-05)
+3.0.6 (2017-02-05)
 ===================
 
 Firefox:

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

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

data/lib/selenium/webdriver/common.rb

@@ -42,13 +42,15 @@ require 'selenium/webdriver/common/options'
 require 'selenium/webdriver/common/w3c_options'
 require 'selenium/webdriver/common/search_context'
 require 'selenium/webdriver/common/action_builder'
+require 'selenium/webdriver/common/interactions/key_actions'
+require 'selenium/webdriver/common/interactions/pointer_actions'
+require 'selenium/webdriver/common/w3c_action_builder'
 require 'selenium/webdriver/common/touch_action_builder'
 require 'selenium/webdriver/common/html5/shared_web_storage'
 require 'selenium/webdriver/common/html5/local_storage'
 require 'selenium/webdriver/common/html5/session_storage'
 require 'selenium/webdriver/common/driver_extensions/takes_screenshot'
 require 'selenium/webdriver/common/driver_extensions/rotatable'
-require 'selenium/webdriver/common/driver_extensions/has_input_devices'
 require 'selenium/webdriver/common/driver_extensions/has_web_storage'
 require 'selenium/webdriver/common/driver_extensions/has_location'
 require 'selenium/webdriver/common/driver_extensions/has_session_id'
@@ -56,6 +58,12 @@ require 'selenium/webdriver/common/driver_extensions/has_touch_screen'
 require 'selenium/webdriver/common/driver_extensions/has_remote_status'
 require 'selenium/webdriver/common/driver_extensions/has_network_connection'
 require 'selenium/webdriver/common/driver_extensions/uploads_files'
+require 'selenium/webdriver/common/interactions/interactions'
+require 'selenium/webdriver/common/interactions/input_device'
+require 'selenium/webdriver/common/interactions/interaction'
+require 'selenium/webdriver/common/interactions/none_input'
+require 'selenium/webdriver/common/interactions/key_input'
+require 'selenium/webdriver/common/interactions/pointer_input'
 require 'selenium/webdriver/common/keys'
 require 'selenium/webdriver/common/bridge_helper'
 require 'selenium/webdriver/common/profile_helper'

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

@@ -23,9 +23,7 @@ module Selenium
     # The ActionBuilder provides the user a way to set up and perform
     # complex user interactions.
     #
-    # This class should not be instantiated directly, but is created by
-    # Selenium::WebDriver::DriverExtensions::HasInputDevices#action, which
-    # is available on Driver instances that support the user interaction API.
+    # This class should not be instantiated directly, but is created by Driver#action
     #
     # @example
     #

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

@@ -124,6 +124,23 @@ module Selenium
         bridge.options
       end
 
+      #
+      # @return [ActionBuilder, W3CActionBuilder]
+      # @see ActionBuilder, W3CActionBuilder
+      #
+
+      def action
+        bridge.action
+      end
+
+      def mouse
+        bridge.mouse
+      end
+
+      def keyboard
+        bridge.keyboard
+      end
+
       #
       # Opens the specified URL in the browser.
       #

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

@@ -0,0 +1,53 @@
+# 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.
+
+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 = nil)
+          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,52 @@
+# 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
+    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 if @duration
+          output
+        end
+      end # Interaction
+    end # Interactions
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,43 @@
+# 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
+    module Interactions
+      KEY = :key
+      POINTER = :pointer
+      NONE = :none
+      SOURCE_TYPES = [KEY, POINTER, NONE].freeze
+
+      class << self
+        def key(name)
+          KeyInput.new(name)
+        end
+
+        def pointer(kind, **kwargs)
+          PointerInput.new(kind, **kwargs)
+        end
+
+        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,112 @@
+# 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
+    module KeyActions
+      #
+      # Performs a key press. Does not release the key - subsequent interactions may assume it's kept pressed.
+      # Note that the modifier key is never released implicitly - either #key_up(key) or #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
+      #
+      # @param [Selenium::WebDriver::Element] element An optional element
+      # @param [:shift, :alt, :control, :command, :meta, 'a'] 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 modifier key release.
+      # Releasing a non-depressed modifier 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
+      #
+      # @param [Selenium::WebDriver::Element] element An optional element
+      # @param [:shift, :alt, :control, :command, :meta, 'a'] key The modifier 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
+      #
+      # @param [Selenium::WebDriver::Element] element An optional element
+      # @param [String] keys The keys to be sent.
+      # @param [Symbol || String] device optional name of the KeyInput device to send keys with
+      # @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
+
+      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,64 @@
+# 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
+    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/common/{driver_extensions/has_input_devices.rb → interactions/none_input.rb}

@@ -19,37 +19,17 @@
 
 module Selenium
   module WebDriver
-    #
-    # @api private
-    #
-
-    module DriverExtensions
-      module HasInputDevices
-        #
-        # @return [ActionBuilder]
-        # @api public
-        #
-
-        def action
-          ActionBuilder.new mouse, keyboard
-        end
-
-        #
-        # @api private
-        #
-
-        def mouse
-          Mouse.new @bridge
+    module Interactions
+      class NoneInput < InputDevice
+        def type
+          Interactions::NONE
         end
 
-        #
-        # @api private
-        #
-
-        def keyboard
-          Keyboard.new @bridge
+        def encode
+          return nil if no_actions?
+          {type: type, id: name, actions: @actions.map(&:encode)}
         end
-      end # HasInputDevices
-    end # DriverExtensions
+      end # NoneInput
+    end # Interactions
   end # WebDriver
 end # Selenium