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 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 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
|
# frozen_string_literal: true
require 'rdoc/code_objects'
module RDoc
# This modules contains various class that are used to hold information
# about the various Puppet language structures we found while parsing.
#
# Those will be mapped to their html counterparts which are defined in
# PuppetGenerator.
# PuppetTopLevel is a top level (usually a .pp/.rb file)
module PuppetTopLevel
attr_accessor :module_name, :global
end
# Add top level comments to a class or module
# @api private
module AddClassModuleComment
def add_comment(comment, location = nil)
super
end
end
# PuppetModule holds a Puppet Module
# This is mapped to an HTMLPuppetModule
# it leverage the RDoc (ruby) module infrastructure
class PuppetModule < NormalModule
include AddClassModuleComment
attr_accessor :facts, :plugins
def initialize(name, superclass = nil)
@facts = []
@plugins = []
@nodes = {}
super(name, superclass)
end
def add_plugin(plugin)
name = plugin.name
type = plugin.type
meth = AnyMethod.new("*args", name)
meth.params = "(*args)"
meth.visibility = :public
meth.document_self = true
meth.singleton = false
meth.comment = plugin.comment
case type
when 'function'
@function_container ||= add_module(NormalModule, "__functions__")
@function_container.add_method(meth)
when 'type'
@type_container ||= add_module(NormalModule, "__types__")
@type_container.add_method(meth)
end
end
def add_fact(fact)
@fact_container ||= add_module(NormalModule, "__facts__")
confine_str = fact.confine.empty? ? '' : fact.confine.to_s
const = Constant.new(fact.name, confine_str, fact.comment)
@fact_container.add_constant(const)
end
# Adds a module called __nodes__ and adds nodes to it as classes
#
def add_node(name, superclass)
cls = @nodes[name]
if cls
return cls
end
@node_container ||= add_module(NormalModule, "__nodes__")
cls = @node_container.add_class(PuppetNode, name, superclass)
@nodes[name] = cls unless @done_documenting
cls
end
def each_fact
@facts.each { |c| yield c }
end
def each_plugin
@plugins.each { |c| yield c }
end
def each_node
@nodes.each { |c| yield c }
end
def nodes
@nodes.values
end
end
# PuppetClass holds a puppet class
# It is mapped to a HTMLPuppetClass for display
# It leverages RDoc (ruby) Class
class PuppetClass < ClassModule
include AddClassModuleComment
attr_accessor :resource_list, :requires, :childs, :realizes
def initialize(name, superclass)
super(name, superclass)
@resource_list = []
@requires = []
@realizes = []
@childs = []
end
def aref_prefix
'puppet_class'
end
def add_resource(resource)
add_to(@resource_list, resource)
end
def is_module?
false
end
def superclass=(superclass)
@superclass = superclass
end
# we're (ab)using the RDoc require system here.
# we're adding a required Puppet class, overriding
# the RDoc add_require method which sees ruby required files.
def add_require(required)
add_to(@requires, required)
end
def add_realize(realized)
add_to(@realizes, realized)
end
def add_child(child)
@childs << child
end
# Look up the given symbol. RDoc only looks for class1::class2.method
# or class1::class2#method. Since our definitions are mapped to RDoc methods
# but are written class1::class2::define we need to perform the lookup by
# ourselves.
def find_symbol(symbol, method = nil)
result = super(symbol)
if !result and symbol =~ /::/
modules = symbol.split(/::/)
unless modules.empty?
module_name = modules.shift
result = find_module_named(module_name)
if result
last_name = ""
previous = nil
modules.each do |mod|
previous = result
last_name = mod
result = result.find_module_named(mod)
break unless result
end
unless result
result = previous
method = last_name
end
end
end
if result && method
unless result.respond_to?(:find_local_symbol)
p result.name
p method
fail
end
result = result.find_local_symbol(method)
end
end
result
end
end
# PuppetNode holds a puppet node
# It is mapped to a HTMLPuppetNode for display
# A node is just a variation of a class
class PuppetNode < PuppetClass
include AddClassModuleComment
def is_module?
false
end
end
# Plugin holds a native puppet plugin (function,type...)
# It is mapped to a HTMLPuppetPlugin for display
class Plugin < Context
attr_accessor :name, :type
def initialize(name, type)
super()
@name = name
@type = type
@comment = ""
end
def <=>(other)
@name <=> other.name
end
def full_name
@name
end
def http_url(prefix)
path = full_name.split("::")
File.join(prefix, *path) + ".html"
end
def is_fact?
false
end
def to_s
res = self.class.name + ": #{@name} (#{@type})\n"
res << @comment.to_s
res
end
end
# Fact holds a custom fact
# It is mapped to a HTMLPuppetPlugin for display
class Fact < Context
attr_accessor :name, :confine
def initialize(name, confine)
super()
@name = name
@confine = confine
@comment = ""
end
def <=>(other)
@name <=> other.name
end
def is_fact?
true
end
def full_name
@name
end
def to_s
res = self.class.name + ": #{@name}\n"
res << @comment.to_s
res
end
end
# PuppetResource holds a puppet resource
# It is mapped to a HTMLPuppetResource for display
# A resource is defined by its "normal" form Type[title]
class PuppetResource < CodeObject
attr_accessor :type, :title, :params
def initialize(type, title, comment, params)
super()
@type = type
@title = title
@comment = comment
@params = params
end
def <=>(other)
full_name <=> other.full_name
end
def full_name
@type + "[#{@title}]"
end
def name
full_name
end
def to_s
res = @type + "[#{@title}]\n"
res << @comment.to_s
res
end
end
end
|