2010-07-10 00:20:32 +00:00
module Capybara
2010-11-21 13:37:36 +00:00
module Node
2010-07-10 00:20:32 +00:00
module Actions
2010-07-17 14:03:46 +00:00
##
#
# 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
#
2013-02-24 15:28:48 +00:00
def click_link_or_button ( locator , options = { } )
find ( :link_or_button , locator , options ) . click
2010-07-10 00:20:32 +00:00
end
2010-10-29 11:41:49 +00:00
alias_method :click_on , :click_link_or_button
2010-07-10 00:20:32 +00:00
2010-07-17 14:03:46 +00:00
##
#
2014-08-24 13:20:45 +00:00
# Finds a link by id, text or title and clicks it. Also looks at image
2010-07-17 14:03:46 +00:00
# alt text inside the link.
#
2014-08-24 13:20:45 +00:00
# @param [String] locator text, id, title or nested image's alt attribute
2015-08-25 21:50:44 +00:00
# @param options See {Capybara::Node::Finders#find_link}
2010-07-17 14:03:46 +00:00
#
2013-02-19 20:12:54 +00:00
def click_link ( locator , options = { } )
find ( :link , locator , options ) . click
2010-07-10 00:20:32 +00:00
end
2010-07-17 14:03:46 +00:00
##
#
2015-08-25 21:50:44 +00:00
# Finds a button on the page and clicks it.
# This can be any \<input> element of type submit, reset, image, button or it can be a
# \<button> element. All buttons can be found by their id, value, or title. \<button> elements can also be found
# by their text content, and image \<input> elements by their alt attribute
2010-07-17 14:03:46 +00:00
#
2015-08-25 21:50:44 +00:00
# @param [String] locator Which button to find
# @param options See {Capybara::Node::Finders#find_button}
2013-02-24 15:36:08 +00:00
def click_button ( locator , options = { } )
find ( :button , locator , options ) . click
2010-07-10 00:20:32 +00:00
end
2010-07-17 14:03:46 +00:00
##
#
# 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'
#
2013-03-29 02:15:07 +00:00
# @param [String] locator Which field to fill in
2014-06-18 23:36:11 +00:00
# @param [Hash] options
# @option options [String] :with The value to fill in - required
# @option options [Hash] :fill_options Driver specific options regarding how to fill fields
2010-07-17 14:03:46 +00:00
#
2010-07-10 00:20:32 +00:00
def fill_in ( locator , options = { } )
raise " Must pass a hash containing 'with' " if not options . is_a? ( Hash ) or not options . has_key? ( :with )
2013-02-24 15:41:20 +00:00
with = options . delete ( :with )
2014-06-18 23:36:11 +00:00
fill_options = options . delete ( :fill_options )
find ( :fillable_field , locator , options ) . set ( with , fill_options )
2010-07-10 00:20:32 +00:00
end
2010-07-17 14:03:46 +00:00
##
#
# 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
#
2013-02-24 15:48:14 +00:00
def choose ( locator , options = { } )
find ( :radio_button , locator , options ) . set ( true )
2010-07-10 00:20:32 +00:00
end
2010-07-17 14:03:46 +00:00
##
#
# 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
#
2013-02-24 15:48:25 +00:00
def check ( locator , options = { } )
find ( :checkbox , locator , options ) . set ( true )
2010-07-10 00:20:32 +00:00
end
2010-07-17 14:03:46 +00:00
##
#
# 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
#
2013-02-24 15:48:33 +00:00
def uncheck ( locator , options = { } )
find ( :checkbox , locator , options ) . set ( false )
2010-07-10 00:20:32 +00:00
end
2010-07-17 14:03:46 +00:00
##
#
2014-08-24 13:20:45 +00:00
# If `:from` option is present, `select` finds a select box on the page
# and selects a particular option from it.
# Otherwise it finds an option inside current scope and selects 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. The option can be found by its text.
2010-07-17 14:03:46 +00:00
#
2010-12-08 21:37:22 +00:00
# page.select 'March', :from => 'Month'
2010-07-17 14:03:46 +00:00
#
2013-03-29 02:15:07 +00:00
# @param [String] value Which option to select
2014-08-24 13:20:45 +00:00
# @option options [String] :from The id, name or label of the select box
2010-07-17 14:03:46 +00:00
#
2010-07-10 00:20:32 +00:00
def select ( value , options = { } )
2010-10-03 17:15:40 +00:00
if options . has_key? ( :from )
2013-02-24 15:58:46 +00:00
from = options . delete ( :from )
find ( :select , from , options ) . find ( :option , value , options ) . select_option
2010-10-03 17:15:40 +00:00
else
2013-02-24 15:58:46 +00:00
find ( :option , value , options ) . select_option
2010-10-03 17:15:40 +00:00
end
2010-07-10 00:20:32 +00:00
end
2010-07-17 14:03:46 +00:00
##
#
2011-04-07 19:43:30 +00:00
# Find a select box on the page and unselect a particular option from it. If the select
# box is a multiple select, +unselect+ can be called multiple times to unselect more than
2010-07-17 14:03:46 +00:00
# one option. The select box can be found via its name, id or label text.
#
2011-04-07 19:43:30 +00:00
# page.unselect 'March', :from => 'Month'
2010-07-17 14:03:46 +00:00
#
2013-03-29 02:15:07 +00:00
# @param [String] value Which option to unselect
# @param [Hash{:from => String}] options The id, name or label of the select box
2010-07-17 14:03:46 +00:00
#
2010-07-10 00:20:32 +00:00
def unselect ( value , options = { } )
2010-10-03 17:15:40 +00:00
if options . has_key? ( :from )
2013-02-24 16:03:12 +00:00
from = options . delete ( :from )
find ( :select , from , options ) . find ( :option , value , options ) . unselect_option
2010-10-03 17:15:40 +00:00
else
2013-02-24 16:03:12 +00:00
find ( :option , value , options ) . unselect_option
2010-10-03 17:15:40 +00:00
end
2010-07-10 00:20:32 +00:00
end
2010-07-17 14:03:46 +00:00
##
#
# 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
2012-09-17 12:48:13 +00:00
# @param [String] path The path of the file that will be attached, or an array of paths
2010-07-17 14:03:46 +00:00
#
2016-02-27 22:28:42 +00:00
# @option options [Symbol] match (:smart) The matching strategy to use (:one, :first, :prefer_exact, :smart).
# @option options [Boolean] exact (true) Match the exact label name/contents or accept a partial match.
# @option options [Fixnum] wait (Capybara.default_max_wait_time) If using a Javascript driver, maximum number of seconds during which the element will be searched for.
# @option options [Boolean] multiple (true) Match field which allows multiple file selection
2016-02-26 19:33:32 +00:00
#
2013-02-24 16:06:01 +00:00
def attach_file ( locator , path , options = { } )
2012-11-20 21:51:25 +00:00
Array ( path ) . each do | p |
2012-09-17 12:48:13 +00:00
raise Capybara :: FileNotFound , " cannot attach file, #{ p } does not exist " unless File . exist? ( p . to_s )
end
2013-02-24 16:06:01 +00:00
find ( :file_field , locator , options ) . set ( path )
2010-07-10 00:20:32 +00:00
end
end
end
end