Class: Capybara::Poltergeist::Browser

Inherits:
Object
  • Object
show all
Defined in:
lib/capybara/poltergeist/browser.rb

Constant Summary collapse

ERROR_MAPPINGS = 
{
  'Poltergeist.JavascriptError' => JavascriptError,
  'Poltergeist.FrameNotFound'   => FrameNotFound,
  'Poltergeist.InvalidSelector' => InvalidSelector,
  'Poltergeist.StatusFailError' => StatusFailError,
  'Poltergeist.NoSuchWindowError' => NoSuchWindowError,
  'Poltergeist.UnsupportedFeature' => UnsupportedFeature,
  'Poltergeist.KeyError' => KeyError,
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(server, client, logger = nil) ⇒ Browser

Returns a new instance of Browser.



20
21
22
23
24
 
# File 'lib/capybara/poltergeist/browser.rb', line 20

def initialize(server, client, logger = nil)
  @server = server
  @client = client
  @logger = logger
end

Instance Attribute Details

#client ⇒ Object (readonly)

Returns the value of attribute client.



18
19
20
 
# File 'lib/capybara/poltergeist/browser.rb', line 18

def client
  @client
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



18
19
20
 
# File 'lib/capybara/poltergeist/browser.rb', line 18

def logger
  @logger
end

#server ⇒ Object (readonly)

Returns the value of attribute server.



18
19
20
 
# File 'lib/capybara/poltergeist/browser.rb', line 18

def server
  @server
end

Instance Method Details

#accept_confirm ⇒ Object 



394
395
396
 
# File 'lib/capybara/poltergeist/browser.rb', line 394

def accept_confirm
  command 'set_confirm_process', true
end

#accept_prompt(response) ⇒ Object

press “OK” with text (response) or default value



405
406
407
 
# File 'lib/capybara/poltergeist/browser.rb', line 405

def accept_prompt(response)
  command 'set_prompt_response', response || false
end

#add_header(header, options = {}) ⇒ Object 



301
302
303
 
# File 'lib/capybara/poltergeist/browser.rb', line 301

def add_header(header, options={})
  command 'add_header', header, options
end

#add_headers(headers) ⇒ Object 



297
298
299
 
# File 'lib/capybara/poltergeist/browser.rb', line 297

def add_headers(headers)
  command 'add_headers', headers
end

#all_text(page_id, id) ⇒ Object 



72
73
74
 
# File 'lib/capybara/poltergeist/browser.rb', line 72

def all_text(page_id, id)
  command 'all_text', page_id, id
end

#attribute(page_id, id, name) ⇒ Object 



92
93
94
 
# File 'lib/capybara/poltergeist/browser.rb', line 92

def attribute(page_id, id, name)
  command 'attribute', page_id, id, name.to_s
end

#attributes(page_id, id) ⇒ Object 



88
89
90
 
# File 'lib/capybara/poltergeist/browser.rb', line 88

def attributes(page_id, id)
  command 'attributes', page_id, id
end

#body ⇒ Object 



47
48
49
 
# File 'lib/capybara/poltergeist/browser.rb', line 47

def body
  command 'body'
end

#clear_cookies ⇒ Object 



325
326
327
 
# File 'lib/capybara/poltergeist/browser.rb', line 325

def clear_cookies
  command 'clear_cookies'
end

#clear_memory_cache ⇒ Object 



362
363
364
 
# File 'lib/capybara/poltergeist/browser.rb', line 362

def clear_memory_cache
  command 'clear_memory_cache'
end

#clear_network_traffic ⇒ Object 



274
275
276
 
# File 'lib/capybara/poltergeist/browser.rb', line 274

def clear_network_traffic
  command('clear_network_traffic')
end

#click(page_id, id) ⇒ Object 



192
193
194
 
# File 'lib/capybara/poltergeist/browser.rb', line 192

def click(page_id, id)
  command 'click', page_id, id
end

#click_coordinates(x, y) ⇒ Object 



120
121
122
 
# File 'lib/capybara/poltergeist/browser.rb', line 120

def click_coordinates(x, y)
  command 'click_coordinates', x, y
end

#close_window(handle) ⇒ Object 



171
172
173
 
# File 'lib/capybara/poltergeist/browser.rb', line 171

def close_window(handle)
  command 'close_window', handle
end

#command(name, *args) ⇒ Object 



366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
 
# File 'lib/capybara/poltergeist/browser.rb', line 366

def command(name, *args)
  cmd = Command.new(name, *args)
  log cmd.message

  response = server.send(cmd)
  log response

  json = JSON.load(response)

  if json['error']
    klass = ERROR_MAPPINGS[json['error']['name']] || BrowserError
    raise klass.new(json['error'])
  else
    json['response']
  end
rescue DeadClient
  restart
  raise
end

#cookies ⇒ Object 



309
310
311
 
# File 'lib/capybara/poltergeist/browser.rb', line 309

def cookies
  Hash[command('cookies').map { |cookie| [cookie['name'], Cookie.new(cookie)] }]
end

#cookies_enabled=(flag) ⇒ Object 



329
330
331
 
# File 'lib/capybara/poltergeist/browser.rb', line 329

def cookies_enabled=(flag)
  command 'cookies_enabled', !!flag
end

#current_url ⇒ Object 



39
40
41
 
# File 'lib/capybara/poltergeist/browser.rb', line 39

def current_url
  command 'current_url'
end

#debug=(val) ⇒ Object 



357
358
359
360
 
# File 'lib/capybara/poltergeist/browser.rb', line 357

def debug=(val)
  @debug = val
  command 'set_debug', !!val
end

#delete_text(page_id, id) ⇒ Object 



80
81
82
 
# File 'lib/capybara/poltergeist/browser.rb', line 80

def delete_text(page_id, id)
  command 'delete_text', page_id, id
end

#disabled?(page_id, id) ⇒ Boolean

Returns:

  • (Boolean) 


116
117
118
 
# File 'lib/capybara/poltergeist/browser.rb', line 116

def disabled?(page_id, id)
  command 'disabled', page_id, id
end

#dismiss_confirm ⇒ Object 



398
399
400
 
# File 'lib/capybara/poltergeist/browser.rb', line 398

def dismiss_confirm
  command 'set_confirm_process', false
end

#dismiss_prompt ⇒ Object

press “Cancel”



412
413
414
 
# File 'lib/capybara/poltergeist/browser.rb', line 412

def dismiss_prompt
  command 'set_prompt_response', nil
end

#double_click(page_id, id) ⇒ Object 



200
201
202
 
# File 'lib/capybara/poltergeist/browser.rb', line 200

def double_click(page_id, id)
  command 'double_click', page_id, id
end

#drag(page_id, id, other_id) ⇒ Object 



208
209
210
 
# File 'lib/capybara/poltergeist/browser.rb', line 208

def drag(page_id, id, other_id)
  command 'drag', page_id, id, other_id
end

#drag_by(page_id, id, x, y) ⇒ Object 



212
213
214
 
# File 'lib/capybara/poltergeist/browser.rb', line 212

def drag_by(page_id, id, x, y)
  command 'drag_by', page_id, id, x, y
end

#equals(page_id, id, other_id) ⇒ Object 



285
286
287
 
# File 'lib/capybara/poltergeist/browser.rb', line 285

def equals(page_id, id, other_id)
  command('equals', page_id, id, other_id)
end

#evaluate(script, *args) ⇒ Object 



124
125
126
 
# File 'lib/capybara/poltergeist/browser.rb', line 124

def evaluate(script, *args)
  command 'evaluate', script, *args
end

#execute(script, *args) ⇒ Object 



128
129
130
 
# File 'lib/capybara/poltergeist/browser.rb', line 128

def execute(script, *args)
  command 'execute', script, *args
end

#extensions=(names) ⇒ Object 



342
343
344
345
346
347
 
# File 'lib/capybara/poltergeist/browser.rb', line 342

def extensions=(names)
  @extensions = names
  Array(names).each do |name|
    command 'add_extension', name
  end
end

#find(method, selector) ⇒ Object 



63
64
65
66
 
# File 'lib/capybara/poltergeist/browser.rb', line 63

def find(method, selector)
  result = command('find', method, selector)
  result['ids'].map { |id| [result['page_id'], id] }
end

#find_window_handle(locator) ⇒ Object

Raises:



175
176
177
178
179
180
181
 
# File 'lib/capybara/poltergeist/browser.rb', line 175

def find_window_handle(locator)
  return locator if window_handles.include? locator

  handle = command 'window_handle', locator
  raise NoSuchWindowError unless handle
  return handle
end

#find_within(page_id, id, method, selector) ⇒ Object 



68
69
70
 
# File 'lib/capybara/poltergeist/browser.rb', line 68

def find_within(page_id, id, method, selector)
  command 'find_within', page_id, id, method, selector
end

#get_headers ⇒ Object 



289
290
291
 
# File 'lib/capybara/poltergeist/browser.rb', line 289

def get_headers
  command 'get_headers'
end

#go_back ⇒ Object 



386
387
388
 
# File 'lib/capybara/poltergeist/browser.rb', line 386

def go_back
  command 'go_back'
end

#go_forward ⇒ Object 



390
391
392
 
# File 'lib/capybara/poltergeist/browser.rb', line 390

def go_forward
  command 'go_forward'
end

#hover(page_id, id) ⇒ Object 



204
205
206
 
# File 'lib/capybara/poltergeist/browser.rb', line 204

def hover(page_id, id)
  command 'hover', page_id, id
end

#js_errors=(val) ⇒ Object 



337
338
339
340
 
# File 'lib/capybara/poltergeist/browser.rb', line 337

def js_errors=(val)
  @js_errors = val
  command 'set_js_errors', !!val
end

#modal_message ⇒ Object 



416
417
418
 
# File 'lib/capybara/poltergeist/browser.rb', line 416

def modal_message
  command 'modal_message'
end

#network_traffic(type = nil) ⇒ Object 



264
265
266
267
268
269
270
271
272
 
# File 'lib/capybara/poltergeist/browser.rb', line 264

def network_traffic(type = nil)
  command('network_traffic', type).map do |event|
    NetworkTraffic::Request.new(
      event['request'],
      event['responseParts'].map { |response| NetworkTraffic::Response.new(response) },
      event['error'] ? NetworkTraffic::Error.new(event['error']) : nil
    )
  end
end

#open_new_window ⇒ Object 



167
168
169
 
# File 'lib/capybara/poltergeist/browser.rb', line 167

def open_new_window
  command 'open_new_window'
end

#parents(page_id, id) ⇒ Object 



59
60
61
 
# File 'lib/capybara/poltergeist/browser.rb', line 59

def parents(page_id, id)
  command 'parents', page_id, id
end

#path(page_id, id) ⇒ Object 



260
261
262
 
# File 'lib/capybara/poltergeist/browser.rb', line 260

def path(page_id, id)
  command 'path', page_id, id
end

#property(page_id, id, name) ⇒ Object 



84
85
86
 
# File 'lib/capybara/poltergeist/browser.rb', line 84

def property(page_id, id, name)
  command 'property', page_id, id, name.to_s
end

#remove_cookie(name) ⇒ Object 



321
322
323
 
# File 'lib/capybara/poltergeist/browser.rb', line 321

def remove_cookie(name)
  command 'remove_cookie', name
end

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



232
233
234
235
236
 
# File 'lib/capybara/poltergeist/browser.rb', line 232

def render(path, options = {})
  check_render_options!(options)
  options[:full] = !!options[:full]
  command 'render', path.to_s, options
end

#render_base64(format, options = {}) ⇒ Object 



238
239
240
241
242
 
# File 'lib/capybara/poltergeist/browser.rb', line 238

def render_base64(format, options = {})
  check_render_options!(options)
  options[:full] = !!options[:full]
  command 'render_base64', format.to_s, options
end

#reset ⇒ Object 



224
225
226
 
# File 'lib/capybara/poltergeist/browser.rb', line 224

def reset
  command 'reset'
end

#resize(width, height) ⇒ Object 



252
253
254
 
# File 'lib/capybara/poltergeist/browser.rb', line 252

def resize(width, height)
  command 'resize', width, height
end

#response_headers ⇒ Object 



305
306
307
 
# File 'lib/capybara/poltergeist/browser.rb', line 305

def response_headers
  command 'response_headers'
end

#restart ⇒ Object 



26
27
28
29
30
31
32
33
 
# File 'lib/capybara/poltergeist/browser.rb', line 26

def restart
  server.restart
  client.restart

  self.debug = @debug if defined?(@debug)
  self.js_errors = @js_errors if defined?(@js_errors)
  self.extensions = @extensions if @extensions
end

#right_click(page_id, id) ⇒ Object 



196
197
198
 
# File 'lib/capybara/poltergeist/browser.rb', line 196

def right_click(page_id, id)
  command 'right_click', page_id, id
end

#scroll_to(left, top) ⇒ Object 



228
229
230
 
# File 'lib/capybara/poltergeist/browser.rb', line 228

def scroll_to(left, top)
  command 'scroll_to', left, top
end

#select(page_id, id, value) ⇒ Object 



216
217
218
 
# File 'lib/capybara/poltergeist/browser.rb', line 216

def select(page_id, id, value)
  command 'select', page_id, id, value
end

#select_file(page_id, id, value) ⇒ Object 



104
105
106
 
# File 'lib/capybara/poltergeist/browser.rb', line 104

def select_file(page_id, id, value)
  command 'select_file', page_id, id, value
end

#send_keys(page_id, id, keys) ⇒ Object 



256
257
258
 
# File 'lib/capybara/poltergeist/browser.rb', line 256

def send_keys(page_id, id, keys)
  command 'send_keys', page_id, id, normalize_keys(keys)
end

#set(page_id, id, value) ⇒ Object 



100
101
102
 
# File 'lib/capybara/poltergeist/browser.rb', line 100

def set(page_id, id, value)
  command 'set', page_id, id, value
end

#set_cookie(cookie) ⇒ Object 



313
314
315
316
317
318
319
 
# File 'lib/capybara/poltergeist/browser.rb', line 313

def set_cookie(cookie)
  if cookie[:expires]
    cookie[:expires] = cookie[:expires].to_i * 1000
  end

  command 'set_cookie', cookie
end

#set_headers(headers) ⇒ Object 



293
294
295
 
# File 'lib/capybara/poltergeist/browser.rb', line 293

def set_headers(headers)
  command 'set_headers', headers
end

#set_http_auth(user, password) ⇒ Object 



333
334
335
 
# File 'lib/capybara/poltergeist/browser.rb', line 333

def set_http_auth(user, password)
  command 'set_http_auth', user, password
end

#set_paper_size(size) ⇒ Object 



248
249
250
 
# File 'lib/capybara/poltergeist/browser.rb', line 248

def set_paper_size(size)
  command 'set_paper_size', size
end

#set_proxy(ip, port, type, user, password) ⇒ Object 



278
279
280
281
282
283
 
# File 'lib/capybara/poltergeist/browser.rb', line 278

def set_proxy(ip, port, type, user, password)
  args = [ip, port, type]
  args << user if user
  args << password if password
  command('set_proxy', *args)
end

#set_zoom_factor(zoom_factor) ⇒ Object 



244
245
246
 
# File 'lib/capybara/poltergeist/browser.rb', line 244

def set_zoom_factor(zoom_factor)
  command 'set_zoom_factor', zoom_factor
end

#source ⇒ Object 



51
52
53
 
# File 'lib/capybara/poltergeist/browser.rb', line 51

def source
  command 'source'
end

#status_code ⇒ Object 



43
44
45
 
# File 'lib/capybara/poltergeist/browser.rb', line 43

def status_code
  command 'status_code'
end

#switch_to_frame(handle, &block) ⇒ Object 



144
145
146
147
148
149
150
151
152
153
 
# File 'lib/capybara/poltergeist/browser.rb', line 144

def switch_to_frame(handle, &block)
  case handle
  when Capybara::Node::Base
    command 'push_frame', [handle.native.page_id, handle.native.id]
  when :parent
    command 'pop_frame'
  when :top
    command 'pop_frame', true
  end
end

#switch_to_window(handle) ⇒ Object 



163
164
165
 
# File 'lib/capybara/poltergeist/browser.rb', line 163

def switch_to_window(handle)
  command 'switch_to_window', handle
end

#tag_name(page_id, id) ⇒ Object 



108
109
110
 
# File 'lib/capybara/poltergeist/browser.rb', line 108

def tag_name(page_id, id)
  command('tag_name', page_id, id).downcase
end

#title ⇒ Object 



55
56
57
 
# File 'lib/capybara/poltergeist/browser.rb', line 55

def title
  command 'title'
end

#trigger(page_id, id, event) ⇒ Object 



220
221
222
 
# File 'lib/capybara/poltergeist/browser.rb', line 220

def trigger(page_id, id, event)
  command 'trigger', page_id, id, event.to_s
end

#url_blacklist=(blacklist) ⇒ Object 



353
354
355
 
# File 'lib/capybara/poltergeist/browser.rb', line 353

def url_blacklist=(blacklist)
  command 'set_url_blacklist', *blacklist
end

#url_whitelist=(whitelist) ⇒ Object 



349
350
351
 
# File 'lib/capybara/poltergeist/browser.rb', line 349

def url_whitelist=(whitelist)
  command 'set_url_whitelist', *whitelist
end

#value(page_id, id) ⇒ Object 



96
97
98
 
# File 'lib/capybara/poltergeist/browser.rb', line 96

def value(page_id, id)
  command 'value', page_id, id
end

#visible?(page_id, id) ⇒ Boolean

Returns:

  • (Boolean) 


112
113
114
 
# File 'lib/capybara/poltergeist/browser.rb', line 112

def visible?(page_id, id)
  command 'visible', page_id, id
end

#visible_text(page_id, id) ⇒ Object 



76
77
78
 
# File 'lib/capybara/poltergeist/browser.rb', line 76

def visible_text(page_id, id)
  command 'visible_text', page_id, id
end

#visit(url) ⇒ Object 



35
36
37
 
# File 'lib/capybara/poltergeist/browser.rb', line 35

def visit(url)
  command 'visit', url
end

#window_handle ⇒ Object 



155
156
157
 
# File 'lib/capybara/poltergeist/browser.rb', line 155

def window_handle
  command 'window_handle'
end

#window_handles ⇒ Object 



159
160
161
 
# File 'lib/capybara/poltergeist/browser.rb', line 159

def window_handles
  command 'window_handles'
end

#within_frame(handle, &block) ⇒ Object 



132
133
134
135
136
137
138
139
140
141
142
 
# File 'lib/capybara/poltergeist/browser.rb', line 132

def within_frame(handle, &block)
  if handle.is_a?(Capybara::Node::Base)
    command 'push_frame', [handle.native.page_id, handle.native.id]
  else
    command 'push_frame', handle
  end

  yield
ensure
  command 'pop_frame'
end

#within_window(locator, &block) ⇒ Object 



183
184
185
186
187
188
189
190
 
# File 'lib/capybara/poltergeist/browser.rb', line 183

def within_window(locator, &block)
  original = window_handle
  handle = find_window_handle(locator)
  switch_to_window(handle)
  yield
ensure
  switch_to_window(original)
end