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.


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

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

Instance Attribute Details

#commandsObject (readonly)

Array of commands.


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

def commands
  @commands
end

#help_formatter_aliasesObject (readonly)

Hash of help formatter aliases.


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

def help_formatter_aliases
  @help_formatter_aliases
end

#optionsObject (readonly)

Global options.


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

def options
  @options
end

Class Method Details

.instanceObject

Return singleton Runner instance.


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

def self.instance
  @singleton ||= new
end

.separate_switches_from_description(*args) ⇒ Object

Return switches and description separated from the args passed.


398
399
400
401
402
# File 'lib/commander/runner.rb', line 398

def self.separate_switches_from_description(*args)
  switches = args.find_all { |arg| arg.to_s =~ /^-/ }
  description = args.last if args.last.is_a?(String) && !args.last.match(/^-/)
  [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

416
417
418
# File 'lib/commander/runner.rb', line 416

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.


232
233
234
# File 'lib/commander/runner.rb', line 232

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

#add_command(command) ⇒ Object

Add a command object to this runner.


209
210
211
# File 'lib/commander/runner.rb', line 209

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

#alias?(name) ⇒ Boolean

Check if command name is an alias.

Returns:

  • (Boolean)

216
217
218
# File 'lib/commander/runner.rb', line 216

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.


193
194
195
196
# File 'lib/commander/runner.rb', line 193

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)


99
100
101
102
# File 'lib/commander/runner.rb', line 99

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

#args_without_command_nameObject

Return arguments without the command name.


262
263
264
265
266
267
268
# File 'lib/commander/runner.rb', line 262

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) && !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:


170
171
172
173
# File 'lib/commander/runner.rb', line 170

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)

223
224
225
# File 'lib/commander/runner.rb', line 223

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.


240
241
242
# File 'lib/commander/runner.rb', line 240

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.


293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
# File 'lib/commander/runner.rb', line 293

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.


202
203
204
# File 'lib/commander/runner.rb', line 202

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.


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

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.


377
378
379
380
381
382
383
384
# File 'lib/commander/runner.rb', line 377

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 && !value.nil?
  end
end

#help_formatterObject

Help formatter instance.


255
256
257
# File 'lib/commander/runner.rb', line 255

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

#help_formatter_alias_defaultsObject

Returns hash of help formatter alias defaults.


273
274
275
276
277
# File 'lib/commander/runner.rb', line 273

def help_formatter_alias_defaults
  {
    compact: HelpFormatter::TerminalCompact,
  }
end

#never_trace!Object

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


107
108
109
110
# File 'lib/commander/runner.rb', line 107

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

#parse_global_optionsObject

Parse global command options.


356
357
358
359
360
361
362
363
364
365
366
367
368
369
# File 'lib/commander/runner.rb', line 356

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)

140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
# File 'lib/commander/runner.rb', line 140

def program(key, *args, &block)
  if key == :help && !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.


282
283
284
285
286
287
# File 'lib/commander/runner.rb', line 282

def program_defaults
  {
    help_formatter: HelpFormatter::Terminal,
    name: File.basename($PROGRAM_NAME),
  }
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.


328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
# File 'lib/commander/runner.rb', line 328

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 (switch_has_arg = 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 = !switch_has_arg
        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.


389
390
391
392
393
# File 'lib/commander/runner.rb', line 389

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

#require_valid_command(command = active_command) ⇒ Object

Raises InvalidCommandError when a command is not found.


319
320
321
# File 'lib/commander/runner.rb', line 319

def require_valid_command(command = active_command)
  fail InvalidCommandError, 'invalid command', caller if command.nil?
end

#run!Object

Run command parsing and execution process.


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
84
85
86
87
# File 'lib/commander/runner.rb', line 50

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') do
    say version
    return
  end
  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
  if trace
    run_active_command
  else
    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
  end
end

#run_active_commandObject

Run the active command.


423
424
425
426
427
428
429
430
# File 'lib/commander/runner.rb', line 423

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:


432
433
434
# File 'lib/commander/runner.rb', line 432

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

#valid_command_names_from(*args) ⇒ Object

Returns array of valid command names found within args.


247
248
249
250
# File 'lib/commander/runner.rb', line 247

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.


92
93
94
# File 'lib/commander/runner.rb', line 92

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