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

data/lib/selenium/webdriver/remote/server_error.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/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,18 +17,23 @@
 # specific language governing permissions and limitations
 # under the License.
 
-require 'websocket'
-require 'pathname'
-
 module Selenium
   module WebDriver
     module Safari
-      MISSING_TEXT = <<-ERROR.tr("\n", '').freeze
-        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
+      autoload :Bridge, 'selenium/webdriver/safari/bridge'
+      autoload :Driver, 'selenium/webdriver/safari/driver'
+      autoload :Options, 'selenium/webdriver/safari/options'
+      autoload :Service, 'selenium/webdriver/safari/service'
 
       class << self
+        def technology_preview
+          "/Applications/Safari\ Technology\ Preview.app/Contents/MacOS/safaridriver"
+        end
+
+        def technology_preview!
+          Service.driver_path = technology_preview
+        end
+
         def path=(path)
           Platform.assert_executable(path)
           @path = path
@@ -37,28 +42,25 @@ module Selenium
         def path
           @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 == :macosx
-          raise Error::WebDriverError, 'Unable to find Safari'
-        end
+          raise Error::WebDriverError, 'Safari is only supported on Mac' unless Platform.os.mac?
 
-        def resource_path
-          @resource_path ||= Pathname.new(File.expand_path('../safari/resources', __FILE__))
+          raise Error::WebDriverError, 'Unable to find Safari'
         end
 
         def driver_path=(path)
-          Platform.assert_executable path
-          @driver_path = path
+          WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path=',
+                                     'Selenium::WebDriver::Safari::Service#driver_path=',
+                                     id: :driver_path
+          Selenium::WebDriver::Safari::Service.driver_path = path
         end
 
         def driver_path
-          @driver_path ||= '/usr/bin/safaridriver'
-          return @driver_path if File.file?(@driver_path) && File.executable?(@driver_path)
-          raise Error::WebDriverError, MISSING_TEXT
+          WebDriver.logger.deprecate 'Selenium::WebDriver::Safari#driver_path',
+                                     'Selenium::WebDriver::Safari::Service#driver_path',
+                                     id: :driver_path
+          Selenium::WebDriver::Safari::Service.driver_path
         end
       end
     end # Safari
   end # WebDriver
 end # Selenium
-
-require 'selenium/webdriver/safari/bridge'
-require 'selenium/webdriver/safari/service'

data/lib/selenium/webdriver/safari/bridge.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,31 +20,31 @@
 module Selenium
   module WebDriver
     module Safari
-      # @api private
-      class Bridge < Remote::Bridge
-        def initialize(opts = {})
-          opts[:desired_capabilities] ||= Remote::Capabilities.safari
-          port = opts.delete(:port) || Service::DEFAULT_PORT
-          service_args = opts.delete(:service_args) || {}
-
-          @service = Service.new(Safari.driver_path, port, *extract_service_args(service_args))
-          @service.start
-          opts[:url] = @service.uri
-
-          super(opts)
+      module Bridge
+
+        # https://developer.apple.com/library/content/documentation/NetworkingInternetWeb/Conceptual/WebDriverEndpointDoc/Commands/Commands.html
+        COMMANDS = {
+          get_permissions: [:get, 'session/:session_id/apple/permissions'],
+          set_permissions: [:post, 'session/:session_id/apple/permissions'],
+          attach_debugger: [:post, 'session/:session_id/apple/attach_debugger']
+        }.freeze
+
+        def commands(command)
+          COMMANDS[command] || super
         end
 
-        def quit
-          super
-        ensure
-          @service.stop if @service
+        def permissions
+          execute(:get_permissions)['permissions']
         end
 
-        private
+        def permissions=(permissions)
+          execute :set_permissions, {}, {permissions: permissions}
+        end
 
-        def extract_service_args(args = {})
-          args.key?(:port) ? ["--port=#{args[:port]}"] : []
+        def attach_debugger
+          execute :attach_debugger, {}, {}
         end
+
       end # Bridge
     end # Safari
   end # WebDriver

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

@@ -0,0 +1,41 @@
+# 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
+
+      #
+      # Driver implementation for Safari.
+      # @api private
+      #
+
+      class Driver < WebDriver::Driver
+        include DriverExtensions::HasDebugger
+        include DriverExtensions::HasPermissions
+        include DriverExtensions::HasWebStorage
+        include DriverExtensions::TakesScreenshot
+
+        def browser
+          :safari
+        end
+      end # Driver
+    end # Safari
+  end # WebDriver
+end # Selenium

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

@@ -0,0 +1,66 @@
+# 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
+      class Options < WebDriver::Options
+        attr_accessor :options
+
+        # @see https://developer.apple.com/documentation/webkit/about_webdriver_for_safari
+        CAPABILITIES = {automatic_inspection: 'safari:automaticInspection',
+                        automatic_profiling: 'safari:automaticProfiling'}.freeze
+
+        CAPABILITIES.each_key do |key|
+          define_method key do
+            @options[key]
+          end
+
+          define_method "#{key}=" do |value|
+            @options[key] = value
+          end
+        end
+
+        #
+        # 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
+        #
+
+        def initialize(**opts)
+          super
+        end
+
+        #
+        # @api private
+        #
+
+        def as_json(*)
+          generate_as_json(super)
+        end
+      end # Options
+    end # Safari
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/safari/service.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,30 +20,14 @@
 module Selenium
   module WebDriver
     module Safari
-      #
-      # @api private
-      #
-
       class Service < WebDriver::Service
         DEFAULT_PORT = 7050
-
-        private
-
-        def start_process
-          server_command = [@executable_path, "--port=#{@port}", *@extra_args]
-          @process       = ChildProcess.build(*server_command)
-
-          @process.io.inherit! if $DEBUG
-          @process.start
-        end
-
-        def stop_server
-          connect_to_server { |http| http.head('/shutdown') }
-        end
-
-        def cannot_connect_error_text
-          "unable to connect to safaridriver #{@host}:#{@port}"
-        end
+        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

data/lib/selenium/webdriver/support.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
@@ -23,3 +23,4 @@ require 'selenium/webdriver/support/block_event_listener'
 require 'selenium/webdriver/support/escaper'
 require 'selenium/webdriver/support/select'
 require 'selenium/webdriver/support/color'
+require 'selenium/webdriver/support/relative_locator'

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

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
@@ -25,7 +25,7 @@ module Selenium
           @callback = callback
         end
 
-        def method_missing(meth, *args)
+        def method_missing(meth, *args) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
           @callback.call meth, *args
         end
       end # BlockEventListener

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
@@ -23,27 +23,27 @@ module Selenium
       class Color
         RGB_PATTERN = %r{^\s*rgb\(\s*(\d{1,3})\s*,
                           \s*(\d{1,3})\s*,
-                          \s*(\d{1,3})\s*\)\s*$}x
+                          \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
+                              \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
+                          \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
-        HEX_PATTERN = /#(\h{2})(\h{2})(\h{2})/
-        HEX3_PATTERN = /#(\h)(\h)(\h)/
+                              %\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
+                         \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
+                          \s*(0|1|0\.\d+)\s*\)\s*$}x.freeze
 
         attr_reader :red, :green, :blue, :alpha
 
@@ -72,18 +72,18 @@ module Selenium
           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
 
             r = hue_to_rgb(luminocity1, luminocity2, h + 1.0 / 3.0)

data/lib/selenium/webdriver/support/escaper.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/support/event_firing_bridge.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
@@ -109,7 +109,7 @@ module Selenium
         end
 
         def driver
-          @driver ||= Driver.new(self)
+          @driver ||= Driver.new(bridge: self)
         end
 
         def dispatch(name, *args)
@@ -120,7 +120,7 @@ module Selenium
           returned
         end
 
-        def method_missing(meth, *args, &blk)
+        def method_missing(meth, *args, &blk) # rubocop:disable Style/MethodMissingSuper, Style/MissingRespondToMissing
           @delegate.__send__(meth, *args, &blk)
         end
       end # EventFiringBridge

data/lib/selenium/webdriver/support/relative_locator.rb

@@ -0,0 +1,51 @@
+# 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
+
+      #
+      # @api private
+      #
+
+      class RelativeLocator
+        KEYS = %w[above below left right near distance].freeze
+
+        def initialize(locator)
+          @filters, @root = locator.partition { |how, _| KEYS.include?(how) }.map(&:to_h)
+        end
+
+        def as_json
+          {
+            relative: {
+              root: @root,
+              filters: @filters.map do |kind, filter|
+                {
+                  kind: kind,
+                  args: [filter]
+                }
+              end
+            }
+          }
+        end
+      end
+    end
+  end
+end