selenium-webdriver 2.53.3 → 3.142.7

data/lib/selenium/webdriver/{firefox/w3c_bridge.rb → safari/driver.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
@@ -19,48 +19,50 @@
 
 module Selenium
   module WebDriver
-    module Firefox
+    module Safari
 
+      #
+      # Driver implementation for Safari.
       # @api private
-      class W3CBridge < Remote::W3CBridge
+      #
+
+      class Driver < WebDriver::Driver
+        include DriverExtensions::HasDebugger
+        include DriverExtensions::HasPermissions
+        include DriverExtensions::TakesScreenshot
 
         def initialize(opts = {})
-          caps = opts[:desired_capabilities] ||= Remote::W3CCapabilities.firefox
-          Binary.path = caps[:firefox_binary] if caps[:firefox_binary]
+          opts[:desired_capabilities] = create_capabilities(opts)
 
-          @service = Service.default_service(*extract_service_args(opts))
-          @service.start
-          opts[:url] = @service.uri
+          opts[:url] ||= service_url(opts)
 
-          super
-        end
+          listener = opts.delete(:listener)
+          @bridge = Remote::Bridge.handshake(**opts)
+          @bridge.extend Bridge
 
-        def browser
-          :firefox
+          super(@bridge, listener: listener)
         end
 
-        def driver_extensions
-          [
-            DriverExtensions::TakesScreenshot,
-            DriverExtensions::HasInputDevices,
-            DriverExtensions::HasWebStorage
-          ]
+        def browser
+          :safari
         end
 
         def quit
           super
         ensure
-          @service.stop if @service
+          @service&.stop
         end
 
         private
 
-        def extract_service_args(opts)
-          service_log_path = opts.delete(:service_log_path)
-          service_log_path ? ["--log-path=#{service_log_path}"] : []
+        def create_capabilities(opts = {})
+          caps = opts.delete(:desired_capabilities) { Remote::Capabilities.safari }
+          options = opts.delete(:options) { Options.new }
+          caps.merge!(options.as_json)
+          caps
         end
 
-      end # W3CBridge
-    end # Firefox
+      end # Driver
+    end # Safari
   end # WebDriver
 end # Selenium

data/lib/selenium/webdriver/safari/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
@@ -21,41 +21,39 @@ module Selenium
   module WebDriver
     module Safari
       class Options
-        DEFAULT_PORT = 56485
-
-        attr_accessor :port, :data_dir, :skip_extension_installation
-
-        def initialize(opts = {})
-          extract_options(opts)
-        end
-
-        def clean_session?
-          !!@clean_session
+        attr_accessor :automatic_inspection, :automatic_profiling
+
+        #
+        # Create a new Options instance for W3C-capable versions of Safari.
+        #
+        # @example
+        #   options = Selenium::WebDriver::Safari::Options.new(automatic_inspection: true)
+        #   driver = Selenium::WebDriver.for :safari, options: options
+        #
+        # @param [Hash] opts the pre-defined options to create the Safari::Options with
+        # @option opts [Boolean] :automatic_inspection Preloads Web Inspector and JavaScript debugger. Default is false
+        # @option opts [Boolean] :automatic_profiling Preloads Web Inspector and starts a timeline recording. Default is false
+        #
+        # @see https://developer.apple.com/documentation/webkit/about_webdriver_for_safari
+        #
+
+        def initialize(**opts)
+          @automatic_inspection = opts.delete(:automatic_inspection) || false
+          @automatic_profiling = opts.delete(:automatic_profiling) || false
         end
 
-        def to_capabilities
-          caps = Remote::Capabilities.safari
-          caps.merge!('safari.options' => as_json)
+        #
+        # @api private
+        #
 
-          caps
-        end
+        def as_json(*)
+          opts = {}
 
-        def as_json
-          {
-            'port'         => port,
-            'dataDir'      => data_dir,
-            'cleanSession' => clean_session?,
-          }
-        end
+          opts['safari:automaticInspection'] = true if @automatic_inspection
+          opts['safari:automaticProfiling'] = true if @automatic_profiling
 
-        private
-
-        def extract_options(opts)
-          @port          = Integer(opts[:port] || DEFAULT_PORT)
-          @data_dir      = opts[:custom_data_dir] || opts[:data_dir]
-          @clean_session = opts[:clean_session]
+          opts
         end
-
       end # Options
     end # Safari
   end # WebDriver

data/lib/selenium/webdriver/safari/service.rb

@@ -0,0 +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
+    module Safari
+      #
+      # @api private
+      #
+
+      class Service < WebDriver::Service
+        @default_port = 7050
+        @executable = 'safaridriver'
+        @missing_text = <<~ERROR
+          Unable to find Apple's safaridriver which comes with Safari 10.
+          More info at https://webkit.org/blog/6900/webdriver-support-in-safari-10/
+        ERROR
+        @shutdown_supported = false
+      end # Service
+    end # Safari
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/safari.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
@@ -17,49 +17,49 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'websocket'
-require 'pathname'
+require 'selenium/webdriver/safari/bridge'
+require 'selenium/webdriver/safari/driver'
+require 'selenium/webdriver/safari/options'
 
 module Selenium
   module WebDriver
     module Safari
-
       class << self
+        def technology_preview
+          "/Applications/Safari\ Technology\ Preview.app/Contents/MacOS/safaridriver"
+        end
+
+        def technology_preview!
+          self.driver_path = technology_preview
+        end
+
         def path=(path)
           Platform.assert_executable(path)
           @path = path
         end
 
         def path
-          @path ||= (
-            path = case Platform.os
-                   when :windows
-                     Platform.find_in_program_files("Safari\\Safari.exe")
-                   when :macosx
-                     "/Applications/Safari.app/Contents/MacOS/Safari"
-                   else
-                     Platform.find_binary("Safari")
-                   end
+          @path ||= '/Applications/Safari.app/Contents/MacOS/Safari'
+          return @path if File.file?(@path) && File.executable?(@path)
+          raise Error::WebDriverError, 'Safari is only supported on Mac' unless Platform.os.mac?
 
-            unless File.file?(path) && File.executable?(path)
-              raise Error::WebDriverError, "unable to find the Safari executable, please set Selenium::WebDriver::Safari.path= or add it to your PATH."
-            end
+          raise Error::WebDriverError, 'Unable to find Safari'
+        end
 
-            path
-          )
+        def driver_path=(path)
+          WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path=',
+                                     'Selenium::WebDriver::Safari::Service#driver_path='
+          Selenium::WebDriver::Safari::Service.driver_path = path
         end
 
-        def resource_path
-          @resource_path ||= Pathname.new(File.expand_path("../safari/resources", __FILE__))
+        def driver_path
+          WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path',
+                                     'Selenium::WebDriver::Safari::Service#driver_path'
+          Selenium::WebDriver::Safari::Service.driver_path
         end
       end
-
     end # Safari
   end # WebDriver
 end # Selenium
 
-require 'selenium/webdriver/safari/browser'
-require 'selenium/webdriver/safari/server'
-require 'selenium/webdriver/safari/options'
-require 'selenium/webdriver/safari/bridge'
-
+require 'selenium/webdriver/safari/service'

data/lib/selenium/webdriver/support/abstract_event_listener.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,7 +20,6 @@
 module Selenium
   module WebDriver
     module Support
-
       #
       # Subclass and override methods from this class
       # to implement your own event listener.
@@ -48,24 +47,40 @@ module Selenium
 
       class AbstractEventListener
         def before_navigate_to(url, driver) end
+
         def after_navigate_to(url, driver) end
+
         def before_navigate_back(driver) end
+
         def after_navigate_back(driver) end
+
         def before_navigate_forward(driver) end
+
         def after_navigate_forward(driver) end
+
         def before_find(by, what, driver) end
+
         def after_find(by, what, driver) end
+
         def before_click(element, driver) end
+
         def after_click(element, driver) end
+
         def before_change_value_of(element, driver) end
+
         def after_change_value_of(element, driver) end
+
         def before_execute_script(script, driver) end
+
         def after_execute_script(script, driver) end
+
         def before_quit(driver) end
+
         def after_quit(driver) end
+
         def before_close(driver) end
-        def after_close(driver) end
 
+        def after_close(driver) end
       end # AbstractEventListener
     end # Support
   end # WebDriver

data/lib/selenium/webdriver/support/block_event_listener.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,16 +20,14 @@
 module Selenium
   module WebDriver
     module Support
-
       class BlockEventListener
         def initialize(callback)
           @callback = callback
         end
 
-        def method_missing(meth, *args, &blk)
+        def method_missing(meth, *args) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
           @callback.call meth, *args
         end
-
       end # BlockEventListener
     end # Support
   end # WebDriver

data/lib/selenium/webdriver/support/color.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
@@ -21,86 +21,104 @@ module Selenium
   module WebDriver
     module Support
       class Color
-        RGB_PATTERN      = /^\s*rgb\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*\)\s*$/
-        RGB_PCT_PATTERN  = /^\s*rgb\(\s*(\d{1,3}|\d{1,2}\.\d+)%\s*,\s*(\d{1,3}|\d{1,2}\.\d+)%\s*,\s*(\d{1,3}|\d{1,2}\.\d+)%\s*\)\s*$/
-        RGBA_PATTERN     = /^\s*rgba\(\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(\d{1,3})\s*,\s*(0|1|0\.\d+)\s*\)\s*$/
-        RGBA_PCT_PATTERN = /^\s*rgba\(\s*(\d{1,3}|\d{1,2}\.\d+)%\s*,\s*(\d{1,3}|\d{1,2}\.\d+)%\s*,\s*(\d{1,3}|\d{1,2}\.\d+)%\s*,\s*(0|1|0\.\d+)\s*\)\s*$/
-        HEX_PATTERN      = /#([A-Fa-f0-9]{2})([A-Fa-f0-9]{2})([A-Fa-f0-9]{2})/ # \p{XDigit} or \h only works on Ruby 1.9
-        HEX3_PATTERN     = /#([A-Fa-f0-9])([A-Fa-f0-9])([A-Fa-f0-9])/ # \p{XDigit} or \h only works on Ruby 1.9
-        HSL_PATTERN      = /^\s*hsl\(\s*(\d{1,3})\s*,\s*(\d{1,3})%\s*,\s*(\d{1,3})%\s*\)\s*$/
-        HSLA_PATTERN     = /^\s*hsla\(\s*(\d{1,3})\s*,\s*(\d{1,3})%\s*,\s*(\d{1,3})%\s*,\s*(0|1|0\.\d+)\s*\)\s*$/
+        RGB_PATTERN = %r{^\s*rgb\(\s*(\d{1,3})\s*,
+                          \s*(\d{1,3})\s*,
+                          \s*(\d{1,3})\s*\)\s*$}x.freeze
+        RGB_PCT_PATTERN = %r{^\s*rgb\(\s*(\d{1,3}|\d{1,2}\.\d+)%\s*,
+                              \s*(\d{1,3}|\d{1,2}\.\d+)%\s*,
+                              \s*(\d{1,3}|\d{1,2}\.\d+)%\s*\)\s*$}x.freeze
+        RGBA_PATTERN = %r{^\s*rgba\(\s*(\d{1,3})\s*,
+                          \s*(\d{1,3})\s*,
+                          \s*(\d{1,3})\s*,
+                          \s*(0|1|0\.\d+)\s*\)\s*$}x.freeze
+        RGBA_PCT_PATTERN = %r{^\s*rgba\(\s*(\d{1,3}|\d{1,2}\.\d+)
+                              %\s*,\s*(\d{1,3}|\d{1,2}\.\d+)
+                              %\s*,\s*(\d{1,3}|\d{1,2}\.\d+)
+                              %\s*,\s*(0|1|0\.\d+)\s*\)\s*$}x.freeze
+        HEX_PATTERN = /#(\h{2})(\h{2})(\h{2})/.freeze
+        HEX3_PATTERN = /#(\h)(\h)(\h)/.freeze
+        HSL_PATTERN = %r{^\s*hsl\(\s*(\d{1,3})\s*,
+                         \s*(\d{1,3})%\s*,
+                         \s*(\d{1,3})%\s*\)\s*$}x.freeze
+        HSLA_PATTERN = %r{^\s*hsla\(\s*(\d{1,3})\s*,
+                          \s*(\d{1,3})%\s*,
+                          \s*(\d{1,3})%\s*,
+                          \s*(0|1|0\.\d+)\s*\)\s*$}x.freeze
 
         attr_reader :red, :green, :blue, :alpha
 
         def self.from_string(str)
           case str
           when RGB_PATTERN
-            new $1, $2, $3
+            new Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3)
           when RGB_PCT_PATTERN
-            new(*[$1, $2, $3].map { |e| Float(e) / 100 * 255 })
+            array = [Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3)]
+            new(*array.map { |e| Float(e) / 100 * 255 })
           when RGBA_PATTERN
-            new $1, $2, $3, $4
+            new Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3), Regexp.last_match(4)
           when RGBA_PCT_PATTERN
-            new(*[$1, $2, $3].map { |e| Float(e) / 100 * 255 } << $4)
+            array = [Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3)]
+            new(*array.map { |e| Float(e) / 100 * 255 } << Regexp.last_match(4))
           when HEX_PATTERN
-            new(*[$1, $2, $3].map { |e| e.to_i(16) })
+            array = [Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3)]
+            new(*array.map { |e| e.to_i(16) })
           when HEX3_PATTERN
-            new(*[$1, $2, $3].map { |e| (e * 2).to_i(16) })
+            array = [Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3)]
+            new(*array.map { |e| (e * 2).to_i(16) })
           when HSL_PATTERN, HSLA_PATTERN
-            from_hsl($1, $2, $3, $4)
+            from_hsl(Regexp.last_match(1), Regexp.last_match(2), Regexp.last_match(3), Regexp.last_match(4))
           else
             raise ArgumentError, "could not convert #{str.inspect} into color"
           end
         end
 
-        def self.from_hsl(h, s, l, a)
+        def self.from_hsl(h, s, l, a) # rubocop:disable Naming/UncommunicativeMethodParamName
           h = Float(h) / 360
           s = Float(s) / 100
           l = Float(l) / 100
           a = Float(a || 1)
 
-          if s == 0
+          if s.zero?
             r = l
             g = r
             b = r
           else
-            luminocity2 = (l < 0.5) ? l * (1 + s) : l + s - l * s
+            luminocity2 = l < 0.5 ? l * (1 + s) : l + s - l * s
             luminocity1 = 2 * l - luminocity2
 
-            hue_to_rgb = lambda do |lum1, lum2, hue|
-              hue += 1 if hue < 0.0
-              hue -= 1 if hue > 1.0
-
-              if hue < 1.0 / 6.0
-                 (lum1 + (lum2 - lum1) * 6.0 * hue)
-              elsif  hue < 1.0 / 2.0
-                 lum2
-              elsif hue < 2.0 / 3.0
-                lum1 + (lum2 - lum1) * ((2.0 / 3.0) - hue) * 6.0
-              else
-                lum1
-              end
-            end
-
-            r = hue_to_rgb.call(luminocity1, luminocity2, h + 1.0 / 3.0)
-            g = hue_to_rgb.call(luminocity1, luminocity2, h)
-            b = hue_to_rgb.call(luminocity1, luminocity2, h - 1.0 / 3.0)
+            r = hue_to_rgb(luminocity1, luminocity2, h + 1.0 / 3.0)
+            g = hue_to_rgb(luminocity1, luminocity2, h)
+            b = hue_to_rgb(luminocity1, luminocity2, h - 1.0 / 3.0)
           end
 
           new (r * 255).round, (g * 255).round, (b * 255).round, a
         end
 
+        def self.hue_to_rgb(lum1, lum2, hue)
+          hue += 1 if hue < 0.0
+          hue -= 1 if hue > 1.0
+
+          if hue < 1.0 / 6.0
+            (lum1 + (lum2 - lum1) * 6.0 * hue)
+          elsif hue < 1.0 / 2.0
+            lum2
+          elsif hue < 2.0 / 3.0
+            lum1 + (lum2 - lum1) * ((2.0 / 3.0) - hue) * 6.0
+          else
+            lum1
+          end
+        end
 
         def initialize(red, green, blue, alpha = 1)
-          @red   = Integer(red)
+          @red = Integer(red)
           @green = Integer(green)
-          @blue  = Integer(blue)
+          @blue = Integer(blue)
           @alpha = Float(alpha)
         end
 
         def ==(other)
           return true if equal?(other)
-          return false unless other.kind_of?(self.class)
+          return false unless other.is_a?(self.class)
 
           [red, green, blue, alpha] == [other.red, other.green, other.blue, other.alpha]
         end
@@ -120,9 +138,8 @@ module Selenium
         end
 
         def hex
-          "#%02x%02x%02x" % [red, green, blue]
+          format '#%02x%02x%02x', red, green, blue
         end
-
       end # Color
     end # Support
   end # WebDriver

data/lib/selenium/webdriver/support/escaper.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
+    module Support
+      module Escaper
+        def self.escape(str)
+          if str.include?('"') && str.include?("'")
+            parts = str.split('"', -1).map { |part| %("#{part}") }
+
+            quoted = parts.join(%(, '"', ))
+                          .gsub(/^"", |, ""$/, '')
+
+            "concat(#{quoted})"
+          elsif str.include?('"')
+            # escape string with just a quote into being single quoted: f"oo -> 'f"oo'
+            "'#{str}'"
+          else
+            # otherwise return the quoted string
+            %("#{str}")
+          end
+        end
+      end # Escaper
+    end # Support
+  end # WebDriver
+end # Selenium