Class: Commander::Runner

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

Defined Under Namespace

Classes: CommandError, InvalidCommandError

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(args = ARGV) ⇒ Runner

Initialize a new command runner. Optionally supplying args for mocking, or arbitrary usage.


32
33
34
35
36
37
# File 'lib/commander/runner.rb', line 32

def initialize args = ARGV
  @args, @commands, @aliases, @options = args, {}, {}, []
  @help_formatter_aliases = help_formatter_alias_defaults
  @program = program_defaults
  create_default_commands
end

Instance Attribute Details

#commandsObject (readonly)

Array of commands.


16
17
18
# File 'lib/commander/runner.rb', line 16

def commands
  @commands
end

#help_formatter_aliasesObject (readonly)

Hash of help formatter aliases.


26
27
28
# File 'lib/commander/runner.rb', line 26

def help_formatter_aliases
  @help_formatter_aliases
end

#optionsObject (readonly)

Global options.


21
22
23
# File 'lib/commander/runner.rb', line 21

def options
  @options
end

Class Method Details

.instanceObject

Return singleton Runner instance.


42
43
44
# File 'lib/commander/runner.rb', line 42

def self.instance
  @singleton ||= new
end

.separate_switches_from_description(*args) ⇒ Object

Return switches and description separated from the args passed.


391
392
393
394
395
# File 'lib/commander/runner.rb', line 391

def self.separate_switches_from_description *args
  switches = args.find_all { |arg| arg.to_s =~ /^-/ } 
  description = args.last unless !args.last.is_a? String or args.last.match(/^-/)
  return switches, description
end

.switch_to_sym(switch) ⇒ Object

Attempts to generate a method name symbol from switch. For example:

-h                 # => :h
--trace            # => :trace
--some-switch      # => :some_switch
--[no-]feature     # => :feature
--file FILE        # => :file
--list of,things   # => :list

409
410
411
# File 'lib/commander/runner.rb', line 409

def self.switch_to_sym switch
  switch.scan(/[\-\]](\w+)/).join('_').to_sym rescue nil
end

Instance Method Details

#active_commandObject

Get active command within arguments passed to this runner.


228
229
230
# File 'lib/commander/runner.rb', line 228

def active_command
  @__active_command ||= command(command_name_from_args)
end

#add_command(command) ⇒ Object

Add a command object to this runner.


205
206
207
# File 'lib/commander/runner.rb', line 205

def add_command command
  @commands[command.name] = command
end

#alias?(name) ⇒ Boolean

Check if command name is an alias.

Returns:

  • (Boolean)

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

def alias? name
  @aliases.include? name.to_s
end

#alias_command(alias_name, name, *args) ⇒ Object

Alias command name with alias_name. Optionally args may be passed as if they were being passed straight to the original command via the command-line.


189
190
191
192
# File 'lib/commander/runner.rb', line 189

def alias_command alias_name, name, *args
  @commands[alias_name.to_s] = command name
  @aliases[alias_name.to_s] = args
end

#always_trace!Object

Enable tracing on all executions (bypasses –trace)


95
96
97
98
# File 'lib/commander/runner.rb', line 95

def always_trace!
  @always_trace = true
  @never_trace = false
end

#args_without_command_nameObject

Return arguments without the command name.


258
259
260
261
262
263
264
# File 'lib/commander/runner.rb', line 258

def args_without_command_name
  removed = []
  parts = command_name_from_args.split rescue []
  @args.dup.delete_if do |arg|
    removed << arg if parts.include?(arg) and not removed.include?(arg)
  end
end

#command(name) {|add_command(Commander::Command.new(name))| ... } ⇒ Object

Creates and yields a command instance when a block is passed. Otherwise attempts to return the command, raising InvalidCommandError when it does not exist.

Examples

command :my_command do |c|
  c.when_called do |args|
    # Code
  end
end

Yields:


166
167
168
169
# File 'lib/commander/runner.rb', line 166

def command name, &block
  yield add_command(Commander::Command.new(name)) if block
  @commands[name.to_s]
end

#command_exists?(name) ⇒ Boolean

Check if a command name exists.

Returns:

  • (Boolean)

219
220
221
# File 'lib/commander/runner.rb', line 219

def command_exists? name
  @commands[name.to_s]
end

#command_name_from_argsObject

Attempts to locate a command name from within the arguments. Supports multi-word commands, using the largest possible match.


236
237
238
# File 'lib/commander/runner.rb', line 236

def command_name_from_args
  @__command_name_from_args ||= (valid_command_names_from(*@args.dup).sort.last || @default_command)
end

#create_default_commandsObject

Creates default commands such as 'help' which is essentially the same as using the –help switch.


285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
# File 'lib/commander/runner.rb', line 285

def create_default_commands
  command :help do |c|
    c.syntax = 'commander help [command]'
    c.description = 'Display global or [command] help documentation'
    c.example 'Display global help', 'command help'
    c.example "Display help for 'foo'", 'command help foo'
    c.when_called do |args, options|
      UI.enable_paging
      if args.empty?
        say help_formatter.render 
      else
        command = command args.join(' ')
        begin
          require_valid_command command
        rescue InvalidCommandError => e
          abort "#{e}. Use --help for more information"
        end
        say help_formatter.render_command(command)
      end
    end
  end
end

#default_command(name) ⇒ Object

Default command name to be used when no other command is found in the arguments.


198
199
200
# File 'lib/commander/runner.rb', line 198

def default_command name
  @default_command = name
end

#global_option(*args, &block) ⇒ Object

Add a global option; follows the same syntax as Command#option This would be used for switches such as –version, –trace, etc.


175
176
177
178
179
180
181
182
183
# File 'lib/commander/runner.rb', line 175

def global_option *args, &block
  switches, description = Runner.separate_switches_from_description *args
  @options << {
    :args => args,
    :proc => block,
    :switches => switches,
    :description => description,
  }
end

#global_option_proc(switches, &block) ⇒ Object

Returns a proc allowing for commands to inherit global options. This functionality works whether a block is present for the global option or not, so simple switches such as –verbose can be used without a block, and used throughout all commands.


370
371
372
373
374
375
376
377
# File 'lib/commander/runner.rb', line 370

def global_option_proc switches, &block
  lambda do |value|
    unless active_command.nil?
      active_command.proxy_options << [Runner.switch_to_sym(switches.last), value]
    end
    yield value if block and !value.nil?
  end
end

#help_formatterObject

Help formatter instance.


251
252
253
# File 'lib/commander/runner.rb', line 251

def help_formatter
  @__help_formatter ||= program(:help_formatter).new self
end

#help_formatter_alias_defaultsObject

Returns hash of help formatter alias defaults.


269
270
271
# File 'lib/commander/runner.rb', line 269

def help_formatter_alias_defaults
  return :compact => HelpFormatter::TerminalCompact
end

#never_trace!Object

Hide the trace option from the help menus and don't add it as a global option


103
104
105
106
# File 'lib/commander/runner.rb', line 103

def never_trace!
  @never_trace = true
  @always_trace = false
end

#parse_global_optionsObject

Parse global command options.


348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
# File 'lib/commander/runner.rb', line 348

def parse_global_options

  parser = options.inject(OptionParser.new) do |options, option|
    options.on *option[:args], &global_option_proc(option[:switches], &option[:proc])
  end

  options = @args.dup
  begin
    parser.parse!(options)
  rescue OptionParser::InvalidOption => e
    # Remove the offending args and retry.
    options = options.reject { |o| e.args.include?(o) }
    retry
  end
end

#program(key, *args, &block) ⇒ Object

Assign program information.

Examples

# Set data
program :name, 'Commander'
program :version, Commander::VERSION
program :description, 'Commander utility program.'
program :help, 'Copyright', '2008 TJ Holowaychuk'
program :help, 'Anything', 'You want'
program :int_message 'Bye bye!'
program :help_formatter, :compact
program :help_formatter, Commander::HelpFormatter::TerminalCompact

# Get data
program :name # => 'Commander'

Keys

:version         (required) Program version triple, ex: '0.0.1'
:description     (required) Program description
:name            Program name, defaults to basename of executable
:help_formatter  Defaults to Commander::HelpFormatter::Terminal
:help            Allows addition of arbitrary global help blocks
:int_message     Message to display when interrupted (CTRL + C)

136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
# File 'lib/commander/runner.rb', line 136

def program key, *args, &block
  if key == :help and !args.empty?
    @program[:help] ||= {}
    @program[:help][args.first] = args.at(1)
  elsif key == :help_formatter && !args.empty?
    @program[key] = (@help_formatter_aliases[args.first] || args.first)
  elsif block
    @program[key] = block
  else
    unless args.empty?
      @program[key] = (args.count == 1 && args[0]) || args
    end
    @program[key]
  end
end

#program_defaultsObject

Returns hash of program defaults.


276
277
278
279
# File 'lib/commander/runner.rb', line 276

def program_defaults
  return :help_formatter => HelpFormatter::Terminal, 
         :name => File.basename($0)
end

#remove_global_options(options, args) ⇒ Object

Removes global options from args. This prevents an invalid option error from occurring when options are parsed again for the command.


320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
# File 'lib/commander/runner.rb', line 320

def remove_global_options options, args
  # TODO: refactor with flipflop, please TJ ! have time to refactor me !
  options.each do |option|
    switches = option[:switches].dup
    next if switches.empty?

    if switchHasArg = switches.any? { |s| s =~ /[ =]/ }
      switches.map! { |s| s[0, s.index('=') || s.index(' ') || s.length] }
    end

    past_switch, arg_removed = false, false
    args.delete_if do |arg|
      if switches.any? { |s| arg[0, s.length] == s }
        arg_removed = !switchHasArg
        past_switch = true
      elsif past_switch && !arg_removed && arg !~ /^-/
        arg_removed = true
      else
        arg_removed = true
        false
      end
    end
  end
end

#require_program(*keys) ⇒ Object

Raises a CommandError when the program any of the keys are not present, or empty.


382
383
384
385
386
# File 'lib/commander/runner.rb', line 382

def require_program *keys
  keys.each do |key|
    raise CommandError, "program #{key} required" if program(key).nil? or program(key).empty?
  end
end

#require_valid_command(command = active_command) ⇒ Object

Raises InvalidCommandError when a command is not found.


311
312
313
# File 'lib/commander/runner.rb', line 311

def require_valid_command command = active_command
  raise InvalidCommandError, 'invalid command', caller if command.nil?
end

#run!Object

Run command parsing and execution process.


49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
# File 'lib/commander/runner.rb', line 49

def run!
  trace = @always_trace || false
  require_program :version, :description
  trap('INT') { abort program(:int_message) } if program(:int_message)
  trap('INT') { program(:int_block).call } if program(:int_block)
  global_option('-h', '--help', 'Display help documentation') do
    args = @args - %w[-h --help]
    command(:help).run(*args)
    return
  end
  global_option('-v', '--version', 'Display version information') { say version; return } 
  global_option('-t', '--trace', 'Display backtrace when an error occurs') { trace = true } unless (@never_trace || @always_trace)
  parse_global_options
  remove_global_options options, @args
  unless trace
    begin
      run_active_command
    rescue InvalidCommandError => e
      abort "#{e}. Use --help for more information"
    rescue \
      OptionParser::InvalidOption, 
      OptionParser::InvalidArgument,
      OptionParser::MissingArgument => e
      abort e.to_s
    rescue => e
      if @never_trace
        abort "error: #{e}."
      else
        abort "error: #{e}. Use --trace to view backtrace"
      end
    end
  else
    run_active_command
  end
end

#run_active_commandObject

Run the active command.


416
417
418
419
420
421
422
423
# File 'lib/commander/runner.rb', line 416

def run_active_command
  require_valid_command
  if alias? command_name_from_args
    active_command.run *(@aliases[command_name_from_args.to_s] + args_without_command_name)
  else
    active_command.run *args_without_command_name
  end      
end

#say(*args) ⇒ Object

:nodoc:


425
426
427
# File 'lib/commander/runner.rb', line 425

def say *args #:nodoc: 
  $terminal.say *args
end

#valid_command_names_from(*args) ⇒ Object

Returns array of valid command names found within args.


243
244
245
246
# File 'lib/commander/runner.rb', line 243

def valid_command_names_from *args
  arg_string = args.delete_if { |value| value =~ /^-/ }.join ' '
  commands.keys.find_all { |name| name if /^#{name}\b/.match arg_string }
end

#versionObject

Return program version.


88
89
90
# File 'lib/commander/runner.rb', line 88

def version
  '%s %s' % [program(:name), program(:version)]
end