\n
Configuration Class\n
Manages any configuration values and the flat YAML file into which they get\nstored. …\n"],["CLIUtils::Configurator","","CLIUtils/Configurator.html","","
\n
Configuration Class\n
Manages any configuration values and the flat YAML file into which they get\nstored. …\n"],["CLIUtils::LoggerDelegator","","CLIUtils/LoggerDelegator.html","","
\n
LoggerDelegator Class\n
Manages any configuration values and the flat YAML file into which they get\nstored. …\n"],["CLIUtils::Messenging","","CLIUtils/Messenging.html","","
\n
CLIMessenger Module Outputs color-coordinated messages to a CLI\n
\n"],["CLIUtils::Prefs","","CLIUtils/Prefs.html","","
\n
PrefManager Class\n
Engine to derive preferences from a YAML file, deliver those to a user via\na prompt, …\n"],["CLIUtils::PrettyIO","","CLIUtils/PrettyIO.html","","
\n
CLIMessenger Module Outputs color-coordinated messages to a CLI\n
\n"],["Hash","","Hash.html","","
\n
Hash Class\n
Contains many convenient methods borred from Rails\napi.rubyonrails.org/classes/Hash.html\n"],["Logger","","Logger.html","","
\n
Logger Class\n
\n"],["String","","String.html","","
\n
String Class\n
\n"],["add_section","CLIUtils::Configurator","CLIUtils/Configurator.html#method-i-add_section","(section_name)","
add_section method\n
Adds a new section to the config file (if it doesn't already exist).\n@param section_name …\n"],["ask","CLIUtils::Prefs","CLIUtils/Prefs.html#method-i-ask","()","
ask method\n
Runs through all of the prompt questions and collects answers from the\nuser. Note that all …\n"],["attach","CLIUtils::LoggerDelegator","CLIUtils/LoggerDelegator.html#method-i-attach","(target)","
attach method\n
Attaches a new target to delegate to. @return void\n"],["blue","String","String.html#method-i-blue","()",""],["color_chart","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-color_chart","()","
color_chart method\n
Displays a chart of all the possible ANSI foreground and background color\ncombinations. …\n"],["colorize","String","String.html#method-i-colorize","(color_code)","
\n
Color String Methods\n
\n"],["configuration","CLIUtils::Configuration","CLIUtils/Configuration.html#method-i-configuration","()","
configuration method\n
Singleton method to return (or initialize, if needed) a Configurator.\n@return Configurator …\n"],["custom_level","Logger","Logger.html#method-c-custom_level","(tag)","
custom_level method\n
Creates a custom Logger level based on the passed tag. @param tag The\nLogger level …\n"],["cyan","String","String.html#method-i-cyan","()",""],["debug","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-debug","(m)","
debug method\n
Empty method so that Messenging doesn't freak out when passed a debug\nmessage. @return …\n"],["deep_merge!","Hash","Hash.html#method-i-deep_merge-21","(other_hash, &block)","
\n
Methods\n
\n"],["deep_stringify_keys","Hash","Hash.html#method-i-deep_stringify_keys","()","
deep_stringify_keys method\n
Recursively turns all Hash keys into strings and returns the new Hash.\n@return …\n"],["deep_stringify_keys!","Hash","Hash.html#method-i-deep_stringify_keys-21","()","
deep_symbolize_keys! method\n
Same as deep_stringify_keys, but destructively alters the original Hash.\n@return …\n"],["deep_symbolize_keys","Hash","Hash.html#method-i-deep_symbolize_keys","()","
deep_symbolize_keys method\n
Recursively turns all Hash keys into symbols and returns the new Hash.\n@return …\n"],["deep_symbolize_keys!","Hash","Hash.html#method-i-deep_symbolize_keys-21","()","
deep_symbolize_keys! method\n
Same as deep_symbolize_keys, but destructively alters the original Hash.\n@return …\n"],["deep_transform_keys","Hash","Hash.html#method-i-deep_transform_keys","(&block)","
deep_transform_keys method\n
Generic method to perform recursive operations on a Hash. @return Hash\n"],["deep_transform_keys!","Hash","Hash.html#method-i-deep_transform_keys-21","(&block)","
deep_transform_keys! method\n
Same as deep_transform_keys, but destructively alters the original Hash.\n@return …\n"],["default_instance","CLIUtils::Messenging","CLIUtils/Messenging.html#method-i-default_instance","()","
default_instance method\n
Returns a default instance of LoggerDelegator that delegates to STDOUT\nonly. @return …\n"],["delegate","CLIUtils::LoggerDelegator","CLIUtils/LoggerDelegator.html#method-c-delegate","()","
delegate_all method\n
Creates delegator methods for all of the methods on IO. @return void\n"],["delete_section","CLIUtils::Configurator","CLIUtils/Configurator.html#method-i-delete_section","(section_name)","
delete_section method\n
Removes a section to the config file (if it exists). @param section_name\nThe section …\n"],["detach","CLIUtils::LoggerDelegator","CLIUtils/LoggerDelegator.html#method-i-detach","(target)","
detach method\n
Detaches a delegation target. @return void\n"],["error","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-error","(m)","
error method\n
Outputs a formatted-red error message. @param m The message to output\n@return Void\n"],["green","String","String.html#method-i-green","()",""],["included","CLIUtils::Configuration","CLIUtils/Configuration.html#method-c-included","(k)","
\n
Methods\n
\n"],["included","CLIUtils::Messenging","CLIUtils/Messenging.html#method-c-included","(k)","
\n
Methods\n
\n"],["included","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-c-included","(k)","
\n
Methods\n
—————————————————-\n"],["info","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-info","(m)","
info method\n
Outputs a formatted-blue informational message. @param m The message to\noutput @return Void …\n"],["info_block","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-info_block","(m1, m2 = 'Done.', multiline = false)","
info_block method\n
Wraps a block in an opening and closing info message. @param m1 The opening\nmessage …\n"],["ingest_prefs","CLIUtils::Configurator","CLIUtils/Configurator.html#method-i-ingest_prefs","(prefs)","
ingest_prefs method\n
Ingests a Prefs class and adds its answers to the configuration data.\n@param prefs …\n"],["load_configuration","CLIUtils::Configuration","CLIUtils/Configuration.html#method-i-load_configuration","(path)","
load_configuration method\n
Initializes a Configurator with the passed filepath. @param path The path\nto …\n"],["log","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-log","(m)","
log method\n
Empty method so that Messenging doesn't freak out when passed a debug\nmessage. @return …\n"],["messenger","CLIUtils::Messenging","CLIUtils/Messenging.html#method-i-messenger","()","
messenger method\n
Singleton method to return (or initialize, if needed) a LoggerDelegator.\n@return LoggerDelegator …\n"],["method_missing","CLIUtils::Configurator","CLIUtils/Configurator.html#method-i-method_missing","(name, *args, &block)","
method_missing method\n
Allows this module to return data from the config Hash when given a method\nname …\n"],["new","CLIUtils::Configurator","CLIUtils/Configurator.html#method-c-new","(path)","
\n
Methods\n
\n"],["new","CLIUtils::LoggerDelegator","CLIUtils/LoggerDelegator.html#method-c-new","(*targets)","
\n
Methods\n
\n"],["new","CLIUtils::Prefs","CLIUtils/Prefs.html#method-c-new","(data)","
\n
Methods\n
\n"],["prompt","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-prompt","(prompt, default = nil, start_dir = '')","
prompt method\n
Outputs a prompt, collects the user's response, and returns it. @param\nprompt The prompt …\n"],["purple","String","String.html#method-i-purple","()",""],["red","String","String.html#method-i-red","()",""],["reset","CLIUtils::Configurator","CLIUtils/Configurator.html#method-i-reset","()","
reset method\n
Clears the configuration data. @return Void\n"],["save","CLIUtils::Configurator","CLIUtils/Configurator.html#method-i-save","()","
save method\n
Saves the configuration data to the previously stored flat file. @return\nVoid\n"],["section","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-section","(m)","
section method\n
Outputs a formatted-purple section message. @param m The message to output\n@return Void …\n"],["section_block","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-section_block","(m, multiline = true)","
section_block method\n
Wraps a block in an opening and closing section message. @param m1 The\nopening message …\n"],["success","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-success","(m)","
success method\n
Outputs a formatted-green success message. @param m The message to output\n@return Void …\n"],["warn","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-i-warn","(m)","
warning method\n
Outputs a formatted-yellow warning message. @param m The message to output\n@return Void …\n"],["white","String","String.html#method-i-white","()",""],["wrap","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-c-wrap","(on)","
wrap method\n
Toggles wrapping on or off @return Integer\n"],["wrap_at","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-c-wrap_at","(chars)","
wrap_at method\n
Sets the number of characters at which to wrap @return Integer\n"],["wrap_limit","CLIUtils::PrettyIO","CLIUtils/PrettyIO.html#method-c-wrap_limit","()","
wrap_limit method\n
Returns the current character wrap amount @return Integer\n"],["yellow","String","String.html#method-i-yellow","()",""],["README","","README_md.html","","
CLIUtils\n
CLIUtils is a library of functionality designed to alleviate common tasks\nand headaches when …\n"]]}}