Skip to content

Commit 30d0640

Browse files
titusfortnertitusfortner
committed
[rb] deprecate #add_option in favor of constructor and attr accessors
For options classes we want to limit what a user can set based on what the specific options class supports. This is the equivalent of removing direct setCapability() support
1 parent 7e6cd52 commit 30d0640

6 files changed

Lines changed: 101 additions & 19 deletions

File tree

‎rb/lib/selenium/webdriver/common/options.rb‎

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,13 @@ def initialize(**opts)
8585
#
8686

8787
def add_option(name, value = nil)
88-
@options[name.keys.first] = name.values.first if value.nil? && name.is_a?(Hash)
88+
name, value = name.first if value.nil? && name.is_a?(Hash)
89+
90+
unless name.to_s.include?(':')
91+
WebDriver.logger.deprecate('Options#add_option for w3c or browser specific capabilities',
92+
'applicable attribute accessors or pass into constructor',
93+
id: :add_option)
94+
end
8995
@options[name] = value
9096
end
9197

‎rb/spec/unit/selenium/webdriver/chrome/options_spec.rb‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -188,14 +188,28 @@ module Chrome
188188

189189
describe '#add_option' do
190190
it 'adds an option with ordered pairs' do
191-
options.add_option(:foo, 'bar')
191+
expect {
192+
options.add_option(:foo, 'bar')
193+
}.to have_deprecated(:add_option)
192194
expect(options.instance_variable_get(:@options)[:foo]).to eq('bar')
193195
end
194196

195197
it 'adds an option with Hash' do
196-
options.add_option(foo: 'bar')
198+
expect {
199+
options.add_option(foo: 'bar')
200+
}.to have_deprecated(:add_option)
197201
expect(options.instance_variable_get(:@options)[:foo]).to eq('bar')
198202
end
203+
204+
it 'adds vendor namespaced options with ordered pairs' do
205+
options.add_option('foo:bar', {bar: 'foo'})
206+
expect(options.instance_variable_get(:@options)['foo:bar']).to eq({bar: 'foo'})
207+
end
208+
209+
it 'adds vendor namespaced options with Hash' do
210+
options.add_option('foo:bar' => {bar: 'foo'})
211+
expect(options.instance_variable_get(:@options)['foo:bar']).to eq({bar: 'foo'})
212+
end
199213
end
200214

201215
describe '#add_preference' do
@@ -250,18 +264,24 @@ module Chrome
250264
end
251265

252266
it 'raises error when w3c is false' do
253-
options.add_option(:w3c, false)
267+
expect {
268+
options.add_option(:w3c, false)
269+
}.to have_deprecated(:add_option)
254270
expect { options.as_json }.to raise_error(Error::InvalidArgumentError)
255271
end
256272

257273
it 'raises error when w3c is true' do
258274
msg = /WARN Selenium \[:w3c\]/
259-
options.add_option(:w3c, true)
275+
expect {
276+
options.add_option(:w3c, true)
277+
}.to have_deprecated(:add_option)
260278
expect { options.as_json }.to output(msg).to_stdout_from_any_process
261279
end
262280

263281
it 'returns added options' do
264-
options.add_option(:foo, 'bar')
282+
expect {
283+
options.add_option(:foo, 'bar')
284+
}.to have_deprecated(:add_option)
265285
options.add_option('foo:bar', {foo: 'bar'})
266286
expect(options.as_json).to eq('browserName' => 'chrome',
267287
'foo:bar' => {'foo' => 'bar'},

‎rb/spec/unit/selenium/webdriver/common/options_spec.rb‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,12 +31,16 @@ module WebDriver
3131

3232
describe '#as_json' do
3333
it 'does not override options set via symbol name' do
34-
options.add_option(:local_state, {foo: 'bar'})
34+
expect {
35+
options.add_option(:local_state, {foo: 'bar'})
36+
}.to have_deprecated(:add_option)
3537
expect(options.as_json).to include('localState' => {'foo' => 'bar'})
3638
end
3739

3840
it 'does not override options set via string name' do
39-
options.add_option('localState', {foo: 'bar'})
41+
expect {
42+
options.add_option('localState', {foo: 'bar'})
43+
}.to have_deprecated(:add_option)
4044
expect(options.as_json).to include('localState' => {'foo' => 'bar'})
4145
end
4246
end

‎rb/spec/unit/selenium/webdriver/edge/options_spec.rb‎

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -143,14 +143,28 @@ module Edge
143143

144144
describe '#add_option' do
145145
it 'adds an option with ordered pairs' do
146-
options.add_option(:foo, 'bar')
146+
expect {
147+
options.add_option(:foo, 'bar')
148+
}.to have_deprecated(:add_option)
147149
expect(options.instance_variable_get(:@options)[:foo]).to eq('bar')
148150
end
149151

150152
it 'adds an option with Hash' do
151-
options.add_option(foo: 'bar')
153+
expect {
154+
options.add_option(foo: 'bar')
155+
}.to have_deprecated(:add_option)
152156
expect(options.instance_variable_get(:@options)[:foo]).to eq('bar')
153157
end
158+
159+
it 'adds vendor namespaced options with ordered pairs' do
160+
options.add_option('foo:bar', {bar: 'foo'})
161+
expect(options.instance_variable_get(:@options)['foo:bar']).to eq({bar: 'foo'})
162+
end
163+
164+
it 'adds vendor namespaced options with Hash' do
165+
options.add_option('foo:bar' => {bar: 'foo'})
166+
expect(options.instance_variable_get(:@options)['foo:bar']).to eq({bar: 'foo'})
167+
end
154168
end
155169

156170
describe '#add_preference' do
@@ -205,18 +219,24 @@ module Edge
205219
end
206220

207221
it 'raises error when w3c is false' do
208-
options.add_option(:w3c, false)
222+
expect {
223+
options.add_option(:w3c, false)
224+
}.to have_deprecated(:add_option)
209225
expect { options.as_json }.to raise_error(Error::InvalidArgumentError)
210226
end
211227

212228
it 'raises error when w3c is true' do
213229
msg = /WARN Selenium \[:w3c\]/
214-
options.add_option(:w3c, true)
230+
expect {
231+
options.add_option(:w3c, true)
232+
}.to have_deprecated(:add_option)
215233
expect { options.as_json }.to output(msg).to_stdout_from_any_process
216234
end
217235

218236
it 'returns added options' do
219-
options.add_option(:foo, 'bar')
237+
expect {
238+
options.add_option(:foo, 'bar')
239+
}.to have_deprecated(:add_option)
220240
options.add_option('foo:bar', {foo: 'bar'})
221241
expect(options.as_json).to eq('browserName' => 'MicrosoftEdge',
222242
'foo:bar' => {'foo' => 'bar'},

‎rb/spec/unit/selenium/webdriver/firefox/options_spec.rb‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -141,14 +141,28 @@ module Firefox
141141

142142
describe '#add_option' do
143143
it 'adds an option with ordered pairs' do
144-
options.add_option(:foo, 'bar')
144+
expect {
145+
options.add_option(:foo, 'bar')
146+
}.to have_deprecated(:add_option)
145147
expect(options.instance_variable_get(:@options)[:foo]).to eq('bar')
146148
end
147149

148150
it 'adds an option with Hash' do
149-
options.add_option(foo: 'bar')
151+
expect {
152+
options.add_option(foo: 'bar')
153+
}.to have_deprecated(:add_option)
150154
expect(options.instance_variable_get(:@options)[:foo]).to eq('bar')
151155
end
156+
157+
it 'adds vendor namespaced options with ordered pairs' do
158+
options.add_option('foo:bar', {bar: 'foo'})
159+
expect(options.instance_variable_get(:@options)['foo:bar']).to eq({bar: 'foo'})
160+
end
161+
162+
it 'adds vendor namespaced options with Hash' do
163+
options.add_option('foo:bar' => {bar: 'foo'})
164+
expect(options.instance_variable_get(:@options)['foo:bar']).to eq({bar: 'foo'})
165+
end
152166
end
153167

154168
describe '#add_preference' do
@@ -197,7 +211,9 @@ module Firefox
197211
end
198212

199213
it 'returns added options' do
200-
options.add_option(:foo, 'bar')
214+
expect {
215+
options.add_option(foo: 'bar')
216+
}.to have_deprecated(:add_option)
201217
options.add_option('foo:bar', {foo: 'bar'})
202218
expect(options.as_json).to eq('acceptInsecureCerts' => true,
203219
'browserName' => 'firefox',

‎rb/spec/unit/selenium/webdriver/ie/options_spec.rb‎

Lines changed: 19 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -103,14 +103,28 @@ module IE
103103

104104
describe '#add_option' do
105105
it 'adds an option with ordered pairs' do
106-
options.add_option(:foo, 'bar')
106+
expect {
107+
options.add_option(:foo, 'bar')
108+
}.to have_deprecated(:add_option)
107109
expect(options.instance_variable_get(:@options)[:foo]).to eq('bar')
108110
end
109111

110112
it 'adds an option with Hash' do
111-
options.add_option(foo: 'bar')
113+
expect {
114+
options.add_option(foo: 'bar')
115+
}.to have_deprecated(:add_option)
112116
expect(options.instance_variable_get(:@options)[:foo]).to eq('bar')
113117
end
118+
119+
it 'adds vendor namespaced options with ordered pairs' do
120+
options.add_option('foo:bar', {bar: 'foo'})
121+
expect(options.instance_variable_get(:@options)['foo:bar']).to eq({bar: 'foo'})
122+
end
123+
124+
it 'adds vendor namespaced options with Hash' do
125+
options.add_option('foo:bar' => {bar: 'foo'})
126+
expect(options.instance_variable_get(:@options)['foo:bar']).to eq({bar: 'foo'})
127+
end
114128
end
115129

116130
describe '#as_json' do
@@ -120,7 +134,9 @@ module IE
120134
end
121135

122136
it 'returns added options' do
123-
options.add_option(:foo, 'bar')
137+
expect {
138+
options.add_option(:foo, 'bar')
139+
}.to have_deprecated(:add_option)
124140
options.add_option('foo:bar', {foo: 'bar'})
125141
expect(options.as_json).to eq('browserName' => 'internet explorer',
126142
'foo:bar' => {'foo' => 'bar'},

0 commit comments

Comments
 (0)