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
18
19
# File 'lib/capybara/poltergeist/driver.rb', line 9

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

  @app_server = Capybara::Server.new(app)
  @app_server.boot if Capybara.run_server
end

Instance Attribute Details

#appObject (readonly)

Returns the value of attribute app.



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

def app
  @app
end

#app_serverObject (readonly)

Returns the value of attribute app_server.



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

def app_server
  @app_server
end

#browserObject (readonly)

Returns the value of attribute browser.



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

def browser
  @browser
end

#clientObject (readonly)

Returns the value of attribute client.



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

def client
  @client
end

#optionsObject (readonly)

Returns the value of attribute options.



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

def options
  @options
end

#serverObject (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

#bodyObject



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

def body
  browser.body
end

#client_pidObject



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

def client_pid
  client.pid
end

#cookiesObject



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

def cookies
  browser.cookies
end

#current_urlObject



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

def current_url
  browser.current_url
end

#debugObject



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

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



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

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

#execute_script(script) ⇒ Object



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

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

#find(selector) ⇒ Object



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

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

#headers=(headers) ⇒ Object



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

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

#inspectorObject



25
26
27
# File 'lib/capybara/poltergeist/driver.rb', line 25

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

#invalid_element_errorsObject



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

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

#js_errorsObject



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

def js_errors
  options.fetch(:js_errors, true)
end

#loggerObject

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



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

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

#network_trafficObject



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

def network_traffic
  browser.network_traffic
end

#pauseObject



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

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

#phantomjs_optionsObject



44
45
46
47
48
# File 'lib/capybara/poltergeist/driver.rb', line 44

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

#quitObject



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

def quit
  server.stop
  client.stop
end


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

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

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



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

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

#reset!Object



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

def reset!
  browser.reset
end

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



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

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

#response_headersObject



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

def response_headers
  browser.response_headers
end

#restartObject



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

def restart
  browser.restart
end


150
151
152
153
154
155
156
# File 'lib/capybara/poltergeist/driver.rb', line 150

def set_cookie(name, value, options = {})
  browser.set_cookie({
    :name   => name,
    :value  => value,
    :domain => URI.parse(app_server.url('')).host
  }.merge(options))
end

#sourceObject



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

def source
  browser.source.to_s
end

#status_codeObject



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

def status_code
  browser.status_code
end

#timeoutObject



54
55
56
# File 'lib/capybara/poltergeist/driver.rb', line 54

def timeout
  server.timeout
end

#timeout=(sec) ⇒ Object



58
59
60
# File 'lib/capybara/poltergeist/driver.rb', line 58

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

#visit(path) ⇒ Object



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

def visit(path)
  browser.visit app_server.url(path)
end

#wait?Boolean

Returns:

  • (Boolean)


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

def wait?
  true
end

#within_frame(name, &block) ⇒ Object



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

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

#within_window(name, &block) ⇒ Object



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

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