Class: Capybara::Webkit::Driver

Inherits:
Driver::Base
  • Object
show all
Defined in:
lib/capybara/webkit/driver.rb

Instance Method Summary collapse

Constructor Details

#initialize(app, options = {}) ⇒ Driver

Returns a new instance of Driver.



12
13
14
15
16
17
18
 
# File 'lib/capybara/webkit/driver.rb', line 12

def initialize(app, options={})
  @app = app
  @options = options.dup
  @options[:server] ||= Server.new(options)
  @browser = options[:browser] || Browser.new(Connection.new(@options))
  apply_options
end

Instance Method Details

#accept_js_confirms! ⇒ Object 



202
203
204
205
206
 
# File 'lib/capybara/webkit/driver.rb', line 202

def accept_js_confirms!
  warn '[DEPRECATION] Capybara::Webkit::Driver#accept_js_confirms! ' \
    'is deprecated. Please use Capybara::Session#accept_confirm instead.'
  @browser.accept_js_confirms
end

#accept_js_prompts! ⇒ Object 



214
215
216
217
218
 
# File 'lib/capybara/webkit/driver.rb', line 214

def accept_js_prompts!
  warn '[DEPRECATION] Capybara::Webkit::Driver#accept_js_prompts! ' \
    'is deprecated. Please use Capybara::Session#accept_prompt instead.'
  @browser.accept_js_prompts
end

#accept_modal(type, options = {}) ⇒ Object 



244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
 
# File 'lib/capybara/webkit/driver.rb', line 244

def accept_modal(type, options={})
  options = modal_action_options_for_browser(options)

  case type
  when :confirm
    id = @browser.accept_confirm(options)
  when :prompt
    id = @browser.accept_prompt(options)
  else
    id = @browser.accept_alert(options)
  end

  yield

  find_modal(type, id, options)
end

#alert_messages ⇒ Object 



102
103
104
105
106
 
# File 'lib/capybara/webkit/driver.rb', line 102

def alert_messages
  warn '[DEPRECATION] Capybara::Webkit::Driver#alert_messages ' \
    'is deprecated. Please use Capybara::Session#accept_alert instead.'
  @browser.alert_messages
end

#allow_unknown_urls ⇒ Object 



40
41
42
43
 
# File 'lib/capybara/webkit/driver.rb', line 40

def allow_unknown_urls
  deprecate_and_replace_with_config "allow_unknown_urls"
  @browser.allow_url("*")
end

#allow_url(url) ⇒ Object 



25
26
27
28
 
# File 'lib/capybara/webkit/driver.rb', line 25

def allow_url(url)
  deprecate_and_replace_with_config "allow_url", "allow_url(#{url.inspect})"
  @browser.allow_url(url)
end

#authenticate(username, password) ⇒ Object 



329
330
331
 
# File 'lib/capybara/webkit/driver.rb', line 329

def authenticate(username, password)
  @browser.authenticate(username, password)
end

#block_unknown_urls ⇒ Object 



35
36
37
38
 
# File 'lib/capybara/webkit/driver.rb', line 35

def block_unknown_urls
  deprecate_and_replace_with_config "block_unknown_urls"
  @browser.block_unknown_urls
end

#block_url(url) ⇒ Object 



30
31
32
33
 
# File 'lib/capybara/webkit/driver.rb', line 30

def block_url(url)
  deprecate_and_replace_with_config "block_url", "block_url(#{url.inspect})"
  @browser.block_url(url)
end

#browser ⇒ Object 



346
347
348
349
 
# File 'lib/capybara/webkit/driver.rb', line 346

def browser
  warn "[DEPRECATION] Capybara::Webkit::Driver#browser is deprecated."
  @browser
end

#clear_cookies ⇒ Object 



308
309
310
 
# File 'lib/capybara/webkit/driver.rb', line 308

def clear_cookies
  @browser.clear_cookies
end

#close_window(selector) ⇒ Object 



194
195
196
 
# File 'lib/capybara/webkit/driver.rb', line 194

def close_window(selector)
  @browser.window_close(selector)
end

#confirm_messages ⇒ Object 



108
109
110
111
112
113
 
# File 'lib/capybara/webkit/driver.rb', line 108

def confirm_messages
  warn '[DEPRECATION] Capybara::Webkit::Driver#confirm_messages ' \
    'is deprecated. Please use Capybara::Session#accept_confirm ' \
    'or Capybara::Session#dismiss_confirm instead.'
  @browser.confirm_messages
end

#console_messages ⇒ Object 



94
95
96
 
# File 'lib/capybara/webkit/driver.rb', line 94

def console_messages
  @browser.console_messages
end

#cookies ⇒ Object 



300
301
302
 
# File 'lib/capybara/webkit/driver.rb', line 300

def cookies
  @cookie_jar ||= CookieJar.new(@browser)
end

#current_url ⇒ Object 



45
46
47
 
# File 'lib/capybara/webkit/driver.rb', line 45

def current_url
  @browser.current_url
end

#current_window_handle ⇒ Object 



186
187
188
 
# File 'lib/capybara/webkit/driver.rb', line 186

def current_window_handle
  @browser.get_window_handle
end

#dismiss_js_confirms! ⇒ Object 



208
209
210
211
212
 
# File 'lib/capybara/webkit/driver.rb', line 208

def dismiss_js_confirms!
  warn '[DEPRECATION] Capybara::Webkit::Driver#dismiss_js_confirms! ' \
    'is deprecated. Please use Capybara::Session#dismiss_confirm instead.'
  @browser.reject_js_confirms
end

#dismiss_js_prompts! ⇒ Object 



220
221
222
223
224
 
# File 'lib/capybara/webkit/driver.rb', line 220

def dismiss_js_prompts!
  warn '[DEPRECATION] Capybara::Webkit::Driver#dismiss_js_prompts! ' \
    'is deprecated. Please use Capybara::Session#dismiss_prompt instead.'
  @browser.reject_js_prompts
end

#dismiss_modal(type, options = {}) ⇒ Object 



261
262
263
264
265
266
267
268
269
270
271
272
273
274
 
# File 'lib/capybara/webkit/driver.rb', line 261

def dismiss_modal(type, options={})
  options = modal_action_options_for_browser(options)

  case type
  when :confirm
    id = @browser.reject_confirm(options)
  else
    id = @browser.reject_prompt(options)
  end

  yield

  find_modal(type, id, options)
end

#enable_logging ⇒ Object 



20
21
22
23
 
# File 'lib/capybara/webkit/driver.rb', line 20

def enable_logging
  deprecate_and_replace_with_config "enable_logging", "debug = true"
  @browser.enable_logging
end

#error_messages ⇒ Object 



98
99
100
 
# File 'lib/capybara/webkit/driver.rb', line 98

def error_messages
  @browser.error_messages
end

#evaluate_script(script, *args) ⇒ Object 



89
90
91
92
 
# File 'lib/capybara/webkit/driver.rb', line 89

def evaluate_script(script, *args)
  result = @browser.evaluate_script(script, *encode_args(args))
  decode_result(result)
end

#execute_script(script, *args) ⇒ Object 



79
80
81
82
83
84
85
86
87
 
# File 'lib/capybara/webkit/driver.rb', line 79

def execute_script(script, *args)
  value = @browser.execute_script(script, *encode_args(args))

  if value.empty?
    nil
  else
    value
  end
end

#find_css(selector) ⇒ Object 



61
62
63
64
65
 
# File 'lib/capybara/webkit/driver.rb', line 61

def find_css(selector)
  @browser.
    find_css(selector).
    map { |native| Node.new(self, native, @browser) }
end

#find_xpath(xpath) ⇒ Object Also known as: find 



53
54
55
56
57
 
# File 'lib/capybara/webkit/driver.rb', line 53

def find_xpath(xpath)
  @browser.
    find_xpath(xpath).
    map { |native| Node.new(self, native, @browser) }
end

#go_back ⇒ Object 



236
237
238
 
# File 'lib/capybara/webkit/driver.rb', line 236

def go_back
  @browser.go_back
end

#go_forward ⇒ Object 



240
241
242
 
# File 'lib/capybara/webkit/driver.rb', line 240

def go_forward
  @browser.go_forward
end

#has_shortcircuit_timeout? ⇒ Boolean

Returns:

  • (Boolean) 


289
290
291
 
# File 'lib/capybara/webkit/driver.rb', line 289

def has_shortcircuit_timeout?
  false
end

#header(key, value) ⇒ Object 



71
72
73
 
# File 'lib/capybara/webkit/driver.rb', line 71

def header(key, value)
  @browser.header(key, value)
end

#html ⇒ Object 



67
68
69
 
# File 'lib/capybara/webkit/driver.rb', line 67

def html
  @browser.body
end

#invalid_element_errors ⇒ Object 



312
313
314
315
 
# File 'lib/capybara/webkit/driver.rb', line 312

def invalid_element_errors
  [Capybara::Webkit::ClickFailed,
   Capybara::Webkit::NodeNotAttachedError]
end

#js_prompt_input=(value) ⇒ Object 



226
227
228
229
230
231
232
233
234
 
# File 'lib/capybara/webkit/driver.rb', line 226

def js_prompt_input=(value)
  warn '[DEPRECATION] Capybara::Webkit::Driver#js_prompt_input= ' \
    'is deprecated. Please use Capybara::Session#accept_prompt instead.'
  if value.nil?
    @browser.clear_prompt_text
  else
    @browser.set_prompt_text_to(value)
  end
end

#maximize_window(selector) ⇒ Object 



198
199
200
 
# File 'lib/capybara/webkit/driver.rb', line 198

def maximize_window(selector)
  @browser.window_maximize(selector)
end

#needs_server? ⇒ Boolean

Returns:

  • (Boolean) 


280
281
282
 
# File 'lib/capybara/webkit/driver.rb', line 280

def needs_server?
  true
end

#no_such_window_error ⇒ Object 



317
318
319
 
# File 'lib/capybara/webkit/driver.rb', line 317

def no_such_window_error
  Capybara::Webkit::NoSuchWindowError
end

#open_new_window ⇒ Object 



190
191
192
 
# File 'lib/capybara/webkit/driver.rb', line 190

def open_new_window
  @browser.window_open
end

#prompt_messages ⇒ Object 



115
116
117
118
119
120
 
# File 'lib/capybara/webkit/driver.rb', line 115

def prompt_messages
  warn '[DEPRECATION] Capybara::Webkit::Driver#prompt_messages ' \
    'is deprecated. Please use Capybara::Session#accept_prompt ' \
    'or Capybara::Session#dismiss_prompt instead.'
  @browser.prompt_messages
end

#reset! ⇒ Object 



284
285
286
287
 
# File 'lib/capybara/webkit/driver.rb', line 284

def reset!
  @browser.reset!
  apply_options
end

#resize_window(width, height) ⇒ Object 



130
131
132
133
134
 
# File 'lib/capybara/webkit/driver.rb', line 130

def resize_window(width, height)
  warn '[DEPRECATION] Capybara::Webkit::Driver#resize_window ' \
    'is deprecated. Please use Capybara::Window#resize_to instead.'
  resize_window_to(current_window_handle, width, height)
end

#resize_window_to(handle, width, height) ⇒ Object 



136
137
138
 
# File 'lib/capybara/webkit/driver.rb', line 136

def resize_window_to(handle, width, height)
  @browser.window_resize(handle, width, height)
end

#response_headers ⇒ Object 



122
123
124
 
# File 'lib/capybara/webkit/driver.rb', line 122

def response_headers
  @browser.response_headers
end

#save_screenshot(path, options = {}) ⇒ Object 



293
294
295
296
297
298
 
# File 'lib/capybara/webkit/driver.rb', line 293

def save_screenshot(path, options={})
  options[:width]  ||= 1000
  options[:height] ||= 10

  @browser.render path, options[:width], options[:height]
end

#set_cookie(cookie) ⇒ Object 



304
305
306
 
# File 'lib/capybara/webkit/driver.rb', line 304

def set_cookie(cookie)
  @browser.set_cookie(cookie)
end

#status_code ⇒ Object 



126
127
128
 
# File 'lib/capybara/webkit/driver.rb', line 126

def status_code
  @browser.status_code
end

#switch_to_frame(frame) ⇒ Object 



153
154
155
156
157
158
159
160
161
162
163
164
165
166
 
# File 'lib/capybara/webkit/driver.rb', line 153

def switch_to_frame(frame)
  case frame
  when :top
    begin
      loop { @browser.frame_focus }
    rescue Capybara::Webkit::InvalidResponseError => e
      raise unless e.message =~ /Already at parent frame/
    end
  when :parent
    @browser.frame_focus
  else
    @browser.frame_focus(frame)
  end
end

#switch_to_window(selector) ⇒ Object 



178
179
180
 
# File 'lib/capybara/webkit/driver.rb', line 178

def switch_to_window(selector)
  @browser.window_focus(selector)
end

#timeout ⇒ Object 



333
334
335
336
 
# File 'lib/capybara/webkit/driver.rb', line 333

def timeout
  deprecate_and_replace_with_config "timeout"
  @browser.timeout
end

#timeout=(timeout) ⇒ Object 



338
339
340
341
342
343
344
 
# File 'lib/capybara/webkit/driver.rb', line 338

def timeout=(timeout)
  deprecate_and_replace_with_config(
    "timeout=",
    "timeout = #{timeout.inspect}"
  )
  @browser.timeout = timeout
end

#title ⇒ Object 



75
76
77
 
# File 'lib/capybara/webkit/driver.rb', line 75

def title
  @browser.title
end

#version ⇒ Object 



321
322
323
324
325
326
327
 
# File 'lib/capybara/webkit/driver.rb', line 321

def version
  [
    "Capybara: #{Capybara::VERSION}",
    "capybara-webkit: #{Capybara::Driver::Webkit::VERSION}",
    @browser.version
  ].join("\n")
end

#visit(path) ⇒ Object 



49
50
51
 
# File 'lib/capybara/webkit/driver.rb', line 49

def visit(path)
  @browser.visit(path)
end

#wait? ⇒ Boolean

Returns:

  • (Boolean) 


276
277
278
 
# File 'lib/capybara/webkit/driver.rb', line 276

def wait?
  true
end

#window_handles ⇒ Object 



182
183
184
 
# File 'lib/capybara/webkit/driver.rb', line 182

def window_handles
  @browser.get_window_handles
end

#window_size(handle) ⇒ Object 



140
141
142
 
# File 'lib/capybara/webkit/driver.rb', line 140

def window_size(handle)
  @browser.window_size(handle)
end

#within_frame(selector) ⇒ Object 



144
145
146
147
148
149
150
151
 
# File 'lib/capybara/webkit/driver.rb', line 144

def within_frame(selector)
  @browser.frame_focus(selector)
  begin
    yield
  ensure
    @browser.frame_focus
  end
end

#within_window(selector) ⇒ Object 



168
169
170
171
172
173
174
175
176
 
# File 'lib/capybara/webkit/driver.rb', line 168

def within_window(selector)
  current_window = current_window_handle
  switch_to_window(selector)
  begin
    yield
  ensure
    @browser.window_focus(current_window)
  end
end