1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
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
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
|
#!/usr/bin/ruby
#
# = Synopsis
#
# Print help about puppet types on the console. Run with '-h' to get detailed
# help.
#
# FIXME: (1) Formatting could be a lot prettier
# (2) The command line options are kinda screwy; unclear how best to
# present the various pieces of info to user
require 'puppet'
require 'optparse'
class Formatter
def initialize(width)
@width = width
end
def wrap(txt, opts)
return "" unless txt && !txt.empty?
work = (opts[:scrub] ? scrub(txt) : txt)
indent = (opts[:indent] ? opts[:indent] : 0)
textLen = @width - indent
patt = Regexp.new("^(.{0,#{textLen}})[ \n]")
prefix = " " * indent
res = []
while work.length > textLen
if work =~ patt
res << $1
work.slice!(0, $&.length)
else
res << work.slice!(0, textLen)
end
end
res << work if work.length.nonzero?
return prefix + res.join("\n" + prefix)
end
def header(txt, sep = "-")
"\n#{txt}\n" + sep * txt.size
end
private
def scrub(text)
# For text with no carriage returns, there's nothing to do.
if text !~ /\n/
return text
end
indent = nil
# If we can match an indentation, then just remove that same level of
# indent from every line.
if text =~ /^(\s+)/
indent = $1
return text.gsub(/^#{indent}/,'')
else
return text
end
end
end
class TypeDoc
def initialize
@format = Formatter.new(76)
@types = {}
Puppet::Type.loadall
Puppet::Type.eachtype { |type|
next if type.name == :component
@types[type.name] = type
}
end
def list_types
puts "These are the types known to puppet:\n"
@types.keys.sort { |a, b|
a.to_s <=> b.to_s
}.each do |name|
type = @types[name]
s = type.doc.gsub(/\s+/, " ")
n = s.index(".")
if n.nil?
s = ".. no documentation .."
elsif n > 45
s = s[0, 45] + " ..."
else
s = s[0, n]
end
printf "%-15s - %s\n", name, s
end
end
def format_type(name, opts)
name = name.to_sym
unless @types.has_key?(name)
puts "Unknown type #{name}"
return
end
type = @types[name]
puts @format.header(name.to_s, "=")
puts @format.wrap(type.doc, :indent => 0, :scrub => true) + "\n\n"
puts @format.header("Parameters")
if opts[:parameters]
format_attrs(type, [:property, :param])
else
list_attrs(type, [:property, :param])
end
if opts[:metaparams]
puts @format.header("Meta Parameters")
if opts[:parameters]
format_attrs(type, [:meta])
else
list_attrs(type, [:meta])
end
end
if type.providers.size > 0
puts @format.header("Providers")
if opts[:providers]
format_providers(type)
else
list_providers(type)
end
end
end
# List details about attributes
def format_attrs(type, attrs)
docs = {}
type.eachattr do |obj, kind|
if attrs.include?(kind) && obj.name != :provider
docs[obj.name] = obj.doc
end
end
docs.sort { |a,b|
a[0].to_s <=> b[0].to_s
}.each { |name, doc|
print "\n- **%s**" % name
if type.namevar == name and name != :name
puts " (*namevar*)"
else
puts ""
end
puts @format.wrap(doc, :indent => 4, :scrub => true)
}
end
# List the names of attributes
def list_attrs(type, attrs)
params = []
type.eachattr do |obj, kind|
if attrs.include?(kind) && obj.name != :provider
params << obj.name.to_s
end
end
puts @format.wrap(params.sort.join(", "), :indent => 4)
end
def format_providers(type)
type.providers.sort { |a,b|
a.to_s <=> b.to_s
}.each { |prov|
puts "\n- **%s**" % prov
puts @format.wrap(type.provider(prov).doc,
:indent => 4, :scrub => true)
}
end
def list_providers(type)
list = type.providers.sort { |a,b|
a.to_s <=> b.to_s
}.join(", ")
puts @format.wrap(list, :indent => 4)
end
end
def process_args
result = {
:list => false,
:providers => false,
:parameters => true,
:metaparams => false
}
opts = OptionParser.new("#{$0} [options] [type]")
opts.separator(" Print documentation for puppet types and their parameters")
opts.on("-l", "--list", "List all types") do |val|
result[:list] = true
end
opts.on("-p", "--providers",
"Describe providers in detail") do |val|
result[:providers] = true
end
opts.on("-s", "--short",
"Only list parameters without detail") do |val|
result[:parameters] = false
end
opts.on("-m", "--meta",
"Include metaparams") do |val|
result[:metaparams] = true
end
result[:types] = opts.order(ARGV)
# Check for obviously bogus options
unless result[:list] || result[:types].size > 0
$stderr.puts opts
exit(1)
end
if result[:list] && result[:types].size > 0
$stderr.puts "Warning: ignoring types when listing all types"
end
return result
end
opts = process_args
doc = TypeDoc.new
if opts[:list]
doc.list_types
else
opts[:types].each { |name| doc.format_type(name, opts) }
end
|