class Selenium::WebDriver::Options
Constants
- GRID_OPTIONS
- W3C_OPTIONS
Attributes
driver_path[R]
options[RW]
Public Class Methods
chrome(**opts)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 32 def chrome(**opts) Chrome::Options.new(**opts) end
edge(**opts)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 45 def edge(**opts) Edge::Options.new(**opts) end
Also aliased as: microsoftedge
firefox(**opts)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 36 def firefox(**opts) Firefox::Options.new(**opts) end
ie(**opts)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 40 def ie(**opts) IE::Options.new(**opts) end
Also aliased as: internet_explorer
new(**opts)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 71 def initialize(**opts) self.class.set_capabilities @options = opts @options[:browser_name] = self.class::BROWSER end
safari(**opts)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 50 def safari(**opts) Safari::Options.new(**opts) end
set_capabilities()
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 54 def set_capabilities (W3C_OPTIONS + self::CAPABILITIES.keys).each do |key| next if method_defined? key define_method key do @options[key] end define_method :"#{key}=" do |value| @options[key] = value end end end
Public Instance Methods
==(other)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 94 def ==(other) return false unless other.is_a? self.class as_json == other.as_json end
Also aliased as: eql?
add_option(name, value = nil)
click to toggle source
Add a new option not yet handled by bindings.
@example Leave Chrome
open when chromedriver is killed
options = Selenium::WebDriver::Chrome::Options.new options.add_option(:detach, true)
@param [String, Symbol] name Name of the option @param [Boolean, String, Integer] value Value of the option
# File lib/selenium/webdriver/common/options.rb, line 89 def add_option(name, value = nil) name, value = name.first if value.nil? && name.is_a?(Hash) @options[name] = value end
as_json(*)
click to toggle source
@api private
# File lib/selenium/webdriver/common/options.rb, line 106 def as_json(*) options = @options.dup downloads = options.delete(:enable_downloads) options['se:downloadsEnabled'] = downloads unless downloads.nil? w3c_options = process_w3c_options(options) browser_options = self.class::CAPABILITIES.each_with_object({}) do |(capability_alias, capability_name), hash| capability_value = options.delete(capability_alias) hash[capability_name] = capability_value unless capability_value.nil? end raise Error::WebDriverError, "These options are not w3c compliant: #{options}" unless options.empty? browser_options = {self.class::KEY => browser_options} if defined?(self.class::KEY) process_browser_options(browser_options) generate_as_json(w3c_options.merge(browser_options)) end
Private Instance Methods
camel_case(str)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 179 def camel_case(str) str.gsub(/_([a-z])/) { Regexp.last_match(1)&.upcase } end
camelize?(_key)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 143 def camelize?(_key) true end
convert_json_key(key, camelize: true)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 171 def convert_json_key(key, camelize: true) key = key.to_s if key.is_a?(Symbol) key = camel_case(key) if camelize return key if key.is_a?(String) raise TypeError, "expected String or Symbol, got #{key.inspect}:#{key.class}" end
generate_as_json(value, camelize_keys: true)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 147 def generate_as_json(value, camelize_keys: true) if value.is_a?(Hash) process_json_hash(value, camelize_keys) elsif value.respond_to?(:as_json) value.as_json elsif value.is_a?(Array) value.map { |val| generate_as_json(val, camelize_keys: camelize_keys) } elsif value.is_a?(Symbol) value.to_s else value end end
process_browser_options(_browser_options)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 139 def process_browser_options(_browser_options) nil end
process_json_hash(value, camelize_keys)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 161 def process_json_hash(value, camelize_keys) value.each_with_object({}) do |(key, val), hash| next if val.respond_to?(:empty?) && val.empty? camelize = camelize_keys ? camelize?(key) : false key = convert_json_key(key, camelize: camelize) hash[key] = generate_as_json(val, camelize_keys: camelize) end end
process_w3c_options(options)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 132 def process_w3c_options(options) w3c_options = options.select { |key, val| w3c?(key) && !val.nil? } w3c_options[:unhandled_prompt_behavior] &&= w3c_options[:unhandled_prompt_behavior]&.to_s&.tr('_', ' ') options.delete_if { |key, _val| w3c?(key) } w3c_options end
w3c?(key)
click to toggle source
# File lib/selenium/webdriver/common/options.rb, line 128 def w3c?(key) W3C_OPTIONS.include?(key) || key.to_s.include?(':') end