selenium-webdriver 3.12.0 → 3.142.7

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
@@ -90,36 +92,47 @@ module Selenium
         os == :linux
       end
 
+      def wsl?
+        return false unless linux?
+
+        File.read('/proc/version').include?('Microsoft')
+      end
+
       def cygwin?
         RUBY_PLATFORM =~ /cygwin/
         !Regexp.last_match.nil?
       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
 
@@ -127,6 +140,7 @@ module Selenium
         assert_file(path)
 
         return if File.executable? path
+
         raise Error::WebDriverError, "not executable: #{path.inspect}"
       end
 
@@ -147,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
@@ -177,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
 
@@ -205,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

data/lib/selenium/webdriver/common/port_prober.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
@@ -23,23 +25,10 @@ module Selenium
         port
       end
 
-      def self.random
-        # TODO: Avoid this
-        #
-        # (a) should pick a port that's guaranteed to be free on all interfaces
-        # (b) should pick a random port outside the ephemeral port range
-        #
-        server = TCPServer.new(Platform.localhost, 0)
-        port   = server.addr[1]
-        server.close
-
-        port
-      end
-
-      IGNORED_ERRORS = [Errno::EADDRNOTAVAIL, Errno::EAFNOSUPPORT]
-      IGNORED_ERRORS << Errno::EBADF if Platform.cygwin?
-      IGNORED_ERRORS << Errno::EACCES if Platform.windows?
-      IGNORED_ERRORS.freeze
+      IGNORED_ERRORS = [Errno::EADDRNOTAVAIL, Errno::EAFNOSUPPORT].tap { |arr|
+        arr << Errno::EBADF if Platform.cygwin?
+        arr << Errno::EACCES if Platform.windows?
+      }.freeze
 
       def self.free?(port)
         Platform.interfaces.each do |host|

data/lib/selenium/webdriver/common/profile_helper.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/proxy.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
@@ -35,7 +37,8 @@ module Selenium
                  auto_detect: 'autodetect',
                  socks: 'socksProxy',
                  socks_username: 'socksUsername',
-                 socks_password: 'socksPassword'}.freeze
+                 socks_password: 'socksPassword',
+                 socks_version: 'socksVersion'}.freeze
 
       ALLOWED.each_key { |t| attr_reader t }
 
@@ -64,6 +67,7 @@ module Selenium
         end
 
         return if not_allowed.empty?
+
         raise ArgumentError, "unknown option#{'s' if not_allowed.size != 1}: #{not_allowed.inspect}"
       end
 
@@ -117,10 +121,13 @@ module Selenium
         @socks_password = value
       end
 
+      def socks_version=(value)
+        self.type = :manual
+        @socks_version = value
+      end
+
       def type=(type)
-        unless TYPES.key? type
-          raise ArgumentError, "invalid proxy type: #{type.inspect}, expected one of #{TYPES.keys.inspect}"
-        end
+        raise ArgumentError, "invalid proxy type: #{type.inspect}, expected one of #{TYPES.keys.inspect}" unless TYPES.key? type
 
         if defined?(@type) && type != @type
           raise ArgumentError, "incompatible proxy type #{type.inspect} (already set to #{@type.inspect})"
@@ -140,7 +147,8 @@ module Selenium
           'autodetect' => auto_detect,
           'socksProxy' => socks,
           'socksUsername' => socks_username,
-          'socksPassword' => socks_password
+          'socksPassword' => socks_password,
+          'socksVersion' => socks_version
         }.delete_if { |_k, v| v.nil? }
 
         json_result if json_result.length > 1

data/lib/selenium/webdriver/common/search_context.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
@@ -58,7 +60,7 @@ module Selenium
         raise ArgumentError, "cannot find element by #{how.inspect}" unless by
 
         bridge.find_element_by by, what.to_s, ref
-      rescue Selenium::WebDriver::Error::TimeOutError
+      rescue Selenium::WebDriver::Error::TimeoutError
         # Implicit Wait times out in Edge
         raise Selenium::WebDriver::Error::NoSuchElementError
       end
@@ -76,7 +78,7 @@ module Selenium
         raise ArgumentError, "cannot find elements by #{how.inspect}" unless by
 
         bridge.find_elements_by by, what.to_s, ref
-      rescue Selenium::WebDriver::Error::TimeOutError
+      rescue Selenium::WebDriver::Error::TimeoutError
         # Implicit Wait times out in Edge
         []
       end
@@ -90,15 +92,11 @@ module Selenium
         when 1
           arg = args.first
 
-          unless arg.respond_to?(:shift)
-            raise ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift"
-          end
+          raise ArgumentError, "expected #{arg.inspect}:#{arg.class} to respond to #shift" unless arg.respond_to?(:shift)
 
           # this will be a single-entry hash, so use #shift over #first or #[]
           arr = arg.dup.shift
-          unless arr.size == 2
-            raise ArgumentError, "expected #{arr.inspect} to have 2 elements"
-          end
+          raise ArgumentError, "expected #{arr.inspect} to have 2 elements" unless arr.size == 2
 
           arr
         else