lib/puppet/reports.rb


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

require 'puppet/util/instance_loader'

# A simple mechanism for loading and returning reports.
class Puppet::Reports
  extend Puppet::Util::ClassGen
  extend Puppet::Util::InstanceLoader

  # Set up autoloading and retrieving of reports.
  instance_load :report, 'puppet/reports'

  class << self
    attr_reader :hooks
  end

  # Add a new report type.
  def self.register_report(name, options = {}, &block)
    name = symbolize(name)

    mod = genmodule(name, :extend => Puppet::Util::Docs, :hash => instance_hash(:report), :block => block)

    mod.useyaml = true if options[:useyaml]

    mod.send(:define_method, :report_name) do
      name
    end
  end

  # Collect the docs for all of our reports.
  def self.reportdocs
    docs = ""

    # Use this method so they all get loaded
    instance_loader(:report).loadall
    loaded_instances(:report).sort { |a,b| a.to_s <=> b.to_s }.each do |name|
      mod = self.report(name)
      docs += "#{name}\n#{"-" * name.to_s.length}\n"

      docs += Puppet::Util::Docs.scrub(mod.doc) + "\n\n"
    end

    docs
  end

  # List each of the reports.
  def self.reports
    instance_loader(:report).loadall
    loaded_instances(:report)
  end
end