class RHC::CommandRunner

Constants

HELP_OPTIONS

Public Instance Methods

create_default_commands() click to toggle source
# File lib/rhc/command_runner.rb, line 120
def create_default_commands
  command 'help options' do |c|
    c.description = "Display all global options and information about configuration"
    c.when_called do |args, options|
      say help_formatter.render_options self
    end
  end
  command :help do |c|
    c.syntax = '<command>'
    c.description = 'Display global or <command> help documentation.'
    c.when_called(&method(:run_help))
  end
end
global_option(*args, &block) click to toggle source
# File lib/rhc/command_runner.rb, line 113
def global_option(*args, &block)
  opts = args.pop if Hash === args.last
  super(*args, &block).tap do |options|
    options.last.merge!(opts) if opts
  end
end
options_parse_help() click to toggle source
# File lib/rhc/command_runner.rb, line 34
def options_parse_help
  if (@args & HELP_OPTIONS).present?
    args = (@args -= HELP_OPTIONS)
    args.shift if args.first == 'help' && !command_exists?(args.join(' '))
    exit run_help(args, nil)
  end
end
options_parse_trace() click to toggle source
# File lib/rhc/command_runner.rb, line 17
def options_parse_trace
  if @args.include?("--trace")
    @args.delete "--trace"
    return true
  end
  false
end
options_parse_version() click to toggle source
# File lib/rhc/command_runner.rb, line 25
def options_parse_version
  if @args.include? "--version"
    say version
    exit 0
  end
end
program(*args) click to toggle source

:nocov:

# File lib/rhc/command_runner.rb, line 11
def program(*args)
  Array(super).first
end
provided_arguments() click to toggle source
# File lib/rhc/command_runner.rb, line 109
def provided_arguments
  @args[0, @args.find_index { |arg| arg.start_with?('-') } || @args.length]
end
run!() click to toggle source

override so we can do our own error handling

# File lib/rhc/command_runner.rb, line 43
def run!
  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', 'Help on any command', :hide => true)
  global_option('--version', 'Display version information', :hide => true)

  # remove these because we monkey patch Commands to process all options
  # at once, avoiding conflicts between the global and command options
  # code left here just in case someone compares this with the original
  # commander code
  #parse_global_options
  #remove_global_options options, @args

  # special case --trace because we need to use it in the runner
  trace = options_parse_trace

  # special case --version so it is processed before an invalid command
  options_parse_version

  # help is a special branch prior to command execution
  options_parse_help

  unless trace
    begin
      run_active_command
    rescue InvalidCommandError => e
      if provided_arguments.empty?
        return RHC::Wizard.new.run unless RHC::Wizard.has_configuration?
        say RHC::HelpFormatter.new(self).render
      else
        RHC::Helpers.error "The command '#{program :name} #{provided_arguments.join(' ')}' is not recognized.\n"
        say "See '#{program :name} help' for a list of valid commands."
      end
      1
    rescue            OptionParser::InvalidOption => e
      RHC::Helpers.error e.message
      1
    rescue            ArgumentError,
      OptionParser::ParseError => e

      help_bindings = CommandHelpBindings.new(active_command, commands, self)
      usage = RHC::HelpFormatter.new(self).render_command_syntax(help_bindings)
      message = case e
      when OptionParser::AmbiguousOption
        "The option #{e.args.join(' ')} is ambiguous. You will need to specify the entire option."
      else
        e.message
      end

      RHC::Helpers.error message
      say "#{usage}"
      1
    rescue RHC::Exception, RHC::Rest::Exception => e
      RHC::Helpers.error e.message
      e.code.nil? ? 128 : [1, (e.code || 1).to_i].max
    end
  else
    run_active_command
  end
end
run_help(args, options) click to toggle source
# File lib/rhc/command_runner.rb, line 134
def run_help(args, options)
  cmd = (1..args.length).reverse_each.map{ |n| args[0,n].join(' ') }.find{ |cmd| command_exists?(cmd) }

  if args.empty?
    say help_formatter.render
    0
  elsif cmd.nil?
    RHC::Helpers.error "The command '#{program :name} #{provided_arguments.join(' ')}' is not recognized.\n"
    say "See '#{program :name} help' for a list of valid commands."
    1
  else
    command = command(cmd)
    help_bindings = CommandHelpBindings.new command, commands, self
    say help_formatter.render_command help_bindings
    0
  end
end
valid_command_names_from(*args) click to toggle source

regex fix from git - match on word boundries

# File lib/rhc/command_runner.rb, line 4
def valid_command_names_from *args
  arg_string = args.delete_if { |value| value =~ %r^-/ }.join ' '
  commands.keys.find_all { |name| name if %r^#{name}\b/.match arg_string }
end