Class: GLI::Commands::MarkdownDocumentListener
- Inherits:
-
Object
- Object
- GLI::Commands::MarkdownDocumentListener
- Defined in:
- lib/lib_ext/markdown_document_listener.rb
Instance Method Summary collapse
- #beginning ⇒ Object
-
#command(name, aliases, desc, long_desc, arg_name, arg_options) ⇒ Object
Gives you a command in the current context and creates a new context of this command.
- #commands ⇒ Object
-
#default_command(name) ⇒ Object
Gives you the name of the current command in the current context.
-
#end_command(name) ⇒ Object
Ends a command, and “pops” you back up one context.
- #end_commands ⇒ Object
- #end_options ⇒ Object
-
#ending ⇒ Object
Called when processing has completed.
-
#flag(name, aliases, desc, long_desc, default_value, arg_name, must_match, type) ⇒ Object
Gives you a flag in the current context.
-
#initialize(global_options, options, arguments) ⇒ MarkdownDocumentListener
constructor
A new instance of MarkdownDocumentListener.
- #options ⇒ Object
-
#program_desc(desc) ⇒ Object
Gives you the program description.
- #program_long_desc(desc) ⇒ Object
-
#switch(name, aliases, desc, long_desc, negetable) ⇒ Object
Gives you a switch in the current context.
-
#version(version) ⇒ Object
Gives you the program version.
Constructor Details
#initialize(global_options, options, arguments) ⇒ MarkdownDocumentListener
Returns a new instance of MarkdownDocumentListener.
13 14 15 16 17 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 13 def initialize(,,arguments) @io = STDOUT #File.new(File.basename($0) + ".rdoc",'w') @nest = '' @arg_name_formatter = GLI::Commands::HelpModules::ArgNameFormatter.new end |
Instance Method Details
#beginning ⇒ Object
19 20 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 19 def beginning end |
#command(name, aliases, desc, long_desc, arg_name, arg_options) ⇒ Object
Gives you a command in the current context and creates a new context of this command
89 90 91 92 93 94 95 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 89 def command(name,aliases,desc,long_desc,arg_name,) @io.puts "#{@nest}=== Command: <tt>#{([name] + aliases).join('|')} #{@arg_name_formatter.format(arg_name,)}</tt>" @io.puts String(desc).strip @io.puts @io.puts String(long_desc).strip @nest = "#{@nest}=" end |
#commands ⇒ Object
83 84 85 86 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 83 def commands @io.puts "#{@nest}=== Commands" @nest = "#{@nest}=" end |
#default_command(name) ⇒ Object
Gives you the name of the current command in the current context
103 104 105 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 103 def default_command(name) @io.puts "[Default Command] #{name}" unless name.nil? end |
#end_command(name) ⇒ Object
Ends a command, and “pops” you back up one context
98 99 100 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 98 def end_command(name) @nest.gsub!(/=$/,'') end |
#end_commands ⇒ Object
107 108 109 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 107 def end_commands @nest.gsub!(/=$/,'') end |
#end_options ⇒ Object
80 81 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 80 def end |
#ending ⇒ Object
Called when processing has completed
23 24 25 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 23 def ending #@io.close end |
#flag(name, aliases, desc, long_desc, default_value, arg_name, must_match, type) ⇒ Object
Gives you a flag in the current context
53 54 55 56 57 58 59 60 61 62 63 64 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 53 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 ⇒ Object
44 45 46 47 48 49 50 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 44 def if @nest.size == 0 @io.puts "=== Global Options" else @io.puts "#{@nest}=== Options" end end |
#program_desc(desc) ⇒ Object
Gives you the program description
28 29 30 31 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 28 def program_desc(desc) @io.puts "== #{File.basename($0)} - #{desc}" @io.puts end |
#program_long_desc(desc) ⇒ Object
33 34 35 36 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 33 def program_long_desc(desc) @io.puts desc @io.puts end |
#switch(name, aliases, desc, long_desc, negetable) ⇒ Object
Gives you a switch in the current context
67 68 69 70 71 72 73 74 75 76 77 78 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 67 def switch(name,aliases,desc,long_desc,negetable) if negetable 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) ⇒ Object
Gives you the program version
39 40 41 42 |
# File 'lib/lib_ext/markdown_document_listener.rb', line 39 def version(version) @io.puts "v#{version}" @io.puts end |