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
|
# frozen_string_literal: true
require_relative '../../puppet/module_tool'
module Puppet::ModuleTool
# = ContentsDescription
#
# This class populates +Metadata+'s Puppet type information.
class ContentsDescription
# Instantiate object for string +module_path+.
def initialize(module_path)
@module_path = module_path
end
# Update +Metadata+'s Puppet type information.
def annotate(metadata)
metadata.types.replace data.clone
end
# Return types for this module. Result is an array of hashes, each of which
# describes a Puppet type. The type description hash structure is:
# * :name => Name of this Puppet type.
# * :doc => Documentation for this type.
# * :properties => Array of hashes representing the type's properties, each
# containing :name and :doc.
# * :parameters => Array of hashes representing the type's parameters, each
# containing :name and :doc.
# * :providers => Array of hashes representing the types providers, each
# containing :name and :doc.
# TODO Write a TypeDescription to encapsulate these structures and logic?
def data
unless @data
@data = []
type_names = []
(Dir[File.join(@module_path, "lib/puppet/type/*.rb")]).each do |module_filename|
require module_filename
type_name = File.basename(module_filename, ".rb")
type_names << type_name
(Dir[File.join(@module_path, "lib/puppet/provider/#{type_name}/*.rb")]).each do |provider_filename|
require provider_filename
end
end
type_names.each do |name|
type = Puppet::Type.type(name.to_sym)
if type
type_hash = { :name => name, :doc => type.doc }
type_hash[:properties] = attr_doc(type, :property)
type_hash[:parameters] = attr_doc(type, :param)
if type.providers.size > 0
type_hash[:providers] = provider_doc(type)
end
@data << type_hash
else
Puppet.warning _("Could not find/load type: %{name}") % { name: name }
end
end
end
@data
end
# Return an array of hashes representing this +type+'s attrs of +kind+
# (e.g. :param or :property), each containing :name and :doc.
def attr_doc(type, kind)
attrs = []
type.allattrs.each do |name|
if type.attrtype(name) == kind && name != :provider
attrs.push(:name => name, :doc => type.attrclass(name).doc)
end
end
attrs
end
# Return an array of hashes representing this +type+'s providers, each
# containing :name and :doc.
def provider_doc(type)
providers = []
type.providers.sort.each do |prov|
providers.push(:name => prov, :doc => type.provider(prov).doc)
end
providers
end
end
end
|
