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

data/lib/selenium/webdriver/common/driver_extensions/has_network_connection.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
@@ -50,7 +50,7 @@ module Selenium
         end
 
         def valid_type?(type)
-          type_to_values.keys.include? type
+          type_to_values.key? type
         end
       end # HasNetworkConnection
     end # DriverExtensions

data/lib/selenium/webdriver/common/driver_extensions/has_permissions.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 DriverExtensions
+      module HasPermissions
+
+        #
+        # Returns permissions.
+        #
+        # @return [Hash]
+        #
+
+        def permissions
+          @bridge.permissions
+        end
+
+        #
+        # Sets permissions.
+        #
+        # @example
+        #   driver.permissions = {'getUserMedia' => true}
+        #
+        # @param [Hash<Symbol, Boolean>] permissions
+        #
+
+        def permissions=(permissions)
+          @bridge.permissions = permissions
+        end
+
+      end # HasPermissions
+    end # DriverExtensions
+  end # WebDriver
+end # Selenium

data/lib/selenium/webdriver/common/driver_extensions/has_remote_status.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/common/driver_extensions/has_session_id.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/common/driver_extensions/has_web_storage.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/common/driver_extensions/rotatable.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,12 +25,12 @@ module Selenium
 
     module DriverExtensions
       module Rotatable
-        ORIENTATIONS = [:landscape, :portrait].freeze
+        ORIENTATIONS = %i[landscape portrait].freeze
 
         #
         # Change the screen orientation
         #
-        # @param [:landscape, :portrait] Orientation
+        # @param [:landscape, :portrait] orientation
         #
         # @api public
         #

data/lib/selenium/webdriver/common/driver_extensions/takes_screenshot.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
@@ -32,6 +32,12 @@ module Selenium
         #
 
         def save_screenshot(png_path)
+          extension = File.extname(png_path).downcase
+          if extension != '.png'
+            WebDriver.logger.warn "name used for saved screenshot does not match file type. "\
+                                  "It should end with .png extension",
+                                  id: :screenshot
+          end
           File.open(png_path, 'wb') { |f| f << screenshot_as(:png) }
         end
 
@@ -48,7 +54,7 @@ module Selenium
           when :base64
             bridge.screenshot
           when :png
-            bridge.screenshot.unpack('m')[0]
+            bridge.screenshot.unpack1('m')
           else
             raise Error::UnsupportedOperationError, "unsupported format: #{format.inspect}"
           end

data/lib/selenium/webdriver/common/driver_extensions/uploads_files.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
@@ -50,9 +50,7 @@ module Selenium
         #
 
         def file_detector=(detector)
-          unless detector.nil? || detector.respond_to?(:call)
-            raise ArgumentError, 'detector must respond to #call'
-          end
+          raise ArgumentError, 'detector must respond to #call' unless detector.nil? || detector.respond_to?(:call)
 
           bridge.file_detector = detector
         end

data/lib/selenium/webdriver/common/element.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,6 +20,8 @@
 module Selenium
   module WebDriver
     class Element
+      ELEMENT_KEY = 'element-6066-11e4-a52e-4f735466cecf'
+
       include SearchContext
 
       #
@@ -34,7 +36,7 @@ module Selenium
       end
 
       def inspect
-        format '#<%s:0x%x id=%s>', self.class, hash * 2, @id.inspect
+        format '#<%<class>s:0x%<hash>x id=%<id>s>', class: self.class, hash: hash * 2, id: @id.inspect
       end
 
       def ==(other)
@@ -108,16 +110,26 @@ module Selenium
       #
       # class, readonly
       #
-      # @param [String]
-      #   attribute name
-      # @return [String,nil]
-      #   attribute value
+      # @param [String] name attribute name
+      # @return [String, nil] attribute value
       #
 
       def attribute(name)
         bridge.element_attribute self, name
       end
 
+      #
+      # Get the value of a the given property with the same name of the element. If the value is not
+      # set, nil is returned.
+      #
+      # @param [String] name property name
+      # @return [String, nil] property value
+      #
+
+      def property(name)
+        bridge.element_property self, name
+      end
+
       #
       # Get the text content of this element
       #
@@ -131,7 +143,7 @@ module Selenium
       #
       # Send keystrokes to this element
       #
-      # @param [String, Symbol, Array]
+      # @param [String, Symbol, Array] args keystrokes to send
       #
       # Examples:
       #
@@ -188,7 +200,7 @@ module Selenium
       #
 
       def displayed?
-        bridge.element_displayed? @id
+        bridge.element_displayed? self
       end
 
       #
@@ -225,6 +237,16 @@ module Selenium
         bridge.element_location @id
       end
 
+      #
+      # Get the dimensions and coordinates of this element.
+      #
+      # @return [WebDriver::Rectangle]
+      #
+
+      def rect
+        bridge.element_rect @id
+      end
+
       #
       # Determine an element's location on the screen once it has been scrolled into view.
       #
@@ -292,7 +314,7 @@ module Selenium
       #
 
       def as_json(*)
-        @id.is_a?(Hash) ? @id : {:ELEMENT => @id}
+        @id.is_a?(Hash) ? @id : {ELEMENT_KEY => @id}
       end
 
       private

data/lib/selenium/webdriver/common/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
@@ -20,206 +20,188 @@
 module Selenium
   module WebDriver
     module Error
+
+      #
+      # Returns exception from its string representation.
+      # @param [String, nil] error
+      #
+
+      def self.for_error(error)
+        return if error.nil?
+
+        klass_name = error.split(' ').map(&:capitalize).join.sub(/Error$/, '')
+        const_get("#{klass_name}Error", false)
+      rescue NameError
+        WebDriverError
+      end
+
       class WebDriverError < StandardError; end
-      class UnsupportedOperationError < WebDriverError; end
 
-      class IndexOutOfBoundsError < WebDriverError; end          # 1
-      class NoCollectionError < WebDriverError; end              # 2
-      class NoStringError < WebDriverError; end                  # 3
-      class NoStringLengthError < WebDriverError; end            # 4
-      class NoStringWrapperError < WebDriverError; end           # 5
-      class NoSuchDriverError < WebDriverError; end              # 6
+      #
+      # An element could not be located on the page using the given search parameters.
+      #
+
+      class NoSuchElementError < WebDriverError; end
 
       #
-      # An element could not be located on the page using the given search
-      # parameters.
+      # A command to switch to a frame could not be satisfied because the frame could not be found.
       #
 
-      class NoSuchElementError < WebDriverError; end # 7
+      class NoSuchFrameError < WebDriverError; end
 
       #
-      # A request to switch to a frame could not be satisfied because the
-      # frame could not be found.
+      # A command could not be executed because the remote end is not aware of it.
       #
 
-      class NoSuchFrameError < WebDriverError; end               # 8
-      class UnknownCommandError < WebDriverError; end            # 9
+      class UnknownCommandError < WebDriverError; end
 
       #
-      # Indicates that a reference to an element is now "stale" - the element
-      # no longer appears in the DOM of the page.
+      # A command failed because the referenced element is no longer attached to the DOM.
       #
 
-      class StaleElementReferenceError < WebDriverError; end # 10
+      class StaleElementReferenceError < WebDriverError; end
 
       #
-      # Raised to indicate that although an element is present on the DOM,
-      # it is not visible, and so is not able to be interacted with.
+      # The target element is in an invalid state, rendering it impossible to interact with, for
+      # example if you click a disabled element.
       #
 
-      class ElementNotVisibleError < WebDriverError; end # 11
+      class InvalidElementStateError < WebDriverError; end
 
       #
-      # Raised when an interaction could not be performed because the element
-      # is in an invalid state (e.g. attempting to click a disabled element).
+      # An unknown error occurred in the remote end while processing the command.
       #
 
-      class InvalidElementStateError < WebDriverError; end # 12
+      class UnknownError < WebDriverError; end
 
       #
-      # An unknown server-side error occurred while processing the command.
+      # An error occurred while executing JavaScript supplied by the user.
       #
 
-      class UnknownError < WebDriverError; end                   # 13
-      class ExpectedError < WebDriverError; end                  # 14
+      class JavascriptError < WebDriverError; end
 
       #
-      # An attempt was made to select an element that cannot be selected.
+      # An operation did not complete before its timeout expired.
       #
 
-      class ElementNotSelectableError < WebDriverError; end      # 15
-      class NoSuchDocumentError < WebDriverError; end            # 16
+      class TimeoutError < WebDriverError; end
 
       #
-      # An error occurred while executing user supplied JavaScript.
+      # A command to switch to a window could not be satisfied because
+      # the window could not be found.
       #
 
-      class JavascriptError < WebDriverError; end                # 17
-      class NoScriptResultError < WebDriverError; end            # 18
+      class NoSuchWindowError < WebDriverError; end
 
       #
-      # An error occurred while searching for an element by XPath.
+      # An illegal attempt was made to set a cookie under a different domain than the current page.
       #
 
-      class XPathLookupError < WebDriverError; end               # 19
-      class NoSuchCollectionError < WebDriverError; end          # 20
+      class InvalidCookieDomainError < WebDriverError; end
 
       #
-      # Raised when a command does not complete in enough time.
+      # A command to set a cookie's value could not be satisfied.
       #
 
-      class TimeOutError < WebDriverError; end                   # 21
-      class NullPointerError < WebDriverError; end               # 22
-      class NoSuchWindowError < WebDriverError; end              # 23
+      class UnableToSetCookieError < WebDriverError; end
 
       #
-      # Raised when attempting to add a cookie under a different domain than
-      # the current URL.
+      # An attempt was made to operate on a modal dialog when one was not open:
       #
 
-      class InvalidCookieDomainError < WebDriverError; end # 24
+      class NoSuchAlertError < WebDriverError; end
 
       #
-      # Raised when a driver fails to set a cookie.
+      # A script did not complete before its timeout expired.
       #
 
-      class UnableToSetCookieError < WebDriverError; end # 25
+      class ScriptTimeoutError < WebDriverError; end
 
       #
-      # Raised when an alert dialog is present that has not been dealt with.
+      # Argument was an invalid selector.
       #
-      class UnhandledAlertError < WebDriverError; end # 26
+
+      class InvalidSelectorError < WebDriverError; end
 
       #
-      # Indicates that a user has tried to access an alert when one is not present.
+      # A new session could not be created.
       #
 
-      class NoAlertPresentError < WebDriverError; end # 27
+      class SessionNotCreatedError < WebDriverError; end
 
       #
-      # A script did not complete before its timeout expired.
+      # The target for mouse interaction is not in the browser's viewport and cannot be brought
+      # into that viewport.
       #
 
-      class ScriptTimeOutError < WebDriverError; end # 28
+      class MoveTargetOutOfBoundsError < WebDriverError; end
 
       #
-      # The coordinates provided to an interactions operation are invalid.
+      # A command could not be completed because the element is not pointer or keyboard
+      # interactable.
       #
 
-      class InvalidElementCoordinatesError < WebDriverError; end # 29
+      class ElementNotInteractableError < WebDriverError; end
 
       #
-      # Indicates that IME support is not available. This exception is rasied
-      # for every IME-related method call if IME support is not available on
-      # the machine.
+      # A command could not be completed because TLS certificate is expired
+      # or invalid.
       #
 
-      class IMENotAvailableError < WebDriverError; end # 30
+      class InsecureCertificateError < WebDriverError; end
 
       #
-      # Indicates that activating an IME engine has failed.
+      # The arguments passed to a command are either invalid or malformed.
       #
 
-      class IMEEngineActivationFailedError < WebDriverError; end # 31
+      class InvalidArgumentError < WebDriverError; end
 
       #
-      # Argument was an invalid selector (e.g. XPath/CSS).
+      # No cookie matching the given path name was found amongst the associated cookies of the
+      # current browsing context's active document.
       #
 
-      class InvalidSelectorError < WebDriverError; end # 32
+      class NoSuchCookieError < WebDriverError; end
 
       #
-      # A new session could not be created.
+      # A screen capture was made impossible.
       #
 
-      class SessionNotCreatedError < WebDriverError; end # 33
-
-      #
-      # Indicates that the target provided to the actions #move method is
-      # invalid, e.g. outside of the bounds of the window.
-      #
-
-      class MoveTargetOutOfBoundsError < WebDriverError; end # 34
-
-      # @api private
-      ERRORS = [
-        IndexOutOfBoundsError,          # 1
-        NoCollectionError,              # 2
-        NoStringError,                  # 3
-        NoStringLengthError,            # 4
-        NoStringWrapperError,           # 5
-        NoSuchDriverError,              # 6
-        NoSuchElementError,             # 7
-        NoSuchFrameError,               # 8
-        UnknownCommandError,            # 9
-        StaleElementReferenceError,     # 10
-        ElementNotVisibleError,         # 11
-        InvalidElementStateError,       # 12
-        UnknownError,                   # 13
-        ExpectedError,                  # 14
-        ElementNotSelectableError,      # 15
-        NoSuchDocumentError,            # 16
-        JavascriptError,                # 17
-        NoScriptResultError,            # 18
-        XPathLookupError,               # 19
-        NoSuchCollectionError,          # 20
-        TimeOutError,                   # 21
-        NullPointerError,               # 22
-        NoSuchWindowError,              # 23
-        InvalidCookieDomainError,       # 24
-        UnableToSetCookieError,         # 25
-        UnhandledAlertError,            # 26
-        NoAlertPresentError,            # 27
-        ScriptTimeOutError,             # 28
-        InvalidElementCoordinatesError, # 29
-        IMENotAvailableError,           # 30
-        IMEEngineActivationFailedError, # 31
-        InvalidSelectorError,           # 32
-        SessionNotCreatedError,         # 33
-        MoveTargetOutOfBoundsError      # 34
-      ].freeze
-
-      class << self
-        def for_code(code)
-          return if [nil, 0].include? code
-          return ERRORS[code - 1] if code.is_a? Fixnum
-
-          klass_name = code.split(' ').map(&:capitalize).join
-          Error.const_get("#{klass_name.gsub('Error', '')}Error")
-        rescue NameError
-          WebDriverError
-        end
-      end
+      class UnableToCaptureScreenError < WebDriverError; end
+
+      #
+      # Occurs if the given session id is not in the list of active sessions, meaning the session
+      # either does not exist or that it's not active.
+      #
+
+      class InvalidSessionIdError < WebDriverError; end
+
+      #
+      # A modal dialog was open, blocking this operation.
+      #
+
+      class UnexpectedAlertOpenError < WebDriverError; end
+
+      #
+      # The requested command matched a known URL but did not match an method for that URL.
+      #
+
+      class UnknownMethodError < WebDriverError; end
+
+      #
+      # The Element Click command could not be completed because the element receiving the events
+      # is obscuring the element that was requested clicked.
+      #
+
+      class ElementClickInterceptedError < WebDriverError; end
+
+      #
+      # Indicates that a command that should have executed properly cannot be supported for some
+      # reason.
+      #
+
+      class UnsupportedOperationError < WebDriverError; end
+
     end # Error
   end # WebDriver
 end # Selenium