Module: Plist4r::Mixlib::CLI::ClassMethods

Defined in:
lib/plist4r/mixin/mixlib_cli.rb

Instance Methods

Instance Method Details

- (Object) option(name, args)

Add a command line option.

Parameters

name:The name of the option to add
args:A hash of arguments for the option, specifying how it should be parsed.

Returns

true:Always returns true.

Raises:

  • (ArgumentError)


32
33
34
35
36
# File 'lib/plist4r/mixin/mixlib_cli.rb', line 32

def option(name, args)
  @options ||= {}
  raise(ArgumentError, "Option name must be a symbol") unless name.kind_of?(Symbol)
  @options[name.to_sym] = args
end

- (Object) options

Get the hash of current options.

Returns

@options:The current options hash.


42
43
44
45
# File 'lib/plist4r/mixin/mixlib_cli.rb', line 42

def options
  @options ||= {}
  @options
end

- (Object) options=(val)

Set the current options hash

Parameters

val:The hash to set the options to

Returns

@options:The current options hash.

Raises:

  • (ArgumentError)


54
55
56
57
# File 'lib/plist4r/mixin/mixlib_cli.rb', line 54

def options=(val)
  raise(ArgumentError, "Options must recieve a hash") unless val.kind_of?(Hash)
  @options = val
end