Class: RDoc::Parser

Inherits:
Object show all
Extended by:
ParserFactory
Defined in:
lib/puppet/util/rdoc/parser.rb

Constant Summary collapse

SITE = 
"__site__"

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(top_level, file_name, content, options, stats) ⇒ Parser

called with the top level file



26
27
28
29
30
31
32
 
# File 'lib/puppet/util/rdoc/parser.rb', line 26

def initialize(top_level, file_name, content, options, stats)
  @options = options
  @stats   = stats
  @input_file_name = file_name
  @top_level = PuppetTopLevel.new(top_level)
  @progress = $stderr unless options.quiet
end

Instance Attribute Details

#ast ⇒ Object

Returns the value of attribute ast.



20
21
22
 
# File 'lib/puppet/util/rdoc/parser.rb', line 20

def ast
  @ast
end

#input_file_name ⇒ Object

Returns the value of attribute input_file_name.



20
21
22
 
# File 'lib/puppet/util/rdoc/parser.rb', line 20

def input_file_name
  @input_file_name
end

#top_level ⇒ Object

Returns the value of attribute top_level.



20
21
22
 
# File 'lib/puppet/util/rdoc/parser.rb', line 20

def top_level
  @top_level
end

Instance Method Details

#document_class(name, klass, container) ⇒ Object

create documentation for a class named name



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
 
# File 'lib/puppet/util/rdoc/parser.rb', line 240

def document_class(name, klass, container)
  Puppet.debug "rdoc: found new class #{name}"
  container, name = get_class_or_module(container, name)

  superclass = klass.parent
  superclass = "" if superclass.nil? or superclass.empty?

  @stats.num_classes += 1
  comment = klass.doc
  look_for_directives_in(container, comment) unless comment.empty?
  cls = container.add_class(PuppetClass, name, superclass)
  # it is possible we already encountered this class, while parsing some namespaces
  # from other classes of other files. But at that time we couldn't know this class superclass
  # so, now we know it and force it.
  cls.superclass = superclass
  cls.record_location(@top_level)

  # scan class code for include
  code = klass.code.children if klass.code.is_a?(Puppet::Parser::AST::ASTArray)
  code ||= klass.code
  unless code.nil?
    scan_for_include_or_require(cls, code)
    scan_for_realize(cls, code)
    scan_for_resource(cls, code) if Puppet.settings[:document_all]
  end

  cls.comment = comment
rescue => detail
  raise Puppet::ParseError, "impossible to parse class '#{name}' in #{klass.file} at line #{klass.line}: #{detail}"
end

#document_define(name, define, container) ⇒ Object

create documentation for a define



297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
 
# File 'lib/puppet/util/rdoc/parser.rb', line 297

def document_define(name, define, container)
  Puppet.debug "rdoc: found new definition #{name}"
  # find superclas if any
  @stats.num_methods += 1

  # find the parent
  # split define name by :: to find the complete module hierarchy
  container, name = get_class_or_module(container,name)

  # build up declaration
  declaration = ""
  define.arguments.each do |arg,value|
    declaration << "\$#{arg}"
    unless value.nil?
      declaration << " => "
      case value
      when Puppet::Parser::AST::Leaf
        declaration << "'#{value.value}'"
      when Puppet::Parser::AST::ASTArray
        declaration << "[#{value.children.collect { |v| "'#{v}'" }.join(", ")}]"
      else
        declaration << "#{value.to_s}"
      end
    end
    declaration << ", "
  end
  declaration.chop!.chop! if declaration.size > 1

  # register method into the container
  meth =  AnyMethod.new(declaration, name)
  meth.comment = define.doc
  container.add_method(meth)
  look_for_directives_in(container, meth.comment) unless meth.comment.empty?
  meth.params = "( #{declaration} )"
  meth.visibility = :public
  meth.document_self = true
  meth.singleton = false
rescue => detail
  raise Puppet::ParseError, "impossible to parse definition '#{name}' in #{define.file} at line #{define.line}: #{detail}"
end

#document_node(name, node, container) ⇒ Object

create documentation for a node



272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
 
# File 'lib/puppet/util/rdoc/parser.rb', line 272

def document_node(name, node, container)
  Puppet.debug "rdoc: found new node #{name}"
  superclass = node.parent
  superclass = "" if superclass.nil? or superclass.empty?

  comment = node.doc
  look_for_directives_in(container, comment) unless comment.empty?
  n = container.add_node(name, superclass)
  n.record_location(@top_level)

  code = node.code.children if node.code.is_a?(Puppet::Parser::AST::ASTArray)
  code ||= node.code
  unless code.nil?
    scan_for_include_or_require(n, code)
    scan_for_realize(n, code)
    scan_for_vardef(n, code)
    scan_for_resource(n, code) if Puppet.settings[:document_all]
  end

  n.comment = comment
rescue => detail
  raise Puppet::ParseError, "impossible to parse node '#{name}' in #{node.file} at line #{node.line}: #{detail}"
end

#find_object_named(container, name) ⇒ Object

Due to a bug in RDoc, we need to roll our own find_module_named The issue is that RDoc tries harder by asking the parent for a class/module of the name. But by doing so, it can mistakenly use a module of same name but from which we are not descendant.



55
56
57
58
59
60
61
 
# File 'lib/puppet/util/rdoc/parser.rb', line 55

def find_object_named(container, name)
  return container if container.name == name
  container.each_classmodule do |m|
    return m if m.name == name
  end
  nil
end

#get_class_or_module(container, name) ⇒ Object

walk down the namespace and lookup/create container as needed



64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
 
# File 'lib/puppet/util/rdoc/parser.rb', line 64

def get_class_or_module(container, name)

  # class ::A -> A is in the top level
  if name =~ /^::/
    container = @top_level
  end

  names = name.split('::')

  final_name = names.pop
  names.each do |name|
    prev_container = container
    container = find_object_named(container, name)
    container ||= prev_container.add_class(PuppetClass, name, nil)
  end
  [container, final_name]
end

#look_for_directives_in(context, comment) ⇒ Object

look_for_directives_in scans the current comment for RDoc directives



441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
 
# File 'lib/puppet/util/rdoc/parser.rb', line 441

def look_for_directives_in(context, comment)
  preprocess = SM::PreProcess.new(@input_file_name, @options.rdoc_include)

  preprocess.handle(comment) do |directive, param|
    case directive
    when "stopdoc"
      context.stop_doc
      ""
    when "startdoc"
      context.start_doc
      context.force_documentation = true
      ""
    when "enddoc"
      #context.done_documenting = true
      #""
      throw :enddoc
    when "main"
      options = Options.instance
      options.main_page = param
      ""
    when "title"
      options = Options.instance
      options.title = param
      ""
    when "section"
      context.set_current_section(param, comment)
      comment.replace("") # 1.8 doesn't support #clear
      break
    else
      warn "Unrecognized directive '#{directive}'"
      break
    end
  end
  remove_private_comments(comment)
end

#parse_elements(container) ⇒ Object

Traverse the AST tree and produce code-objects node that contains the documentation



340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
 
# File 'lib/puppet/util/rdoc/parser.rb', line 340

def parse_elements(container)
  Puppet.debug "rdoc: scanning manifest"
  @ast.hostclasses.values.sort { |a,b| a.name <=> b.name }.each do |klass|
    name = klass.name
    if klass.file == @input_file_name
      unless name.empty?
        document_class(name,klass,container)
      else # on main class document vardefs
        code = klass.code.children if klass.code.is_a?(Puppet::Parser::AST::ASTArray)
        code ||= klass.code
        scan_for_vardef(container, code) unless code.nil?
      end
    end
  end

  @ast.definitions.each do |name, define|
    if define.file == @input_file_name
      document_define(name,define,container)
    end
  end

  @ast.nodes.each do |name, node|
    if node.file == @input_file_name
      document_node(name.to_s,node,container)
    end
  end
end

#parse_fact(container) ⇒ Object

this is a poor man custom fact parser :-)



379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
 
# File 'lib/puppet/util/rdoc/parser.rb', line 379

def parse_fact(container)
  comments = ""
  current_fact = nil
  File.open(@input_file_name) do |of|
    of.each do |line|
      # fetch comments
      if line =~ /^[ \t]*# ?(.*)$/
        comments += $1 + "\n"
      elsif line =~ /^[ \t]*Facter.add\(['"](.*?)['"]\)/
        current_fact = Fact.new($1,{})
        look_for_directives_in(container, comments) unless comments.empty?
        current_fact.comment = comments
        container.add_fact(current_fact)
        current_fact.record_location(@top_level)
        comments = ""
        Puppet.debug "rdoc: found custom fact #{current_fact.name}"
      elsif line =~ /^[ \t]*confine[ \t]*:(.*?)[ \t]*=>[ \t]*(.*)$/
        current_fact.confine = { :type => $1, :value => $2 } unless current_fact.nil?
      else # unknown line type
        comments =""
      end
    end
  end
end

#parse_plugins(container) ⇒ Object

create documentation for plugins



369
370
371
372
373
374
375
376
 
# File 'lib/puppet/util/rdoc/parser.rb', line 369

def parse_plugins(container)
  Puppet.debug "rdoc: scanning plugin or fact"
  if @input_file_name =~ /\/facter\/[^\/]+\.rb$/
    parse_fact(container)
  else
    parse_puppet_plugin(container)
  end
end

#parse_puppet_plugin(container) ⇒ Object

this is a poor man puppet plugin parser :-) it doesn’t extract doc nor desc :-(



406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
 
# File 'lib/puppet/util/rdoc/parser.rb', line 406

def parse_puppet_plugin(container)
  comments = ""
  current_plugin = nil

  File.open(@input_file_name) do |of|
    of.each do |line|
      # fetch comments
      if line =~ /^[ \t]*# ?(.*)$/
        comments += $1 + "\n"
      elsif line =~ /^[ \t]*newfunction[ \t]*\([ \t]*:(.*?)[ \t]*,[ \t]*:type[ \t]*=>[ \t]*(:rvalue|:lvalue)\)/
        current_plugin = Plugin.new($1, "function")
        container.add_plugin(current_plugin)
        look_for_directives_in(container, comments) unless comments.empty?
        current_plugin.comment = comments
        current_plugin.record_location(@top_level)
        comments = ""
        Puppet.debug "rdoc: found new function plugins #{current_plugin.name}"
      elsif line =~ /^[ \t]*Puppet::Type.newtype[ \t]*\([ \t]*:(.*?)\)/
        current_plugin = Plugin.new($1, "type")
        container.add_plugin(current_plugin)
        look_for_directives_in(container, comments) unless comments.empty?
        current_plugin.comment = comments
        current_plugin.record_location(@top_level)
        comments = ""
        Puppet.debug "rdoc: found new type plugins #{current_plugin.name}"
      elsif line =~ /module Puppet::Parser::Functions/
        # skip
      else # unknown line type
        comments =""
      end
    end
  end
end

#remove_private_comments(comment) ⇒ Object 



477
478
479
480
 
# File 'lib/puppet/util/rdoc/parser.rb', line 477

def remove_private_comments(comment)
  comment.gsub!(/^#--.*?^#\+\+/m, '')
  comment.sub!(/^#--.*/m, '')
end

#resource_stmt_to_ref(stmt) ⇒ Object 



229
230
231
232
233
234
235
236
237
 
# File 'lib/puppet/util/rdoc/parser.rb', line 229

def resource_stmt_to_ref(stmt)
  type = stmt.type.split("::").collect { |s| s.capitalize }.join("::")
  title = stmt.title.is_a?(Puppet::Parser::AST::ASTArray) ? stmt.title.to_s.gsub(/\[(.*)\]/,'\1') : stmt.title.to_s

  param = stmt.params.children.collect do |p|
    {"name" => p.param, "value" => p.value.to_s}
  end
  PuppetResource.new(type, title, stmt.doc, param)
end

#scan ⇒ Object

main entry point



35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'lib/puppet/util/rdoc/parser.rb', line 35

def scan
  env = Puppet::Node::Environment.new
  unless env.known_resource_types.watching_file?(@input_file_name)
    Puppet.info "rdoc: scanning #{@input_file_name}"
    if @input_file_name =~ /\.pp$/
      @parser = Puppet::Parser::Parser.new(env)
      @parser.file = @input_file_name
      @ast = @parser.parse
    end
  else
    @ast = env.known_resource_types
  end
  scan_top_level(@top_level)
  @top_level
end

#scan_for_include_or_require(container, code) ⇒ Object

create documentation for include statements we can find in code and associate it with container



155
156
157
158
159
160
161
162
163
164
165
166
167
 
# File 'lib/puppet/util/rdoc/parser.rb', line 155

def scan_for_include_or_require(container, code)
  code = [code] unless code.is_a?(Array)
  code.each do |stmt|
    scan_for_include_or_require(container,stmt.children) if stmt.is_a?(Puppet::Parser::AST::ASTArray)

    if stmt.is_a?(Puppet::Parser::AST::Function) and ['include','require'].include?(stmt.name)
      stmt.arguments.each do |included|
        Puppet.debug "found #{stmt.name}: #{included}"
        container.send("add_#{stmt.name}",Include.new(included.to_s, stmt.doc))
      end
    end
  end
end

#scan_for_realize(container, code) ⇒ Object

create documentation for realize statements we can find in code and associate it with container



171
172
173
174
175
176
177
178
179
180
181
182
183
 
# File 'lib/puppet/util/rdoc/parser.rb', line 171

def scan_for_realize(container, code)
  code = [code] unless code.is_a?(Array)
  code.each do |stmt|
    scan_for_realize(container,stmt.children) if stmt.is_a?(Puppet::Parser::AST::ASTArray)

    if stmt.is_a?(Puppet::Parser::AST::Function) and stmt.name == 'realize'
      stmt.arguments.each do |realized|
        Puppet.debug "found #{stmt.name}: #{realized}"
        container.add_realize(Include.new(realized.to_s, stmt.doc))
      end
    end
  end
end

#scan_for_resource(container, code) ⇒ Object

create documentation for resources we can find in code and associate it with container



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
 
# File 'lib/puppet/util/rdoc/parser.rb', line 201

def scan_for_resource(container, code)
  code = [code] unless code.is_a?(Array)
  code.each do |stmt|
    scan_for_resource(container,stmt.children) if stmt.is_a?(Puppet::Parser::AST::ASTArray)

    if stmt.is_a?(Puppet::Parser::AST::Resource) and !stmt.type.nil?
      begin
        type = stmt.type.split("::").collect { |s| s.capitalize }.join("::")
        title = stmt.title.is_a?(Puppet::Parser::AST::ASTArray) ? stmt.title.to_s.gsub(/\[(.*)\]/,'\1') : stmt.title.to_s
        Puppet.debug "rdoc: found resource: #{type}[#{title}]"

        param = []
        stmt.parameters.children.each do |p|
          res = {}
          res["name"] = p.param
          res["value"] = "#{p.value.to_s}" unless p.value.nil?

          param << res
        end

        container.add_resource(PuppetResource.new(type, title, stmt.doc, param))
      rescue => detail
        raise Puppet::ParseError, "impossible to parse resource in #{stmt.file} at line #{stmt.line}: #{detail}"
      end
    end
  end
end

#scan_for_vardef(container, code) ⇒ Object

create documentation for global variables assignements we can find in code and associate it with container



187
188
189
190
191
192
193
194
195
196
197
 
# File 'lib/puppet/util/rdoc/parser.rb', line 187

def scan_for_vardef(container, code)
  code = [code] unless code.is_a?(Array)
  code.each do |stmt|
    scan_for_vardef(container,stmt.children) if stmt.is_a?(Puppet::Parser::AST::ASTArray)

    if stmt.is_a?(Puppet::Parser::AST::VarDef)
      Puppet.debug "rdoc: found constant: #{stmt.name} = #{stmt.value}"
      container.add_constant(Constant.new(stmt.name.to_s, stmt.value.to_s, stmt.doc))
    end
  end
end

#scan_top_level(container) ⇒ Object

create documentation for the top level container



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
 
# File 'lib/puppet/util/rdoc/parser.rb', line 119

def scan_top_level(container)
  # use the module README as documentation for the module
  comment = ""
  readme = File.join(File.dirname(File.dirname(@input_file_name)), "README")
  comment = File.open(readme,"r") { |f| f.read } if FileTest.readable?(readme)
  look_for_directives_in(container, comment) unless comment.empty?

  # infer module name from directory
  name = split_module(@input_file_name)
  if name.nil?
    # skip .pp files that are not in manifests directories as we can't guarantee they're part
    # of a module or the global configuration.
    container.document_self = false
    return
  end

  Puppet.debug "rdoc: scanning for #{name}"

  container.module_name = name
  container.global=true if name == SITE

  @stats.num_modules += 1
  container, name  = get_class_or_module(container,name)
  mod = container.add_module(PuppetModule, name)
  mod.record_location(@top_level)
  mod.comment = comment

  if @input_file_name =~ /\.pp$/
    parse_elements(mod)
  elsif @input_file_name =~ /\.rb$/
    parse_plugins(mod)
  end
end

#split_module(path) ⇒ Object

split_module tries to find if path belongs to the module path if it does, it returns the module name, otherwise if we are sure it is part of the global manifest path, “__site__” is returned. And finally if this path couldn’t be mapped anywhere, nil is returned.



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
 
# File 'lib/puppet/util/rdoc/parser.rb', line 86

def split_module(path)
  # find a module
  fullpath = File.expand_path(path)
  Puppet.debug "rdoc: testing #{fullpath}"
  if fullpath =~ /(.*)\/([^\/]+)\/(?:manifests|plugins|lib)\/.+\.(pp|rb)$/
    modpath = $1
    name = $2
    Puppet.debug "rdoc: module #{name} into #{modpath} ?"
    Puppet::Module.modulepath.each do |mp|
      if File.identical?(modpath,mp)
        Puppet.debug "rdoc: found module #{name}"
        return name
      end
    end
  end
  if fullpath =~ /\.(pp|rb)$/
    # there can be paths we don't want to scan under modules
    # imagine a ruby or manifest that would be distributed as part as a module
    # but we don't want those to be hosted under <site>
    Puppet::Module.modulepath.each do |mp|
      # check that fullpath is a descendant of mp
      dirname = fullpath
      while (dirname = File.dirname(dirname)) != '/'
        return nil if File.identical?(dirname,mp)
      end
    end
  end
  # we are under a global manifests
  Puppet.debug "rdoc: global manifests"
  SITE
end