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 460 def initialize(context, html_file, prefix, options) 461 super(context, options) 462 463 @html_file = html_file 464 @is_module = context.is_module? 465 @values = {} 466 467 context.viewer = self 468 469 if options.all_one_file 470 @path = context.full_name 471 else 472 @path = http_url(context.full_name, prefix) 473 end 474 475 AllReferences.add("NODE(#{@context.full_name})", self) 476 end
Public Instance Methods
<=>(other)
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 645 def <=>(other) 646 self.name <=> other.name 647 end
build_attribute_list(section)
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 569 def build_attribute_list(section) 570 atts = @context.attributes.sort 571 res = [] 572 atts.each do |att| 573 next unless att.section == section 574 if att.visibility == :public || att.visibility == :protected || @options.show_all 575 entry = { 576 "name" => CGI.escapeHTML(att.name), 577 "rw" => att.rw, 578 "a_desc" => markup(att.comment, true) 579 } 580 unless att.visibility == :public || att.visibility == :protected 581 entry["rw"] << "-" 582 end 583 res << entry 584 end 585 end 586 res 587 end
build_child_list(context)
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 641 def build_child_list(context) 642 build_referenced_list(context.childs) 643 end
build_realize_list(context)
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 637 def build_realize_list(context) 638 build_referenced_list(context.realizes) 639 end
build_require_list(context)
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 633 def build_require_list(context) 634 build_referenced_list(context.requires) 635 end
class_attribute_values()
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 589 def class_attribute_values 590 h_name = CGI.escapeHTML(name) 591 592 @values["classmod"] = "Node" 593 @values["title"] = CGI.escapeHTML("#{@values['classmod']}: #{h_name}") 594 595 c = @context 596 c = c.parent while c and !c.diagram 597 598 @values["diagram"] = diagram_reference(c.diagram) if c && c.diagram 599 600 @values["full_name"] = h_name 601 602 parent_class = @context.superclass 603 604 if parent_class 605 @values["parent"] = CGI.escapeHTML(parent_class) 606 607 if parent_name 608 lookup = parent_name + "::#{parent_class}" 609 else 610 lookup = parent_class 611 end 612 lookup = "NODE(#{lookup})" 613 parent_url = AllReferences[lookup] || AllReferences[parent_class] 614 @values["par_url"] = aref_to(parent_url.path) if parent_url and parent_url.document_self 615 end 616 617 files = [] 618 @context.in_files.each do |f| 619 res = {} 620 full_path = CGI.escapeHTML(f.file_absolute_name) 621 622 res["full_path"] = full_path 623 res["full_path_url"] = aref_to(f.viewer.path) if f.document_self 624 625 res["cvsurl"] = cvs_url( @options.webcvs, full_path ) if @options.webcvs 626 627 files << res 628 end 629 630 @values['infiles'] = files 631 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 484 def http_url(full_name, prefix) 485 path = full_name.dup 486 path.gsub!(/<<\s*(\w*)/) { "from-#$1" } if path['<<'] 487 File.join(prefix, path.split("::").collect { |p| Digest::MD5.hexdigest(p) }) + ".html" 488 end
index_name()
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 494 def index_name 495 name 496 end
name()
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 478 def name 479 @context.name 480 end
parent_name()
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 490 def parent_name 491 @context.parent.full_name 492 end
value_hash()
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 509 def value_hash 510 class_attribute_values 511 add_table_of_sections 512 513 @values["charset"] = @options.charset 514 @values["style_url"] = style_url(path, @options.css) 515 516 d = markup(@context.comment) 517 @values["description"] = d unless d.empty? 518 519 ml = build_method_summary_list 520 @values["methods"] = ml unless ml.empty? 521 522 rl = build_resource_summary_list 523 @values["resources"] = rl unless rl.empty? 524 525 il = build_include_list(@context) 526 @values["includes"] = il unless il.empty? 527 528 rl = build_require_list(@context) 529 @values["requires"] = rl unless rl.empty? 530 531 rl = build_realize_list(@context) 532 @values["realizes"] = rl unless rl.empty? 533 534 cl = build_child_list(@context) 535 @values["childs"] = cl unless cl.empty? 536 537 @values["sections"] = @context.sections.map do |section| 538 539 secdata = { 540 "sectitle" => section.title, 541 "secsequence" => section.sequence, 542 "seccomment" => markup(section.comment) 543 } 544 545 al = build_alias_summary_list(section) 546 secdata["aliases"] = al unless al.empty? 547 548 co = build_constants_summary_list(section) 549 secdata["constants"] = co unless co.empty? 550 551 al = build_attribute_list(section) 552 secdata["attributes"] = al unless al.empty? 553 554 cl = build_class_list(0, @context, section) 555 secdata["classlist"] = cl unless cl.empty? 556 557 mdl = build_method_detail_list(section) 558 secdata["method_list"] = mdl unless mdl.empty? 559 560 rdl = build_resource_detail_list(section) 561 secdata["resource_list"] = rdl unless rdl.empty? 562 563 secdata 564 end 565 566 @values 567 end
write_on(f)
click to toggle source
# File lib/puppet/util/rdoc/generators/puppet_generator.rb 498 def write_on(f) 499 value_hash 500 501 template = TemplatePage.new( 502 RDoc::Page::BODYINC, 503 RDoc::Page::NODE_PAGE, 504 505 RDoc::Page::METHOD_LIST) 506 template.write_html_on(f, @values) 507 end