selenium-webdriver 3.141.0 → 3.142.7

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

@@ -1,3 +1,5 @@
+# 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
@@ -34,6 +36,7 @@ module Selenium
 
         def encode
           return nil if no_actions?
+
           output = {type: type, id: name, actions: @actions.map(&:encode)}
           output[:parameters] = {pointerType: kind}
           output
@@ -41,6 +44,7 @@ module Selenium
 
         def assert_kind(pointer)
           raise TypeError, "#{pointer.inspect} is not a valid pointer type" unless KIND.key? pointer
+
           KIND[pointer]
         end
 
@@ -78,14 +82,17 @@ module Selenium
         def assert_button(button)
           if button.is_a? Symbol
             raise TypeError, "#{button.inspect} is not a valid button!" unless BUTTONS.key? button
+
             button = BUTTONS[button]
           end
           raise ArgumentError, 'Button number cannot be negative!' unless button >= 0
+
           button
         end
 
         def assert_direction(direction)
           raise TypeError, "#{direction.inspect} is not a valid button direction" unless DIRECTIONS.key? direction
+
           DIRECTIONS[direction]
         end
 

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

@@ -1,3 +1,5 @@
+# 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
@@ -56,10 +58,11 @@ module Selenium
 
       private
 
-      MODIFIERS = [:control, :shift, :alt, :command, :meta].freeze
+      MODIFIERS = %i[control shift alt command meta].freeze
 
       def assert_modifier(key)
         return if MODIFIERS.include? key
+
         raise ArgumentError, "#{key.inspect} is not a modifier key, expected one of #{MODIFIERS.inspect}"
       end
     end # Keyboard

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

@@ -1,3 +1,5 @@
+# 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
@@ -110,6 +112,7 @@ module Selenium
 
       def self.[](key)
         return KEYS[key] if KEYS[key]
+
         raise Error::UnsupportedOperationError, "no such key #{key.inspect}"
       end
 

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

@@ -1,3 +1,5 @@
+# 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
@@ -28,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

@@ -1,3 +1,5 @@
+# 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
@@ -33,54 +35,27 @@ module Selenium
     #
     class Logger
       extend Forwardable
-      include ::Logger::Severity
 
-      def_delegators :@logger, :debug, :debug?,
+      def_delegators :@logger,
+                     :close,
+                     :debug, :debug?,
                      :info, :info?,
                      :warn, :warn?,
                      :error, :error?,
                      :fatal, :fatal?,
-                     :level
+                     :level, :level=
 
       def initialize
         @logger = create_logger($stdout)
       end
 
-      def output=(io)
-        # `Logger#reopen` was added in Ruby 2.3
-        if @logger.respond_to?(:reopen)
-          @logger.reopen(io)
-        else
-          @logger = create_logger(io)
-        end
-      end
-
       #
-      # For Ruby < 2.3 compatibility
-      # Based on https://github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250
+      # Changes logger output to a new IO.
       #
-
-      def level=(severity)
-        if severity.is_a?(Integer)
-          @logger.level = severity
-        else
-          case severity.to_s.downcase
-          when 'debug'.freeze
-            @logger.level = DEBUG
-          when 'info'.freeze
-            @logger.level = INFO
-          when 'warn'.freeze
-            @logger.level = WARN
-          when 'error'.freeze
-            @logger.level = ERROR
-          when 'fatal'.freeze
-            @logger.level = FATAL
-          when 'unknown'.freeze
-            @logger.level = UNKNOWN
-          else
-            raise ArgumentError, "invalid log level: #{severity}"
-          end
-        end
+      # @param [String] io
+      #
+      def output=(io)
+        @logger.reopen(io)
       end
 
       #
@@ -95,7 +70,7 @@ module Selenium
       # @api private
       #
       def io
-        @logger.instance_variable_get(:@logdev).instance_variable_get(:@dev)
+        @logger.instance_variable_get(:@logdev).dev
       end
 
       #
@@ -105,7 +80,7 @@ module Selenium
       # @param [String, nil] new
       #
       def deprecate(old, new = nil)
-        message = "[DEPRECATION] #{old} is deprecated"
+        message = +"[DEPRECATION] #{old} is deprecated"
         message << if new
                      ". Use #{new} instead."
                    else
@@ -130,9 +105,9 @@ module Selenium
 
       def default_level
         if $DEBUG || ENV.key?('DEBUG')
-          DEBUG
+          :debug
         else
-          WARN
+          :warn
         end
       end
     end # Logger

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

@@ -1,3 +1,5 @@
+# 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)
+        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

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

@@ -1,3 +1,5 @@
+# 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
@@ -79,6 +81,7 @@ module Selenium
 
       def assert_element(element)
         return if element.is_a? Element
+
         raise TypeError, "expected #{Element}, got #{element.inspect}:#{element.class}"
       end
     end # Mouse

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

@@ -1,3 +1,5 @@
+# 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,3 +1,5 @@
+# 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
@@ -17,135 +19,35 @@
 
 module Selenium
   module WebDriver
-    class Options
-      #
-      # @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
-
-      #
-      # @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
+    module Common
+      class Options
+        private
+
+        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
+            value
+          end
+        end
 
-      def datetime_at(int)
-        DateTime.civil(1970) + (int / SECONDS_PER_DAY)
-      end
+        def convert_json_key(key)
+          key = camel_case(key) if key.is_a?(Symbol)
+          return key if key.is_a?(String)
 
-      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}"
+          raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}"
         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
+        def camel_case(str)
+          str.to_s.gsub(/_([a-z])/) { Regexp.last_match(1).upcase }
+        end
+      end # Options
+    end # Common
   end # WebDriver
 end # Selenium

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

@@ -1,3 +1,5 @@
+# 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
@@ -25,12 +27,11 @@ module Selenium
       module_function
 
       def home
-        # jruby has an issue with ENV['HOME'] on Windows
-        @home ||= jruby? ? ENV_JAVA['user.home'] : ENV['HOME']
+        @home ||= Dir.home
       end
 
       def engine
-        @engine ||= defined?(RUBY_ENGINE) ? RUBY_ENGINE.to_sym : :ruby
+        @engine ||= RUBY_ENGINE.to_sym
       end
 
       def os
@@ -50,8 +51,13 @@ module Selenium
       end
 
       def ci
-        return :travis if ENV['TRAVIS']
-        :jenkins if ENV['JENKINS']
+        if ENV['TRAVIS']
+          :travis
+        elsif ENV['JENKINS']
+          :jenkins
+        elsif ENV['APPVEYOR']
+          :appveyor
+        end
       end
 
       def bitsize
@@ -70,10 +76,6 @@ module Selenium
         engine == :jruby
       end
 
-      def ironruby?
-        engine == :ironruby
-      end
-
       def ruby_version
         RUBY_VERSION
       end
@@ -92,6 +94,7 @@ module Selenium
 
       def wsl?
         return false unless linux?
+
         File.read('/proc/version').include?('Microsoft')
       end
 
@@ -101,30 +104,35 @@ module Selenium
       end
 
       def null_device
-        @null_device ||= if defined?(File::NULL)
-                           File::NULL
-                         else
-                           Platform.windows? ? 'NUL' : '/dev/null'
-                         end
+        File::NULL
       end
 
       def wrap_in_quotes_if_necessary(str)
         windows? && !cygwin? ? %("#{str}") : str
       end
 
-      def cygwin_path(path, opts = {})
+      def cygwin_path(path, **opts)
         flags = []
         opts.each { |k, v| flags << "--#{k}" if v }
 
         `cygpath #{flags.join ' '} "#{path}"`.strip
       end
 
+      def unix_path(path)
+        path.tr(File::ALT_SEPARATOR, File::SEPARATOR)
+      end
+
+      def windows_path(path)
+        path.tr(File::SEPARATOR, File::ALT_SEPARATOR)
+      end
+
       def make_writable(file)
         File.chmod 0o766, file
       end
 
       def assert_file(path)
         return if File.file? path
+
         raise Error::WebDriverError, "not a file: #{path.inspect}"
       end
 
@@ -132,6 +140,7 @@ module Selenium
         assert_file(path)
 
         return if File.executable? path
+
         raise Error::WebDriverError, "not executable: #{path.inspect}"
       end
 
@@ -152,7 +161,7 @@ module Selenium
         binary_names.each do |binary_name|
           paths.each do |path|
             full_path = File.join(path, binary_name)
-            full_path.tr!('\\', '/') if windows?
+            full_path = unix_path(full_path) if windows?
             exe = Dir.glob(full_path).find { |f| File.executable?(f) }
             return exe if exe
           end
@@ -182,6 +191,7 @@ module Selenium
         info = Socket.getaddrinfo 'localhost', 80, Socket::AF_INET, Socket::SOCK_STREAM
 
         return info[0][3] unless info.empty?
+
         raise Error::WebDriverError, "unable to translate 'localhost' for TCP + IPv4"
       end
 
@@ -210,17 +220,3 @@ module Selenium
     end # Platform
   end # WebDriver
 end # Selenium
-
-if $PROGRAM_NAME == __FILE__
-  p engine: Selenium::WebDriver::Platform.engine,
-    os: Selenium::WebDriver::Platform.os,
-    ruby_version: Selenium::WebDriver::Platform.ruby_version,
-    jruby?: Selenium::WebDriver::Platform.jruby?,
-    windows?: Selenium::WebDriver::Platform.windows?,
-    home: Selenium::WebDriver::Platform.home,
-    bitsize: Selenium::WebDriver::Platform.bitsize,
-    localhost: Selenium::WebDriver::Platform.localhost,
-    ip: Selenium::WebDriver::Platform.ip,
-    interfaces: Selenium::WebDriver::Platform.interfaces,
-    null_device: Selenium::WebDriver::Platform.null_device
-end