Class: Slop::Commands

Inherits:
Object
  • Object
show all
Includes:
Enumerable
Defined in:
lib/slop/commands.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(config = {}, &block) ⇒ Commands

Create a new instance of Slop::Commands and optionally build Slop instances via a block. Any configuration options used in this method will be the default configuration options sent to each Slop object created.

config - An optional configuration Hash. block - Optional block used to define commands.

Examples:

commands = Slop::Commands.new do
  on :new do
    on '-o', '--outdir=', 'The output directory'
    on '-v', '--verbose', 'Enable verbose mode'
  end

  on :generate do
    on '--assets', 'Generate assets', :default => true
  end

  global do
    on '-D', '--debug', 'Enable debug mode', :default => false
  end
end

commands[:new].class #=> Slop
commands.parse



36
37
38
39
40
41
42
43
44
 
# File 'lib/slop/commands.rb', line 36

def initialize(config = {}, &block)
  @config = config
  @commands = {}
  @banner = nil

  if block_given?
    block.arity == 1 ? yield(self) : instance_eval(&block)
  end
end

Instance Attribute Details

Optionally set the banner for this command help output.

banner - The String text to set the banner.

Returns the String banner if one is set.



51
52
53
54
 
# File 'lib/slop/commands.rb', line 51

def banner(banner = nil)
  @banner = banner if banner
  @banner
end

#commands ⇒ Object (readonly)

Returns the value of attribute commands.



5
6
7
 
# File 'lib/slop/commands.rb', line 5

def commands
  @commands
end

#config ⇒ Object (readonly)

Returns the value of attribute config.



5
6
7
 
# File 'lib/slop/commands.rb', line 5

def config
  @config
end

Instance Method Details

#[](key) ⇒ Object Also known as: get

Fetch the instance of Slop tied to a command.

key - The String or Symbol key used to locate this command.

Returns the Slop instance if this key is found, nil otherwise.



92
93
94
 
# File 'lib/slop/commands.rb', line 92

def [](key)
  commands[key.to_s]
end

#default(config = {}, &block) ⇒ Object

Add a Slop instance used when no other commands exist.

config - A Hash of configuration options to pass to Slop. block - An optional block used to pass options to Slop.

Returns the newly created Slop instance mapped to default.



73
74
75
 
# File 'lib/slop/commands.rb', line 73

def default(config = {}, &block)
  on('default', config, &block)
end

#each(&block) ⇒ Object

Enumerable interface.



107
108
109
 
# File 'lib/slop/commands.rb', line 107

def each(&block)
  @commands.each(&block)
end

#global(config = {}, &block) ⇒ Object

Add a global Slop instance.

config - A Hash of configuration options to pass to Slop. block - An optional block used to pass options to Slop.

Returns the newly created Slop instance mapped to global.



83
84
85
 
# File 'lib/slop/commands.rb', line 83

def global(config = {}, &block)
  on('global', config, &block)
end

#inspect ⇒ Object

Returns the inspection String.



138
139
140
 
# File 'lib/slop/commands.rb', line 138

def inspect
  "#<Slop::Commands #{config.inspect} #{commands.values.map(&:inspect)}>"
end

#on(command, config = {}, &block) ⇒ Object

Add a Slop instance for a specific command.

command - A String or Symbol key used to identify this command. config - A Hash of configuration options to pass to Slop. block - An optional block used to pass options to Slop.

Returns the newly created Slop instance mapped to command.



63
64
65
 
# File 'lib/slop/commands.rb', line 63

def on(command, config = {}, &block)
  commands[command.to_s] = Slop.new(@config.merge(config), &block)
end

#parse(items = ARGV) ⇒ Object

Parse a list of items.

items - The Array of items to parse.

Returns the original Array of items.



102
103
104
 
# File 'lib/slop/commands.rb', line 102

def parse(items = ARGV)
  parse_items(items)
end

#parse!(items = ARGV) ⇒ Object

Parse a list of items, removing any options or option arguments found.

items - The Array of items to parse.

Returns the original Array of items with options removed.



116
117
118
 
# File 'lib/slop/commands.rb', line 116

def parse!(items = ARGV)
  parse_items(items, true)
end

#to_hash ⇒ Object

Returns a nested Hash with Slop options and values. See Slop#to_hash.



121
122
123
 
# File 'lib/slop/commands.rb', line 121

def to_hash
  Hash[commands.map { |k, v| [k.to_sym, v.to_hash] }]
end

#to_s ⇒ Object Also known as: help

Returns the help String.



126
127
128
129
130
131
132
133
134
 
# File 'lib/slop/commands.rb', line 126

def to_s
  defaults = commands.delete('default')
  globals = commands.delete('global')
  helps = commands.reject { |_, v| v.options.none? }
  helps.merge!('Global options' => globals.to_s) if globals
  helps.merge!('Other options' => defaults.to_s) if defaults
  banner = @banner ? "#{@banner}\n" : ""
  banner + helps.map { |key, opts| "  #{key}\n#{opts}" }.join("\n\n")
end