Method: Generators::PuppetGenerator#gen_composite_index

Defined in:
lib/puppet/util/rdoc/generators/puppet_generator.rb

#gen_composite_index(collection, template, filename) ⇒ Object



250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
# File 'lib/puppet/util/rdoc/generators/puppet_generator.rb', line 250

def gen_composite_index(collection, template, filename)
  return if Puppet::FileSystem.exist?(filename)

  template = TemplatePage.new(RDoc::Page::FR_INDEX_BODY, template)
  res1 = []
  collection['classes'].sort.each do |f|
    if f.document_self
      res1 << { "href" => "../" + CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.index_name) } unless f.context.is_module?
    end
  end

  res2 = []
  collection['methods'].sort.each do |f|
    res2 << { "href" => "../#{f.path}", "name" => f.index_name.sub(/\(.*\)$/, '') } if f.document_self
  end

  module_name = []
  res3 = []
  res4 = []
  collection['modules'].sort.each do |f|
    module_name << { "href" => "../" + CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.index_name) }
    unless f.facts.nil?
      f.facts.each do |fact|
        res3 << { "href" => "../" + CGI.escapeHTML(AllReferences["PLUGIN(#{fact.name})"].path), "name" => CGI.escapeHTML(fact.name) }
      end
    end
    next if f.plugins.nil?

    f.plugins.each do |plugin|
      res4 << { "href" => "../" + CGI.escapeHTML(AllReferences["PLUGIN(#{plugin.name})"].path), "name" => CGI.escapeHTML(plugin.name) }
    end
  end

  res5 = []
  collection['nodes'].sort.each do |f|
    res5 << { "href" => "../" + CGI.escapeHTML(f.path), "name" => CGI.escapeHTML(f.name) } if f.document_self
  end

  values = {
    "module" => module_name,
    "classes" => res1,
    'classes_title' => CGI.escapeHTML("Classes"),
    'defines_title' => CGI.escapeHTML("Defines"),
    'facts_title' => CGI.escapeHTML("Custom Facts"),
    'plugins_title' => CGI.escapeHTML("Plugins"),
    'nodes_title' => CGI.escapeHTML("Nodes"),
    'index_url' => main_url,
    'charset' => @options.charset,
    'style_url' => style_url('', @options.css),
  }

  values["defines"] = res2 if res2.size > 0
  values["facts"] = res3 if res3.size > 0
  values["plugins"] = res4 if res4.size > 0
  values["nodes"] = res5 if res5.size > 0

  Puppet::FileSystem.open(filename, nil, "w:UTF-8") do |f|
    template.write_html_on(f, values)
  end
end