Class: Commander::Runner
Defined Under Namespace
Classes: CommandError, InvalidCommandError
Instance Attribute Summary collapse
-
#commands ⇒ Object
readonly
Array of commands.
-
#help_formatter_aliases ⇒ Object
readonly
Hash of help formatter aliases.
-
#options ⇒ Object
readonly
Global options.
Class Method Summary collapse
-
.instance ⇒ Object
Return singleton Runner instance.
-
.separate_switches_from_description(*args) ⇒ Object
Return switches and description separated from the args passed.
-
.switch_to_sym(switch) ⇒ Object
Attempts to generate a method name symbol from
switch
.
Instance Method Summary collapse
-
#active_command ⇒ Object
Get active command within arguments passed to this runner.
-
#add_command(command) ⇒ Object
Add a command object to this runner.
-
#alias?(name) ⇒ Boolean
Check if command name is an alias.
-
#alias_command(alias_name, name, *args) ⇒ Object
Alias command name with alias_name.
-
#always_trace! ⇒ Object
Enable tracing on all executions (bypasses –trace).
-
#args_without_command_name ⇒ Object
Return arguments without the command name.
-
#command(name) {|add_command(Commander::Command.new(name))| ... } ⇒ Object
Creates and yields a command instance when a block is passed.
-
#command_exists?(name) ⇒ Boolean
Check if a command name exists.
-
#command_name_from_args ⇒ Object
Attempts to locate a command name from within the arguments.
-
#create_default_commands ⇒ Object
Creates default commands such as ‘help’ which is essentially the same as using the –help switch.
-
#default_command(name) ⇒ Object
Default command name to be used when no other command is found in the arguments.
-
#expand_optionally_negative_switches(switches) ⇒ Object
expand switches of the style ‘–[no-]blah’ into both their ‘–blah’ and ‘–no-blah’ variants, so that they can be properly detected and removed.
-
#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.
-
#global_option_proc(switches, &block) ⇒ Object
Returns a proc allowing for commands to inherit global options.
-
#help_formatter ⇒ Object
Help formatter instance.
-
#help_formatter_alias_defaults ⇒ Object
Returns hash of help formatter alias defaults.
-
#initialize(args = ARGV) ⇒ Runner
constructor
Initialize a new command runner.
-
#never_trace! ⇒ Object
Hide the trace option from the help menus and don’t add it as a global option.
-
#parse_global_options ⇒ Object
Parse global command options.
-
#program(key, *args, &block) ⇒ Object
Assign program information.
-
#program_defaults ⇒ Object
Returns hash of program defaults.
-
#remove_global_options(options, args) ⇒ Object
Removes global options from args.
-
#require_program(*keys) ⇒ Object
Raises a CommandError when the program any of the keys are not present, or empty.
-
#require_valid_command(command = active_command) ⇒ Object
Raises InvalidCommandError when a command is not found.
-
#run! ⇒ Object
Run command parsing and execution process.
-
#run_active_command ⇒ Object
Run the active command.
-
#say(*args) ⇒ Object
:nodoc:.
-
#valid_command_names_from(*args) ⇒ Object
Returns array of valid command names found within args.
-
#version ⇒ Object
Return program version.
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
#commands ⇒ Object (readonly)
Array of commands.
15 16 17 |
# File 'lib/commander/runner.rb', line 15 def commands @commands end |
#help_formatter_aliases ⇒ Object (readonly)
Hash of help formatter aliases.
25 26 27 |
# File 'lib/commander/runner.rb', line 25 def help_formatter_aliases @help_formatter_aliases end |
#options ⇒ Object (readonly)
Global options.
20 21 22 |
# File 'lib/commander/runner.rb', line 20 def @options end |
Class Method Details
.instance ⇒ Object
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.
422 423 424 425 426 |
# File 'lib/commander/runner.rb', line 422 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
440 441 442 |
# File 'lib/commander/runner.rb', line 440 def self.switch_to_sym(switch) switch.scan(/[\-\]](\w+)/).join('_').to_sym rescue nil end |
Instance Method Details
#active_command ⇒ Object
Get active command within arguments passed to this runner.
233 234 235 |
# File 'lib/commander/runner.rb', line 233 def active_command @__active_command ||= command(command_name_from_args) end |
#add_command(command) ⇒ Object
Add a command object to this runner.
210 211 212 |
# File 'lib/commander/runner.rb', line 210 def add_command(command) @commands[command.name] = command end |
#alias?(name) ⇒ Boolean
Check if command name is an alias.
217 218 219 |
# File 'lib/commander/runner.rb', line 217 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.
194 195 196 197 |
# File 'lib/commander/runner.rb', line 194 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_name ⇒ Object
Return arguments without the command name.
264 265 266 267 268 269 270 |
# File 'lib/commander/runner.rb', line 264 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
171 172 173 174 |
# File 'lib/commander/runner.rb', line 171 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.
224 225 226 |
# File 'lib/commander/runner.rb', line 224 def command_exists?(name) @commands[name.to_s] end |
#command_name_from_args ⇒ Object
Attempts to locate a command name from within the arguments. Supports multi-word commands, using the largest possible match.
241 242 243 |
# File 'lib/commander/runner.rb', line 241 def command_name_from_args @__command_name_from_args ||= (valid_command_names_from(*@args.dup).sort.last || @default_command) end |
#create_default_commands ⇒ Object
Creates default commands such as ‘help’ which is essentially the same as using the –help switch.
296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 |
# File 'lib/commander/runner.rb', line 296 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, | UI.enable_paging if program(:help_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.
203 204 205 |
# File 'lib/commander/runner.rb', line 203 def default_command(name) @default_command = name end |
#expand_optionally_negative_switches(switches) ⇒ Object
expand switches of the style ‘–[no-]blah’ into both their ‘–blah’ and ‘–no-blah’ variants, so that they can be properly detected and removed
366 367 368 369 370 371 372 373 374 375 |
# File 'lib/commander/runner.rb', line 366 def (switches) switches.reduce([]) do |memo, val| if val =~ /\[no-\]/ memo << val.gsub(/\[no-\]/, '') memo << val.gsub(/\[no-\]/, 'no-') else memo << val end end 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.
180 181 182 183 184 185 186 187 188 |
# File 'lib/commander/runner.rb', line 180 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.
401 402 403 404 405 406 407 408 |
# File 'lib/commander/runner.rb', line 401 def global_option_proc(switches, &block) lambda do |value| unless active_command.nil? active_command. << [Runner.switch_to_sym(switches.last), value] end yield value if block && !value.nil? end end |
#help_formatter ⇒ Object
Help formatter instance.
257 258 259 |
# File 'lib/commander/runner.rb', line 257 def help_formatter @__help_formatter ||= program(:help_formatter).new self end |
#help_formatter_alias_defaults ⇒ Object
Returns hash of help formatter alias defaults.
275 276 277 278 279 |
# File 'lib/commander/runner.rb', line 275 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_options ⇒ Object
Parse global command options.
380 381 382 383 384 385 386 387 388 389 390 391 392 393 |
# File 'lib/commander/runner.rb', line 380 def parser = .inject(OptionParser.new) do |, option| .on(*option[:args], &global_option_proc(option[:switches], &option[:proc])) end = @args.dup begin parser.parse!() rescue OptionParser::InvalidOption => e # Remove the offending args and retry. = .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
:help_paging Flag for toggling help paging
:int_message Message to display when interrupted (CTRL + C)
141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 |
# File 'lib/commander/runner.rb', line 141 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_defaults ⇒ Object
Returns hash of program defaults.
284 285 286 287 288 289 290 |
# File 'lib/commander/runner.rb', line 284 def program_defaults { help_formatter: HelpFormatter::Terminal, name: File.basename($PROGRAM_NAME), help_paging: true, } 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.
331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 |
# File 'lib/commander/runner.rb', line 331 def (, args) .each do |option| switches = option[:switches] next if switches.empty? option_takes_argument = switches.any? { |s| s =~ /[ =]/ } switches = (switches) option_argument_needs_removal = false args.delete_if do |token| break if token == '--' # Use just the portion of the token before the = when # comparing switches. index_of_equals = token.index('=') if option_takes_argument token = token[0, index_of_equals] if index_of_equals token_contains_option_argument = !index_of_equals.nil? if switches.any? { |s| s[0, token.length] == token } option_argument_needs_removal = option_takes_argument && !token_contains_option_argument true elsif option_argument_needs_removal && token !~ /^-/ option_argument_needs_removal = false true else option_argument_needs_removal = false false end end end end |
#require_program(*keys) ⇒ Object
Raises a CommandError when the program any of the keys are not present, or empty.
413 414 415 416 417 |
# File 'lib/commander/runner.rb', line 413 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.
322 323 324 |
# File 'lib/commander/runner.rb', line 322 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 , @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_command ⇒ Object
Run the active command.
447 448 449 450 451 452 453 454 |
# File 'lib/commander/runner.rb', line 447 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:
456 457 458 |
# File 'lib/commander/runner.rb', line 456 def say(*args) #:nodoc: HighLine.default_instance.say(*args) end |
#valid_command_names_from(*args) ⇒ Object
Returns array of valid command names found within args.
248 249 250 251 252 |
# File 'lib/commander/runner.rb', line 248 def valid_command_names_from(*args) , args arg_string = args.delete_if { |value| value =~ /^-/ }.join ' ' commands.keys.find_all { |name| name if arg_string =~ /^#{name}\b/ } end |
#version ⇒ Object
Return program version.
92 93 94 |
# File 'lib/commander/runner.rb', line 92 def version format('%s %s', program(:name), program(:version)) end |