selenium-webdriver 2.53.4 → 3.8.0

data/lib/selenium/webdriver/{firefox/w3c_bridge.rb → safari/driver.rb}

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,32 +17,32 @@
 
 module Selenium
   module WebDriver
-    module Firefox
+    module Safari
 
+      #
+      # Driver implementation for Safari.
       # @api private
-      class W3CBridge < Remote::W3CBridge
+      #
+
+      class Driver < WebDriver::Driver
+        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] ||= Remote::Capabilities.safari
 
-          @service = Service.default_service(*extract_service_args(opts))
-          @service.start
-          opts[:url] = @service.uri
+          unless opts.key?(:url)
+            driver_path = opts.delete(:driver_path) || Safari.driver_path
+            driver_opts = opts.delete(:driver_opts) || {}
+            port = opts.delete(:port) || Service::DEFAULT_PORT
 
-          super
-        end
+            @service = Service.new(driver_path, port, driver_opts)
+            @service.start
+            opts[:url] = @service.uri
+          end
 
-        def browser
-          :firefox
-        end
-
-        def driver_extensions
-          [
-            DriverExtensions::TakesScreenshot,
-            DriverExtensions::HasInputDevices,
-            DriverExtensions::HasWebStorage
-          ]
+          listener = opts.delete(:listener)
+          @bridge = Remote::Bridge.handshake(opts)
+          super(@bridge, listener: listener)
         end
 
         def quit
@@ -53,14 +51,7 @@ module Selenium
           @service.stop if @service
         end
 
-        private
-
-        def extract_service_args(opts)
-          service_log_path = opts.delete(:service_log_path)
-          service_log_path ? ["--log-path=#{service_log_path}"] : []
-        end
-
-      end # W3CBridge
-    end # Firefox
+      end # Driver
+    end # Safari
   end # WebDriver
 end # Selenium

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

@@ -0,0 +1,57 @@
+# 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 = '/usr/bin/safaridriver'.freeze
+        @missing_text = <<-ERROR.gsub(/\n +| {2,}/, ' ').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
+
+        def stop
+          stop_process
+        end
+
+        private
+
+        def binary_path(path)
+          path = self.class.executable if path.nil?
+          raise Error::WebDriverError, self.class.missing_text unless path
+          Platform.assert_executable path
+          path
+        end
+
+        def start_process
+          @process = build_process(@executable_path, "--port=#{@port}", *@extra_args)
+          @process.start
+        end
+
+        def cannot_connect_error_text
+          "unable to connect to safaridriver #{@host}:#{@port}"
+        end
+      end # Service
+    end # Safari
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/support.rb

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,5 +18,6 @@
 require 'selenium/webdriver/support/event_firing_bridge'
 require 'selenium/webdriver/support/abstract_event_listener'
 require 'selenium/webdriver/support/block_event_listener'
+require 'selenium/webdriver/support/escaper'
 require 'selenium/webdriver/support/select'
 require 'selenium/webdriver/support/color'

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +18,6 @@
 module Selenium
   module WebDriver
     module Support
-
       #
       # Subclass and override methods from this class
       # to implement your own event listener.
@@ -48,24 +45,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,3 @@
-# encoding: utf-8
-#
 # 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 +18,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)
           @callback.call meth, *args
         end
-
       end # BlockEventListener
     end # Support
   end # WebDriver

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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,33 +19,52 @@ 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
+        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
+        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
+        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)/
+        HSL_PATTERN = %r{^\s*hsl\(\s*(\d{1,3})\s*,
+                         \s*(\d{1,3})%\s*,
+                         \s*(\d{1,3})%\s*\)\s*$}x
+        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
 
         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
@@ -59,48 +76,47 @@ module Selenium
           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 +136,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,41 @@
+# 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

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

@@ -1,5 +1,3 @@
-# encoding: utf-8
-#
 # 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 +18,6 @@
 module Selenium
   module WebDriver
     module Support
-
       #
       # @api private
       #
@@ -29,69 +26,69 @@ module Selenium
         def initialize(delegate, listener)
           @delegate = delegate
 
-          if listener.respond_to? :call
-            @listener = BlockEventListener.new(listener)
-          else
-            @listener = listener
-          end
+          @listener = if listener.respond_to? :call
+                        BlockEventListener.new(listener)
+                      else
+                        listener
+                      end
         end
 
         def get(url)
-          dispatch(:navigate_to, url, driver) {
+          dispatch(:navigate_to, url, driver) do
             @delegate.get(url)
-          }
+          end
         end
 
-        def goForward
-          dispatch(:navigate_forward, driver) {
-            @delegate.goForward
-          }
+        def go_forward
+          dispatch(:navigate_forward, driver) do
+            @delegate.go_forward
+          end
         end
 
-        def goBack
-          dispatch(:navigate_back, driver) {
-            @delegate.goBack
-          }
+        def go_back
+          dispatch(:navigate_back, driver) do
+            @delegate.go_back
+          end
         end
 
-        def clickElement(ref)
-          dispatch(:click, create_element(ref), driver) {
-            @delegate.clickElement(ref)
-          }
+        def click_element(ref)
+          dispatch(:click, create_element(ref), driver) do
+            @delegate.click_element(ref)
+          end
         end
 
-        def clearElement(ref)
-          dispatch(:change_value_of, create_element(ref), driver) {
-            @delegate.clearElement(ref)
-          }
+        def clear_element(ref)
+          dispatch(:change_value_of, create_element(ref), driver) do
+            @delegate.clear_element(ref)
+          end
         end
 
-        def sendKeysToElement(ref, keys)
-          dispatch(:change_value_of, create_element(ref), driver) {
-            @delegate.sendKeysToElement(ref, keys)
-          }
+        def send_keys_to_element(ref, keys)
+          dispatch(:change_value_of, create_element(ref), driver) do
+            @delegate.send_keys_to_element(ref, keys)
+          end
         end
 
         def find_element_by(how, what, parent = nil)
-          e = dispatch(:find, how, what, driver) {
+          e = dispatch(:find, how, what, driver) do
             @delegate.find_element_by how, what, parent
-          }
+          end
 
           Element.new self, e.ref
         end
 
         def find_elements_by(how, what, parent = nil)
-          es = dispatch(:find, how, what, driver) {
+          es = dispatch(:find, how, what, driver) do
             @delegate.find_elements_by(how, what, parent)
-          }
+          end
 
           es.map { |e| Element.new self, e.ref }
         end
 
-        def executeScript(script, *args)
-          dispatch(:execute_script, script, driver) {
-            @delegate.executeScript(script, *args)
-          }
+        def execute_script(script, *args)
+          dispatch(:execute_script, script, driver) do
+            @delegate.execute_script(script, *args)
+          end
         end
 
         def quit
@@ -113,7 +110,7 @@ module Selenium
           @driver ||= Driver.new(self)
         end
 
-        def dispatch(name, *args, &blk)
+        def dispatch(name, *args)
           @listener.__send__("before_#{name}", *args)
           returned = yield
           @listener.__send__("after_#{name}", *args)
@@ -125,7 +122,6 @@ module Selenium
           @delegate.__send__(meth, *args, &blk)
         end
       end # EventFiringBridge
-
     end # Support
   end # WebDriver
 end # Selenium