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
45
46
47
48
49
 
# File 'lib/slop/commands.rb', line 36

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

  warn "[DEPRECATED] Slop::Commands is deprecated and will be removed in "\
    "Slop version 4. Check out http://injekt.github.com/slop/#commands for "\
    "a new implementation of commands."

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

Instance Attribute Details

#arguments ⇒ Object (readonly)

Returns the value of attribute arguments.



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

def arguments
  @arguments
end

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.



56
57
58
59
 
# File 'lib/slop/commands.rb', line 56

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.



97
98
99
 
# File 'lib/slop/commands.rb', line 97

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.



78
79
80
 
# File 'lib/slop/commands.rb', line 78

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

#each(&block) ⇒ Object

Enumerable interface.



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

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.



88
89
90
 
# File 'lib/slop/commands.rb', line 88

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

#inspect ⇒ Object

Returns the inspection String.



176
177
178
 
# File 'lib/slop/commands.rb', line 176

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.



68
69
70
 
# File 'lib/slop/commands.rb', line 68

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.



125
126
127
128
 
# File 'lib/slop/commands.rb', line 125

def parse(items = ARGV)
  parse! items.dup
  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.



135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
 
# File 'lib/slop/commands.rb', line 135

def parse!(items = ARGV)
  if opts = commands[items[0].to_s]
    @triggered_command = items.shift
    execute_arguments! items
    opts.parse! items
    execute_global_opts! items
  else
    if opts = commands['default']
      opts.parse! items
    else
      if config[:strict] && items[0]
        raise InvalidCommandError, "Unknown command `#{items[0]}`"
      end
    end
    execute_global_opts! items
  end
  items
end

#present?(key) ⇒ Boolean

Check for a command presence.

Examples:

cmds.parse %w( foo )
cmds.present?(:foo) #=> true
cmds.present?(:bar) #=> false

Returns true if the given key is present in the parsed arguments.

Returns:

  • (Boolean) 


111
112
113
 
# File 'lib/slop/commands.rb', line 111

def present?(key)
  key.to_s == @triggered_command
end

#to_hash ⇒ Object

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



155
156
157
 
# File 'lib/slop/commands.rb', line 155

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.



160
161
162
163
164
165
166
167
168
169
170
171
172
 
# File 'lib/slop/commands.rb', line 160

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