Class: Capybara::Poltergeist::Driver

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

Constant Summary collapse

DEFAULT_TIMEOUT = 
30

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Driver.



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

def initialize(app, options = {})
  @app       = app
  @options   = options
  @browser   = nil
  @inspector = nil
  @server    = nil
  @client    = nil
  @started   = false
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



9
10
11
 
# File 'lib/capybara/poltergeist/driver.rb', line 9

def app
  @app
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



9
10
11
 
# File 'lib/capybara/poltergeist/driver.rb', line 9

def options
  @options
end

Instance Method Details

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



375
376
377
378
379
380
381
382
383
384
385
386
 
# File 'lib/capybara/poltergeist/driver.rb', line 375

def accept_modal(type, options = {})
  case type
  when :confirm
    browser.accept_confirm
  when :prompt
    browser.accept_prompt options[:with]
  end

  yield if block_given?

  find_modal(options)
end

#add_header(name, value, options = {}) ⇒ Object 



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

def add_header(name, value, options = {})
  browser.add_header({ name => value }, { permanent: true }.merge(options))
end

#add_headers(headers) ⇒ Object 



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

def add_headers(headers)
  browser.add_headers(headers)
end

#basic_authorize(user, password) ⇒ Object

  • PhantomJS with set settings doesn’t send ‘Authorize` on POST request

  • With manually set header PhantomJS makes next request with

‘Authorization: Basic Og==` header when settings are empty and the response was `401 Unauthorized` (which means Base64.encode64(’:‘)). Combining both methods to reach proper behavior.



310
311
312
313
314
 
# File 'lib/capybara/poltergeist/driver.rb', line 310

def basic_authorize(user, password)
  browser.set_http_auth(user, password)
  credentials = ["#{user}:#{password}"].pack('m*').strip
  add_header('Authorization', "Basic #{credentials}")
end

#browser ⇒ Object 



25
26
27
28
29
30
31
32
33
34
35
 
# File 'lib/capybara/poltergeist/driver.rb', line 25

def browser
  @browser ||= begin
    browser = Browser.new(server, client, logger)
    browser.js_errors  = options[:js_errors] if options.key?(:js_errors)
    browser.extensions = options.fetch(:extensions, [])
    browser.debug      = true if options[:debug]
    browser.url_blacklist = options[:url_blacklist] if options.key?(:url_blacklist)
    browser.url_whitelist = options[:url_whitelist] if options.key?(:url_whitelist)
    browser
  end
end

#clear_cookies ⇒ Object 



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

def clear_cookies
  browser.clear_cookies
end

#clear_memory_cache ⇒ Object 



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

def clear_memory_cache
  browser.clear_memory_cache
end

#clear_network_traffic ⇒ Object 



243
244
245
 
# File 'lib/capybara/poltergeist/driver.rb', line 243

def clear_network_traffic
  browser.clear_network_traffic
end

#click(x, y) ⇒ Object 



135
136
137
 
# File 'lib/capybara/poltergeist/driver.rb', line 135

def click(x, y)
  browser.click_coordinates(x, y)
end

#client ⇒ Object 



45
46
47
48
49
50
51
52
 
# File 'lib/capybara/poltergeist/driver.rb', line 45

def client
  @client ||= Client.start(server,
    :path              => options[:phantomjs],
    :window_size       => options[:window_size],
    :phantomjs_options => phantomjs_options,
    :phantomjs_logger  => phantomjs_logger
  )
end

#client_pid ⇒ Object 



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

def client_pid
  client.pid
end

#close_window(handle) ⇒ Object 



170
171
172
 
# File 'lib/capybara/poltergeist/driver.rb', line 170

def close_window(handle)
  browser.close_window(handle)
end

#cookies ⇒ Object 



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

def cookies
  browser.cookies
end

#cookies_enabled=(flag) ⇒ Object 



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

def cookies_enabled=(flag)
  browser.cookies_enabled = flag
end

#current_url ⇒ Object 



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

def current_url
  browser.current_url
end

#current_window_handle ⇒ Object 



162
163
164
 
# File 'lib/capybara/poltergeist/driver.rb', line 162

def current_window_handle
  browser.window_handle
end

#debug ⇒ Object 



316
317
318
319
320
321
322
323
324
325
326
327
 
# File 'lib/capybara/poltergeist/driver.rb', line 316

def debug
  if @options[:inspector]
    # Fall back to default scheme
    scheme = URI.parse(browser.current_url).scheme rescue nil
    scheme = 'http' if scheme != 'https'
    inspector.open(scheme)
    pause
  else
    raise Error, "To use the remote debugging, you have to launch the driver " \
                 "with `:inspector => true` configuration option"
  end
end

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



388
389
390
391
392
393
394
395
396
397
398
 
# File 'lib/capybara/poltergeist/driver.rb', line 388

def dismiss_modal(type, options = {})
  case type
  when :confirm
    browser.dismiss_confirm
  when :prompt
    browser.dismiss_prompt
  end

  yield if block_given?
  find_modal(options)
end

#evaluate_async_script(script, *args) ⇒ Object 



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

def evaluate_async_script(script, *args)
  result = browser.evaluate_async(script, session_wait_time, *args.map { |arg| arg.is_a?(Capybara::Poltergeist::Node) ?  arg.native : arg})
  unwrap_script_result(result)
end

#evaluate_script(script, *args) ⇒ Object 



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

def evaluate_script(script, *args)
  result = browser.evaluate(script, *args.map { |arg| arg.is_a?(Capybara::Poltergeist::Node) ?  arg.native : arg})
  unwrap_script_result(result)
end

#execute_script(script, *args) ⇒ Object 



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

def execute_script(script, *args)
  browser.execute(script, *args.map { |arg| arg.is_a?(Capybara::Poltergeist::Node) ?  arg.native : arg})
  nil
end

#find(method, selector) ⇒ Object 



123
124
125
 
# File 'lib/capybara/poltergeist/driver.rb', line 123

def find(method, selector)
  browser.find(method, selector).map { |page_id, id| Capybara::Poltergeist::Node.new(self, page_id, id) }
end

#find_css(selector) ⇒ Object 



131
132
133
 
# File 'lib/capybara/poltergeist/driver.rb', line 131

def find_css(selector)
  find :css, selector
end

#find_xpath(selector) ⇒ Object 



127
128
129
 
# File 'lib/capybara/poltergeist/driver.rb', line 127

def find_xpath(selector)
  find :xpath, selector
end

#go_back ⇒ Object 



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

def go_back
  browser.go_back
end

#go_forward ⇒ Object 



367
368
369
 
# File 'lib/capybara/poltergeist/driver.rb', line 367

def go_forward
  browser.go_forward
end

#headers ⇒ Object 



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

def headers
  browser.get_headers
end

#headers=(headers) ⇒ Object 



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

def headers=(headers)
  browser.set_headers(headers)
end

#html ⇒ Object Also known as: body 



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

def html
  browser.body
end

#inspector ⇒ Object 



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

def inspector
  @inspector ||= options[:inspector] && Inspector.new(options[:inspector])
end

#invalid_element_errors ⇒ Object 



359
360
361
 
# File 'lib/capybara/poltergeist/driver.rb', line 359

def invalid_element_errors
  [Capybara::Poltergeist::ObsoleteNode, Capybara::Poltergeist::MouseEventFailed]
end

#logger ⇒ Object

logger should be an object that responds to puts, or nil



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

def logger
  options[:logger] || (options[:debug] && STDERR)
end

#maximize_window(handle) ⇒ Object 



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

def maximize_window(handle)
  resize_window_to(handle, *screen_size)
end

#needs_server? ⇒ Boolean

Returns:

  • (Boolean) 


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

def needs_server?
  true
end

#network_traffic(type = nil) ⇒ Object 



239
240
241
 
# File 'lib/capybara/poltergeist/driver.rb', line 239

def network_traffic(type = nil)
  browser.network_traffic(type)
end

#no_such_window_error ⇒ Object 



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

def no_such_window_error
  NoSuchWindowError
end

#open_new_window ⇒ Object 



174
175
176
 
# File 'lib/capybara/poltergeist/driver.rb', line 174

def open_new_window
  browser.open_new_window
end

#paper_size=(size = {}) ⇒ Object 



206
207
208
 
# File 'lib/capybara/poltergeist/driver.rb', line 206

def paper_size=(size = {})
  browser.set_paper_size(size)
end

#pause ⇒ Object 



329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
 
# File 'lib/capybara/poltergeist/driver.rb', line 329

def pause
  # STDIN is not necessarily connected to a keyboard. It might even be closed.
  # So we need a method other than keypress to continue.

  # In jRuby - STDIN returns immediately from select
  # see https://github.com/jruby/jruby/issues/1783
  read, write = IO.pipe
  Thread.new { IO.copy_stream(STDIN, write); write.close }

  STDERR.puts "Poltergeist execution paused. Press enter (or run 'kill -CONT #{Process.pid}') to continue."

  signal = false
  old_trap = trap('SIGCONT') { signal = true; STDERR.puts "\nSignal SIGCONT received" }
  keyboard = IO.select([read], nil, nil, 1) until keyboard || signal # wait for data on STDIN or signal SIGCONT received

  begin
    input = read.read_nonblock(80) # clear out the read buffer
    puts unless input && input =~ /\n\z/
  rescue EOFError, IO::WaitReadable # Ignore problems reading from STDIN.
  end unless signal

ensure
  trap('SIGCONT', old_trap) # Restore the previous signal handler, if there was one.
  STDERR.puts 'Continuing'
end

#phantomjs_logger ⇒ Object

logger should be an object that behaves like IO or nil



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

def phantomjs_logger
  options.fetch(:phantomjs_logger, nil)
end

#phantomjs_options ⇒ Object 



54
55
56
57
58
59
60
61
62
63
64
 
# File 'lib/capybara/poltergeist/driver.rb', line 54

def phantomjs_options
  list = options[:phantomjs_options] || []

  # PhantomJS defaults to only using SSLv3, which since POODLE (Oct 2014)
  # many sites have dropped from their supported protocols (eg PayPal,
  # Braintree).
  list += ["--ignore-ssl-errors=yes"] unless list.grep(/ignore-ssl-errors/).any?
  list += ["--ssl-protocol=TLSv1"] unless list.grep(/ssl-protocol/).any?
  list += ["--remote-debugger-port=#{inspector.port}", "--remote-debugger-autorun=yes"] if inspector
  list
end

#quit ⇒ Object 



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

def quit
  server.stop
  client.stop
end

#refresh ⇒ Object 



371
372
373
 
# File 'lib/capybara/poltergeist/driver.rb', line 371

def refresh
  browser.refresh
end

#remove_cookie(name) ⇒ Object 



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

def remove_cookie(name)
  browser.remove_cookie(name)
end

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



202
203
204
 
# File 'lib/capybara/poltergeist/driver.rb', line 202

def render_base64(format = :png, options = {})
  browser.render_base64(format, options)
end

#reset! ⇒ Object 



190
191
192
193
194
195
 
# File 'lib/capybara/poltergeist/driver.rb', line 190

def reset!
  browser.reset
  browser.url_blacklist = options[:url_blacklist] if options.key?(:url_blacklist)
  browser.url_whitelist = options[:url_whitelist] if options.key?(:url_whitelist)
  @started = false
end

#resize(width, height) ⇒ Object Also known as: resize_window 



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

def resize(width, height)
  browser.resize(width, height)
end

#resize_window_to(handle, width, height) ⇒ Object 



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

def resize_window_to(handle, width, height)
  within_window(handle) do
    resize(width, height)
  end
end

#response_headers ⇒ Object 



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

def response_headers
  browser.response_headers
end

#restart ⇒ Object 



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

def restart
  browser.restart
end

#save_screenshot(path, options = {}) ⇒ Object Also known as: render 



197
198
199
 
# File 'lib/capybara/poltergeist/driver.rb', line 197

def save_screenshot(path, options = {})
  browser.render(path, options)
end

#scroll_to(left, top) ⇒ Object 



235
236
237
 
# File 'lib/capybara/poltergeist/driver.rb', line 235

def scroll_to(left, top)
  browser.scroll_to(left, top)
end

#server ⇒ Object 



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

def server
  @server ||= Server.new(options[:port], options.fetch(:timeout) { DEFAULT_TIMEOUT }, options[:host])
end

#set_cookie(name, value, options = {}) ⇒ Object 



275
276
277
278
279
280
281
282
283
284
285
286
287
 
# File 'lib/capybara/poltergeist/driver.rb', line 275

def set_cookie(name, value, options = {})
  options[:name]  ||= name
  options[:value] ||= value
  options[:domain] ||= begin
    if @started
      URI.parse(browser.current_url).host
    else
      URI.parse(default_cookie_host).host || "127.0.0.1"
    end
  end

  browser.set_cookie(options)
end

#set_proxy(ip, port, type = "http", user = nil, password = nil) ⇒ Object 



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

def set_proxy(ip, port, type = "http", user = nil, password = nil)
  browser.set_proxy(ip, port, type, user, password)
end

#source ⇒ Object 



115
116
117
 
# File 'lib/capybara/poltergeist/driver.rb', line 115

def source
  browser.source.to_s
end

#status_code ⇒ Object 



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

def status_code
  browser.status_code
end

#switch_to_frame(locator) ⇒ Object 



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

def switch_to_frame(locator)
  browser.switch_to_frame(locator)
end

#switch_to_window(handle) ⇒ Object 



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

def switch_to_window(handle)
  browser.switch_to_window(handle)
end

#timeout ⇒ Object 



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

def timeout
  server.timeout
end

#timeout=(sec) ⇒ Object 



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

def timeout=(sec)
  server.timeout = sec
end

#title ⇒ Object 



119
120
121
 
# File 'lib/capybara/poltergeist/driver.rb', line 119

def title
  browser.title
end

#visit(url) ⇒ Object 



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

def visit(url)
  @started = true
  browser.visit(url)
end

#wait? ⇒ Boolean

Returns:

  • (Boolean) 


355
356
357
 
# File 'lib/capybara/poltergeist/driver.rb', line 355

def wait?
  true
end

#window_handles ⇒ Object 



166
167
168
 
# File 'lib/capybara/poltergeist/driver.rb', line 166

def window_handles
  browser.window_handles
end

#window_size(handle) ⇒ Object 



229
230
231
232
233
 
# File 'lib/capybara/poltergeist/driver.rb', line 229

def window_size(handle)
  within_window(handle) do
    evaluate_script('[window.innerWidth, window.innerHeight]')
  end
end

#within_frame(name, &block) ⇒ Object 



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

def within_frame(name, &block)
  browser.within_frame(name, &block)
end

#within_window(name, &block) ⇒ Object 



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

def within_window(name, &block)
  browser.within_window(name, &block)
end

#zoom_factor=(zoom_factor) ⇒ Object 



210
211
212
 
# File 'lib/capybara/poltergeist/driver.rb', line 210

def zoom_factor=(zoom_factor)
  browser.set_zoom_factor(zoom_factor)
end