selenium-webdriver 2.45.0 → 3.142.7

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

@@ -1,87 +1,119 @@
-# 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
+# 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 Keys
-
       #
       # @see Element#send_keys
-      # @see http://www.google.com.au/search?&q=unicode+pua&btnG=Search
+      # @see http://www.google.com.au/search?&q=unicode+pua&btnK=Search
       #
 
       KEYS = {
-      # \x works on both 1.8.6/1.9
-        :null         => "\xEE\x80\x80",
-        :cancel       => "\xEE\x80\x81",
-        :help         => "\xEE\x80\x82",
-        :backspace    => "\xEE\x80\x83",
-        :tab          => "\xEE\x80\x84",
-        :clear        => "\xEE\x80\x85",
-        :return       => "\xEE\x80\x86",
-        :enter        => "\xEE\x80\x87",
-        :shift        => "\xEE\x80\x88",
-        :left_shift   => "\xEE\x80\x88",
-        :control      => "\xEE\x80\x89",
-        :left_control => "\xEE\x80\x89",
-        :alt          => "\xEE\x80\x8A",
-        :left_alt     => "\xEE\x80\x8A",
-        :pause        => "\xEE\x80\x8B",
-        :escape       => "\xEE\x80\x8C",
-        :space        => "\xEE\x80\x8D",
-        :page_up      => "\xEE\x80\x8E",
-        :page_down    => "\xEE\x80\x8F",
-        :end          => "\xEE\x80\x90",
-        :home         => "\xEE\x80\x91",
-        :left         => "\xEE\x80\x92",
-        :arrow_left   => "\xEE\x80\x92",
-        :up           => "\xEE\x80\x93",
-        :arrow_up     => "\xEE\x80\x93",
-        :right        => "\xEE\x80\x94",
-        :arrow_right  => "\xEE\x80\x94",
-        :down         => "\xEE\x80\x95",
-        :arrow_down   => "\xEE\x80\x95",
-        :insert       => "\xEE\x80\x96",
-        :delete       => "\xEE\x80\x97",
-        :semicolon    => "\xEE\x80\x98",
-        :equals       => "\xEE\x80\x99",
-        :numpad0      => "\xEE\x80\x9A",
-        :numpad1      => "\xEE\x80\x9B",
-        :numpad2      => "\xEE\x80\x9C",
-        :numpad3      => "\xEE\x80\x9D",
-        :numpad4      => "\xEE\x80\x9E",
-        :numpad5      => "\xEE\x80\x9F",
-        :numpad6      => "\xEE\x80\xA0",
-        :numpad7      => "\xEE\x80\xA1",
-        :numpad8      => "\xEE\x80\xA2",
-        :numpad9      => "\xEE\x80\xA3",
-        :multiply     => "\xEE\x80\xA4",
-        :add          => "\xEE\x80\xA5",
-        :separator    => "\xEE\x80\xA6",
-        :subtract     => "\xEE\x80\xA7",
-        :decimal      => "\xEE\x80\xA8",
-        :divide       => "\xEE\x80\xA9",
-        :f1           => "\xEE\x80\xB1",
-        :f2           => "\xEE\x80\xB2",
-        :f3           => "\xEE\x80\xB3",
-        :f4           => "\xEE\x80\xB4",
-        :f5           => "\xEE\x80\xB5",
-        :f6           => "\xEE\x80\xB6",
-        :f7           => "\xEE\x80\xB7",
-        :f8           => "\xEE\x80\xB8",
-        :f9           => "\xEE\x80\xB9",
-        :f10          => "\xEE\x80\xBA",
-        :f11          => "\xEE\x80\xBB",
-        :f12          => "\xEE\x80\xBC",
-        :meta         => "\xEE\x80\xBD",
-        :command      => "\xEE\x80\xBD" # alias
-      }
+        null: "\ue000",
+        cancel: "\ue001",
+        help: "\ue002",
+        backspace: "\ue003",
+        tab: "\ue004",
+        clear: "\ue005",
+        return: "\ue006",
+        enter: "\ue007",
+        shift: "\ue008",
+        left_shift: "\ue008",
+        control: "\ue009",
+        left_control: "\ue009",
+        alt: "\ue00A",
+        left_alt: "\ue00A",
+        pause: "\ue00B",
+        escape: "\ue00C",
+        space: "\ue00D",
+        page_up: "\ue00E",
+        page_down: "\ue00F",
+        end: "\ue010",
+        home: "\ue011",
+        left: "\ue012",
+        arrow_left: "\ue012",
+        up: "\ue013",
+        arrow_up: "\ue013",
+        right: "\ue014",
+        arrow_right: "\ue014",
+        down: "\ue015",
+        arrow_down: "\ue015",
+        insert: "\ue016",
+        delete: "\ue017",
+        semicolon: "\ue018",
+        equals: "\ue019",
+        numpad0: "\ue01A",
+        numpad1: "\ue01B",
+        numpad2: "\ue01C",
+        numpad3: "\ue01D",
+        numpad4: "\ue01E",
+        numpad5: "\ue01F",
+        numpad6: "\ue020",
+        numpad7: "\ue021",
+        numpad8: "\ue022",
+        numpad9: "\ue023",
+        multiply: "\ue024",
+        add: "\ue025",
+        separator: "\ue026",
+        subtract: "\ue027",
+        decimal: "\ue028",
+        divide: "\ue029",
+        f1: "\ue031",
+        f2: "\ue032",
+        f3: "\ue033",
+        f4: "\ue034",
+        f5: "\ue035",
+        f6: "\ue036",
+        f7: "\ue037",
+        f8: "\ue038",
+        f9: "\ue039",
+        f10: "\ue03A",
+        f11: "\ue03B",
+        f12: "\ue03C",
+        meta: "\ue03D",
+        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
 
       #
       # @api private
       #
 
       def self.[](key)
-        KEYS[key] or raise Error::UnsupportedOperationError, "no such key #{key.inspect}"
+        return KEYS[key] if KEYS[key]
+
+        raise Error::UnsupportedOperationError, "no such key #{key.inspect}"
       end
 
       #
@@ -89,21 +121,26 @@ module Selenium
       #
 
       def self.encode(keys)
-        keys.map do |arg|
-          case arg
-          when Symbol
-            Keys[arg]
-          when Array
-            arg = arg.map { |e| e.kind_of?(Symbol) ? Keys[e] : e }.join
-            arg << Keys[:null]
+        keys.map { |key| encode_key(key) }
+      end
+
+      #
+      # @api private
+      #
 
-            arg
-          else
-            arg.to_s
-          end
+      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]
+
+          key
+        else
+          key.to_s
         end
       end
-
     end # Keys
   end # WebDriver
 end # Selenium

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

@@ -1,19 +1,38 @@
+# 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 LogEntry
       attr_reader :level, :timestamp, :message
 
       def initialize(level, timestamp, message)
-        @level      = level
+        @level = level
         @timestamp = timestamp
-        @message    = message
+        @message = message
       end
 
-      def as_json(opts = nil)
+      def as_json(*)
         {
-          'level'     => level,
+          'level' => level,
           'timestamp' => timestamp,
-          'message'   => message
+          'message' => message
         }
       end
 
@@ -24,6 +43,6 @@ module Selenium
       def time
         Time.at timestamp / 1000
       end
-    end
-  end
-end
+    end # LogEntry
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,115 @@
+# 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 'forwardable'
+require 'logger'
+
+module Selenium
+  module WebDriver
+    #
+    # @example Enable full logging
+    #   Selenium::WebDriver.logger.level = :debug
+    #
+    # @example Log to file
+    #   Selenium::WebDriver.logger.output = 'selenium.log'
+    #
+    # @example Use logger manually
+    #   Selenium::WebDriver.logger.info('This is info message')
+    #   Selenium::WebDriver.logger.warn('This is warning message')
+    #
+    class Logger
+      extend Forwardable
+
+      def_delegators :@logger,
+                     :close,
+                     :debug, :debug?,
+                     :info, :info?,
+                     :warn, :warn?,
+                     :error, :error?,
+                     :fatal, :fatal?,
+                     :level, :level=
+
+      def initialize
+        @logger = create_logger($stdout)
+      end
+
+      #
+      # Changes logger output to a new IO.
+      #
+      # @param [String] io
+      #
+      def output=(io)
+        @logger.reopen(io)
+      end
+
+      #
+      # Returns IO object used by logger internally.
+      #
+      # Normally, we would have never needed it, but we want to
+      # use it as IO object for all child processes to ensure their
+      # output is redirected there.
+      #
+      # It is only used in debug level, in other cases output is suppressed.
+      #
+      # @api private
+      #
+      def io
+        @logger.instance_variable_get(:@logdev).dev
+      end
+
+      #
+      # Marks code as deprecated with/without replacement.
+      #
+      # @param [String] old
+      # @param [String, nil] new
+      #
+      def deprecate(old, new = nil)
+        message = +"[DEPRECATION] #{old} is deprecated"
+        message << if new
+                     ". Use #{new} instead."
+                   else
+                     ' and will be removed in the next releases.'
+                   end
+
+        warn message
+      end
+
+      private
+
+      def create_logger(output)
+        logger = ::Logger.new(output)
+        logger.progname = 'Selenium'
+        logger.level = default_level
+        logger.formatter = proc do |severity, time, progname, msg|
+          "#{time.strftime('%F %T')} #{severity} #{progname} #{msg}\n"
+        end
+
+        logger
+      end
+
+      def default_level
+        if $DEBUG || ENV.key?('DEBUG')
+          :debug
+        else
+          :warn
+        end
+      end
+    end # Logger
+  end # WebDriver
+end # Selenium

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

@@ -1,7 +1,25 @@
+# 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 Logs
-
       #
       # @api private
       #
@@ -11,13 +29,12 @@ module Selenium
       end
 
       def get(type)
-        @bridge.getLog type
+        @bridge.log type
       end
 
       def available_types
-        @bridge.getAvailableLogTypes
+        @bridge.available_log_types
       end
-
-    end
-  end
-end
+    end # Logs
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,177 @@
+# 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 Manager
+      #
+      # @api private
+      #
+
+      def initialize(bridge)
+        @bridge = bridge
+      end
+
+      #
+      # Add a cookie to the browser
+      #
+      # @param [Hash] opts the options to create a cookie with.
+      # @option opts [String] :name A name
+      # @option opts [String] :value A value
+      # @option opts [String] :path ('/') A path
+      # @option opts [String] :secure (false) A boolean
+      # @option opts [Time,DateTime,Numeric,nil] :expires (nil) Expiry date, either as a Time, DateTime, or seconds since epoch.
+      #
+      # @raise [ArgumentError] if :name or :value is not specified
+      #
+
+      def add_cookie(opts = {})
+        raise ArgumentError, 'name is required' unless opts[:name]
+        raise ArgumentError, 'value is required' unless opts[:value]
+
+        opts[:path] ||= '/'
+        opts[:secure] ||= false
+
+        obj = opts.delete(:expires)
+        opts[:expiry] = seconds_from(obj).to_i if obj
+
+        @bridge.add_cookie opts
+      end
+
+      #
+      # Get the cookie with the given name
+      #
+      # @param [String] name the name of the cookie
+      # @return [Hash, nil] the cookie, or nil if it wasn't found.
+      #
+
+      def cookie_named(name)
+        all_cookies.find { |c| c[:name] == name }
+      end
+
+      #
+      # Delete the cookie with the given name
+      #
+      # @param [String] name the name of the cookie to delete
+      #
+
+      def delete_cookie(name)
+        @bridge.delete_cookie name
+      end
+
+      #
+      # Delete all cookies
+      #
+
+      def delete_all_cookies
+        @bridge.delete_all_cookies
+      end
+
+      #
+      # Get all cookies
+      #
+      # @return [Array<Hash>] list of cookies
+      #
+
+      def all_cookies
+        @bridge.cookies.map { |cookie| convert_cookie(cookie) }
+      end
+
+      def timeouts
+        @timeouts ||= Timeouts.new(@bridge)
+      end
+
+      #
+      # @api beta This API may be changed or removed in a future release.
+      #
+
+      def logs
+        @logs ||= Logs.new(@bridge)
+      end
+
+      #
+      # Create a new top-level browsing context
+      # https://w3c.github.io/webdriver/#new-window
+      # @param type [Symbol] Supports two values: :tab and :window.
+      #  Use :tab if you'd like the new window to share an OS-level window
+      #  with the current browsing context.
+      #  Use :window otherwise
+      # @return [String] The value of the window handle
+      #
+      def new_window(type = :tab)
+        case type
+        when :tab, :window
+          result = @bridge.new_window(type)
+          unless result.key?('handle')
+            raise UnknownError, "the driver did not return a handle. " \
+                                "The returned result: #{result.inspect}"
+          end
+          result['handle']
+        else
+          raise ArgumentError, "invalid argument for type. Got: '#{type.inspect}'. " \
+                               "Try :tab or :window"
+        end
+      end
+
+      #
+      # @api beta This API may be changed or removed in a future release.
+      #
+
+      def window
+        @window ||= Window.new(@bridge)
+      end
+
+      private
+
+      SECONDS_PER_DAY = 86_400.0
+
+      def datetime_at(int)
+        DateTime.civil(1970) + (int / SECONDS_PER_DAY)
+      end
+
+      def seconds_from(obj)
+        case obj
+        when Time
+          obj.to_f
+        when DateTime
+          (obj - DateTime.civil(1970)) * SECONDS_PER_DAY
+        when Numeric
+          obj
+        else
+          raise ArgumentError, "invalid value for expiration date: #{obj.inspect}"
+        end
+      end
+
+      def strip_port(str)
+        str.split(':', 2).first
+      end
+
+      def convert_cookie(cookie)
+        {
+          name: cookie['name'],
+          value: cookie['value'],
+          path: cookie['path'],
+          domain: cookie['domain'] && strip_port(cookie['domain']),
+          expires: cookie['expiry'] && datetime_at(cookie['expiry']),
+          secure: cookie['secure']
+        }
+      end
+    end # Options
+  end # WebDriver
+end # Selenium