Bauxite Namespace\n"],["Bauxite::Action","","Bauxite/Action.html","","
Test action class.\n
Test actions are basic test operations that can be combined to create a\ntest case. …\n"],["Bauxite::ActionModule","","Bauxite/ActionModule.html","","
Action common state and behavior.\n"],["Bauxite::Application","","Bauxite/Application.html","","
bauxite command-line program.\n
This program executes Bauxite tests and outputs the execution progress and\n…\n"],["Bauxite::Context","","Bauxite/Context.html","","
The Main test context. This class includes state and helper functions used\nby clients execute tests and …\n"],["Bauxite::Errors","","Bauxite/Errors.html","","
Errors Module\n"],["Bauxite::Errors::AssertionError","","Bauxite/Errors/AssertionError.html","","
Error raised when an assertion fails.\n"],["Bauxite::Errors::FileNotFoundError","","Bauxite/Errors/FileNotFoundError.html","","
Error raised when an invalid file tried to be loaded.\n"],["Bauxite::Errors::FormatError","","Bauxite/Errors/FormatError.html","","
Error raised when trying to process an invalid file format.\n"],["Bauxite::Loggers","","Bauxite/Loggers.html","","
Test loggers module\n
The default Logger class and all custom loggers must be included in this\nmodule.\n"],["Bauxite::Loggers::CompositeLogger","","Bauxite/Loggers/CompositeLogger.html","","
Composite logger.\n
This composite logger forwards logging calls to each of its children.\n
Set the :loggers …\n"],["Bauxite::Loggers::EchoLogger","","Bauxite/Loggers/EchoLogger.html","","
Echo logger.\n
This logger outputs the raw action text for every action executed.\n
Note that this logger does …\n"],["Bauxite::Loggers::FileLogger","","Bauxite/Loggers/FileLogger.html","","
File logger.\n
This logger outputs the raw action text for every action executed to the\nfile specified in …\n"],["Bauxite::Loggers::NullLogger","","Bauxite/Loggers/NullLogger.html","","
Test logger class.\n
Test loggers handle test output format.\n
The default logger does not provide any output …\n"],["Bauxite::Loggers::TerminalLogger","","Bauxite/Loggers/TerminalLogger.html","","
Terminal logger.\n
This logger outputs text using basic text formatting for a terminal window.\n"],["Bauxite::Loggers::XtermLogger","","Bauxite/Loggers/XtermLogger.html","","
XTerm logger.\n
This logger outputs colorized lines using xterm (VT100/2) escape sequences.\n"],["Bauxite::Parser","","Bauxite/Parser.html","","
Parser class.\n
Parser represent different strategies for reading input files into lists of\nBauxite actions. …\n"],["Bauxite::ParserModule","","Bauxite/ParserModule.html","","
Parser common state and behavior.\n"],["Bauxite::Selector","","Bauxite/Selector.html","","
Selector class.\n
Selectors represent different strategies for finding elements. Selenium\nprovides a list …\n"],["Bauxite::SelectorModule","","Bauxite/SelectorModule.html","","
Selector common state and behavior.\n"],["_block","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-_block","(color, text, size)","
Prints text centered inside a square-bracketed block.\n"],["_cmd_color","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-_cmd_color","(cmd)","
Get the color of cmd.\n"],["_fmt","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-_fmt","(color, text, size = 0)","
Centers text to a fixed size with.\n"],["_fmt","Bauxite::Loggers::XtermLogger","Bauxite/Loggers/XtermLogger.html#method-i-_fmt","(color, text, size = 0)",""],["_restore_cursor","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-_restore_cursor","()","
Restores the cursor to the previously saved cursor position.\n"],["_restore_cursor","Bauxite::Loggers::XtermLogger","Bauxite/Loggers/XtermLogger.html#method-i-_restore_cursor","()",""],["_save_cursor","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-_save_cursor","()","
Save the current cursor position,\n"],["_save_cursor","Bauxite::Loggers::XtermLogger","Bauxite/Loggers/XtermLogger.html#method-i-_save_cursor","()",""],["_screen_width","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-_screen_width","()","
Returns the terminal screen width.\n"],["_screen_width","Bauxite::Loggers::XtermLogger","Bauxite/Loggers/XtermLogger.html#method-i-_screen_width","()",""],["action_args","Bauxite::Context","Bauxite/Context.html#method-c-action_args","(action)","
Returns an array with the names of the arguments of the specified action.\n
For example:\n\n
Context::action_args ...\n"],["actions","Bauxite::Context","Bauxite/Context.html#method-c-actions","()","
Returns an array with the names of every action available.\n
For example:\n\n
Context::actions\n# => [ "assert", ...\n\n"],["add_alias","Bauxite::Context","Bauxite/Context.html#method-i-add_alias","(name, action, args)","
Adds an alias named name to the specified action\nwith the arguments specified in args.\n"],["alias_action","Bauxite::Action","Bauxite/Action.html#method-i-alias_action","(name, action, *args)","
Aliases name to action with additional arguments.\n
In args the variables ${1}..${n}\nwill be expanded to …\n"],["args","Bauxite::ActionModule","Bauxite/ActionModule.html#method-i-args","(quote = false)","
Returns the action arguments after applying variable expansion.\n
See Context#expand.\n
If quote is true, the …\n"],["assert","Bauxite::Action","Bauxite/Action.html#method-i-assert","(selector, text)","
Asserts that the value of the selected element matches text.\n
text is a regular expression. text can be …\n"],["assertv","Bauxite::Action","Bauxite/Action.html#method-i-assertv","(expected, actual)","
Asserts that the actual text matches the expected\ntext.\n
expected can be a regular expression. See #assert …\n"],["attr","Bauxite::Selector","Bauxite/Selector.html#method-i-attr","(arg, &block)","
Select an element by attribute value.\n
The attribute selector syntax is:\n\n
attr=name:value\n"],["break_action","Bauxite::Action","Bauxite/Action.html#method-i-break_action","()","
Prompts the user to press ENTER before resuming execution.\n
Note that this method provides an action named …\n"],["capture","Bauxite::Action","Bauxite/Action.html#method-i-capture","(file = nil)","
Captures a screenshot of the current browser window and saves it with\nspecified file name. If file is …\n"],["click","Bauxite::Action","Bauxite/Action.html#method-i-click","(selector)","
Triggers the click event on the selected element.\n
For example:\n\n
# assuming <button type="button" id="btn">click ...\n"],["csv","Bauxite::Parser","Bauxite/Parser.html#method-i-csv","(file)","
Load CSV files.\n"],["debug","Bauxite::Action","Bauxite/Action.html#method-i-debug","()","
Breaks into the debug console.\n
In the debug console you can type action strings and test their result. …\n"],["debug","Bauxite::Context","Bauxite/Context.html#method-i-debug","()","
Breaks into the debug console.\n
For example:\n\n
ctx.debug\n# => this breaks into the debug console\n\n"],["debug_prompt","Bauxite::Loggers::CompositeLogger","Bauxite/Loggers/CompositeLogger.html#method-i-debug_prompt","()","
Returns a colorized debug prompt.\n
This implementation returns the debug_prompt of the first logger.\n"],["debug_prompt","Bauxite::Loggers::NullLogger","Bauxite/Loggers/NullLogger.html#method-i-debug_prompt","()","
Returns the prompt shown by the debug console (see Context#debug).\n
For example:\n\n
log.debug_prompt\n# => returns ...\n\n"],["debug_prompt","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-debug_prompt","()","
Returns a colorized debug prompt.\n"],["default","Bauxite::Parser","Bauxite/Parser.html#method-i-default","(file, io = nil)","
Load default Bauxite files.\n"],["doif","Bauxite::Action","Bauxite/Action.html#method-i-doif","(expected, actual, action, *args)","
Executes action only if expected matches\nactual.\n
The conditional check in this action is similar to #assertv …\n"],["echo","Bauxite::Action","Bauxite/Action.html#method-i-echo","(text)","
Prints the value of the specified text.\n
text is subject to variable expansion (see Context#expand).\n
For …\n"],["exec","Bauxite::Action","Bauxite/Action.html#method-i-exec","(*command)","
Executes command, optionally storing the results in a\nvariable.\n
If the first argument of command is name=... …\n"],["exec_action","Bauxite::Context","Bauxite/Context.html#method-i-exec_action","(text)","
Executes the specified action string handling errors, logging and debug\nhistory.\n
If log is true, log the …\n"],["exec_action_object","Bauxite::Context","Bauxite/Context.html#method-i-exec_action_object","(action)","
Executes the specified action object injecting built-in variables. Note\nthat the result returned by this …\n"],["exec_file","Bauxite::Context","Bauxite/Context.html#method-i-exec_file","(file)","
Executes the specified file.\n
For example:\n\n
ctx.exec_file('file')\n# => executes every action defined in 'file'\n\n"],["exec_parsed_action","Bauxite::Context","Bauxite/Context.html#method-i-exec_parsed_action","(action, args, log = true, text = nil)","
Executes the specified action handling errors, logging and debug history.\n
If log is true, log the action …\n"],["execute","Bauxite::ActionModule","Bauxite/ActionModule.html#method-i-execute","()","
Executes the action evaluating the arguments in the current context.\n
Note that #execute calls #args to …\n"],["expand","Bauxite::Context","Bauxite/Context.html#method-i-expand","(s)","
Recursively replaces occurencies of variable expansions in s\nwith the corresponding variable value.\n
The …\n"],["failif","Bauxite::Action","Bauxite/Action.html#method-i-failif","(action, *args)","
Executes the specified action expected to fail. If\naction succeeds the #failif action fails. If\naction …\n"],["find","Bauxite::Context","Bauxite/Context.html#method-i-find","(selector)","
Finds an element by selector.\n
The element found is yielded to the given block (if any) and\nreturned.\n
Note …\n"],["find","Bauxite::SelectorModule","Bauxite/SelectorModule.html#method-i-find","(selector, &block)","
Searches for elements using the specified selector string.\n
For more information see Context#find.\n
Selectors …\n"],["frame","Bauxite::Selector","Bauxite/Selector.html#method-i-frame","(arg, &block)","
Change the selector scope to the given frame and finds an element in that\nframe.\n
This is a composite selector. …\n"],["get_action","Bauxite::Context","Bauxite/Context.html#method-i-get_action","(action, args, text = nil)","
Returns an executable Action object constructed from the specified\narguments resolving action aliases. …\n"],["get_value","Bauxite::Context","Bauxite/Context.html#method-i-get_value","(element)","
Returns the value of the specified element.\n
This method takes into account the type of element and selectively …\n"],["js","Bauxite::Action","Bauxite/Action.html#method-i-js","(script, name = nil)","
Executes the specified Javascript script, optionally storing\nthe results the variable named name.\n
Note …\n"],["load","Bauxite::Action","Bauxite/Action.html#method-i-load","(file, *vars)","
Load the specified file into an isolated variable context and execute the\nactions specified. If the file …\n"],["load_logger","Bauxite::Context","Bauxite/Context.html#method-c-load_logger","(name, options)","
Constructs a Logger instance using name as a hint for the\nlogger type.\n"],["log","Bauxite::Loggers::CompositeLogger","Bauxite/Loggers/CompositeLogger.html#method-i-log","(s, type = :info)","
Prints the specified string.\n
See Bauxite::Loggers::NullLogger#print\n"],["log","Bauxite::Loggers::NullLogger","Bauxite/Loggers/NullLogger.html#method-i-log","(s, type = :info)","
Logs the specified string.\n
type, if specified, should be one of :error,\n:warning, :info (default), :debug …\n"],["log","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-log","(s, type = :info)","
Prints the specified string.\n
See Bauxite::Loggers::NullLogger#print\n"],["log_cmd","Bauxite::Loggers::CompositeLogger","Bauxite/Loggers/CompositeLogger.html#method-i-log_cmd","(action, &block)","
Pretty prints action information and status.\n
This implementation only yileds in the first logger.\n
Additional …\n"],["log_cmd","Bauxite::Loggers::EchoLogger","Bauxite/Loggers/EchoLogger.html#method-i-log_cmd","(action)","
Echoes the raw action text.\n"],["log_cmd","Bauxite::Loggers::FileLogger","Bauxite/Loggers/FileLogger.html#method-i-log_cmd","(action)","
Echoes the raw action text.\n"],["log_cmd","Bauxite::Loggers::NullLogger","Bauxite/Loggers/NullLogger.html#method-i-log_cmd","(action)","
Executes the given block in a logging context.\n
This default implementation does not provide any logging …\n"],["log_cmd","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-log_cmd","(action)","
Pretty prints action information and status.\n"],["loggers","Bauxite::Context","Bauxite/Context.html#method-c-loggers","()","
Returns an array with the names of every logger available.\n
For example:\n\n
Context::loggers\n# => [ "null", ...\n\n"],["max_action_name_size","Bauxite::Context","Bauxite/Context.html#method-c-max_action_name_size","()","
Returns the maximum size in characters of an action name.\n
This method is useful to pretty print lists …\n"],["new","Bauxite::ActionModule","Bauxite/ActionModule.html#method-c-new","(ctx, cmd, args, text, file, line)","
Constructs a new test action instance.\n"],["new","Bauxite::Context","Bauxite/Context.html#method-c-new","(options)","
Constructs a new test context instance.\n
options is a hash with the following values:\n
:driver — selenium driver …\n"],["new","Bauxite::Loggers::CompositeLogger","Bauxite/Loggers/CompositeLogger.html#method-c-new","(options)","
Constructs a new composite logger instance.\n"],["new","Bauxite::Loggers::FileLogger","Bauxite/Loggers/FileLogger.html#method-c-new","(options)","
Constructs a new echo logger instance.\n"],["new","Bauxite::Loggers::NullLogger","Bauxite/Loggers/NullLogger.html#method-c-new","(options)","
Constructs a new null logger instance.\n"],["new","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-c-new","(options)","
Constructs a new Terminal logger instance.\n"],["new","Bauxite::ParserModule","Bauxite/ParserModule.html#method-c-new","(ctx)","
Constructs a new test parser instance.\n"],["new","Bauxite::SelectorModule","Bauxite/SelectorModule.html#method-c-new","(ctx, default_selector)","
Constructs a new test selector instance.\n"],["open","Bauxite::Action","Bauxite/Action.html#method-i-open","(url)","
Opens the specified url in the browser.\n
For example:\n\n
open "http://www.ruby-lang.org"\n# => this would open ...\n\n"],["params","Bauxite::Action","Bauxite/Action.html#method-i-params","(*vars)","
Asserts that the variables named vars are defined and not\nempty.\n
For example:\n\n
params host db_name username ...\n"],["parse","Bauxite::ParserModule","Bauxite/ParserModule.html#method-i-parse","(file)","
Parse Default action parsing strategy.\n"],["parsers","Bauxite::Context","Bauxite/Context.html#method-c-parsers","()"," Returns an array with the names of every parser available.\n For example:\n\n Prints the specified For example: …\n"],["progress","Bauxite::Loggers::CompositeLogger","Bauxite/Loggers/CompositeLogger.html#method-i-progress","(value)"," Updates action progress.\n"],["progress","Bauxite::Loggers::NullLogger","Bauxite/Loggers/NullLogger.html#method-i-progress","(value)"," Updates the progress of the current action.\n"],["progress","Bauxite::Loggers::TerminalLogger","Bauxite/Loggers/TerminalLogger.html#method-i-progress","(value)"," Updates action progress.\n"],["replace","Bauxite::Action","Bauxite/Action.html#method-i-replace","(text, pattern, replacement, name)"," Replaces the occurrences of Resets the test engine by closing and reopening the browser. As a side\neffect of resetting the test engine, …\n"],["reset_driver","Bauxite::Context","Bauxite/Context.html#method-i-reset_driver","()"," Stops the test engine and starts a new engine with the same provider.\n For example:\n\n Returns the specified variables to the parent scope (if any).\n If Load the specified ruby file into an isolated variable context and execute\nthe ruby code.\n Sets the value of the selected Returns an array with the names of every selector available.\n If Searches for elements using standard Selenium selectors.\n Selectors calling this method should forward …\n"],["selenium_ide_html","Bauxite::Parser","Bauxite/Parser.html#method-i-selenium_ide_html","(file)"," Load Selenium IDE HTML files.\n"],["set","Bauxite::Action","Bauxite/Action.html#method-i-set","(name, value)"," Sets the variable named Both Sets the variable named Select an element by id suffix.\n This is the default selector. Any selector strings that do not contain …\n"],["smart","Bauxite::Selector","Bauxite/Selector.html#method-i-smart","(arg, &block)"," Select an element by applying different Selector strategies.\n This selector tries to find elements by using …\n"],["source","Bauxite::Action","Bauxite/Action.html#method-i-source","(text)"," Asserts that the page source matches Starts the test engine and executes the actions specified. If no action was\nspecified, returns without …\n"],["stop","Bauxite::Context","Bauxite/Context.html#method-i-stop","()"," Stops the test engine.\n Calling this method at the end of the test is mandatory if #start was\ncalled without …\n"],["store","Bauxite::Action","Bauxite/Action.html#method-i-store","(selector, name)"," Sets the variable named Submits the form that contains the selected element.\n For example:\n\n Load If Load the specified file into an isolated variable context and execute the\nactions specified. If the file …\n"],["wait","Bauxite::Action","Bauxite/Action.html#method-i-wait","(seconds)"," Wait for the specified number of For example:\n\n Prompts the user to press ENTER before resuming execution.\n For example:\n\n Executes the given block using the specified driver Note that the driver Executes the given block retrying for at most Temporarily alter the value of context variables.\n This method alters the value of the variables specified …\n"],["write","Bauxite::Action","Bauxite/Action.html#method-i-write","(selector, text)"," Sets the value of the selected element to bauxite\n Bauxite is a façade over Selenium intended for non-developers\n The idea behind this project was …\n"]]}}file and yield the resulting actions.\n"],["parse_action_default","Bauxite::Context","Bauxite/Context.html#method-c-parse_action_default","(text, file = 'Context::parsers\n# => [ "default", ...\n
\n"],["print_error","Bauxite::Context","Bauxite/Context.html#method-i-print_error","(e, capture = true)","error using the Logger configured and \nhandling the verbose option.\npattern in text with\nreplacement and assigns the result to the variable named …\n"],["reset","Bauxite::Action","Bauxite/Action.html#method-i-reset","()","ctx.reset_driver\n=> ...\n
\n"],["return_action","Bauxite::Action","Bauxite/Action.html#method-i-return_action","(*vars)","vars is * every variable defined in the …\n"],["ruby","Bauxite::Action","Bauxite/Action.html#method-i-ruby","(file, *vars)","file can be …\n"],["select","Bauxite::Action","Bauxite/Action.html#method-i-select","(selector, text)","HTMLSelect to\ntext.\ntext can be the value or the text of\nthe target HTMLOption …\n"],["selectors","Bauxite::Context","Bauxite/Context.html#method-c-selectors","(include_standard_selectors = true)","include_standard_selectors is true (default …\n"],["selenium_find","Bauxite::SelectorModule","Bauxite/SelectorModule.html#method-i-selenium_find","(type, selector)","name to the value\nspecified.\nname and value are subject to variable\nexpansion …\n"],["setif","Bauxite::Action","Bauxite/Action.html#method-i-setif","(name, value, action, *args)","name to the value\nspecified only if the. action execution succeeds. If the\nexecution …\n"],["sid","Bauxite::Selector","Bauxite/Selector.html#method-i-sid","(arg, &block)","text.\ntext can be a regular expression. See #assert for more\ndetails. …\n"],["start","Bauxite::Context","Bauxite/Context.html#method-i-start","(actions = [])","name to the value of the selected\nelement.\nname is subject to variable expansion …\n"],["submit","Bauxite::Action","Bauxite/Action.html#method-i-submit","(selector)","# assuming <form><input id="i"/></form> ...
\n"],["test","Bauxite::Action","Bauxite/Action.html#method-i-test","(file, name = nil)","file using the #load action into a new test context.\nname is specified, it will be used as the …\n"],["tryload","Bauxite::Action","Bauxite/Action.html#method-i-tryload","(file, *vars)","seconds.\nwait 5\n# => this would wait for 5 seconds and then ...\n
\n"],["wait","Bauxite::Context","Bauxite/Context.html#method-c-wait","()","Context::wait\n# => echoes "Press ...\n
\n"],["with_driver_timeout","Bauxite::Context","Bauxite/Context.html#method-i-with_driver_timeout","(timeout)","timeout.\ntimeout is the time …\n"],["with_timeout","Bauxite::Context","Bauxite/Context.html#method-i-with_timeout","(*error_types)","${__TIMEOUT__}\nseconds. Note that this method does not …\n"],["with_vars","Bauxite::Context","Bauxite/Context.html#method-i-with_vars","(vars)","text.\ntext is subject to variable expansion (see Context#expand …\n"],["README","","README_md.html","","