Table of Contents - convoy-1.3.2 Documentation
Classes and Modules
- Convoy
- Convoy::ActionCommand
- Convoy::ActionCommand::Base
- Convoy::ActionCommand::ConvoyUtilityCommand
- Convoy::App
- Convoy::Arguments
- Convoy::AutoOptions
- Convoy::BaseError
- Convoy::ClientError
- Convoy::Error
- Convoy::Formatter
- Convoy::Formatter::Command
- Convoy::Formatter::Commands
- Convoy::Formatter::CursorPosition
- Convoy::Formatter::DefaultHelpFormatter
- Convoy::Formatter::GlobalCommand
- Convoy::Formatter::Option
- Convoy::Formatter::Options
- Convoy::Formatter::ShellCommandExecutor
- Convoy::Formatter::StreamOutputFormatter
- Convoy::Formatter::StringGrid
- Convoy::Formatter::StringSplitter
- Convoy::Formatter::Terminal
- Convoy::GlobalPreParser
- Convoy::InternalError
- Convoy::Logger
- Convoy::OptionDependencyValidator
- Convoy::OptionParser
- Convoy::Setup
- Convoy::Setup::Configuration
- Convoy::Setup::Configuration::Generator
- Convoy::Setup::Configuration::Instance
- Convoy::Setup::Configuration::Loader
- Convoy::Setup::Configuration::Locator
- Convoy::Setup::Configuration::Locator::Base
- Convoy::Setup::Configuration::Locator::Chaining
- Convoy::Setup::Configuration::Locator::DescendingToHome
- Convoy::Setup::Configuration::Locator::ExecutingScriptDirectory
- Convoy::Setup::Configuration::Locator::SpecifiedDirectory
- Convoy::Setup::Configuration::MergeTool
- Convoy::Setup::Configuration::Reader
- Convoy::Setup::Configuration::Writer
- Convoy::Setup::Dsl
- Convoy::Setup::Dsl::Action
- Convoy::Setup::Dsl::Command
- Convoy::Setup::Dsl::ConfigFile
- Convoy::Setup::Dsl::Global
- Convoy::Setup::Dsl::Options
- Convoy::SetupAccessor
- Convoy::TransientError
- Convoy::UserError
- Convoy::Utils
- Convoy::Validator
- Object
- Trollop
- Trollop::CommandlineError
- Trollop::HelpNeeded
- Trollop::Parser
- Trollop::Parser::vals
- Trollop::VersionNeeded
Methods
- ::action — Convoy::Setup::Dsl::Action
- ::advanced_error_formatter — Convoy::Logger
- ::augment — Convoy::AutoOptions
- ::basic_error_formatter — Convoy::Logger
- ::blank — Convoy::Setup::Configuration::Instance
- ::close — Convoy::Logger
- ::command_for — Convoy::Formatter::Commands
- ::create — Convoy::App
- ::die — Trollop
- ::error — Convoy::Logger
- ::for — Convoy::OptionDependencyValidator
- ::for — Convoy::Validator
- ::msg2str — Convoy::Logger
- ::new — Convoy::ActionCommand::Base
- ::new — Convoy::ActionCommand::ConvoyUtilityCommand
- ::new — Convoy::App
- ::new — Convoy::AutoOptions
- ::new — Convoy::Formatter::Command
- ::new — Convoy::Formatter::Commands
- ::new — Convoy::Formatter::CursorPosition
- ::new — Convoy::Formatter::DefaultHelpFormatter
- ::new — Convoy::Formatter::GlobalCommand
- ::new — Convoy::Formatter::Option
- ::new — Convoy::Formatter::Options
- ::new — Convoy::Formatter::ShellCommandExecutor
- ::new — Convoy::Formatter::StreamOutputFormatter
- ::new — Convoy::Formatter::StringGrid
- ::new — Convoy::Formatter::StringSplitter
- ::new — Convoy::GlobalPreParser
- ::new — Convoy::OptionDependencyValidator
- ::new — Convoy::OptionParser
- ::new — Convoy::Setup::Configuration::Generator
- ::new — Convoy::Setup::Configuration::Instance
- ::new — Convoy::Setup::Configuration::Loader
- ::new — Convoy::Setup::Configuration::Locator::Base
- ::new — Convoy::Setup::Configuration::Locator::Chaining
- ::new — Convoy::Setup::Configuration::Locator::SpecifiedDirectory
- ::new — Convoy::Setup::Configuration::MergeTool
- ::new — Convoy::Setup::Configuration::Reader
- ::new — Convoy::Setup::Configuration::Writer
- ::new — Convoy::Setup::Dsl::Action
- ::new — Convoy::Setup::Dsl::Command
- ::new — Convoy::Setup::Dsl::ConfigFile
- ::new — Convoy::Setup::Dsl::Global
- ::new — Convoy::Setup::Dsl::Options
- ::new — Convoy::SetupAccessor
- ::new — Trollop::Parser
- ::new — Convoy::Validator
- ::options — Convoy::Setup::Dsl::Options
- ::options — Trollop
- ::output — Convoy::Logger
- ::output_formatter — Convoy::Logger
- ::puts — Convoy::Logger
- ::read — Convoy::Arguments
- ::setup_error_logger — Convoy::Logger
- ::symbolize_keys — Convoy::Utils
- ::tokenize_option_string — Convoy::Utils
- ::tput_cols_command_error_callback — Convoy::Formatter::Terminal
- ::tput_cols_command_success_callback — Convoy::Formatter::Terminal
- ::tput_width — Convoy::Formatter::Terminal
- ::width — Convoy::Formatter::Terminal
- ::with_standard_exception_handling — Trollop
- #absolute_path — Convoy::ActionCommand::ConvoyUtilityCommand
- #action — Convoy::Setup::Dsl::Command
- #action_block_from — Convoy::SetupAccessor
- #action_for — Convoy::SetupAccessor
- #add_global_command — Convoy::SetupAccessor
- #add_global_option — Convoy::SetupAccessor
- #add_locator — Convoy::Setup::Configuration::Locator::Chaining
- #add_option_conflicts_to — Convoy::OptionParser
- #add_setup_options_to — Convoy::GlobalPreParser
- #add_setup_options_to — Convoy::OptionParser
- #add_setup_options_to — Convoy::Setup::Configuration::Generator
- #alias_string — Convoy::Formatter::Command
- #aliases — Convoy::Formatter::Command
- #ancestor_options — Convoy::ActionCommand::Base
- #arguments_from — Convoy::OptionParser
- #arguments_required_for — Convoy::SetupAccessor
- #arguments_usage_string — Convoy::Formatter::Command
- #banner — Trollop::Parser
- #base_description_string — Convoy::Formatter::Option
- #base_long_string — Convoy::Formatter::Option
- #blank? — Convoy::Setup::Configuration::Instance
- #canonical_command_names_for — Convoy::SetupAccessor
- #canonical_command_names_from — Convoy::SetupAccessor
- #canonical_script_name — Convoy::Formatter::Command
- #cell_value — Convoy::Formatter::StringGrid
- #chars_to_end_of_line — Convoy::Formatter::CursorPosition
- #child_command_usage_string — Convoy::Formatter::Command
- #child_commands — Convoy::Formatter::Command
- #cli_option_is_a_command? — Convoy::OptionParser
- #cloaker — Trollop::Parser
- #collect_argument_parameters — Trollop::Parser
- #column_width — Convoy::Formatter::StringGrid
- #command — Convoy::Setup::Dsl::Command
- #command_aliases_for — Convoy::SetupAccessor
- #command_context — Convoy::ActionCommand::Base
- #command_description_for — Convoy::SetupAccessor
- #command_name — Convoy::ActionCommand::Base
- #command_name_from — Convoy::OptionParser
- #command_names_for — Convoy::SetupAccessor
- #command_names_from — Convoy::SetupAccessor
- #command_options — Convoy::ActionCommand::Base
- #command_summary_for — Convoy::SetupAccessor
- #command_with_options — Convoy::Formatter::Command
- #commands_help — Convoy::Formatter::DefaultHelpFormatter
- #commands_in_order — Convoy::App
- #config_file — Convoy::Setup::Dsl::Global
- #config_file — Convoy::SetupAccessor
- #config_file_autocreatable? — Convoy::SetupAccessor
- #config_file_object — Convoy::SetupAccessor
- #config_filename — Convoy::Setup::Configuration::Loader
- #config_has_value_for_context? — Convoy::OptionParser
- #config_hash — Convoy::Setup::Configuration::MergeTool
- #config_hash_for_context — Convoy::OptionParser
- #config_path — Convoy::AutoOptions
- #config_path — Convoy::Setup::Configuration::Loader
- #config_value_for_context — Convoy::OptionParser
- #configuration — Convoy::Setup::Configuration::Loader
- #conflict — Convoy::Setup::Dsl::Options
- #conflicting_options_for — Convoy::SetupAccessor
- #conflicts — Convoy::Formatter::Option
- #conflicts — Trollop::Parser
- #conflicts_hash_for — Convoy::SetupAccessor
- #conflicts_list — Convoy::Formatter::Option
- #context_from_options — Convoy::App
- #context_hash — Convoy::ActionCommand::Base
- #context_requires_arguments — Convoy::SetupAccessor
- #count — Convoy::Formatter::Commands
- #count — Convoy::Formatter::Options
- #create_config — Convoy::ActionCommand::ConvoyUtilityCommand
- #create_default_config — Convoy::ActionCommand::ConvoyUtilityCommand
- #current_cli_options — Convoy::App
- #current_help_formatter — Trollop::Parser
- #current_indent_string — Convoy::Formatter::StreamOutputFormatter
- #current_indent_width — Convoy::Formatter::StreamOutputFormatter
- #custom_reset — Convoy::Setup::Dsl::Command
- #custom_reset — Convoy::Setup::Dsl::Global
- #default_config_path — Convoy::ActionCommand::ConvoyUtilityCommand
- #default_config_path — Convoy::Setup::Configuration::Loader
- #default_data — Convoy::Setup::Configuration::Generator
- #default_option_values — Convoy::Setup::Configuration::Generator
- #default_option_values_from_config_for — Convoy::OptionParser
- #default_string — Convoy::Formatter::Option
- #dependencies — Convoy::Formatter::Option
- #dependencies_for — Convoy::SetupAccessor
- #dependencies_hash_from — Convoy::SetupAccessor
- #dependencies_list — Convoy::Formatter::Option
- #dependency — Convoy::Setup::Dsl::Options
- #depends — Trollop::Parser
- #description — Convoy::Formatter::Command
- #description — Convoy::Formatter::GlobalCommand
- #description — Convoy::Formatter::Option
- #description — Convoy::Setup::Dsl::Command
- #description_default_string — Convoy::Formatter::Option
- #description_for — Convoy::SetupAccessor
- #die — Trollop::Parser
- #die — Trollop
- #each — Convoy::Formatter::Commands
- #each — Convoy::Formatter::Options
- #each_arg — Trollop::Parser
- #educate — Trollop::Parser
- #empty? — Convoy::Setup::Configuration::Instance
- #ensure_ancestor — Convoy::ActionCommand::Base
- #ensure_config_hash_has_options_and_commands — Convoy::OptionParser
- #ensure_context_object — Convoy::SetupAccessor
- #ensure_dependencies_satisfied_for — Convoy::OptionDependencyValidator
- #ensure_dependency_for_valid_option — Convoy::OptionDependencyValidator
- #ensure_dependency_specification_syntax — Convoy::Setup::Dsl::Options
- #ensure_grandparent — Convoy::ActionCommand::Base
- #ensure_no_self_dependency — Convoy::Setup::Dsl::Options
- #ensure_option_depends_on_valid_option — Convoy::OptionDependencyValidator
- #ensure_parent — Convoy::ActionCommand::Base
- #error_formatter — Convoy::AutoOptions
- #error_logger — Object
- #error_output_format — Convoy::AutoOptions
- #error_verbosity — Convoy::AutoOptions
- #execute — Convoy::ActionCommand::ConvoyUtilityCommand
- #execute — Convoy::App
- #execute_action — Convoy::App
- #execute_in_current_shell — Convoy::Formatter::ShellCommandExecutor
- #fair_column_width — Convoy::Formatter::StringGrid
- #fetch_instance_variable_from — Convoy::SetupAccessor
- #fetch_instance_variable_from_setup — Convoy::SetupAccessor
- #flag? — Convoy::Formatter::Option
- #flag_with_default_true? — Convoy::Formatter::Option
- #format_dependency_list — Convoy::Formatter::Option
- #format_physical_row_values — Convoy::Formatter::StringGrid
- #global — Convoy::Setup::Configuration::Instance
- #global_options — Convoy::ActionCommand::Base
- #grandparent_options — Convoy::ActionCommand::Base
- #grid — Convoy::Formatter::StreamOutputFormatter
- #handle_action_error — Convoy::App
- #handle_all_option_value_dependency_rules — Convoy::OptionDependencyValidator
- #handle_convoy_error — Convoy::App
- #handle_possible_option_value_dependency_issue — Convoy::OptionDependencyValidator
- #handle_possible_presence_dependency_issue — Convoy::OptionDependencyValidator
- #handle_possible_self_dependency — Convoy::Setup::Dsl::Options
- #has_aliases? — Convoy::Formatter::Command
- #has_child_commands? — Convoy::Formatter::Command
- #has_config_file? — Convoy::SetupAccessor
- #has_conflicts? — Convoy::Formatter::Option
- #has_dependencies? — Convoy::Formatter::Option
- #has_validations? — Convoy::Formatter::Option
- #help_formatter — Trollop::Parser
- #indent — Convoy::Formatter::StreamOutputFormatter
- #init_config_hash — Convoy::Setup::Configuration::Generator
- #init_invoked_options_hash — Convoy::OptionParser
- #init_parser — Convoy::GlobalPreParser
- #init_parser — Convoy::OptionParser
- #init_parser — Convoy::Setup::Configuration::Generator
- #invalid? — Convoy::Validator
- #last_column_width — Convoy::Formatter::StringGrid
- #load_config_at_path — Convoy::Setup::Configuration::Reader
- #locate — Convoy::Setup::Configuration::Locator::Base
- #locate — Convoy::Setup::Configuration::Locator::Chaining
- #locate — Convoy::Setup::Configuration::Locator::DescendingToHome
- #locate — Convoy::Setup::Configuration::Locator::ExecutingScriptDirectory
- #locate — Convoy::Setup::Configuration::Locator::SpecifiedDirectory
- #locator — Convoy::Setup::Configuration::Loader
- #long_string — Convoy::Formatter::Option
- #max_column_width — Convoy::Formatter::StringGrid
- #max_column_width_remainder — Convoy::Formatter::StringGrid
- #merge_config — Convoy::Setup::Configuration::MergeTool
- #name_help — Convoy::Formatter::DefaultHelpFormatter
- #name_with_aliases — Convoy::Formatter::Command
- #newline — Convoy::Formatter::StreamOutputFormatter
- #newline? — Convoy::Formatter::CursorPosition
- #non_default_config_path — Convoy::AutoOptions
- #normalize_virtual_row — Convoy::Formatter::StringGrid
- #opt — Convoy::Setup::Dsl::Options
- #opt — Trollop::Parser
- #option_conflicts_help — Convoy::Formatter::DefaultHelpFormatter
- #option_dependencies_help — Convoy::Formatter::DefaultHelpFormatter
- #option_exists? — Convoy::OptionDependencyValidator
- #option_exists? — Convoy::OptionParser
- #option_exists? — Convoy::Validator
- #option_validations_help — Convoy::Formatter::DefaultHelpFormatter
- #option_was_specified? — Convoy::OptionDependencyValidator
- #option_was_unspecified? — Convoy::OptionDependencyValidator
- #options — Convoy::Setup::Configuration::Generator
- #options — Convoy::Setup::Dsl::Command
- #options — Trollop
- #options_for — Convoy::SetupAccessor
- #options_for_commands — Convoy::Setup::Configuration::Generator
- #options_hash_from — Convoy::SetupAccessor
- #options_help — Convoy::Formatter::DefaultHelpFormatter
- #options_object_from — Convoy::SetupAccessor
- #outline — Convoy::Formatter::Command
- #output_logger — Object
- #pad_string_to_account_for_cursor_position — Convoy::Formatter::StreamOutputFormatter
- #padding_string — Convoy::Formatter::StreamOutputFormatter
- #parent_commands_usage_string — Convoy::Formatter::Command
- #parent_options — Convoy::ActionCommand::Base
- #parse — Convoy::GlobalPreParser
- #parse — Convoy::OptionParser
- #parse — Trollop::Parser
- #parse_command_options — Convoy::OptionParser
- #parse_float_parameter — Trollop::Parser
- #parse_global_options — Convoy::GlobalPreParser
- #parse_global_options — Convoy::OptionParser
- #parse_integer_parameter — Trollop::Parser
- #parse_io_parameter — Trollop::Parser
- #parse_options — Convoy::OptionParser
- #parse_options_string — Convoy::GlobalPreParser
- #parse_options_string — Convoy::OptionParser
- #physical_row_count_for — Convoy::Formatter::StringGrid
- #physical_row_for — Convoy::Formatter::StringGrid
- #print — Convoy::Formatter::DefaultHelpFormatter
- #print — Convoy::Formatter::StreamOutputFormatter
- #print_convoy_error_message — Convoy::App
- #print_stacktrace — Convoy::App
- #puts — Convoy::Formatter::StreamOutputFormatter
- #read — Convoy::Setup::Configuration::Reader
- #remove_padding_that_account_for_cursor_position — Convoy::Formatter::StreamOutputFormatter
- #requires_arguments — Convoy::Setup::Dsl::Command
- #requires_arguments? — Convoy::Formatter::Command
- #reset — Convoy::Formatter::CursorPosition
- #reset — Convoy::Setup::Dsl::Command
- #resolve_default_short_options! — Trollop::Parser
- #row — Convoy::Formatter::StringGrid
- #rules_as_array — Convoy::Setup::Dsl::Options
- #save_to_file — Convoy::Setup::Configuration::Writer
- #script_name — Convoy::Formatter::Command
- #script_name_usage_string — Convoy::Formatter::Command
- #setup_application — Convoy::App
- #short_string — Convoy::Formatter::Option
- #size — Convoy::Formatter::Commands
- #size — Convoy::Formatter::Options
- #split — Convoy::Formatter::StringSplitter
- #split_string — Convoy::Formatter::StringSplitter
- #split_strings — Convoy::Formatter::StringSplitter
- #stop_on — Trollop::Parser
- #stop_on_unknown — Trollop::Parser
- #summary — Convoy::Formatter::Command
- #summary — Convoy::Formatter::GlobalCommand
- #summary — Convoy::Setup::Dsl::Command
- #summary_for — Convoy::SetupAccessor
- #text — Trollop::Parser
- #to_s — Convoy::Formatter::StringGrid
- #type_string — Convoy::Formatter::Option
- #update — Convoy::Setup::Configuration::Writer
- #update_config — Convoy::ActionCommand::ConvoyUtilityCommand
- #update_default_config — Convoy::ActionCommand::ConvoyUtilityCommand
- #update_for — Convoy::Formatter::CursorPosition
- #usage — Convoy::Formatter::Command
- #usage — Convoy::Formatter::Option
- #usage_help — Convoy::Formatter::DefaultHelpFormatter
- #user — Convoy::Setup::Configuration::Instance
- #validate — Convoy::OptionDependencyValidator
- #validate — Convoy::Setup::Dsl::Options
- #validate — Convoy::Validator
- #validate_option — Convoy::Validator
- #validation_messages — Convoy::Formatter::Option
- #validations — Convoy::Formatter::Option
- #validations_for — Convoy::SetupAccessor
- #validations_hash_from — Convoy::SetupAccessor
- #validations_list — Convoy::Formatter::Option
- #values_in_column — Convoy::Formatter::StringGrid
- #verbosity — Convoy::AutoOptions
- #version — Convoy::Setup::Dsl::Global
- #version — Convoy::SetupAccessor
- #version — Trollop::Parser
- #version_help — Convoy::Formatter::DefaultHelpFormatter
- #virtual_row_for — Convoy::Formatter::StringGrid
- #with_context — Convoy::SetupAccessor
- #with_standard_exception_handling — Trollop
- #wrap_line — Trollop::Parser
- #write — Convoy::Setup::Configuration::Writer