1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
|
# 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 Options
W3C_OPTIONS = %i[browser_name browser_version platform_name accept_insecure_certs page_load_strategy proxy
set_window_rect timeouts unhandled_prompt_behavior strict_file_interactability
web_socket_url].freeze
GRID_OPTIONS = %i[enable_downloads].freeze
class << self
attr_reader :driver_path
def chrome(**)
Chrome::Options.new(**)
end
def firefox(**)
Firefox::Options.new(**)
end
def ie(**)
IE::Options.new(**)
end
alias internet_explorer ie
def edge(**)
Edge::Options.new(**)
end
alias microsoftedge edge
def safari(**)
Safari::Options.new(**)
end
def set_capabilities
(W3C_OPTIONS + GRID_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
end
attr_accessor :options
def initialize(**opts)
self.class.set_capabilities
@options = opts
@options[:browser_name] = self.class::BROWSER
end
#
# 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
#
def add_option(name, value = nil)
name, value = name.first if value.nil? && name.is_a?(Hash)
@options[name] = value
end
def ==(other)
return false unless other.is_a? self.class
as_json == other.as_json
end
alias eql? ==
#
# @api private
#
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
def w3c?(key)
W3C_OPTIONS.include?(key) || key.to_s.include?(':')
end
def process_w3c_options(options)
w3c_options = options.select { |key, val| w3c?(key) && !val.nil? }
w3c_options[:unhandled_prompt_behavior] &&=
process_unhandled_prompt_behavior_value(w3c_options[:unhandled_prompt_behavior])
options.delete_if { |key, _val| w3c?(key) }
w3c_options
end
def process_unhandled_prompt_behavior_value(value)
if value.is_a?(Hash)
value.transform_values { |v| process_unhandled_prompt_behavior_value(v) }
else
value&.to_s&.tr('_', ' ')
end
end
def process_browser_options(_browser_options)
nil
end
def camelize?(_key)
true
end
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
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
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
def camel_case(str)
str.gsub(/_([a-z])/) { Regexp.last_match(1)&.upcase }
end
end # Options
end # WebDriver
end # Selenium
|
