Class: Rabal::Usage

Inherits:
Object
  • Object
show all
Defined in:
lib/rabal/usage.rb

Overview

Rabal has unique Usage output requirements and as such the default usage provided by the Main gem although nice are not sufficient.

Rabal requires the Usage to be generated after the parameters have been parsed as the parameters that are on the commandline determine how the help is printed.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(app) ⇒ Usage

Returns a new instance of Usage.



16
17
18
19
20
21
22
 
# File 'lib/rabal/usage.rb', line 16

def initialize(app)
    @app = app
    @old_usage = {}
    app.main.usage.each_pair do |key,value|
        @old_usage[key] = value
    end
end

Instance Attribute Details

#app ⇒ Object (readonly)

Returns the value of attribute app.



13
14
15
 
# File 'lib/rabal/usage.rb', line 13

def app
  @app
end

#old_usage ⇒ Object (readonly)

Returns the value of attribute old_usage.



14
15
16
 
# File 'lib/rabal/usage.rb', line 14

def old_usage
  @old_usage
end

Instance Method Details

#option_format(pre, option, description, col1, col2, width) ⇒ Object

take in an option and a description and some formatting criteria and format a single option



77
78
79
80
81
82
83
84
85
86
87
88
89
90
 
# File 'lib/rabal/usage.rb', line 77

def option_format(pre,option,description,col1,col2,width)
    s = ""
    s << "#{pre}#{option}".ljust(col1)
    if description then
        lines = ::Main::Util.columnize(description,:indent => col2, :width => width).split("\n")
        inter_first = ' ' * (col2 - col1 - 2) 
        s << lines.shift.sub(/^\s*/,"#{inter_first}- ")
        if lines.size > 0 then
            s << "\n"
            s << lines.join("\n")
        end
    end
    s
end

#section_options(pre, list) ⇒ Object 



92
93
94
95
96
97
98
99
100
101
 
# File 'lib/rabal/usage.rb', line 92

def section_options(pre,list)
    if list.size == 0 then
        return "No options available\n"
    end
    list.sort_by{|p| p.name}.collect do |p|
        ps = ""
        ps << option_format(pre,p.short_synopsis,p.description,42,45,78)
        ps
    end.join("\n")
end

#to_s ⇒ Object

some of the generated usage is quite useful, others we want to dump, or rename



26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
 
# File 'lib/rabal/usage.rb', line 26

def to_s
    u = ::Main::Usage.new
    # just transfer directly over these chunks
    %w[name synopsis].each do |chunk|
        u[chunk.dup] = old_usage[chunk].to_s
    end

    u['description'] = ::Main::Util.columnize(old_usage['description'].to_s, :indent => 6, :width => 78)

    arguments       = app.main.parameters.select{|p| p.type == :argument}
    global_options  = app.main.parameters.select{|p| p.type == :option and app.global_option_names.include?(p.name) }
    load_options    = app.main.parameters.select{|p| p.type == :option and app.plugin_load_option_names.include?(p.name) }
    plugin_options  = app.main.parameters.select{|p| p.type == :option and app.plugin_option_names.include?(p.name) }

    # rework the formatting of the parameters limiting them to
    # the globals, force 
    u['global options'] = section_options("  ",global_options)

    # format the available modules
    s = ""
    s << ::Main::Util.columnize("Force any module to be used by giving the --use-[modulename] option.  Modules with a '*' next to them are always used.",:indent => 0, :width => 72)
    s << "\n\n"
    s << ""
    module_options = []
    app.plugin_manager.plugins.sort_by{|c,p| c}.each do |cat,plugins|
         plugins.each do |key,plugin|
             pre = "  " + (plugin.use_always? ? "*" : " ")
             s << option_format(pre,"#{plugin.use_name} (#{plugin.register_path})",plugin.description,40,43,78)
             s << "\n"

             # create the module options for this one, if the
             # plugin is use_always.
             if app.main.parameters['use-all'].given? or plugin.use_always? or 
                 app.main.parameters["use-#{plugin.use_name}"].given? then
                plugin_options = app.main.parameters.select{|p| p.type == :option and p.name =~ %r{^#{plugin.use_name}}}
                module_options << ["Module options - #{plugin.use_name.camelize}", section_options("  ",plugin_options)]
             end
         end
    end


    u['Available Modules'] = s
       
    module_options.each { |k,v| u[k] = v }

    u['author'] = old_usage['author']
    u.to_s
end