selenium-webdriver 4.1.0 → 4.9.0

data/lib/selenium/webdriver/common/driver_extensions/has_pinned_scripts.rb

@@ -21,7 +21,6 @@ module Selenium
   module WebDriver
     module DriverExtensions
       module HasPinnedScripts
-
         #
         # Returns the list of all pinned scripts.
         #
@@ -62,7 +61,7 @@ module Selenium
         #
         # Unpins script making it undefined for the subsequent calls.
         #
-        # @param [DevTools::PinnedScript]
+        # @param [DevTools::PinnedScript] script
         #
 
         def unpin_script(script)
@@ -70,7 +69,6 @@ module Selenium
           devtools.page.remove_script_to_evaluate_on_new_document(identifier: script.devtools_identifier)
           pinned_scripts.delete(script)
         end
-
       end # HasPinnedScripts
     end # DriverExtensions
   end # WebDriver

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

@@ -0,0 +1,43 @@
+# 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
+    class DriverFinder
+      def self.path(options, klass)
+        path = klass.driver_path
+        path = path.call if path.is_a?(Proc)
+        path ||= Platform.find_binary(klass::EXECUTABLE)
+
+        path ||= begin
+          SeleniumManager.driver_path(options)
+        rescue StandardError => e
+          WebDriver.logger.warn("Unable obtain driver using Selenium Manager\n #{e.message}")
+          nil
+        end
+        msg = "Unable to locate the #{klass::EXECUTABLE} executable; for more information on how to install drivers, " \
+              'see https://www.selenium.dev/documentation/webdriver/getting_started/install_drivers/'
+        raise Error::WebDriverError, msg unless path
+
+        Platform.assert_executable path
+        path
+      end
+    end
+  end
+end

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

@@ -43,10 +43,10 @@ module Selenium
       def ==(other)
         other.is_a?(self.class) && ref == other.ref
       end
-      alias_method :eql?, :==
+      alias eql? ==
 
       def hash
-        @id.hash ^ @bridge.hash
+        [@id, @bridge].hash
       end
 
       #
@@ -101,7 +101,7 @@ module Selenium
       # if it exists. If it does not, then the value of the attribute with the given name is returned.
       # If neither exists, null is returned.
       #
-      # The "style" attribute is converted as best can be to a text representation with a trailing semi-colon.
+      # The "style" attribute is converted as best can be to a text representation with a trailing semicolon.
       #
       # The following are deemed to be "boolean" attributes, and will return either "true" or "false":
       #
@@ -207,7 +207,7 @@ module Selenium
       def send_keys(*args)
         bridge.send_keys_to_element @id, Keys.encode(args)
       end
-      alias_method :send_key, :send_keys
+      alias send_key send_keys
 
       #
       # If this element is a text entry element, this will clear the value. Has no effect on other
@@ -275,7 +275,7 @@ module Selenium
       def css_value(prop)
         bridge.element_value_of_css_property @id, prop
       end
-      alias_method :style, :css_value
+      alias style css_value
 
       #
       # Get the location of this element.
@@ -333,18 +333,18 @@ module Selenium
       #   element.first(id: 'foo')
       #
 
-      alias_method :first, :find_element
+      alias first find_element
 
       #
       #   element.all(class: 'bar')
       #
 
-      alias_method :all, :find_elements
+      alias all find_elements
 
       #
       #   element['class'] or element[:class] #=> "someclass"
       #
-      alias_method :[], :attribute
+      alias [] attribute
 
       #
       # @api private

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

@@ -20,7 +20,6 @@
 module Selenium
   module WebDriver
     module Error
-
       #
       # Returns exception from its string representation.
       # @param [String, nil] error
@@ -29,7 +28,7 @@ module Selenium
       def self.for_error(error)
         return if error.nil?
 
-        klass_name = error.split(' ').map(&:capitalize).join.sub(/Error$/, '')
+        klass_name = error.split.map(&:capitalize).join.sub(/Error$/, '')
         const_get("#{klass_name}Error", false)
       rescue NameError
         WebDriverError
@@ -213,7 +212,6 @@ module Selenium
       #
 
       class UnsupportedOperationError < WebDriverError; end
-
     end # Error
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/common/html5/shared_web_storage.rb

@@ -26,8 +26,8 @@ module Selenium
         def key?(key)
           keys.include? key
         end
-        alias_method :member?, :key?
-        alias_method :has_key?, :key?
+        alias member? key?
+        alias has_key? key?
 
         def fetch(key)
           return self[key] if key? key

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

@@ -22,8 +22,15 @@ require 'securerandom'
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Superclass for the input device sources
+      # Manages Array of Interaction instances for the device
+      #
+      # @api private
+      #
+
       class InputDevice
-        attr_reader :name, :actions
+        attr_reader :name, :actions, :type
 
         def initialize(name = nil)
           @name = name || SecureRandom.uuid
@@ -44,9 +51,8 @@ module Selenium
           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?
+        def encode
+          {type: type, id: name, actions: @actions.map(&:encode)} unless @actions.empty?
         end
       end # InputDevice
     end # Interactions

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

@@ -20,37 +20,24 @@
 module Selenium
   module WebDriver
     module Interactions
-      class Interaction
-        PAUSE = :pause
+      #
+      # Superclass for classes defining actions
+      # Do not initialize directly, only use subclass
+      #
+      # @api private
+      #
 
-        attr_reader :source
+      class Interaction
+        attr_reader :type
 
         def initialize(source)
-          unless Interactions::SOURCE_TYPES.include? source.type
-            raise TypeError,
-                  "#{source.type} is not a valid input type"
-          end
-
-          @source = source
+          assert_source(source)
         end
-      end
 
-      class Pause < Interaction
-        def initialize(source, duration = nil)
-          super(source)
-          @duration = duration
+        def assert_source(_source)
+          raise NotImplementedError, 'subclass responsibility'
         end
-
-        def type
-          PAUSE
-        end
-
-        def encode
-          output = {type: type}
-          output[:duration] = (@duration * 1000).to_i if @duration
-          output
-        end
-      end # Interaction
+      end
     end # Interactions
   end # WebDriver
 end # Selenium

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

@@ -23,20 +23,40 @@ module Selenium
       KEY = :key
       POINTER = :pointer
       NONE = :none
-      SOURCE_TYPES = [KEY, POINTER, NONE].freeze
+      WHEEL = :wheel
+
+      #
+      # Class methods for initializing known Input devices
+      #
 
       class << self
-        def key(name)
+        def key(name = nil)
           KeyInput.new(name)
         end
 
-        def pointer(kind, **kwargs)
-          PointerInput.new(kind, **kwargs)
+        def pointer(kind = :mouse, name: nil)
+          PointerInput.new(kind, name: name)
+        end
+
+        def mouse(name: nil)
+          pointer(name: name)
+        end
+
+        def pen(name: nil)
+          pointer(:pen, name: name)
+        end
+
+        def touch(name: nil)
+          pointer(:touch, name: name)
         end
 
         def none(name = nil)
           NoneInput.new(name)
         end
+
+        def wheel(name = nil)
+          WheelInput.new(name)
+        end
       end
     end # Interactions
   end # WebDriver

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

@@ -134,12 +134,16 @@ module Selenium
       #
 
       def key_action(*args, action: nil, device: nil)
-        key_input = get_device(device) || key_inputs.first
+        key_input = key_input(device)
         click(args.shift) if args.first.is_a? Element
         key_input.send(action, args.last)
         tick(key_input)
         self
       end
+
+      def key_input(name = nil)
+        device(name: name, type: Interactions::KEY) || add_key_input('keyboard')
+      end
     end # KeyActions
   end # WebDriver
 end # Selenium

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

@@ -20,17 +20,18 @@
 module Selenium
   module WebDriver
     module Interactions
+      #
+      # Creates actions specific to Key Input devices
+      #
+      # @api private
+      #
+
       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)}
+        def initialize(name = nil)
+          super
+          @type = Interactions::KEY
         end
 
         def create_key_down(key)
@@ -41,25 +42,8 @@ module Selenium
           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
+        # Backward compatibility in case anyone called this directly
+        class TypingInteraction < Interactions::TypingInteraction; end
       end # KeyInput
     end # Interactions
   end # WebDriver

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

@@ -20,15 +20,17 @@
 module Selenium
   module WebDriver
     module Interactions
-      class NoneInput < InputDevice
-        def type
-          Interactions::NONE
-        end
+      #
+      # Creates actions specific to null input source
+      # This is primarily used for adding pauses
+      #
+      # @api private
+      #
 
-        def encode
-          return nil if no_actions?
-
-          {type: type, id: name, actions: @actions.map(&:encode)}
+      class NoneInput < InputDevice
+        def initialize(name = nil)
+          super
+          @type = Interactions::NONE
         end
       end # NoneInput
     end # Interactions

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

@@ -0,0 +1,49 @@
+# 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
+      #
+      # Action to create a waiting period between actions
+      # Also used for synchronizing actions across devices
+      #
+      # @api private
+      #
+
+      class Pause < Interaction
+        def initialize(source, duration = nil)
+          super(source)
+          @duration = duration
+          @type = :pause
+        end
+
+        def assert_source(source)
+          raise TypeError, "#{source.type} is not a valid input type" unless source.is_a? InputDevice
+        end
+
+        def encode
+          output = {type: type}
+          output[:duration] = (@duration * 1000).to_i if @duration
+          output
+        end
+      end # Pause
+    end # Interactions
+  end # WebDriver
+end # Selenium