Class: Commander::Command

Inherits:
Object show all
Defined in:
lib/commander/command.rb

Defined Under Namespace

Classes: Options

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name) ⇒ Command

Initialize new command with specified name.


39
40
41
42
43
# File 'lib/commander/command.rb', line 39

def initialize(name)
  @name, @examples, @when_called = name.to_s, [], []
  @options, @proxy_options = [], []
  @global_options = []
end

Instance Attribute Details

#descriptionObject

Returns the value of attribute description


5
6
7
# File 'lib/commander/command.rb', line 5

def description
  @description
end

#examplesObject

Returns the value of attribute examples


5
6
7
# File 'lib/commander/command.rb', line 5

def examples
  @examples
end

#global_optionsObject (readonly)

Returns the value of attribute global_options


7
8
9
# File 'lib/commander/command.rb', line 7

def global_options
  @global_options
end

#nameObject

Returns the value of attribute name


5
6
7
# File 'lib/commander/command.rb', line 5

def name
  @name
end

#optionsObject

Returns the value of attribute options


6
7
8
# File 'lib/commander/command.rb', line 6

def options
  @options
end

#proxy_optionsObject

Returns the value of attribute proxy_options


6
7
8
# File 'lib/commander/command.rb', line 6

def proxy_options
  @proxy_options
end

#summaryObject

Returns the value of attribute summary


6
7
8
# File 'lib/commander/command.rb', line 6

def summary
  @summary
end

#syntaxObject

Returns the value of attribute syntax


5
6
7
# File 'lib/commander/command.rb', line 5

def syntax
  @syntax
end

Instance Method Details

#call(args = []) ⇒ Object

Call the commands when_called block with args.


178
179
180
181
182
183
184
185
186
187
188
# File 'lib/commander/command.rb', line 178

def call(args = [])
  object, meth = @when_called[0, 2]
  meth ||= :call
  options = proxy_option_struct

  case object
  when Proc then object.call(args, options)
  when Class then meth != :call ? object.new.send(meth, args, options) : object.new(args, options)
  else object.send(meth, args, options) if object
  end
end

#example(description, command) ⇒ Object

Add a usage example for this command.

Usage examples are later displayed in help documentation created by the help formatters.

Examples

command :something do |c|
  c.example "Should do something", "my_command something"
end

58
59
60
# File 'lib/commander/command.rb', line 58

def example(description, command)
  @examples << [description, command]
end

#inspectObject


212
213
214
# File 'lib/commander/command.rb', line 212

def inspect
  "<Commander::Command:#{name}>"
end

#option(*args, &block) ⇒ Object

Add an option.

Options are parsed via OptionParser so view it for additional usage documentation. A block may optionally be passed to handle the option, otherwise the options struct seen below contains the results of this option. This handles common formats such as:

-h, --help          options.help           # => bool
--[no-]feature      options.feature        # => bool
--large-switch      options.large_switch   # => bool
--file FILE         options.file           # => file passed
--list WORDS        options.list           # => array
--date [DATE]       options.date           # => date or nil when optional argument not set

Examples

command :something do |c|
  c.option '--recursive', 'Do something recursively'
  c.option '--file FILE', 'Specify a file'
  c.option('--info', 'Display info') { puts "handle with block" }
  c.option '--[no-]feature', 'With or without feature'
  c.option '--list FILES', Array, 'List the files specified'

  c.when_called do |args, options|
    do_something_recursively if options.recursive
    do_something_with_file options.file if options.file
  end
end

Help Formatters

This method also parses the arguments passed in order to determine which were switches, and which were descriptions for the option which can later be used within help formatters using option and option.

Input Parsing

Since Commander utilizes OptionParser you can pre-parse and evaluate option arguments. Simply require 'optparse/time', or 'optparse/date', as these objects must respond to #parse.

c.option '--time TIME', Time
c.option '--date [DATE]', Date

109
110
111
112
113
114
115
116
117
118
# File 'lib/commander/command.rb', line 109

def option(*args, &block)
  switches, description = Runner.separate_switches_from_description(*args)
  proc = block || option_proc(switches)
  @options << {
    args: args,
    proc: proc,
    switches: switches,
    description: description,
  }
end

#option_proc(switches) ⇒ Object

Option proxy proc used when a block is not explicitly passed via the #option method. This allows commander to auto-populate and work with option values.


208
209
210
# File 'lib/commander/command.rb', line 208

def option_proc(switches)
  ->(value) { proxy_options << [Runner.switch_to_sym(switches.last), value] }
end

#parse_options_and_call_procs(*args) ⇒ Object

Parses options and calls associated procs, returning the arguments remaining.


164
165
166
167
168
169
170
171
172
173
# File 'lib/commander/command.rb', line 164

def parse_options_and_call_procs(*args)
  return args if args.empty?
  # empty proxy_options before populating via OptionParser
  # prevents duplication of options if the command is run twice
  proxy_options.clear
  @options.each_with_object(OptionParser.new) do |option, opts|
    opts.on(*option[:args], &option[:proc])
    opts
  end.parse! args
end

#proxy_option_structObject

Creates an Options instance populated with the option values collected by the #option_proc.


194
195
196
197
198
199
200
201
# File 'lib/commander/command.rb', line 194

def proxy_option_struct
  (global_options + proxy_options).each_with_object(Options.new) do |(option, value), options|
    # options that are present will evaluate to true
    value = true if value.nil?
    options.__send__ :"#{option}=", value
    options
  end
end

#run(*args) ⇒ Object

Run the command with args.

  • parses options, call option blocks

  • invokes when_called proc


154
155
156
# File 'lib/commander/command.rb', line 154

def run(*args)
  call parse_options_and_call_procs(*args)
end

#when_called(*args, &block) ⇒ Object Also known as: action

Handle execution of command. The handler may be a class, object, or block (see examples below).

Examples

# Simple block handling
c.when_called do |args, options|
   # do something
end

# Create inst of Something and pass args / options
c.when_called MyLib::Command::Something

# Create inst of Something and use arbitrary method
 c.when_called MyLib::Command::Something, :some_method

# Pass an object to handle callback (requires method symbol)
c.when_called SomeObject, :some_method

141
142
143
144
# File 'lib/commander/command.rb', line 141

def when_called(*args, &block)
  fail ArgumentError, 'must pass an object, class, or block.' if args.empty? && !block
  @when_called = block ? [block] : args
end