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.



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

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.



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

def client
  @client
end

#logger ⇒ Object (readonly)

Returns the value of attribute logger.



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

def logger
  @logger
end

#server ⇒ Object (readonly)

Returns the value of attribute server.



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

def server
  @server
end

Instance Method Details

#accept_confirm ⇒ Object 



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

def accept_confirm
  command 'set_confirm_process', true
end

#accept_prompt(response) ⇒ Object

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



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

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

#add_header(header, permanent) ⇒ Object 



267
268
269
 
# File 'lib/capybara/poltergeist/browser.rb', line 267

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

#add_headers(headers) ⇒ Object 



263
264
265
 
# File 'lib/capybara/poltergeist/browser.rb', line 263

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

#all_text(page_id, id) ⇒ Object 



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

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

#attribute(page_id, id, name) ⇒ Object 



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

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

#attributes(page_id, id) ⇒ Object 



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

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

#body ⇒ Object 



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

def body
  command 'body'
end

#clear_cookies ⇒ Object 



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

def clear_cookies
  command 'clear_cookies'
end

#clear_network_traffic ⇒ Object 



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

def clear_network_traffic
  command('clear_network_traffic')
end

#click(page_id, id) ⇒ Object 



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

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

#click_coordinates(x, y) ⇒ Object 



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

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

#close_window(handle) ⇒ Object 



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

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

#command(name, *args) ⇒ Object 



324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
 
# File 'lib/capybara/poltergeist/browser.rb', line 324

def command(name, *args)
  message = JSON.dump({ 'name' => name, 'args' => args })
  log message

  response = server.send(message)
  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 



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

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

#cookies_enabled=(flag) ⇒ Object 



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

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

#current_url ⇒ Object 



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

def current_url
  command 'current_url'
end

#debug=(val) ⇒ Object 



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

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

#delete_text(page_id, id) ⇒ Object 



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

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

#disabled?(page_id, id) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#dismiss_confirm ⇒ Object 



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

def dismiss_confirm
  command 'set_confirm_process', false
end

#dismiss_prompt ⇒ Object

press “Cancel”



370
371
372
 
# File 'lib/capybara/poltergeist/browser.rb', line 370

def dismiss_prompt
  command 'set_prompt_response', nil
end

#double_click(page_id, id) ⇒ Object 



176
177
178
 
# File 'lib/capybara/poltergeist/browser.rb', line 176

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

#drag(page_id, id, other_id) ⇒ Object 



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

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

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



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

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

#equals(page_id, id, other_id) ⇒ Object 



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

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

#evaluate(script) ⇒ Object 



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

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

#execute(script) ⇒ Object 



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

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

#extensions=(names) ⇒ Object 



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

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

#find(method, selector) ⇒ Object 



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

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

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



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

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

#get_headers ⇒ Object 



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

def get_headers
  command 'get_headers'
end

#go_back ⇒ Object 



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

def go_back
  command 'go_back'
end

#go_forward ⇒ Object 



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

def go_forward
  command 'go_forward'
end

#hover(page_id, id) ⇒ Object 



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

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

#js_errors=(val) ⇒ Object 



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

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

#modal_message ⇒ Object 



374
375
376
 
# File 'lib/capybara/poltergeist/browser.rb', line 374

def modal_message
  command 'modal_message'
end

#network_traffic ⇒ Object 



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

def network_traffic
  command('network_traffic').values.map do |event|
    NetworkTraffic::Request.new(
      event['request'],
      event['responseParts'].map { |response| NetworkTraffic::Response.new(response) }
    )
  end
end

#open_new_window ⇒ Object 



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

def open_new_window
  command 'open_new_window'
end

#parents(page_id, id) ⇒ Object 



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

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

#path(page_id, id) ⇒ Object 



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

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

#remove_cookie(name) ⇒ Object 



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

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

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



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

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

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



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

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

#reset ⇒ Object 



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

def reset
  command 'reset'
end

#resize(width, height) ⇒ Object 



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

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

#response_headers ⇒ Object 



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

def response_headers
  command 'response_headers'
end

#restart ⇒ Object 



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

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 



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

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

#scroll_to(left, top) ⇒ Object 



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

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

#select(page_id, id, value) ⇒ Object 



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

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

#select_file(page_id, id, value) ⇒ Object 



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

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

#send_keys(page_id, id, keys) ⇒ Object 



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

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

#set(page_id, id, value) ⇒ Object 



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

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

#set_cookie(cookie) ⇒ Object 



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

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

  command 'set_cookie', cookie
end

#set_headers(headers) ⇒ Object 



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

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

#set_http_auth(user, password) ⇒ Object 



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

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

#set_paper_size(size) ⇒ Object 



222
223
224
 
# File 'lib/capybara/poltergeist/browser.rb', line 222

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

#set_zoom_factor(zoom_factor) ⇒ Object 



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

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

#source ⇒ Object 



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

def source
  command 'source'
end

#status_code ⇒ Object 



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

def status_code
  command 'status_code'
end

#switch_to_window(handle) ⇒ Object 



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

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

#tag_name(page_id, id) ⇒ Object 



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

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

#title ⇒ Object 



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

def title
  command 'title'
end

#trigger(page_id, id, event) ⇒ Object 



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

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

#url_blacklist=(blacklist) ⇒ Object 



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

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

#value(page_id, id) ⇒ Object 



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

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

#visible?(page_id, id) ⇒ Boolean

Returns:

  • (Boolean) 


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

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

#visible_text(page_id, id) ⇒ Object 



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

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

#visit(url) ⇒ Object 



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

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

#window_handle ⇒ Object 



137
138
139
 
# File 'lib/capybara/poltergeist/browser.rb', line 137

def window_handle
  command 'window_handle'
end

#window_handles ⇒ Object 



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

def window_handles
  command 'window_handles'
end

#within_frame(handle, &block) ⇒ Object 



125
126
127
128
129
130
131
132
133
134
135
 
# File 'lib/capybara/poltergeist/browser.rb', line 125

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

  yield
ensure
  command 'pop_frame'
end

#within_window(name, &block) ⇒ Object 



157
158
159
160
161
162
163
164
165
166
 
# File 'lib/capybara/poltergeist/browser.rb', line 157

def within_window(name, &block)
  original = window_handle
  handle = command 'window_handle', name
  handle = name if handle.nil? && window_handles.include?(name)
  raise NoSuchWindowError unless handle
  switch_to_window(handle)
  yield
ensure
  switch_to_window(original)
end