Table of Contents - RDoc Documentation
Pages
- FAQ
- Gemfile
-
History
- [3.0.0] / 2018-08-24
- [2.1.3] / 2018-07-05
- [2.1.2] / 2015-03-10
- [2.1.1] / 2015-01-03
- 2.1.0 / 2015-01-02
- 2.0 / 2012-08-11
- 1.16.2 / 2010-04-06
- 1.16.1 / 2010-04-05
- 1.16 / 2010-04-01
- 1.15 / 2009-09-30
- 1.14 / 2009-06-19
- 1.13 / 2009-03-16
- 1.12 / 2009-01-30
- 1.11 / 2009-01-29
- 1.10.2 / 2008-10-23
- 1.10.1 / 2008-10-22
- 1.10 / 2008-10-21
- 1.9 / 2008-08-20
- 1.8.2 / 2008-06-25
- 1.8.1 / 2008-06-24
- 1.8 / 2008-06-16
- 1.7.2 / 2008-01-16
- 1.7.1 / 2008-01-07
- 1.7 / 2007-06-17
- 1.6 / 2007-04-01
- 1.5 / 2007-03-31
- 1.4 / 2007-03-26
- 1.3 / 2007-01-31
- 1.2 / 2007-01-31
- 1.1 / 2007-01-30
- 1.0 / 2007-01-29
- README
- Rakefile
- changelog
- compat
- control
- copyright
- dh_ruby.mk
- rock-master-18.09-ruby-optimist.docs
- ruby-tests.rake
- rules
- format
- watch
- optimist.gemspec
Classes and Modules
- Minitest
- Minitest::Assertions
- Optimist
- Optimist::BooleanOption
- Optimist::CommandlineError
- Optimist::CommandlineErrorTest
- Optimist::DateArrayOption
- Optimist::DateOption
- Optimist::FloatArrayOption
- Optimist::FloatOption
- Optimist::HelpNeeded
- Optimist::HelpNeededTest
- Optimist::IOArrayOption
- Optimist::IOOption
- Optimist::IntegerArrayOption
- Optimist::IntegerOption
- Optimist::Option
- Optimist::Parser
- Optimist::ParserEduateTest
- Optimist::ParserOptTest
- Optimist::ParserParseTest
- Optimist::ParserTest
- Optimist::StringArrayOption
- Optimist::StringOption
- Optimist::VersionNeeded
- Optimist::VersionNeededTest
- OptimistTest
Methods
- ::create — Optimist::Option
- ::die — Optimist
- ::educate — Optimist
- ::new — Optimist::CommandlineError
- ::new — Optimist::Parser
- ::new — Optimist::Option
- ::new — Optimist::BooleanOption
- ::options — Optimist
- ::register — Optimist::Parser
- ::register_alias — Optimist::Option
- ::registry_getopttype — Optimist::Parser
- ::with_standard_exception_handling — Optimist
- #array_default? — Optimist::Option
- #assert_parses_correctly — Minitest::Assertions
- #assert_stderr — Minitest::Assertions
- #assert_stdout — Minitest::Assertions
- #assert_system_exit — Minitest::Assertions
- #banner — Optimist::Parser
- #callback — Optimist::Option
- #conflicts — Optimist::Parser
- #depends — Optimist::Parser
- #desc — Optimist::Option
- #description_with_default — Optimist::Option
- #die — Optimist::Parser
- #educate — Optimist::Parser
- #educate — Optimist::Option
- #educate_on_error — Optimist::Parser
- #flag? — Optimist::Option
- #flag? — Optimist::BooleanOption
- #multi — Optimist::Option
- #multi? — Optimist::Option
- #multi_arg? — Optimist::Option
- #multi_arg? — Optimist::IntegerArrayOption
- #multi_arg? — Optimist::FloatArrayOption
- #multi_arg? — Optimist::StringArrayOption
- #multi_arg? — Optimist::DateArrayOption
- #multi_arg? — Optimist::IOArrayOption
- #opt — Optimist::Parser
- #opts — Optimist::Option
- #opts= — Optimist::Option
- #parse — Optimist::Parser
- #parse — Optimist::Option
- #parse — Optimist::BooleanOption
- #parse — Optimist::FloatOption
- #parse — Optimist::IntegerOption
- #parse — Optimist::IOOption
- #parse — Optimist::StringOption
- #parse — Optimist::DateOption
- #parser — Optimist::ParserTest
- #parser — OptimistTest
- #required? — Optimist::Option
- #setup — Optimist::ParserEduateTest
- #setup — Optimist::ParserTest
- #setup — OptimistTest
- #short? — Optimist::Option
- #single_arg? — Optimist::Option
- #stop_on — Optimist::Parser
- #stop_on_unknown — Optimist::Parser
- #synopsis — Optimist::Parser
- #test_accepts_arguments_with_spaces — Optimist::ParserTest
- #test_alternate_args — Optimist::ParserTest
- #test_ambigious_multi_plus_array_default_resolved_as_specified_by_documentation — Optimist::ParserTest
- #test_argflags_demand_args — Optimist::ParserTest
- #test_arglessflags_refuse_args — Optimist::ParserTest
- #test_argument_to_stringio — Optimist::ParserEduateTest
- #test_arguments_passed_through_block — Optimist::ParserTest
- #test_auto_generated_long_names_convert_underscores_to_hyphens — Optimist::ParserTest
- #test_class — Optimist::CommandlineErrorTest
- #test_class — Optimist::HelpNeededTest
- #test_class — Optimist::VersionNeededTest
- #test_combined_short_options_with_multiple_arguments — Optimist::ParserTest
- #test_conflict_error_messages — Optimist::ParserTest
- #test_conflicting_longs_detected — Optimist::ParserTest
- #test_conflicting_names_are_detected — Optimist::ParserTest
- #test_conflicting_shorts_detected — Optimist::ParserTest
- #test_conflicts — Optimist::ParserTest
- #test_date_arg_type — Optimist::ParserTest
- #test_date_formatting — Optimist::ParserTest
- #test_default_shorts_assigned_only_after_user_shorts — Optimist::ParserTest
- #test_depend_error_messages — Optimist::ParserTest
- #test_depends — Optimist::ParserTest
- #test_die — OptimistTest
- #test_die_custom_error_code — OptimistTest
- #test_die_custom_error_code_two_args — OptimistTest
- #test_die_without_options_ever_run — OptimistTest
- #test_doubledash_ends_option_processing — Optimist::ParserTest
- #test_educate — OptimistTest
- #test_educate_without_options_ever_run — OptimistTest
- #test_error_code_custom — Optimist::CommandlineErrorTest
- #test_error_code_default — Optimist::CommandlineErrorTest
- #test_flag_parameters — Optimist::ParserTest
- #test_flag_parameters_for_inverted_flags — Optimist::ParserTest
- #test_flag_with_no_defaults_and_no_args_act_as_switches_array — Optimist::ParserTest
- #test_flags_with_defaults_and_no_args_act_as_switches — Optimist::ParserTest
- #test_floating_point_formatting — Optimist::ParserTest
- #test_floating_point_formatting_default — Optimist::ParserTest
- #test_given_keys — Optimist::ParserTest
- #test_help_has_default_banner — Optimist::ParserEduateTest
- #test_help_has_grammatical_default_text — Optimist::ParserEduateTest
- #test_help_has_optional_synopsis — Optimist::ParserEduateTest
- #test_help_has_optional_usage — Optimist::ParserEduateTest
- #test_help_has_specific_order_for_usage_and_synopsis — Optimist::ParserEduateTest
- #test_help_includes_option_types — Optimist::ParserEduateTest
- #test_help_needed — Optimist::ParserParseTest
- #test_help_overridden — Optimist::ParserParseTest
- #test_help_preserves_positions — Optimist::ParserEduateTest
- #test_help_with_arg_error — Optimist::ParserParseTest
- #test_help_with_other_args — Optimist::ParserParseTest
- #test_ignore_invalid_options — Optimist::ParserTest
- #test_ignore_invalid_options_stop_on_unknown_long — Optimist::ParserTest
- #test_ignore_invalid_options_stop_on_unknown_partial_end_short — Optimist::ParserTest
- #test_ignore_invalid_options_stop_on_unknown_partial_mid_short — Optimist::ParserTest
- #test_ignore_invalid_options_stop_on_unknown_short — Optimist::ParserTest
- #test_integer_formatting — Optimist::ParserTest
- #test_invalid_option_with_simple_interface — Optimist::ParserTest
- #test_io_arg_type — Optimist::ParserTest
- #test_long_detects_bad_names — Optimist::ParserTest
- #test_long_options_also_take_equals — Optimist::ParserTest
- #test_long_options_with_multiple_arguments — Optimist::ParserTest
- #test_long_options_with_multiple_options — Optimist::ParserTest
- #test_long_options_with_multiple_options_and_arguments — Optimist::ParserTest
- #test_message — Optimist::CommandlineErrorTest
- #test_message — Optimist::HelpNeededTest
- #test_message — Optimist::VersionNeededTest
- #test_multi_args_autobox_defaults — Optimist::ParserTest
- #test_multi_args_default_to_empty_array — Optimist::ParserTest
- #test_multi_line_description — Optimist::ParserTest
- #test_no_arguments_to_stdout — Optimist::ParserEduateTest
- #test_no_headers — Optimist::ParserEduateTest
- #test_openstruct_style_access — Optimist::ParserTest
- #test_options — OptimistTest
- #test_options_can_be_set_multiple_times_if_specified — Optimist::ParserTest
- #test_options_cant_be_set_multiple_times_if_not_specified — Optimist::ParserTest
- #test_options_die_default — OptimistTest
- #test_options_die_educate_on_error — OptimistTest
- #test_required_flags_are_required — Optimist::ParserTest
- #test_short_autocreation_is_ok_with_running_out_of_chars — Optimist::ParserTest
- #test_short_autocreation_skips_dashes_and_numbers — Optimist::ParserTest
- #test_short_can_be_nothing — Optimist::ParserTest
- #test_short_detects_bad_names — Optimist::ParserTest
- #test_short_names_created_automatically — Optimist::ParserTest
- #test_short_options_can_be_weird — Optimist::ParserTest
- #test_short_options_cant_be_numeric — Optimist::ParserTest
- #test_short_options_combine — Optimist::ParserTest
- #test_short_options_with_multiple_arguments — Optimist::ParserTest
- #test_short_options_with_multiple_options — Optimist::ParserTest
- #test_short_options_with_multiple_options_and_arguments — Optimist::ParserTest
- #test_short_options_with_multiple_options_does_not_affect_flags_type — Optimist::ParserTest
- #test_simple_interface_handles_die — Optimist::ParserTest
- #test_simple_interface_handles_die_without_message — Optimist::ParserTest
- #test_simple_interface_handles_help — Optimist::ParserTest
- #test_simple_interface_handles_regular_usage — Optimist::ParserTest
- #test_simple_interface_handles_version — Optimist::ParserTest
- #test_stopwords_mixed — Optimist::ParserTest
- #test_stopwords_multiple_stopwords — Optimist::ParserTest
- #test_stopwords_no_stopwords — Optimist::ParserTest
- #test_stopwords_with_short_args — Optimist::ParserTest
- #test_supports_callback_inline — Optimist::ParserTest
- #test_supports_callback_param — Optimist::ParserTest
- #test_synopsis — Optimist::ParserTest
- #test_syntax_check — Optimist::ParserTest
- #test_two_required_one_missing_accuses_correctly — Optimist::ParserTest
- #test_type_and_default_must_match — Optimist::ParserTest
- #test_type_and_empty_array — Optimist::ParserTest
- #test_type_correctly_derived_from_default — Optimist::ParserTest
- #test_typed_args_refuse_args_of_other_types — Optimist::ParserTest
- #test_unknown_arg_class_type — Optimist::ParserTest
- #test_unknown_arguments — Optimist::ParserTest
- #test_unknown_subcommand — Optimist::ParserTest
- #test_usage — Optimist::ParserEduateTest
- #test_usage — Optimist::ParserTest
- #test_usage_synopsis_version — Optimist::ParserEduateTest
- #test_version — Optimist::ParserTest
- #test_version_and_help_override_errors — Optimist::ParserTest
- #test_version_needed — Optimist::ParserParseTest
- #test_version_needed_unset — Optimist::ParserParseTest
- #test_version_only_appears_if_set — Optimist::ParserParseTest
- #test_version_overridden — Optimist::ParserParseTest
- #test_version_with_arg_error — Optimist::ParserParseTest
- #test_version_with_other_args — Optimist::ParserParseTest
- #test_with_standard_exception_die — OptimistTest
- #test_with_standard_exception_die_custom_error — OptimistTest
- #test_with_standard_exception_die_exception — OptimistTest
- #test_with_standard_exception_die_exception_custom_error — OptimistTest
- #test_with_standard_exception_help_needed — OptimistTest
- #test_with_standard_exception_help_needed_flag — OptimistTest
- #test_with_standard_exception_options — OptimistTest
- #test_with_standard_exception_version_exception — OptimistTest
- #test_with_standard_exception_version_flag — OptimistTest
- #test_wrap — Optimist::ParserTest
- #text — Optimist::Parser
- #type_format — Optimist::Option
- #type_format — Optimist::FloatOption
- #type_format — Optimist::IntegerOption
- #type_format — Optimist::IOOption
- #type_format — Optimist::StringOption
- #type_format — Optimist::DateOption
- #type_format — Optimist::IntegerArrayOption
- #type_format — Optimist::FloatArrayOption
- #type_format — Optimist::StringArrayOption
- #type_format — Optimist::DateArrayOption
- #type_format — Optimist::IOArrayOption
- #usage — Optimist::Parser
- #version — Optimist::Parser