Module: Capybara

Extended by:

DSL

Defined in:

lib/capybara.rb,
lib/capybara/dsl.rb,
lib/capybara/server.rb,
lib/capybara/session.rb,
lib/capybara/version.rb,
lib/capybara/selector.rb,
lib/capybara/node/base.rb,
lib/capybara/driver/node.rb,
lib/capybara/node/simple.rb,
lib/capybara/node/actions.rb,
lib/capybara/node/element.rb,
lib/capybara/node/finders.rb,
lib/capybara/util/timeout.rb,
lib/capybara/node/matchers.rb,
lib/capybara/node/document.rb,
lib/capybara/rspec/matchers.rb,
lib/capybara/rspec/features.rb,
lib/capybara/util/save_and_open_page.rb

Defined Under Namespace

Modules: DSL, Driver, Features, Node, RSpecMatchers, RackTest, Selenium Classes: CapybaraError, DriverNotFoundError, ElementNotFound, FileNotFound, InfiniteRedirectError, LocateHiddenElementError, NotSupportedByDriverError, Selector, Server, Session, TimeoutError, UnselectNotAllowed

Constant Summary

VERSION =

'1.0.0'

Class Attribute Summary (collapse)

• + (Object) app

  Returns the value of attribute app.

• + (Object) app_host

  Returns the value of attribute app_host.

• + (Object) asset_root

  Returns the value of attribute asset_root.

• + (Symbol) current_driver (also: mode)

  The name of the driver currently in use.

• + (Symbol) default_driver

  The name of the driver to use by default.

• + (Object) default_host

  Returns the value of attribute default_host.

• + (Object) default_selector

  Returns the value of attribute default_selector.

• + (Object) default_wait_time

  Returns the value of attribute default_wait_time.

• + (Object) ignore_hidden_elements

  Returns the value of attribute ignore_hidden_elements.

• + (Symbol) javascript_driver

  The name of the driver used when JavaScript is needed.

• + (Object) prefer_visible_elements

  Returns the value of attribute prefer_visible_elements.

• + (Object) run_server

  Returns the value of attribute run_server.

• + (Object) save_and_open_page_path

  Returns the value of attribute save_and_open_page_path.

• + (Object) server_boot_timeout

  Returns the value of attribute server_boot_timeout.

• + (Object) server_port

  Returns the value of attribute server_port.

• + (Symbol) session_name

  The current session name.

Class Method Summary (collapse)

• + (Object) add_selector(name) { ... }

  Add a new selector to Capybara.

• + (Object) configure {|_self| ... }

  Configure Capybara to suit your needs.

• + (Capybara::Session) current_session

  The current Capybara::Session base on what is set as Capybara.app and Capybara.current_driver.

• + (Object) deprecate(method, alternate_method)
• + (Object) drivers
• + (Object) included(base)
• + (Object) register_driver(name) {|app| ... }

  Register a new driver for Capybara.

• + (Object) reset_sessions! (also: reset!)

  Reset sessions, cleaning out the pool of sessions.

• + (Object) run_default_server(app, port)

  Runs Capybara's default server for the given application and port under most circumstances you should not have to call this method manually.

• + (Object) save_and_open_page(html, file_name = nil)
• + (Object) save_page(html, file_name = nil)
• + (Object) server {|app, port| ... }

  Register a proc that Capybara will call to run the Rack application.

• + (Capybara::Node::Simple) string(html)

  Wraps the given string, which should contain an HTML document or fragment in a Node::Simple which exposes all Node::Matchers and Node::Finders.

• + (Object) timeout(seconds = 1, driver = nil, error_message = nil, &block)

  Provides timeout similar to standard library Timeout, but avoids threads.

• + (Object) use_default_driver

  Use the default driver as the current driver.

• + (Object) using_driver(driver)

  Yield a block using a specific driver.

• + (Object) using_session(name)

  Yield a block using a specific session name.

Methods included from DSL

page, using_session

12
13
14

# File 'lib/capybara/dsl.rb', line 12

def app
  @app
end

16
17
18

# File 'lib/capybara.rb', line 16

def app_host
  @app_host
end

16
17
18

# File 'lib/capybara.rb', line 16

def asset_root
  @asset_root
end

26
27
28

# File 'lib/capybara/dsl.rb', line 26

def current_driver
  @current_driver || default_driver
end

18
19
20

# File 'lib/capybara/dsl.rb', line 18

def default_driver
  @default_driver || :rack_test
end

16
17
18

# File 'lib/capybara.rb', line 16

def default_host
  @default_host
end

18
19
20

# File 'lib/capybara.rb', line 18

def default_selector
  @default_selector
end

18
19
20

# File 'lib/capybara.rb', line 18

def default_wait_time
  @default_wait_time
end

18
19
20

# File 'lib/capybara.rb', line 18

def ignore_hidden_elements
  @ignore_hidden_elements
end

35
36
37

# File 'lib/capybara/dsl.rb', line 35

def javascript_driver
  @javascript_driver || :selenium
end

18
19
20

# File 'lib/capybara.rb', line 18

def prefer_visible_elements
  @prefer_visible_elements
end

16
17
18

# File 'lib/capybara.rb', line 16

def run_server
  @run_server
end

19
20
21

# File 'lib/capybara.rb', line 19

def save_and_open_page_path
  @save_and_open_page_path
end

17
18
19

# File 'lib/capybara.rb', line 17

def server_boot_timeout
  @server_boot_timeout
end

17
18
19

# File 'lib/capybara.rb', line 17

def server_port
  @server_port
end

84
85
86

# File 'lib/capybara/dsl.rb', line 84

def session_name
  @session_name ||= :default
end

Capybara.add_selector(:row) do
  xpath { |num| ".//tbody/tr[#{num}]" }
end

find(:row, 3)
page.find('table#myTable').find(:row, 3).text
page.find('table#myTable').has_selector?(:row, 3)
within(:row, 3) { page.should have_content('$100.000') }

Capybara.add_selector(:id) do
  xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] }
  match { |value| value.is_a?(Symbol) }
end

find(:post_123)

104
105
106

# File 'lib/capybara.rb', line 104

def add_selector(name, &block)
  Capybara::Selector.add(name, &block)
end

Capybara.configure do |config|
  config.run_server = false
  config.app_host   = 'http://www.google.com'
end

47
48
49

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

def configure
  yield self
end

64
65
66

# File 'lib/capybara/dsl.rb', line 64

def current_session
  session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app)
end

180
181
182

# File 'lib/capybara.rb', line 180

def deprecate(method, alternate_method)
  warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead"
end

108
109
110

# File 'lib/capybara.rb', line 108

def drivers
  @drivers ||= {}
end

4
5
6
7

# File 'lib/capybara/dsl.rb', line 4

def self.included(base)
  base.send(:include, Capybara::DSL)
  warn "`include Capybara` is deprecated please use `include Capybara::DSL` instead."
end

Capybara.register_driver :rack_test do |app|
  Capybara::Driver::RackTest.new(app)
end

64
65
66

# File 'lib/capybara.rb', line 64

def register_driver(name, &block)
  drivers[name] = block
end

73
74
75

# File 'lib/capybara/dsl.rb', line 73

def reset_sessions!
  session_pool.each { |mode, session| session.reset! }
end

169
170
171
172
173
174
175
176
177
178

# File 'lib/capybara.rb', line 169

def run_default_server(app, port)
  begin
    require 'rack/handler/thin'
    Thin::Logging.silent = true
    Rack::Handler::Thin.run(app, :Port => port)
  rescue LoadError
    require 'rack/handler/webrick'
    Rack::Handler::WEBrick.run(app, :Port => port, :AccessLog => [], :Logger => WEBrick::Log::new(nil, 0))
  end
end

18
19
20

# File 'lib/capybara/util/save_and_open_page.rb', line 18

def save_and_open_page(html, file_name=nil)
  open_in_browser save_page(html, file_name)
end

3
4
5
6
7
8
9
10
11
12
13
14
15
16

# File 'lib/capybara/util/save_and_open_page.rb', line 3

def save_page(html, file_name=nil)
  file_name ||= "capybara-#{Time.new.strftime("%Y%m%d%H%M%S")}#{rand(10**10)}.html"
  name = File.join(*[Capybara.save_and_open_page_path, file_name].compact)

  unless Capybara.save_and_open_page_path.nil? || File.directory?(Capybara.save_and_open_page_path )
    FileUtils.mkdir_p(Capybara.save_and_open_page_path)
  end
  FileUtils.touch(name) unless File.exist?(name)

  tempfile = File.new(name,'w')
  tempfile.write(rewrite_css_and_image_references(html))
  tempfile.close
  tempfile.path
end

Capybara.server do |app, port|
  require 'rack/handler/mongrel'
  Rack::Handler::Mongrel.run(app, :Port => port)
end

125
126
127
128
129
130
131

# File 'lib/capybara.rb', line 125

def server(&block)
  if block_given?
    @server = block
  else
    @server
  end
end

node = Capybara.string <<-HTML
  <ul>
    <li id="home">Home</li>
    <li id="projects">Projects</li>
  </ul>
HTML

node.find('#projects').text # => 'Projects'
node.has_selector?('li#home', :text => 'Home')
node.has_selector?(:projects)
node.find('ul').find('li').text # => 'Home'

156
157
158

# File 'lib/capybara.rb', line 156

def string(html)
  Capybara::Node::Simple.new(html)
end

7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

# File 'lib/capybara/util/timeout.rb', line 7

def timeout(seconds = 1, driver = nil, error_message = nil, &block)
  start_time = Time.now

  result = nil

  until result
    return result if result = yield

    delay = seconds - (Time.now - start_time)
    if delay <= 0
      raise TimeoutError, error_message || "timed out"
    end

    driver && driver.wait_until(delay)

    sleep(0.05)
  end
end

43
44
45

# File 'lib/capybara/dsl.rb', line 43

def use_default_driver
  @current_driver = nil
end

51
52
53
54
55
56

# File 'lib/capybara/dsl.rb', line 51

def using_driver(driver)
  Capybara.current_driver = driver
  yield
ensure
  Capybara.use_default_driver
end

92
93
94
95
96
97

# File 'lib/capybara/dsl.rb', line 92

def using_session(name)
  self.session_name = name
  yield
ensure
  self.session_name = :default
end