Module: RDoc::PuppetParserCore

Included in:
PuppetParserRDoc2
Defined in:
lib/puppet/util/rdoc/parser/puppet_parser_core.rb

Overview

Functionality common to both our RDoc version 1 and 2 parsers.

Constant Summary collapse

SITE = 
"__site__"

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.included(base) ⇒ Object 



7
8
9
10
11
12
13
14
 
# File 'lib/puppet/util/rdoc/parser/puppet_parser_core.rb', line 7

def self.included(base)
  base.class_eval do
    attr_accessor :input_file_name, :top_level

    # parser registration into RDoc
    parse_files_matching(/\.(rb)$/)
  end
end

Instance Method Details

#create_rdoc_preprocess ⇒ Object

New instance of the appropriate PreProcess for our RDoc version.

Raises:

  • (NotImplementedError) 


217
218
219
 
# File 'lib/puppet/util/rdoc/parser/puppet_parser_core.rb', line 217

def create_rdoc_preprocess
  raise(NotImplementedError, "This method must be overwritten for whichever version of RDoc this parser is working with")
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.



37
38
39
40
41
42
43
44
 
# File 'lib/puppet/util/rdoc/parser/puppet_parser_core.rb', line 37

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



47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'lib/puppet/util/rdoc/parser/puppet_parser_core.rb', line 47

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 |n|
    prev_container = container
    container = find_object_named(container, n)
    container ||= prev_container.add_class(RDoc::PuppetClass, n, nil)
  end
  [container, final_name]
end

#initialize(top_level, file_name, body, options, stats) ⇒ Object

called with the top level file



17
18
19
20
21
22
23
24
 
# File 'lib/puppet/util/rdoc/parser/puppet_parser_core.rb', line 17

def initialize(top_level, file_name, body, options, stats)
  @options = options
  @stats   = stats
  @input_file_name = file_name
  @top_level = top_level
  @top_level.extend(RDoc::PuppetTopLevel)
  @progress = $stderr unless options.quiet
end

#look_for_directives_in(context, comment) ⇒ Object

look_for_directives_in scans the current comment for RDoc directives



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

def look_for_directives_in(context, comment)
  preprocess = create_rdoc_preprocess

  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_fact(container) ⇒ Object

this is a poor man custom fact parser :-)



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

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

#parse_plugins(container) ⇒ Object

create documentation for plugins



139
140
141
142
143
144
145
146
 
# File 'lib/puppet/util/rdoc/parser/puppet_parser_core.rb', line 139

def parse_plugins(container)
  Puppet.debug "rdoc: scanning plugin or fact"
  if @input_file_name =~ %r{/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 :-(



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

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

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

#remove_private_comments(comment) ⇒ Object 



258
259
260
261
 
# File 'lib/puppet/util/rdoc/parser/puppet_parser_core.rb', line 258

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

#scan ⇒ Object

main entry point



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

def scan
  environment = Puppet.lookup(:current_environment)
  scan_top_level(@top_level, environment)
  @top_level
end

#scan_top_level(container, environment) ⇒ Object

create documentation for the top level container



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

def scan_top_level(container, environment)
  # use the module README as documentation for the module
  comment = ""
  %w[README README.rdoc].each do |rfile|
    readme = File.join(File.dirname(File.dirname(@input_file_name)), rfile)
    # module README should be UTF-8, not default system encoding
    comment = File.open(readme, "r:UTF-8", &:read) if FileTest.readable?(readme)
  end
  look_for_directives_in(container, comment) unless comment.empty?

  # infer module name from directory
  name = split_module(@input_file_name, environment)
  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.
    # PUP-3638, keeping this while it should have no effect since no .pp files are now processed
    container.document_self = false
    return
  end

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

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

  container, name = get_class_or_module(container, name)
  mod = container.add_module(RDoc::PuppetModule, name)
  mod.record_location(@top_level)
  mod.add_comment(comment, @top_level)

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

#split_module(path, environment) ⇒ 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.



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

def split_module(path, environment)
  # find a module
  fullpath = File.expand_path(path)
  Puppet.debug "rdoc: testing #{fullpath}"
  if fullpath =~ %r{(.*)/([^/]+)/(?:manifests|plugins|lib)/.+\.(rb)$}
    modpath = ::Regexp.last_match(1)
    name = ::Regexp.last_match(2)
    Puppet.debug "rdoc: module #{name} into #{modpath} ?"
    environment.modulepath.each do |mp|
      if File.identical?(modpath, mp)
        Puppet.debug "rdoc: found module #{name}"
        return name
      end
    end
  end
  if fullpath =~ /\.(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>
    environment.modulepath.each do |mp|
      # check that fullpath is a descendant of mp
      dirname = fullpath
      previous = dirname
      while (dirname = File.dirname(previous)) != previous
        previous = dirname
        return nil if File.identical?(dirname, mp)
      end
    end
  end
  # we are under a global manifests
  Puppet.debug "rdoc: global manifests"
  SITE
end