Class: Capybara::Session

Inherits:
Object
  • Object
show all
Defined in:
lib/capybara/session.rb

Overview

The Session class represents a single user’s interaction with the system. The Session can use any of the underlying drivers. A session can be initialized manually like this:

session = Capybara::Session.new(:culerity, MyRackApp)

The application given as the second argument is optional. When running Capybara against an external page, you might want to leave it out:

session = Capybara::Session.new(:culerity)
session.visit('http://www.google.com')

Session provides a number of methods for controlling the navigation of the page, such as visit, +current_path, and so on. It also delegate a number of methods to a Capybara::Document, representing the current HTML document. This allows interaction:

session.fill_in('q', :with => 'Capybara')
session.click_button('Search')
session.should have_content('Capybara')

When using capybara/dsl, the Session is initialized automatically for you.

Constant Summary collapse

NODE_METHODS =
[
  :all, :first, :attach_file, :text, :check, :choose,
  :click_link_or_button, :click_button, :click_link, :field_labeled,
  :fill_in, :find, :find_button, :find_by_id, :find_field, :find_link,
  :has_content?, :has_text?, :has_css?, :has_no_content?, :has_no_text?,
  :has_no_css?, :has_no_xpath?, :resolve, :has_xpath?, :select, :uncheck,
  :has_link?, :has_no_link?, :has_button?, :has_no_button?, :has_field?,
  :has_no_field?, :has_checked_field?, :has_unchecked_field?,
  :has_no_table?, :has_table?, :unselect, :has_select?, :has_no_select?,
  :has_selector?, :has_no_selector?, :click_on, :has_no_checked_field?,
  :has_no_unchecked_field?, :query, :assert_selector, :assert_no_selector
]
SESSION_METHODS =
[
  :body, :html, :current_url, :current_host, :evaluate_script, :source,
  :visit, :within, :within_fieldset, :within_table, :within_frame,
  :within_window, :current_path, :save_page, :save_and_open_page,
  :save_screenshot, :reset_session!, :response_headers, :status_code,
  :title, :has_title?, :has_no_title?, :current_scope
]
DSL_METHODS =
NODE_METHODS + SESSION_METHODS

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(mode, app = nil) ⇒ Session

Returns a new instance of Session.



51
52
53
54
55
56
57
58
59
60
# File 'lib/capybara/session.rb', line 51

def initialize(mode, app=nil)
  @mode = mode
  @app = app
  if Capybara.run_server and @app and driver.needs_server?
    @server = Capybara::Server.new(@app).boot
  else
    @server = nil
  end
  @touched = false
end

Instance Attribute Details

#appObject (readonly)

Returns the value of attribute app.



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

def app
  @app
end

#modeObject (readonly)

Returns the value of attribute mode.



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

def mode
  @mode
end

#serverObject (readonly)

Returns the value of attribute server.



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

def server
  @server
end

#synchronizedObject

Returns the value of attribute synchronized.



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

def synchronized
  @synchronized
end

Instance Method Details

#current_hostString

Returns Host of the current page.

Returns:

  • (String)

    Host of the current page



129
130
131
132
# File 'lib/capybara/session.rb', line 129

def current_host
  uri = URI.parse(current_url)
  "#{uri.scheme}://#{uri.host}" if uri.host
end

#current_pathString

Returns Path of the current page, without any domain information.

Returns:

  • (String)

    Path of the current page, without any domain information



120
121
122
123
# File 'lib/capybara/session.rb', line 120

def current_path
  path = URI.parse(current_url).path
  path if path and not path.empty?
end

#current_scopeObject



384
385
386
# File 'lib/capybara/session.rb', line 384

def current_scope
  scopes.last
end

#current_urlString

Returns Fully qualified URL of the current page.

Returns:

  • (String)

    Fully qualified URL of the current page



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

def current_url
  driver.current_url
end

#documentObject



347
348
349
# File 'lib/capybara/session.rb', line 347

def document
  @document ||= Capybara::Node::Document.new(self, driver)
end

#driverObject



62
63
64
65
66
67
68
69
70
# File 'lib/capybara/session.rb', line 62

def driver
  @driver ||= begin
    unless Capybara.drivers.has_key?(mode)
      other_drivers = Capybara.drivers.keys.map { |key| key.inspect }
      raise Capybara::DriverNotFoundError, "no driver called #{mode.inspect} was found, available drivers: #{other_drivers.join(', ')}"
    end
    Capybara.drivers[mode].call(app)
  end
end

#evaluate_script(script) ⇒ Object

Evaluate the given JavaScript and return the result. Be careful when using this with scripts that return complex objects, such as jQuery statements. execute_script might be a better alternative.

Parameters:

  • script (String)

    A string of JavaScript to evaluate

Returns:

  • (Object)

    The result of the evaluated JavaScript (may be driver specific)



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

def evaluate_script(script)
  @touched = true
  driver.evaluate_script(script)
end

#execute_script(script) ⇒ Object

Execute the given script, not returning a result. This is useful for scripts that return complex objects, such as jQuery statements. execute_script should be used over evaluate_script whenever possible.

Parameters:

  • script (String)

    A string of JavaScript to execute



289
290
291
292
# File 'lib/capybara/session.rb', line 289

def execute_script(script)
  @touched = true
  driver.execute_script(script)
end

#has_no_title?(content) ⇒ Boolean

Returns:

  • (Boolean)


373
374
375
376
377
378
379
380
381
382
# File 'lib/capybara/session.rb', line 373

def has_no_title?(content)
  document.synchronize do
    if title.match(Capybara::Helpers.to_regexp(content))
      raise ExpectationNotMet
    end
  end
  return true
rescue Capybara::ExpectationNotMet
  return false
end

#has_title?(content) ⇒ Boolean

Returns:

  • (Boolean)


362
363
364
365
366
367
368
369
370
371
# File 'lib/capybara/session.rb', line 362

def has_title?(content)
  document.synchronize do
    unless title.match(Capybara::Helpers.to_regexp(content))
      raise ExpectationNotMet
    end
  end
  return true
rescue Capybara::ExpectationNotMet
  return false
end

#htmlString Also known as: body, source

Returns A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).

Returns:

  • (String)

    A snapshot of the DOM of the current document, as it looks right now (potentially modified by JavaScript).



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

def html
  driver.html
end

#inspectObject



358
359
360
# File 'lib/capybara/session.rb', line 358

def inspect
  %(#<Capybara::Session>)
end

#reset!Object Also known as: cleanup!, reset_session!

Reset the session, removing all cookies.



76
77
78
79
80
81
82
# File 'lib/capybara/session.rb', line 76

def reset!
  driver.reset! if @touched
  @touched = false
  raise @server.error if Capybara.raise_server_errors and @server and @server.error
ensure
  @server.reset_error! if @server
end

#response_headersHash{String => String}

Returns a hash of response headers. Not supported by all drivers (e.g. Selenium)

Returns:

  • (Hash{String => String})

    A hash of response headers.



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

def response_headers
  driver.response_headers
end

#save_and_open_page(file_name = nil) ⇒ Object

Save a snapshot of the page and open it in a browser for inspection

Parameters:

  • file_name (String) (defaults to: nil)

    The path to where it should be saved [optional]



330
331
332
333
334
335
# File 'lib/capybara/session.rb', line 330

def save_and_open_page(file_name=nil)
  require "launchy"
  Launchy.open(save_page(file_name))
rescue LoadError
  warn "Please install the launchy gem to open page with save_and_open_page"
end

#save_page(path = nil) ⇒ Object

Save a snapshot of the page.

Parameters:

  • path (String) (defaults to: nil)

    The path to where it should be saved [optional]



314
315
316
317
318
319
320
321
322
# File 'lib/capybara/session.rb', line 314

def save_page(path=nil)
  path ||= "capybara-#{Time.new.strftime("%Y%m%d%H%M%S")}#{rand(10**10)}.html"
  path = File.expand_path(path, Capybara.save_and_open_page_path) if Capybara.save_and_open_page_path

  FileUtils.mkdir_p(File.dirname(path))

  File.open(path,'w') { |f| f.write(Capybara::Helpers.inject_asset_host(body)) }
  path
end

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

Save a screenshot of page

Parameters:

  • path (String)

    A string of image path

  • [Hash] (Hash)

    a customizable set of options



343
344
345
# File 'lib/capybara/session.rb', line 343

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

#status_codeInteger

Returns the current HTTP status code as an Integer. Not supported by all drivers (e.g. Selenium)

Returns:

  • (Integer)

    Current HTTP status code



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

def status_code
  driver.status_code
end

#titleString

Returns Title of the current page.

Returns:

  • (String)

    Title of the current page



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

def title
  driver.title
end

#visit(url) ⇒ Object

Navigate to the given URL. The URL can either be a relative URL or an absolute URL The behaviour of either depends on the driver.

session.visit('/foo')
session.visit('http://google.com')

For drivers which can run against an external application, such as the selenium driver giving an absolute URL will navigate to that page. This allows testing applications running on remote servers. For these drivers, setting Capybara.app_host will make the remote server the default. For example:

Capybara.app_host = 'http://google.com'
session.visit('/') # visits the google homepage

If Capybara.always_include_port is set to true and this session is running against a rack application, then the port that the rack application is running on will automatically be inserted into the URL. Supposing the app is running on port ‘4567`, doing something like:

visit("http://google.com/test")

Will actually navigate to ‘google.com:4567/test`.

Parameters:

  • url (String)

    The URL to navigate to



176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
# File 'lib/capybara/session.rb', line 176

def visit(url)
  @touched = true

  if url !~ /^http/ and Capybara.app_host
    url = Capybara.app_host + url.to_s
  end

  if @server
    url = "http://#{@server.host}:#{@server.port}" + url.to_s unless url =~ /^http/

    if Capybara.always_include_port
      uri = URI.parse(url)
      uri.port = @server.port if uri.port == uri.default_port
      url = uri.to_s
    end
  end

  driver.visit(url)
end

#within(*find_args) ⇒ Object #within(a_node) ⇒ Object

Execute the given block for a particular scope on the page. Within will find the first element matching the given selector and execute the block scoped to that element:

within(:xpath, '//div[@id="delivery-address"]') do
  fill_in('Street', :with => '12 Main Street')
end

It is possible to omit the first parameter, in that case, the selector is assumed to be of the type set in Capybara.default_selector.

within('div#delivery-address') do
  fill_in('Street', :with => '12 Main Street')
end

Overloads:

  • #within(a_node) ⇒ Object

    Parameters:

Raises:



220
221
222
223
224
225
226
227
228
# File 'lib/capybara/session.rb', line 220

def within(*args)
  new_scope = if args.first.is_a?(Capybara::Node::Base) then args.first else find(*args) end
  begin
    scopes.push(new_scope)
    yield
  ensure
    scopes.pop
  end
end

#within_fieldset(locator) ⇒ Object

Execute the given block within the a specific fieldset given the id or legend of that fieldset.

Parameters:

  • locator (String)

    Id or legend of the fieldset



236
237
238
239
240
# File 'lib/capybara/session.rb', line 236

def within_fieldset(locator)
  within :fieldset, locator do
    yield
  end
end

#within_frame(index) ⇒ Object #within_frame(name) ⇒ Object

Execute the given block within the given iframe using given frame name or index. May be supported by not all drivers. Drivers that support it, may provide additional options.

Overloads:

  • #within_frame(index) ⇒ Object

    Parameters:

    • index (Integer)

      index of a frame

  • #within_frame(name) ⇒ Object

    Parameters:

    • name (String)

      name of a frame



264
265
266
267
268
# File 'lib/capybara/session.rb', line 264

def within_frame(frame_handle)
  driver.within_frame(frame_handle) do
    yield
  end
end

#within_table(locator) ⇒ Object

Execute the given block within the a specific table given the id or caption of that table.

Parameters:

  • locator (String)

    Id or caption of the table



248
249
250
251
252
# File 'lib/capybara/session.rb', line 248

def within_table(locator)
  within :table, locator do
    yield
  end
end

#within_window(handle, &blk) ⇒ Object

Execute the given block within the given window. Only works on some drivers (e.g. Selenium)

Parameters:

  • handle (String)

    of the window



277
278
279
# File 'lib/capybara/session.rb', line 277

def within_window(handle, &blk)
  driver.within_window(handle, &blk)
end