class Mercenary::Presenter

Attributes

command[RW]

Public Class Methods

new(command) click to toggle source

Public: Make a new Presenter

command - a Mercenary::Command to present

Returns nothing

# File lib/mercenary/presenter.rb, line 12
def initialize(command)
  @command = command
end

Public Instance Methods

command_header() click to toggle source

Public: Builds the command header, including the command identity and description

Returns the command header as a String

# File lib/mercenary/presenter.rb, line 62
def command_header
  header = command.identity.to_s
  header << " -- #{command.description}" if command.description
  header
end
command_options_presentation() click to toggle source
# File lib/mercenary/presenter.rb, line 32
def command_options_presentation
  return nil if command.options.empty?

  options = command.options
  options -= command.parent.options if command.parent
  options.map(&:to_s).join("\n")
end
command_presentation() click to toggle source

Public: Builds a string representation of the whole command

Returns the string representation of the whole command

# File lib/mercenary/presenter.rb, line 71
def command_presentation
  msg = []
  msg << command_header
  msg << "Usage:"
  msg << usage_presentation

  if opts = options_presentation
    msg << "Options:\n#{opts}"
  end
  if subcommands = subcommands_presentation
    msg << "Subcommands:\n#{subcommands_presentation}"
  end
  msg.join("\n\n")
end
method_missing(meth, *args, &block) click to toggle source

Public: Turn a print_* into a *_presentation or freak out

meth - the method being called args - an array of arguments passed to the missing method block - the block passed to the missing method

Returns the value of whatever function is called

Calls superclass method
# File lib/mercenary/presenter.rb, line 93
def method_missing(meth, *args, &block)
  if meth.to_s =~ %r!^print_(.+)$!
    send("#{Regexp.last_match(1).downcase}_presentation")
  else
    # You *must* call super if you don't handle the method,
    # otherwise you'll mess up Ruby's method lookup.
    super
  end
end
options_presentation() click to toggle source

Public: Builds a string representation of the options

Returns the string representation of the options

# File lib/mercenary/presenter.rb, line 26
def options_presentation
  return nil unless command_options_presentation || parent_command_options_presentation

  [command_options_presentation, parent_command_options_presentation].compact.join("\n")
end
parent_command_options_presentation() click to toggle source

Public: Builds a string representation of the options for parent commands

Returns the string representation of the options for parent commands

# File lib/mercenary/presenter.rb, line 44
def parent_command_options_presentation
  return nil unless command.parent

  Presenter.new(command.parent).options_presentation
end
subcommands_presentation() click to toggle source

Public: Builds a string representation of the subcommands

Returns the string representation of the subcommands

# File lib/mercenary/presenter.rb, line 53
def subcommands_presentation
  return nil if command.commands.empty?

  command.commands.values.uniq.map(&:summarize).join("\n")
end
usage_presentation() click to toggle source

Public: Builds a string representation of the command usage

Returns the string representation of the command usage

# File lib/mercenary/presenter.rb, line 19
def usage_presentation
  "  #{command.syntax}"
end