selenium-webdriver 3.0.0.beta4.0 → 4.0.0.alpha5

data/lib/selenium/webdriver/common/keys.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
@@ -22,7 +22,7 @@ module Selenium
     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 = {
@@ -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
 
       #
@@ -97,6 +112,7 @@ module Selenium
 
       def self.[](key)
         return KEYS[key] if KEYS[key]
+
         raise Error::UnsupportedOperationError, "no such key #{key.inspect}"
       end
 
@@ -105,18 +121,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/log_entry.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
@@ -30,9 +30,9 @@ module Selenium
 
       def as_json(*)
         {
-          'level'     => level,
+          'level' => level,
           'timestamp' => timestamp,
-          'message'   => message
+          'message' => message
         }
       end
 

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

@@ -0,0 +1,147 @@
+# 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=
+
+      #
+      # @param [String] progname Allow child projects to use Selenium's Logger pattern
+      #
+      def initialize(progname = 'Selenium')
+        @logger = create_logger(progname)
+        @ignored = []
+      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
+
+      #
+      # Will not log the provided ID.
+      #
+      # @param [Array, Symbol] id
+      #
+      def ignore(id)
+        Array(id).each { |ignore| @ignored << ignore }
+      end
+
+      #
+      # Overrides default #warn to skip ignored messages by provided id
+      #
+      # @param [String] message
+      # @param [Symbol, Array<Sybmol>] id
+      # @yield see #deprecate
+      #
+      def warn(message, id: [])
+        id = Array(id)
+        return if (@ignored & id).any?
+
+        msg = id.empty? ? message : "[#{id.map(&:inspect).join(', ')}] #{message} "
+        msg += " #{yield}" if block_given?
+
+        @logger.warn { msg }
+      end
+
+      #
+      # Marks code as deprecated with/without replacement.
+      #
+      # @param [String] old
+      # @param [String, nil] new
+      # @param [Symbol, Array<Sybmol>] id
+      # @yield appends additional message to end of provided template
+      #
+      def deprecate(old, new = nil, id: [], &block)
+        id = Array(id)
+        return if @ignored.include?(:deprecations) || (@ignored & id).any?
+
+        ids = id.empty? ? '' : "[#{id.map(&:inspect).join(', ')}] "
+
+        message = +"[DEPRECATION] #{ids}#{old} is deprecated"
+        message << if new
+                     ". Use #{new} instead."
+                   else
+                     ' and will be removed in a future release.'
+                   end
+        warn message, &block
+      end
+
+      private
+
+      def create_logger(name)
+        logger = ::Logger.new($stdout)
+        logger.progname = name
+        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
+        $DEBUG || ENV.key?('DEBUG') ? :debug : :warn
+      end
+    end # Logger
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/logs.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

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)
+        convert_cookie(@bridge.cookie(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

data/lib/selenium/webdriver/common/navigation.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

data/lib/selenium/webdriver/common/options.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
@@ -20,131 +20,73 @@
 module Selenium
   module WebDriver
     class Options
-      #
-      # @api private
-      #
-
-      def initialize(bridge)
-        @bridge = bridge
+      attr_accessor :options
+
+      def initialize(options: nil, **opts)
+        @options = if options
+                     WebDriver.logger.deprecate(":options as keyword for initializing #{self.class}",
+                                                "custom values directly in #new constructor",
+                                                id: :options_options)
+                     opts.merge(options)
+                   else
+                     opts
+                   end
       end
 
       #
-      # Add a cookie to the browser
+      # Add a new option not yet handled by bindings.
       #
-      # @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.
+      # @example Leave Chrome open when chromedriver is killed
+      #   options = Selenium::WebDriver::Chrome::Options.new
+      #   options.add_option(:detach, true)
       #
-      # @raise [ArgumentError] if :name or :value is not specified
+      # @param [String, Symbol] name Name of the option
+      # @param [Boolean, String, Integer] value Value of the option
       #
 
-      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
+      def add_option(name, value)
+        @options[name] = value
       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
+      # @api private
       #
 
-      def delete_all_cookies
-        @bridge.delete_all_cookies
-      end
+      def as_json(*)
+        options = @options.dup
 
-      #
-      # Get all cookies
-      #
-      # @return [Array<Hash>] list of cookies
-      #
-
-      def all_cookies
-        @bridge.cookies.map do |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']
-          }
+        opts = self.class::CAPABILITIES.each_with_object({}) do |(capability_alias, capability_name), hash|
+          capability_value = options.delete(capability_alias)
+          hash[capability_name] = capability_value unless capability_value.nil?
         end
-      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
-
-      #
-      # @api beta This API may be changed or removed in a future release.
-      #
-
-      def window
-        @window ||= Window.new(@bridge)
+        opts.merge(options)
       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
+      def generate_as_json(value)
+        if value.respond_to?(:as_json)
+          value.as_json
+        elsif value.is_a?(Hash)
+          value.each_with_object({}) { |(key, val), hash| hash[convert_json_key(key)] = generate_as_json(val) }
+        elsif value.is_a?(Array)
+          value.map(&method(:generate_as_json))
+        elsif value.is_a?(Symbol)
+          value.to_s
         else
-          raise ArgumentError, "invalid value for expiration date: #{obj.inspect}"
+          value
         end
       end
 
-      def strip_port(str)
-        str.split(':', 2).first
+      def convert_json_key(key)
+        key = camel_case(key) if key.is_a?(Symbol)
+        return key if key.is_a?(String)
+
+        raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
+      end
+
+      def camel_case(str)
+        str.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
       end
     end # Options
   end # WebDriver