class GLI::Commands::RdocDocumentListener

Public Class Methods

new(global_options,options,arguments,app) click to toggle source
# File lib/gli/commands/rdoc_document_listener.rb, line 7
def initialize(global_options,options,arguments,app)
  @io = File.new("#{app.exe_name}.rdoc",'w')
  @nest = ''
  @arg_name_formatter = GLI::Commands::HelpModules::ArgNameFormatter.new
end

Public Instance Methods

beginning() click to toggle source
# File lib/gli/commands/rdoc_document_listener.rb, line 13
def beginning
end
command(name,aliases,desc,long_desc,arg_name,arg_options) click to toggle source

Gives you a command in the current context and creates a new context of this command

# File lib/gli/commands/rdoc_document_listener.rb, line 83
def command(name,aliases,desc,long_desc,arg_name,arg_options)
  @io.puts "#{@nest}=== Command: <tt>#{([name] + aliases).join('|')} #{@arg_name_formatter.format(arg_name,arg_options,[])}</tt>"
  @io.puts String(desc).strip
  @io.puts 
  @io.puts String(long_desc).strip
  @nest = "#{@nest}="
end
commands() click to toggle source
# File lib/gli/commands/rdoc_document_listener.rb, line 77
def commands
  @io.puts "#{@nest}=== Commands"
  @nest = "#{@nest}="
end
default_command(name) click to toggle source

Gives you the name of the current command in the current context

# File lib/gli/commands/rdoc_document_listener.rb, line 97
def default_command(name)
  @io.puts "[Default Command] #{name}" unless name.nil?
end
end_command(name) click to toggle source

Ends a command, and “pops” you back up one context

# File lib/gli/commands/rdoc_document_listener.rb, line 92
def end_command(name)
  @nest.gsub!(/=$/,'')
end
end_commands() click to toggle source
# File lib/gli/commands/rdoc_document_listener.rb, line 101
def end_commands
  @nest.gsub!(/=$/,'')
end
end_options() click to toggle source
# File lib/gli/commands/rdoc_document_listener.rb, line 74
def end_options
end
ending() click to toggle source

Called when processing has completed

# File lib/gli/commands/rdoc_document_listener.rb, line 17
def ending
  @io.close
end
flag(name,aliases,desc,long_desc,default_value,arg_name,must_match,type) click to toggle source

Gives you a flag in the current context

# File lib/gli/commands/rdoc_document_listener.rb, line 47
def flag(name,aliases,desc,long_desc,default_value,arg_name,must_match,type)
  invocations = ([name] + Array(aliases)).map { |_| add_dashes(_) }.join('|')
  usage = "#{invocations} #{arg_name || 'arg'}"
  @io.puts "#{@nest}=== #{usage}"
  @io.puts
  @io.puts String(desc).strip
  @io.puts
  @io.puts "[Default Value] #{default_value || 'None'}"
  @io.puts "[Must Match] #{must_match.to_s}" unless must_match.nil?
  @io.puts String(long_desc).strip
  @io.puts
end
options() click to toggle source
# File lib/gli/commands/rdoc_document_listener.rb, line 38
def options
  if @nest.size == 0
    @io.puts "=== Global Options"
  else
    @io.puts "#{@nest}=== Options"
  end
end
program_desc(desc) click to toggle source

Gives you the program description

# File lib/gli/commands/rdoc_document_listener.rb, line 22
def program_desc(desc)
  @io.puts "== #{@app.exe_name} - #{desc}"
  @io.puts
end
program_long_desc(desc) click to toggle source
# File lib/gli/commands/rdoc_document_listener.rb, line 27
def program_long_desc(desc)
  @io.puts desc
  @io.puts
end
switch(name,aliases,desc,long_desc,negatable) click to toggle source

Gives you a switch in the current context

# File lib/gli/commands/rdoc_document_listener.rb, line 61
def switch(name,aliases,desc,long_desc,negatable)
  if negatable
    name = "[no-]#{name}" if name.to_s.length > 1
    aliases = aliases.map { |_|  _.to_s.length > 1 ? "[no-]#{_}" : _ } 
  end
  invocations = ([name] + aliases).map { |_| add_dashes(_) }.join('|')
  @io.puts "#{@nest}=== #{invocations}"
  @io.puts String(desc).strip
  @io.puts
  @io.puts String(long_desc).strip
  @io.puts
end
version(version) click to toggle source

Gives you the program version

# File lib/gli/commands/rdoc_document_listener.rb, line 33
def version(version)
  @io.puts "v#{version}"
  @io.puts
end

Private Instance Methods

add_dashes(name) click to toggle source
# File lib/gli/commands/rdoc_document_listener.rb, line 107
def add_dashes(name)
  name = "-#{name}"
  name = "-#{name}" if name.length > 2
  name
end