Module: Mixlib::CLI::ClassMethods
- Defined in:
- lib/mixlib/cli.rb
Instance Method Summary collapse
-
#banner(bstring = nil) ⇒ Object
Change the banner.
-
#option(name, args) ⇒ Object
Add a command line option.
-
#options ⇒ Object
Get the hash of current options.
-
#options=(val) ⇒ Object
Set the current options hash.
-
#use_separate_default_options(true_or_false) ⇒ Object
When this setting is set to
true
, default values supplied to the mixlib-cli DSL will be stored in a separate Hash. - #use_separate_defaults? ⇒ Boolean
Instance Method Details
#banner(bstring = nil) ⇒ Object
Change the banner. Defaults to:
Usage: #{0} (options)
Parameters
- bstring<String>
-
The string to set the banner to
Returns
- @banner<String>
-
The current banner
133 134 135 136 137 138 139 140 |
# File 'lib/mixlib/cli.rb', line 133 def (bstring = nil) if bstring @banner = bstring else @banner ||= "Usage: #{$0} (options)" @banner end end |
#option(name, args) ⇒ Object
Add a command line option.
Parameters
- name<Symbol>
-
The name of the option to add
- args<Hash>
-
A hash of arguments for the option, specifying how it should be parsed.
Returns
- true
-
Always returns true.
98 99 100 101 102 |
# File 'lib/mixlib/cli.rb', line 98 def option(name, args) @options ||= {} raise(ArgumentError, "Option name must be a symbol") unless name.kind_of?(Symbol) @options[name.to_sym] = args end |
#options ⇒ Object
Get the hash of current options.
Returns
- @options<Hash>
-
The current options hash.
108 109 110 111 |
# File 'lib/mixlib/cli.rb', line 108 def @options ||= {} @options end |
#options=(val) ⇒ Object
Set the current options hash
Parameters
- val<Hash>
-
The hash to set the options to
Returns
- @options<Hash>
-
The current options hash.
120 121 122 123 |
# File 'lib/mixlib/cli.rb', line 120 def (val) raise(ArgumentError, "Options must recieve a hash") unless val.kind_of?(Hash) @options = val end |
#use_separate_default_options(true_or_false) ⇒ Object
When this setting is set to true
, default values supplied to the mixlib-cli DSL will be stored in a separate Hash
83 84 85 |
# File 'lib/mixlib/cli.rb', line 83 def (true_or_false) @separate_default_options = true_or_false end |
#use_separate_defaults? ⇒ Boolean
87 88 89 |
# File 'lib/mixlib/cli.rb', line 87 def use_separate_defaults? @separate_default_options ||= false end |