Add a new selector to Capybara. Selectors can be used by various methods in Capybara to find certain elements on the page in a more convenient way. For example adding a selector to find certain table rows might look like this:
Capybara.add_selector(:row) do xpath { |num| ".//tbody/tr[#{num}]" } end
This makes it possible to use this selector in a variety of ways:
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') }
It might be convenient to specify that the selector is automatically chosen for certain values. This way you don't have to explicitly specify that you are looking for a row, or an id. Let's say we want Capybara to treat any Symbols sent into methods like find to be treated as though they were element ids. We could achieve this like so:
Capybara.add_selector(:id) do xpath { |id| XPath.descendant[XPath.attr(:id) == id.to_s] } match { |value| value.is_a?(Symbol) } end
Now we can retrieve elements by id like this:
find(:post_123)
Note that this particular selector already ships with Capybara.
@param [Symbol] name The name of the selector to add @yield A block executed in the context of the new {Capybara::Selector}
# File lib/capybara.rb, line 108 def add_selector(name, &block) Capybara::Selector.add(name, &block) end
Configure Capybara to suit your needs.
Capybara.configure do |config| config.run_server = false config.app_host = 'http://www.google.com' end
Where static assets are located, used by ::save_and_open_page
The default host to use when giving a relative URL to visit
Whether to start a Rack server for the given Rack app (Default: true)
Methods which take a selector use the given type by default (Default: CSS)
The number of seconds to wait for asynchronous processes to finish (Default: 2)
Whether to ignore hidden elements on the page (Default: false)
Whether to prefer visible elements over hidden elements (Default: true)
Whether to automatically reload elements as Capybara is waiting (Default: true)
Where to put pages saved through ::save_and_open_page (Default: Dir.pwd)
when using capybara/dsl, the following options are also available:
The name of the driver to use by default. (Default: :rack_test)
The name of a driver to use for JavaScript enabled tests. (Default: :selenium)
# File lib/capybara.rb, line 51 def configure yield self end
@return [Symbol] The name of the driver currently in use
# File lib/capybara/dsl.rb, line 26 def current_driver @current_driver || default_driver end
The current Capybara::Session base on what is set as ::app and ::current_driver
@return [Capybara::Session] The currently used session
# File lib/capybara/dsl.rb, line 77 def current_session session_pool["#{current_driver}:#{session_name}:#{app.object_id}"] ||= Capybara::Session.new(current_driver, app) end
@return [Symbol] The name of the driver to use by default
# File lib/capybara/dsl.rb, line 18 def default_driver @default_driver || :rack_test end
# File lib/capybara.rb, line 184 def deprecate(method, alternate_method) warn "DEPRECATED: ##{method} is deprecated, please use ##{alternate_method} instead" end
# File lib/capybara.rb, line 112 def drivers @drivers ||= {} end
# 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
@return [Symbol] The name of the driver used when JavaScript is needed
# File lib/capybara/dsl.rb, line 35 def javascript_driver @javascript_driver || :selenium end
Register a new driver for Capybara.
Capybara.register_driver :rack_test do |app| Capybara::Driver::RackTest.new(app) end
@param [Symbol] name The name of the new driver @yield [app] This block takes a rack app and returns a Capybara driver @yieldparam [<Rack>] app The rack application that this driver runs agains. May be nil. @yieldreturn [Capybara::Driver::Base] A Capybara driver instance
# File lib/capybara.rb, line 68 def register_driver(name, &block) drivers[name] = block end
Reset sessions, cleaning out the pool of sessions. This will remove any session information such as cookies.
# File lib/capybara/dsl.rb, line 86 def reset_sessions! session_pool.each { |mode, session| session.reset! } end
Runs Capybara's default server for the given application and port under most circumstances you should not have to call this method manually.
@param [Rack Application] app The rack application to run @param [Fixnum] port The port to run the application on
# File lib/capybara.rb, line 173 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
# 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
# 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
Register a proc that Capybara will call to run the Rack application.
Capybara.server do |app, port| require 'rack/handler/mongrel' Rack::Handler::Mongrel.run(app, :Port => port) end
By default, Capybara will try to run thin, falling back to webrick.
@yield [app, port] This block recieves a rack app and port and should run a Rack handler
# File lib/capybara.rb, line 129 def server(&block) if block_given? @server = block else @server end end
The current session name.
@return [Symbol] The name of the currently used session.
# File lib/capybara/dsl.rb, line 97 def session_name @session_name ||= :default end
Wraps the given string, which should contain an HTML document or fragment in a {Capybara::Node::Simple} which exposes all {Capybara::Node::Matchers} and {Capybara::Node::Finders}. This allows you to query any string containing HTML in the exact same way you would query the current document in a Capybara session. For example:
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'
@param [String] html An html fragment or document @return [Capybara::Node::Simple] A node which has Capybara's finders and matchers
# File lib/capybara.rb, line 160 def string(html) Capybara::Node::Simple.new(html) end
Provides timeout similar to standard library Timeout, but avoids threads
# 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
Use the default driver as the current driver
# File lib/capybara/dsl.rb, line 43 def use_default_driver @current_driver = nil end
Yield a block using a specific driver
# File lib/capybara/dsl.rb, line 51 def using_driver(driver) previous_driver = Capybara.current_driver Capybara.current_driver = driver yield ensure @current_driver = previous_driver end
Yield a block using a specific session name.
# File lib/capybara/dsl.rb, line 105 def using_session(name) self.session_name = name yield ensure self.session_name = :default end
Yield a block using a specific wait time
# File lib/capybara/dsl.rb, line 63 def using_wait_time(seconds) previous_wait_time = Capybara.default_wait_time Capybara.default_wait_time = seconds yield ensure Capybara.default_wait_time = previous_wait_time end
# File lib/capybara/util/save_and_open_page.rb, line 24 def open_in_browser(path) # :nodoc require "launchy" Launchy.open(path) rescue LoadError warn "Sorry, you need to install launchy (`gem install launchy`) and " << "make sure it's available to open pages with `save_and_open_page`." end
# File lib/capybara/dsl.rb, line 114 def session_pool @session_pool ||= {} end