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
}

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Browser.



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

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.



16
17
18
 
# File 'lib/capybara/poltergeist/browser.rb', line 16

def client
  @client
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



16
17
18
 
# File 'lib/capybara/poltergeist/browser.rb', line 16

def logger
  @logger
end

#server ⇒ Object (readonly)

Returns the value of attribute server.



16
17
18
 
# File 'lib/capybara/poltergeist/browser.rb', line 16

def server
  @server
end

Instance Method Details

#accept_confirm ⇒ Object 



376
377
378
 
# File 'lib/capybara/poltergeist/browser.rb', line 376

def accept_confirm
  command 'set_confirm_process', true
end

#accept_prompt(response) ⇒ Object

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



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

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

#add_header(header, permanent) ⇒ Object 



291
292
293
 
# File 'lib/capybara/poltergeist/browser.rb', line 291

def add_header(header, permanent)
  command 'add_header', header, permanent
end

#add_headers(headers) ⇒ Object 



287
288
289
 
# File 'lib/capybara/poltergeist/browser.rb', line 287

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

#all_text(page_id, id) ⇒ Object 



70
71
72
 
# File 'lib/capybara/poltergeist/browser.rb', line 70

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

#attribute(page_id, id, name) ⇒ Object 



90
91
92
 
# File 'lib/capybara/poltergeist/browser.rb', line 90

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

#attributes(page_id, id) ⇒ Object 



86
87
88
 
# File 'lib/capybara/poltergeist/browser.rb', line 86

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

#body ⇒ Object 



45
46
47
 
# File 'lib/capybara/poltergeist/browser.rb', line 45

def body
  command 'body'
end

#clear_cookies ⇒ Object 



315
316
317
 
# File 'lib/capybara/poltergeist/browser.rb', line 315

def clear_cookies
  command 'clear_cookies'
end

#clear_network_traffic ⇒ Object 



271
272
273
 
# File 'lib/capybara/poltergeist/browser.rb', line 271

def clear_network_traffic
  command('clear_network_traffic')
end

#click(page_id, id) ⇒ Object 



179
180
181
 
# File 'lib/capybara/poltergeist/browser.rb', line 179

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

#click_coordinates(x, y) ⇒ Object 



118
119
120
 
# File 'lib/capybara/poltergeist/browser.rb', line 118

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

#close_window(handle) ⇒ Object 



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

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

#command(name, *args) ⇒ Object 



348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/capybara/poltergeist/browser.rb', line 348

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 



299
300
301
 
# File 'lib/capybara/poltergeist/browser.rb', line 299

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

#cookies_enabled=(flag) ⇒ Object 



319
320
321
 
# File 'lib/capybara/poltergeist/browser.rb', line 319

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

#current_url ⇒ Object 



37
38
39
 
# File 'lib/capybara/poltergeist/browser.rb', line 37

def current_url
  command 'current_url'
end

#debug=(val) ⇒ Object 



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

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

#delete_text(page_id, id) ⇒ Object 



78
79
80
 
# File 'lib/capybara/poltergeist/browser.rb', line 78

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

#disabled?(page_id, id) ⇒ Boolean

Returns:

  • (Boolean) 


114
115
116
 
# File 'lib/capybara/poltergeist/browser.rb', line 114

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

#dismiss_confirm ⇒ Object 



380
381
382
 
# File 'lib/capybara/poltergeist/browser.rb', line 380

def dismiss_confirm
  command 'set_confirm_process', false
end

#dismiss_prompt ⇒ Object

press “Cancel”



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

def dismiss_prompt
  command 'set_prompt_response', nil
end

#double_click(page_id, id) ⇒ Object 



187
188
189
 
# File 'lib/capybara/poltergeist/browser.rb', line 187

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

#drag(page_id, id, other_id) ⇒ Object 



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

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

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



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

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

#equals(page_id, id, other_id) ⇒ Object 



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

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

#evaluate(script) ⇒ Object 



122
123
124
 
# File 'lib/capybara/poltergeist/browser.rb', line 122

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

#execute(script) ⇒ Object 



126
127
128
 
# File 'lib/capybara/poltergeist/browser.rb', line 126

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

#extensions=(names) ⇒ Object 



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

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

#find(method, selector) ⇒ Object 



61
62
63
64
 
# File 'lib/capybara/poltergeist/browser.rb', line 61

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

#find_window_handle(locator) ⇒ Object 



162
163
164
165
166
167
168
 
# File 'lib/capybara/poltergeist/browser.rb', line 162

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 



66
67
68
 
# File 'lib/capybara/poltergeist/browser.rb', line 66

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

#get_headers ⇒ Object 



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

def get_headers
  command 'get_headers'
end

#go_back ⇒ Object 



368
369
370
 
# File 'lib/capybara/poltergeist/browser.rb', line 368

def go_back
  command 'go_back'
end

#go_forward ⇒ Object 



372
373
374
 
# File 'lib/capybara/poltergeist/browser.rb', line 372

def go_forward
  command 'go_forward'
end

#hover(page_id, id) ⇒ Object 



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

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

#js_errors=(val) ⇒ Object 



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

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

#modal_message ⇒ Object 



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

def modal_message
  command 'modal_message'
end

#network_traffic ⇒ Object 



261
262
263
264
265
266
267
268
269
 
# File 'lib/capybara/poltergeist/browser.rb', line 261

def network_traffic
  command('network_traffic').values.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 



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

def open_new_window
  command 'open_new_window'
end

#parents(page_id, id) ⇒ Object 



57
58
59
 
# File 'lib/capybara/poltergeist/browser.rb', line 57

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

#path(page_id, id) ⇒ Object 



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

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

#property(page_id, id, name) ⇒ Object 



82
83
84
 
# File 'lib/capybara/poltergeist/browser.rb', line 82

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

#remove_cookie(name) ⇒ Object 



311
312
313
 
# File 'lib/capybara/poltergeist/browser.rb', line 311

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

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



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

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

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



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

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

#reset ⇒ Object 



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

def reset
  command 'reset'
end

#resize(width, height) ⇒ Object 



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

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

#response_headers ⇒ Object 



295
296
297
 
# File 'lib/capybara/poltergeist/browser.rb', line 295

def response_headers
  command 'response_headers'
end

#restart ⇒ Object 



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

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 



183
184
185
 
# File 'lib/capybara/poltergeist/browser.rb', line 183

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

#scroll_to(left, top) ⇒ Object 



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

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

#select(page_id, id, value) ⇒ Object 



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

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

#select_file(page_id, id, value) ⇒ Object 



102
103
104
 
# File 'lib/capybara/poltergeist/browser.rb', line 102

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

#send_keys(page_id, id, keys) ⇒ Object 



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

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

#set(page_id, id, value) ⇒ Object 



98
99
100
 
# File 'lib/capybara/poltergeist/browser.rb', line 98

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

#set_cookie(cookie) ⇒ Object 



303
304
305
306
307
308
309
 
# File 'lib/capybara/poltergeist/browser.rb', line 303

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

  command 'set_cookie', cookie
end

#set_flash(s_version) ⇒ Object 



237
238
239
 
# File 'lib/capybara/poltergeist/browser.rb', line 237

def set_flash(s_version)
  command 'set_flash', s_version
end

#set_headers(headers) ⇒ Object 



283
284
285
 
# File 'lib/capybara/poltergeist/browser.rb', line 283

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

#set_http_auth(user, password) ⇒ Object 



323
324
325
 
# File 'lib/capybara/poltergeist/browser.rb', line 323

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

#set_java(s_java) ⇒ Object 



241
242
243
 
# File 'lib/capybara/poltergeist/browser.rb', line 241

def set_java(s_java)
  command 'set_java', s_java
end

#set_paper_size(size) ⇒ Object 



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

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

#set_screen_size(s_width, s_height, s_color) ⇒ Object 



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

def set_screen_size(s_width,s_height,s_color)
  command 'set_screen_size', s_width, s_height, s_color
end

#set_zoom_factor(zoom_factor) ⇒ Object 



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

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

#source ⇒ Object 



49
50
51
 
# File 'lib/capybara/poltergeist/browser.rb', line 49

def source
  command 'source'
end

#status_code ⇒ Object 



41
42
43
 
# File 'lib/capybara/poltergeist/browser.rb', line 41

def status_code
  command 'status_code'
end

#switch_to_window(handle) ⇒ Object 



150
151
152
 
# File 'lib/capybara/poltergeist/browser.rb', line 150

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

#tag_name(page_id, id) ⇒ Object 



106
107
108
 
# File 'lib/capybara/poltergeist/browser.rb', line 106

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

#title ⇒ Object 



53
54
55
 
# File 'lib/capybara/poltergeist/browser.rb', line 53

def title
  command 'title'
end

#trigger(page_id, id, event) ⇒ Object 



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

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

#url_blacklist=(blacklist) ⇒ Object 



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

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

#value(page_id, id) ⇒ Object 



94
95
96
 
# File 'lib/capybara/poltergeist/browser.rb', line 94

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

#visible?(page_id, id) ⇒ Boolean

Returns:

  • (Boolean) 


110
111
112
 
# File 'lib/capybara/poltergeist/browser.rb', line 110

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

#visible_text(page_id, id) ⇒ Object 



74
75
76
 
# File 'lib/capybara/poltergeist/browser.rb', line 74

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

#visit(url) ⇒ Object 



33
34
35
 
# File 'lib/capybara/poltergeist/browser.rb', line 33

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

#window_handle ⇒ Object 



142
143
144
 
# File 'lib/capybara/poltergeist/browser.rb', line 142

def window_handle
  command 'window_handle'
end

#window_handles ⇒ Object 



146
147
148
 
# File 'lib/capybara/poltergeist/browser.rb', line 146

def window_handles
  command 'window_handles'
end

#within_frame(handle, &block) ⇒ Object 



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

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 



170
171
172
173
174
175
176
177
 
# File 'lib/capybara/poltergeist/browser.rb', line 170

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