File: //lib/ruby/vendor_ruby/selenium/webdriver/edge/options.rb
# 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 Edge
class Options
attr_accessor :in_private, :start_page
attr_reader :extension_paths
#
# Create a new Options instance for Edge.
#
# @example
# options = Selenium::WebDriver::Edge::Options.new(in_private: true)
# driver = Selenium::WebDriver.for :edge, options: options
#
# @param [Hash] opts the pre-defined options to create the Edge::Options with
# @option opts [Boolean] :in_private Start in private mode. Default is false
# @option opts [Array<String>] :extension_paths A list of full paths to extensions to install on startup
# @option opts [String] :start_page Default page to start with
#
# @see https://docs.microsoft.com/en-us/microsoft-edge/webdriver
#
def initialize(**opts)
@in_private = opts.delete(:in_private) || false
@extension_paths = opts.delete(:extension_paths) || []
@start_page = opts.delete(:start_page)
end
#
# Add an extension by local path.
#
# @example
# options = Selenium::WebDriver::Edge::Options.new
# options.add_extension_path('C:\path\to\extension')
#
# @param [String] path The local path to the extension folder
#
def add_extension_path(path)
raise Error::WebDriverError, "could not find extension at #{path.inspect}" unless File.directory?(path)
@extension_paths << path
end
#
# @api private
#
def as_json(*)
opts = {}
opts['ms:inPrivate'] = true if @in_private
opts['ms:extensionPaths'] = @extension_paths if @extension_paths.any?
opts['ms:startPage'] = @start_page if @start_page
opts
end
end # Options
end # Edge
end # WebDriver
end # Selenium