From 0ac9be6cbd1c71e770093a151ea2f9a9ff88930b Mon Sep 17 00:00:00 2001 From: Jonas Nicklas Date: Sat, 17 Jul 2010 16:03:46 +0200 Subject: [PATCH] Documentation for Node actions, deprecated drag --- lib/capybara/node/actions.rb | 94 ++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) diff --git a/lib/capybara/node/actions.rb b/lib/capybara/node/actions.rb index c7175bc8..0d091295 100644 --- a/lib/capybara/node/actions.rb +++ b/lib/capybara/node/actions.rb @@ -1,57 +1,151 @@ module Capybara class Node module Actions + + ## + # + # Finds a button or link by id, text or value and clicks it. Also looks at image + # alt text inside the link. + # + # @param [String] locator Text, id or value of link or button + # def click_link_or_button(locator) msg = "no link or button '#{locator}' found" locate(:xpath, XPath.link(locator).button(locator), :message => msg).click end + ## + # + # Finds a link by id or text and clicks it. Also looks at image + # alt text inside the link. + # + # @param [String] locator Text, id or text of link + # def click_link(locator) msg = "no link with title, id or text '#{locator}' found" locate(:xpath, XPath.link(locator), :message => msg).click end + ## + # + # Finds a button by id, text or value and clicks it. + # + # @param [String] locator Text, id or value of button + # def click_button(locator) msg = "no button with value or id or text '#{locator}' found" locate(:xpath, XPath.button(locator), :message => msg).click end + ## + # + # Locate a text field or text area and fill it in with the given text + # The field can be found via its name, id or label text. + # + # page.fill_in 'Name', :with => 'Bob' + # + # @param [String] locator Which field to fill in + # @param [Hash{:with => String}] The value to fill in + # def fill_in(locator, options={}) msg = "cannot fill in, no text field, text area or password field with id, name, or label '#{locator}' found" raise "Must pass a hash containing 'with'" if not options.is_a?(Hash) or not options.has_key?(:with) locate(:xpath, XPath.fillable_field(locator), :message => msg).set(options[:with]) end + ## + # + # Find a radio button and mark it as checked. The radio button can be found + # via name, id or label text. + # + # page.choose('Male') + # + # @param [String] locator Which radio button to choose + # def choose(locator) msg = "cannot choose field, no radio button with id, name, or label '#{locator}' found" locate(:xpath, XPath.radio_button(locator), :message => msg).set(true) end + ## + # + # Find a check box and mark it as checked. The check box can be found + # via name, id or label text. + # + # page.check('German') + # + # @param [String] locator Which check box to check + # def check(locator) msg = "cannot check field, no checkbox with id, name, or label '#{locator}' found" locate(:xpath, XPath.checkbox(locator), :message => msg).set(true) end + ## + # + # Find a check box and mark uncheck it. The check box can be found + # via name, id or label text. + # + # page.uncheck('German') + # + # @param [String] locator Which check box to uncheck + # def uncheck(locator) msg = "cannot uncheck field, no checkbox with id, name, or label '#{locator}' found" locate(:xpath, XPath.checkbox(locator), :message => msg).set(false) end + ## + # + # Find a select box on the page and select a particular option from it. If the select + # box is a multiple select, +select+ can be called multiple times to select more than + # one option. The select box can be found via its name, id or label text. + # + # page.uncheck('German') + # + # @param [String] locator Which check box to uncheck + # def select(value, options={}) msg = "cannot select option, no select box with id, name, or label '#{options[:from]}' found" locate(:xpath, XPath.select(options[:from]), :message => msg).select_option(value) end + ## + # + # Find a select box on the page and select a particular option from it. If the select + # box is a multiple select, +select+ can be called multiple times to select more than + # one option. The select box can be found via its name, id or label text. + # + # page.uncheck('German') + # + # @param [String] locator Which check box to uncheck + # def unselect(value, options={}) msg = "cannot unselect option, no select box with id, name, or label '#{options[:from]}' found" locate(:xpath, XPath.select(options[:from]), :message => msg).unselect_option(value) end + ## + # + # Find a file field on the page and attach a file given its path. The file field can + # be found via its name, id or label text. + # + # page.attach_file(locator, '/path/to/file.png') + # + # @param [String] locator Which field to attach the file to + # @param [String] path The path of the file that will be attached + # def attach_file(locator, path) msg = "cannot attach file, no file field with id, name, or label '#{locator}' found" locate(:xpath, XPath.file_field(locator), :message => msg).set(path) end + ## + # + # Drag one element to another + # + # @deprecated Use Capybara::Element#drag_to instead. + # def drag(source_locator, target_locator) source = locate(:xpath, source_locator, :message => "drag source '#{source_locator}' not found on page") target = locate(:xpath, target_locator, :message => "drag target '#{target_locator}' not found on page")