class Generators::HTMLPuppetNode

Attributes

path[R]

Public Class Methods

new(context, html_file, prefix, options) click to toggle source
Calls superclass method
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
461 def initialize(context, html_file, prefix, options)
462   super(context, options)
463 
464   @html_file = html_file
465   @is_module = context.is_module?
466   @values    = {}
467 
468   context.viewer = self
469 
470   if options.all_one_file
471     @path = context.full_name
472   else
473     @path = http_url(context.full_name, prefix)
474   end
475 
476   AllReferences.add("NODE(#{@context.full_name})", self)
477 end

Public Instance Methods

<=>(other) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
646 def <=>(other)
647   self.name <=> other.name
648 end
build_attribute_list(section) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
570 def build_attribute_list(section)
571   atts = @context.attributes.sort
572   res = []
573   atts.each do |att|
574     next unless att.section == section
575     if att.visibility == :public || att.visibility == :protected || @options.show_all
576       entry = {
577         "name"   => CGI.escapeHTML(att.name),
578         "rw"     => att.rw,
579         "a_desc" => markup(att.comment, true)
580       }
581       unless att.visibility == :public || att.visibility == :protected
582         entry["rw"] << "-"
583       end
584       res << entry
585     end
586   end
587   res
588 end
build_child_list(context) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
642 def build_child_list(context)
643   build_referenced_list(context.childs)
644 end
build_realize_list(context) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
638 def build_realize_list(context)
639   build_referenced_list(context.realizes)
640 end
build_require_list(context) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
634 def build_require_list(context)
635   build_referenced_list(context.requires)
636 end
class_attribute_values() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
590 def class_attribute_values
591   h_name = CGI.escapeHTML(name)
592 
593   @values["classmod"]  = "Node"
594   @values["title"]     = CGI.escapeHTML("#{@values['classmod']}: #{h_name}")
595 
596   c = @context
597   c = c.parent while c and !c.diagram
598 
599   @values["diagram"] = diagram_reference(c.diagram) if c && c.diagram
600 
601   @values["full_name"] = h_name
602 
603   parent_class = @context.superclass
604 
605   if parent_class
606     @values["parent"] = CGI.escapeHTML(parent_class)
607 
608     if parent_name
609       lookup = parent_name + "::#{parent_class}"
610     else
611       lookup = parent_class
612     end
613     lookup = "NODE(#{lookup})"
614     parent_url = AllReferences[lookup] || AllReferences[parent_class]
615     @values["par_url"] = aref_to(parent_url.path) if parent_url and parent_url.document_self
616   end
617 
618   files = []
619   @context.in_files.each do |f|
620     res = {}
621     full_path = CGI.escapeHTML(f.file_absolute_name)
622 
623     res["full_path"]     = full_path
624     res["full_path_url"] = aref_to(f.viewer.path) if f.document_self
625 
626     res["cvsurl"] = cvs_url( @options.webcvs, full_path ) if @options.webcvs
627 
628     files << res
629   end
630 
631   @values['infiles'] = files
632 end
http_url(full_name, prefix) click to toggle source

return the relative file name to store this class in, which is also its url

    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
485 def http_url(full_name, prefix)
486   path = full_name.dup
487   path.gsub!(/<<\s*(\w*)/) { "from-#$1" } if path['<<']
488   File.join(prefix, path.split("::").collect { |p| Digest::MD5.hexdigest(p) }) + ".html"
489 end
index_name() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
495 def index_name
496   name
497 end
name() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
479 def name
480   @context.name
481 end
parent_name() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
491 def parent_name
492   @context.parent.full_name
493 end
value_hash() click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
510 def value_hash
511   class_attribute_values
512   add_table_of_sections
513 
514   @values["charset"] = @options.charset
515   @values["style_url"] = style_url(path, @options.css)
516 
517   d = markup(@context.comment)
518   @values["description"] = d unless d.empty?
519 
520   ml = build_method_summary_list
521   @values["methods"] = ml unless ml.empty?
522 
523   rl = build_resource_summary_list
524   @values["resources"] = rl unless rl.empty?
525 
526   il = build_include_list(@context)
527   @values["includes"] = il unless il.empty?
528 
529   rl = build_require_list(@context)
530   @values["requires"] = rl unless rl.empty?
531 
532   rl = build_realize_list(@context)
533   @values["realizes"] = rl unless rl.empty?
534 
535   cl = build_child_list(@context)
536   @values["childs"] = cl unless cl.empty?
537 
538   @values["sections"] = @context.sections.map do |section|
539 
540     secdata = {
541       "sectitle" => section.title,
542       "secsequence" => section.sequence,
543       "seccomment" => markup(section.comment)
544     }
545 
546     al = build_alias_summary_list(section)
547     secdata["aliases"] = al unless al.empty?
548 
549     co = build_constants_summary_list(section)
550     secdata["constants"] = co unless co.empty?
551 
552     al = build_attribute_list(section)
553     secdata["attributes"] = al unless al.empty?
554 
555     cl = build_class_list(0, @context, section)
556     secdata["classlist"] = cl unless cl.empty?
557 
558     mdl = build_method_detail_list(section)
559     secdata["method_list"] = mdl unless mdl.empty?
560 
561     rdl = build_resource_detail_list(section)
562     secdata["resource_list"] = rdl unless rdl.empty?
563 
564     secdata
565   end
566 
567   @values
568 end
write_on(f) click to toggle source
    # File lib/puppet/util/rdoc/generators/puppet_generator.rb
499 def write_on(f)
500   value_hash
501 
502     template = TemplatePage.new(
503       RDoc::Page::BODYINC,
504         RDoc::Page::NODE_PAGE,
505 
506         RDoc::Page::METHOD_LIST)
507   template.write_html_on(f, @values)
508 end