Class: Capybara::Session

Inherits:

Object

• Object
• Capybara::Session

show all

Defined in:

lib/capybara/session.rb

Overview

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

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

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

Constant Summary

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
]

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, :reset_session!
]

DSL_METHODS =

NODE_METHODS + SESSION_METHODS

Instance Attribute Summary (collapse)

• - (Object) app readonly

  Returns the value of attribute app.

• - (Object) mode readonly

  Returns the value of attribute mode.

Instance Method Summary (collapse)

• - (String) current_host

  Host of the current page.

• - (String) current_path

  Path of the current page, without any domain information.

• - (String) current_url

  Fully qualified URL of the current page.

• - (Object) document
• - (Object) driver
• - (Object) evaluate_script(script)

  Evaluate the given JavaScript and return the result.

• - (Object) execute_script(script)

  Execute the given script, not returning a result.

• - (String) html

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

• - (Session) initialize(mode, app = nil) constructor

  A new instance of Session.

• - (Object) inspect
• - (Object) reset! (also: #cleanup!, #reset_session!)

  Reset the session, removing all cookies.

• - (Hash{String => String}) response_headers

  Returns a hash of response headers.

• - (Object) save_and_open_page
• - (Object) save_page

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

• - (String) source (also: #body)

  HTML source of the document, before being modified by JavaScript.

• - (Integer) status_code

  Returns the current HTTP status code as an Integer.

• - (Object) visit(url)

  Navigate to the given URL.

• - (Object) within(*args)

  Execute the given block for a particular scope on the page.

• - (Object) within_fieldset(locator)

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

• - (Object) within_frame(frame_id)

  Execute the given block within the given iframe given the id of that iframe.

• - (Object) within_table(locator)

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

• - (Object) within_window(handle, &blk)

  Execute the given block within the given window.

49
50
51
52

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

def initialize(mode, app=nil)
  @mode = mode
  @app = app
end

47
48
49

# File 'lib/capybara/session.rb', line 47

def app
  @app
end

47
48
49

# File 'lib/capybara/session.rb', line 47

def mode
  @mode
end

124
125
126
127

# File 'lib/capybara/session.rb', line 124

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

115
116
117
118

# File 'lib/capybara/session.rb', line 115

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

133
134
135

# File 'lib/capybara/session.rb', line 133

def current_url
  driver.current_url
end

284
285
286

# File 'lib/capybara/session.rb', line 284

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

54
55
56
57
58
59
60
61
62

# File 'lib/capybara/session.rb', line 54

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

266
267
268

# File 'lib/capybara/session.rb', line 266

def evaluate_script(script)
  driver.evaluate_script(script)
end

253
254
255

# File 'lib/capybara/session.rb', line 253

def execute_script(script)
  driver.execute_script(script)
end

98
99
100

# File 'lib/capybara/session.rb', line 98

def html
  driver.body
end

296
297
298

# File 'lib/capybara/session.rb', line 296

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

68
69
70

# File 'lib/capybara/session.rb', line 68

def reset!
  driver.reset!
end

80
81
82

# File 'lib/capybara/session.rb', line 80

def response_headers
  driver.response_headers
end

279
280
281
282

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

def save_and_open_page
  require 'capybara/util/save_and_open_page'
  Capybara.save_and_open_page(body)
end

274
275
276
277

# File 'lib/capybara/session.rb', line 274

def save_page
  require 'capybara/util/save_and_open_page'
  Capybara.save_page(body)
end

106
107
108

# File 'lib/capybara/session.rb', line 106

def source
  driver.source
end

90
91
92

# File 'lib/capybara/session.rb', line 90

def status_code
  driver.status_code
end

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

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

155
156
157

# File 'lib/capybara/session.rb', line 155

def visit(url)
  driver.visit(url)
end

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

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

183
184
185
186
187
188
189
190
191
192
193
194
195

# File 'lib/capybara/session.rb', line 183

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

203
204
205
206
207

# File 'lib/capybara/session.rb', line 203

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

228
229
230
231
232

# File 'lib/capybara/session.rb', line 228

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

215
216
217
218
219

# File 'lib/capybara/session.rb', line 215

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

241
242
243

# File 'lib/capybara/session.rb', line 241

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