class Cri::Command

Cri::Command represents a command that can be executed on the command line. It is also used for the command-line tool itself.

Attributes

aliases[RW]

@return [Array<String>] A list of aliases for this command that can be

used to invoke this command
block[RW]

@return [Proc] The block that should be executed when invoking this

command (ignored for commands with subcommands)
commands[RW]

@return [Set<Cri::Command>] This command’s subcommands

description[RW]

@return [String] The long description (“description”)

hidden[RW]

@return [Boolean] true if the command is hidden (e.g. because it is

deprecated), false otherwise
hidden?[RW]

@return [Boolean] true if the command is hidden (e.g. because it is

deprecated), false otherwise
name[RW]

@return [String] The name

option_definitions[RW]

@return [Array<Hash>] The list of option definitions

subcommands[RW]

@return [Set<Cri::Command>] This command’s subcommands

summary[RW]

@return [String] The short description (“summary”)

supercommand[RW]

@return [Cri::Command, nil] This command’s supercommand, or nil if the

command has no supercommand
usage[RW]

@return [String] The usage, without the “usage:” prefix and without the

supercommands’ names.

Public Class Methods

define(string = nil, filename = nil, &block) click to toggle source

Creates a new command using the DSL. If a string is given, the command will be defined using the string; if a block is given, the block will be used instead.

If the block has one parameter, the block will be executed in the same context with the command DSL as its parameter. If the block has no parameters, the block will be executed in the context of the DSL.

@param [String, nil] string The command definition as a string

@param [String, nil] filename The filename corresponding to the string parameter (only useful if a string is given)

@return [Cri::Command] The newly defined command

# File lib/cri/command.rb, line 91
def self.define(string = nil, filename = nil, &block)
  dsl = Cri::CommandDSL.new
  if string
    args = filename ? [string, filename] : [string]
    dsl.instance_eval(*args)
  elsif [-1, 0].include? block.arity
    dsl.instance_eval(&block)
  else
    block.call(dsl)
  end
  dsl.command
end
new() click to toggle source
# File lib/cri/command.rb, line 122
def initialize
  @aliases            = Set.new
  @commands           = Set.new
  @option_definitions = Set.new
end
new_basic_help() click to toggle source

Returns a new command that implements showing help.

@return [Cri::Command] A basic help command

# File lib/cri/command.rb, line 117
def self.new_basic_help
  filename = File.dirname(__FILE__) + '/commands/basic_help.rb'
  define(File.read(filename))
end
new_basic_root() click to toggle source

Returns a new command that has support for the `-h`/`–help` option and also has a `help` subcommand. It is intended to be modified (adding name, summary, description, other subcommands, …)

@return [Cri::Command] A basic root command

# File lib/cri/command.rb, line 109
def self.new_basic_root
  filename = File.dirname(__FILE__) + '/commands/basic_root.rb'
  define(File.read(filename))
end

Public Instance Methods

<=>(other) click to toggle source

Compares this command's name to the other given command's name.

@param [Cri::Command] other The command to compare with

@return [-1, 0, 1] The result of the comparison between names

@see Object<=>

# File lib/cri/command.rb, line 313
def <=>(other)
  name <=> other.name
end
add_command(command) click to toggle source

Adds the given command as a subcommand to the current command.

@param [Cri::Command] command The command to add as a subcommand

@return [void]

# File lib/cri/command.rb, line 159
def add_command(command)
  @commands << command
  command.supercommand = self
end
command_named(name) click to toggle source

Returns the command with the given name. This method will display error messages and exit in case of an error (unknown or ambiguous command).

The name can be a full command name, a partial command name (e.g. “com” for “commit”) or an aliased command name (e.g. “ci” for “commit”).

@param [String] name The full, partial or aliases name of the command

@return [Cri::Command] The command with the given name

# File lib/cri/command.rb, line 214
def command_named(name)
  commands = commands_named(name)

  if commands.empty?
    $stderr.puts "#{self.name}: unknown command '#{name}'\n"
    exit 1
  elsif commands.size > 1
    $stderr.puts "#{self.name}: '#{name}' is ambiguous:"
    $stderr.puts "  #{commands.map(&:name).sort.join(' ')}"
    exit 1
  else
    commands[0]
  end
end
commands_named(name) click to toggle source

Returns the commands that could be referred to with the given name. If the result contains more than one command, the name is ambiguous.

@param [String] name The full, partial or aliases name of the command

@return [Array<Cri::Command>] A list of commands matching the given name

# File lib/cri/command.rb, line 192
def commands_named(name)
  # Find by exact name or alias
  @commands.each do |cmd|
    found = cmd.name == name || cmd.aliases.include?(name)
    return [cmd] if found
  end

  # Find by approximation
  @commands.select do |cmd|
    cmd.name[0, name.length] == name
  end
end
define_command(name = nil) { |dsl| ... } click to toggle source

Defines a new subcommand for the current command using the DSL.

@param [String, nil] name The name of the subcommand, or nil if no name

should be set (yet)

@return [Cri::Command] The subcommand

# File lib/cri/command.rb, line 170
def define_command(name = nil, &block)
  # Execute DSL
  dsl = Cri::CommandDSL.new
  dsl.name name unless name.nil?
  if [-1, 0].include? block.arity
    dsl.instance_eval(&block)
  else
    yield(dsl)
  end

  # Create command
  cmd = dsl.command
  add_command(cmd)
  cmd
end
global_option_definitions() click to toggle source

@return [Hash] The option definitions for the command itself and all its

ancestors
# File lib/cri/command.rb, line 147
def global_option_definitions
  res = Set.new
  res.merge(option_definitions)
  res.merge(supercommand.global_option_definitions) if supercommand
  res
end
help(params = {}) click to toggle source

@return [String] The help text for this command

@option params [Boolean] :verbose true if the help output should be

verbose, false otherwise.

@option params [IO] :io ($stdout) the IO the help text is intended for.

This influences the decision to enable/disable colored output.
# File lib/cri/command.rb, line 302
def help(params = {})
  HelpRenderer.new(self, params).render
end
modify() { |dsl| ... } click to toggle source

Modifies the command using the DSL.

If the block has one parameter, the block will be executed in the same context with the command DSL as its parameter. If the block has no parameters, the block will be executed in the context of the DSL.

@return [Cri::Command] The command itself

# File lib/cri/command.rb, line 135
def modify(&block)
  dsl = Cri::CommandDSL.new(self)
  if [-1, 0].include? block.arity
    dsl.instance_eval(&block)
  else
    yield(dsl)
  end
  self
end
run(opts_and_args, parent_opts = {}) click to toggle source

Runs the command with the given command-line arguments, possibly invoking subcommands and passing on the options and arguments.

@param [Array<String>] opts_and_args A list of unparsed arguments

@param [Hash] parent_opts A hash of options already handled by the

supercommand

@return [void]

# File lib/cri/command.rb, line 238
def run(opts_and_args, parent_opts = {})
  # Parse up to command name
  stuff = partition(opts_and_args)
  opts_before_subcmd, subcmd_name, opts_and_args_after_subcmd = *stuff

  if subcommands.empty? || (subcmd_name.nil? && !block.nil?)
    run_this(opts_and_args, parent_opts)
  else
    # Handle options
    handle_options(opts_before_subcmd)

    # Get command
    if subcmd_name.nil?
      $stderr.puts "#{name}: no command given"
      exit 1
    end
    subcommand = command_named(subcmd_name)

    # Run
    subcommand.run(opts_and_args_after_subcmd, opts_before_subcmd)
  end
end
run_this(opts_and_args, parent_opts = {}) click to toggle source

Runs the actual command with the given command-line arguments, not invoking any subcommands. If the command does not have an execution block, an error ir raised.

@param [Array<String>] opts_and_args A list of unparsed arguments

@param [Hash] parent_opts A hash of options already handled by the

supercommand

@raise [NotImplementedError] if the command does not have an execution

block

@return [void]

# File lib/cri/command.rb, line 274
def run_this(opts_and_args, parent_opts = {})
  # Parse
  parser = Cri::OptionParser.new(
    opts_and_args, global_option_definitions
  )
  handle_parser_errors_while { parser.run }
  local_opts  = parser.options
  global_opts = parent_opts.merge(parser.options)
  args = parser.arguments

  # Handle options
  handle_options(local_opts)

  # Execute
  if block.nil?
    raise NotImplementedError,
          "No implementation available for '#{name}'"
  end
  block.call(global_opts, args, self)
end

Private Instance Methods

handle_options(opts) click to toggle source
# File lib/cri/command.rb, line 319
def handle_options(opts)
  opts.each_pair do |key, value|
    opt_def = global_option_definitions.find { |o| (o[:long] || o[:short]) == key.to_s }
    block = opt_def[:block]
    block.call(value, self) if block
  end
end
handle_parser_errors_while() { || ... } click to toggle source
# File lib/cri/command.rb, line 342
def handle_parser_errors_while
  yield
rescue Cri::OptionParser::IllegalOptionError => e
  $stderr.puts "#{name}: illegal option -- #{e}"
  exit 1
rescue Cri::OptionParser::OptionRequiresAnArgumentError => e
  $stderr.puts "#{name}: option requires an argument -- #{e}"
  exit 1
end
partition(opts_and_args) click to toggle source
# File lib/cri/command.rb, line 327
def partition(opts_and_args)
  # Parse
  delegate = Cri::Command::OptionParserPartitioningDelegate.new
  parser = Cri::OptionParser.new(opts_and_args, global_option_definitions)
  parser.delegate = delegate
  handle_parser_errors_while { parser.run }

  # Extract
  [
    parser.options,
    delegate.last_argument,
    parser.unprocessed_arguments_and_options,
  ]
end