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.



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

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.



7
8
9
 
# File 'lib/capybara/poltergeist/driver.rb', line 7

def app
  @app
end

#browser ⇒ Object (readonly)

Returns the value of attribute browser.



7
8
9
 
# File 'lib/capybara/poltergeist/driver.rb', line 7

def browser
  @browser
end

#client ⇒ Object (readonly)

Returns the value of attribute client.



7
8
9
 
# File 'lib/capybara/poltergeist/driver.rb', line 7

def client
  @client
end

#options ⇒ Object (readonly)

Returns the value of attribute options.



7
8
9
 
# File 'lib/capybara/poltergeist/driver.rb', line 7

def options
  @options
end

#server ⇒ Object (readonly)

Returns the value of attribute server.



7
8
9
 
# File 'lib/capybara/poltergeist/driver.rb', line 7

def server
  @server
end

Instance Method Details

#click(x, y) ⇒ Object 



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

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

#client_pid ⇒ Object 



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

def client_pid
  client.pid
end

#cookies ⇒ Object 



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

def cookies
  browser.cookies
end

#current_url ⇒ Object 



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

def current_url
  browser.current_url
end

#debug ⇒ Object 



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

def debug
  if @options[:inspector]
    inspector.open
    pause
  else
    raise Error, "To use the remote debugging, you have to launch the driver " \
                 "with `:inspector => true` configuration option"
  end
end

#evaluate_script(script) ⇒ Object 



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

def evaluate_script(script)
  browser.evaluate(script)
end

#execute_script(script) ⇒ Object 



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

def execute_script(script)
  browser.execute(script)
  nil
end

#find(selector) ⇒ Object 



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

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

#headers=(headers) ⇒ Object 



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

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

#html ⇒ Object Also known as: body 



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

def html
  browser.body
end

#inspector ⇒ Object 



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

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

#invalid_element_errors ⇒ Object 



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

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

#logger ⇒ Object

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



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

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

#needs_server? ⇒ Boolean

Returns:

  • (Boolean) 


19
20
21
 
# File 'lib/capybara/poltergeist/driver.rb', line 19

def needs_server?
  true
end

#network_traffic ⇒ Object 



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

def network_traffic
  browser.network_traffic
end

#pause ⇒ Object 



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

def pause
  STDERR.puts "Poltergeist execution paused. Press enter to continue."
  STDIN.gets
end

#phantomjs_logger ⇒ Object

logger should be an object that behaves like IO or nil



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

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

#phantomjs_options ⇒ Object 



50
51
52
53
54
 
# File 'lib/capybara/poltergeist/driver.rb', line 50

def phantomjs_options
  list = options[:phantomjs_options] || []
  list += ["--remote-debugger-port=#{inspector.port}", "--remote-debugger-autorun=yes"] if inspector
  list
end

#quit ⇒ Object 



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

def quit
  server.stop
  client.stop
end

#remove_cookie(name) ⇒ Object 



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

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

#reset! ⇒ Object 



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

def reset!
  browser.reset
  @started = false
end

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



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

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

#response_headers ⇒ Object 



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

def response_headers
  browser.response_headers
end

#restart ⇒ Object 



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

def restart
  browser.restart
end

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



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

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

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



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

def set_cookie(name, value, options = {})
  options[:name]  ||= name
  options[:value] ||= value

  if @started
    options[:domain] = URI.parse(browser.current_url).host
  else
    options[:domain] = Capybara.app_host || "127.0.0.1"
  end

  browser.set_cookie(options)
end

#source ⇒ Object 



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

def source
  browser.source.to_s
end

#status_code ⇒ Object 



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

def status_code
  browser.status_code
end

#timeout ⇒ Object 



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

def timeout
  server.timeout
end

#timeout=(sec) ⇒ Object 



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

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

#visit(url) ⇒ Object 



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

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

#wait? ⇒ Boolean

Returns:

  • (Boolean) 


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

def wait?
  true
end

#within_frame(name, &block) ⇒ Object 



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

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

#within_window(name, &block) ⇒ Object 



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

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