selenium-webdriver 3.141.0 → 3.141.592

data/lib/selenium/webdriver/common/file_reaper.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
@@ -41,9 +43,7 @@ module Selenium
         def reap(file)
           return unless reap?
 
-          unless tmp_files.include?(file)
-            raise Error::WebDriverError, "file not added for reaping: #{file.inspect}"
-          end
+          raise Error::WebDriverError, "file not added for reaping: #{file.inspect}" unless tmp_files.include?(file)
 
           FileUtils.rm_rf tmp_files.delete(file)
         end

data/lib/selenium/webdriver/common/html5/local_storage.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/html5/session_storage.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/html5/shared_web_storage.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
@@ -30,6 +32,7 @@ module Selenium
         def fetch(key)
           return self[key] if key? key
           return yield(key) if block_given?
+
           raise KeyError, "missing key #{key.inspect}"
         end
 
@@ -40,7 +43,7 @@ module Selenium
         def each
           return enum_for(:each) unless block_given?
 
-          keys.each do |k| # rubocop:disable Performance/HashEachMethods
+          keys.each do |k|
             yield k, self[k]
           end
         end

data/lib/selenium/webdriver/common/interactions/input_device.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
@@ -30,6 +32,7 @@ module Selenium
 
         def add_action(action)
           raise TypeError, "#{action.inspect} is not a valid action" unless action.class < Interaction
+
           @actions << action
         end
 

data/lib/selenium/webdriver/common/interactions/interaction.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,6 +27,7 @@ module Selenium
 
         def initialize(source)
           raise TypeError, "#{source.type} is not a valid input type" unless Interactions::SOURCE_TYPES.include? source.type
+
           @source = source
         end
       end

data/lib/selenium/webdriver/common/interactions/interactions.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
@@ -13,7 +15,7 @@
 # "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
+# under the License.
 
 module Selenium
   module WebDriver

data/lib/selenium/webdriver/common/interactions/key_actions.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/interactions/key_input.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
@@ -27,6 +29,7 @@ module Selenium
 
         def encode
           return nil if no_actions?
+
           {type: type, id: name, actions: @actions.map(&:encode)}
         end
 
@@ -49,6 +52,7 @@ module Selenium
 
           def assert_type(type)
             raise TypeError, "#{type.inspect} is not a valid key subtype" unless KeyInput::SUBTYPES.key? type
+
             KeyInput::SUBTYPES[type]
           end
 

data/lib/selenium/webdriver/common/interactions/none_input.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,6 +27,7 @@ module Selenium
 
         def encode
           return nil if no_actions?
+
           {type: type, id: name, actions: @actions.map(&:encode)}
         end
       end # NoneInput

data/lib/selenium/webdriver/common/interactions/pointer_actions.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/interactions/pointer_input.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
@@ -34,6 +36,7 @@ module Selenium
 
         def encode
           return nil if no_actions?
+
           output = {type: type, id: name, actions: @actions.map(&:encode)}
           output[:parameters] = {pointerType: kind}
           output
@@ -41,6 +44,7 @@ module Selenium
 
         def assert_kind(pointer)
           raise TypeError, "#{pointer.inspect} is not a valid pointer type" unless KIND.key? pointer
+
           KIND[pointer]
         end
 
@@ -78,14 +82,17 @@ module Selenium
         def assert_button(button)
           if button.is_a? Symbol
             raise TypeError, "#{button.inspect} is not a valid button!" unless BUTTONS.key? button
+
             button = BUTTONS[button]
           end
           raise ArgumentError, 'Button number cannot be negative!' unless button >= 0
+
           button
         end
 
         def assert_direction(direction)
           raise TypeError, "#{direction.inspect} is not a valid button direction" unless DIRECTIONS.key? direction
+
           DIRECTIONS[direction]
         end
 

data/lib/selenium/webdriver/common/keyboard.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
@@ -56,10 +58,11 @@ module Selenium
 
       private
 
-      MODIFIERS = [:control, :shift, :alt, :command, :meta].freeze
+      MODIFIERS = %i[control shift alt command meta].freeze
 
       def assert_modifier(key)
         return if MODIFIERS.include? key
+
         raise ArgumentError, "#{key.inspect} is not a modifier key, expected one of #{MODIFIERS.inspect}"
       end
     end # Keyboard

data/lib/selenium/webdriver/common/keys.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
@@ -110,6 +112,7 @@ module Selenium
 
       def self.[](key)
         return KEYS[key] if KEYS[key]
+
         raise Error::UnsupportedOperationError, "no such key #{key.inspect}"
       end
 

data/lib/selenium/webdriver/common/log_entry.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
@@ -28,9 +30,9 @@ module Selenium
 
       def as_json(*)
         {
-          'level'     => level,
+          'level' => level,
           'timestamp' => timestamp,
-          'message'   => message
+          'message' => message
         }
       end
 

data/lib/selenium/webdriver/common/logger.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
@@ -33,54 +35,27 @@ module Selenium
     #
     class Logger
       extend Forwardable
-      include ::Logger::Severity
 
-      def_delegators :@logger, :debug, :debug?,
+      def_delegators :@logger,
+                     :close,
+                     :debug, :debug?,
                      :info, :info?,
                      :warn, :warn?,
                      :error, :error?,
                      :fatal, :fatal?,
-                     :level
+                     :level, :level=
 
       def initialize
         @logger = create_logger($stdout)
       end
 
-      def output=(io)
-        # `Logger#reopen` was added in Ruby 2.3
-        if @logger.respond_to?(:reopen)
-          @logger.reopen(io)
-        else
-          @logger = create_logger(io)
-        end
-      end
-
       #
-      # For Ruby < 2.3 compatibility
-      # Based on https://github.com/ruby/ruby/blob/ruby_2_3/lib/logger.rb#L250
+      # Changes logger output to a new IO.
       #
-
-      def level=(severity)
-        if severity.is_a?(Integer)
-          @logger.level = severity
-        else
-          case severity.to_s.downcase
-          when 'debug'.freeze
-            @logger.level = DEBUG
-          when 'info'.freeze
-            @logger.level = INFO
-          when 'warn'.freeze
-            @logger.level = WARN
-          when 'error'.freeze
-            @logger.level = ERROR
-          when 'fatal'.freeze
-            @logger.level = FATAL
-          when 'unknown'.freeze
-            @logger.level = UNKNOWN
-          else
-            raise ArgumentError, "invalid log level: #{severity}"
-          end
-        end
+      # @param [String] io
+      #
+      def output=(io)
+        @logger.reopen(io)
       end
 
       #
@@ -95,7 +70,7 @@ module Selenium
       # @api private
       #
       def io
-        @logger.instance_variable_get(:@logdev).instance_variable_get(:@dev)
+        @logger.instance_variable_get(:@logdev).dev
       end
 
       #
@@ -105,7 +80,7 @@ module Selenium
       # @param [String, nil] new
       #
       def deprecate(old, new = nil)
-        message = "[DEPRECATION] #{old} is deprecated"
+        message = +"[DEPRECATION] #{old} is deprecated"
         message << if new
                      ". Use #{new} instead."
                    else
@@ -130,9 +105,9 @@ module Selenium
 
       def default_level
         if $DEBUG || ENV.key?('DEBUG')
-          DEBUG
+          :debug
         else
-          WARN
+          :warn
         end
       end
     end # Logger

data/lib/selenium/webdriver/common/logs.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/manager.rb

@@ -0,0 +1,177 @@
+# 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
+    class Manager
+      #
+      # @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
+
+      #
+      # Create a new top-level browsing context
+      # https://w3c.github.io/webdriver/#new-window
+      # @param type [Symbol] Supports two values: :tab and :window.
+      #  Use :tab if you'd like the new window to share an OS-level window
+      #  with the current browsing context.
+      #  Use :window otherwise
+      # @return [String] The value of the window handle
+      #
+      def new_window(type = :tab)
+        case type
+        when :tab, :window
+          result = @bridge.new_window(type)
+          unless result.key?('handle')
+            raise UnknownError, "the driver did not return a handle. " \
+                                "The returned result: #{result.inspect}"
+          end
+          result['handle']
+        else
+          raise ArgumentError, "invalid argument for type. Got: '#{type.inspect}'. " \
+                               "Try :tab or :window"
+        end
+      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
+
+      def datetime_at(int)
+        DateTime.civil(1970) + (int / SECONDS_PER_DAY)
+      end
+
+      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}"
+        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
+  end # WebDriver
+end # Selenium