Class: Generators::HtmlClass
Overview
Wrap a ClassModule context
Instance Attribute Summary collapse
Attributes inherited from ContextUser
#context
Instance Method Summary
collapse
Methods inherited from ContextUser
#add_table_of_sections, #aref_to, #as_href, #build_alias_summary_list, #build_class_list, #build_constants_summary_list, #build_include_list, #build_method_detail_list, #build_method_summary_list, #build_requires_list, #collect_methods, #diagram_reference, #document_self, #find_symbol, #href, #potentially_referenced_list, #url
Methods included from MarkUp
#cvs_url, #markup, #style_url
Constructor Details
#initialize(context, html_file, prefix, options) ⇒ HtmlClass
Returns a new instance of HtmlClass.
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
|
# File 'lib/rdoc/generators/html_generator.rb', line 590
def initialize(context, html_file, prefix, options)
super(context, options)
@html_file = html_file
@is_module = context.is_module?
@values = {}
context.viewer = self
if options.all_one_file
@path = context.full_name
else
@path = http_url(context.full_name, prefix)
end
collect_methods
AllReferences.add(name, self)
end
|
Instance Attribute Details
#path ⇒ Object
Returns the value of attribute path
588
589
590
|
# File 'lib/rdoc/generators/html_generator.rb', line 588
def path
@path
end
|
Instance Method Details
#<=>(other) ⇒ Object
756
757
758
|
# File 'lib/rdoc/generators/html_generator.rb', line 756
def <=>(other)
self.name <=> other.name
end
|
#build_attribute_list(section) ⇒ Object
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
|
# File 'lib/rdoc/generators/html_generator.rb', line 686
def build_attribute_list(section)
atts = @context.attributes.sort
res = []
atts.each do |att|
next unless att.section == section
if att.visibility == :public || att.visibility == :protected || @options.show_all
entry = {
"name" => CGI.escapeHTML(att.name),
"rw" => att.rw,
"a_desc" => markup(att., true)
}
unless att.visibility == :public || att.visibility == :protected
entry["rw"] << "-"
end
res << entry
end
end
res
end
|
#class_attribute_values ⇒ Object
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
|
# File 'lib/rdoc/generators/html_generator.rb', line 706
def class_attribute_values
h_name = CGI.escapeHTML(name)
@values["classmod"] = @is_module ? "Module" : "Class"
@values["title"] = "#{@values['classmod']}: #{h_name}"
c = @context
c = c.parent while c and !c.diagram
if c && c.diagram
@values["diagram"] = diagram_reference(c.diagram)
end
@values["full_name"] = h_name
parent_class = @context.superclass
if parent_class
@values["parent"] = CGI.escapeHTML(parent_class)
if parent_name
lookup = parent_name + "::" + parent_class
else
lookup = parent_class
end
parent_url = AllReferences[lookup] || AllReferences[parent_class]
if parent_url and parent_url.document_self
@values["par_url"] = aref_to(parent_url.path)
end
end
files = []
@context.in_files.each do |f|
res = {}
full_path = CGI.escapeHTML(f.file_absolute_name)
res["full_path"] = full_path
res["full_path_url"] = aref_to(f.viewer.path) if f.document_self
if @options.webcvs
res["cvsurl"] = cvs_url( @options.webcvs, full_path )
end
files << res
end
@values['infiles'] = files
end
|
#http_url(full_name, prefix) ⇒ Object
return the relative file name to store this class in, which is also its url
612
613
614
615
616
617
618
|
# File 'lib/rdoc/generators/html_generator.rb', line 612
def http_url(full_name, prefix)
path = full_name.dup
if path['<<']
path.gsub!(/<<\s*(\w*)/) { "from-#$1" }
end
File.join(prefix, path.split("::")) + ".html"
end
|
#index_name ⇒ Object
629
630
631
|
# File 'lib/rdoc/generators/html_generator.rb', line 629
def index_name
name
end
|
#name ⇒ Object
621
622
623
|
# File 'lib/rdoc/generators/html_generator.rb', line 621
def name
@context.full_name
end
|
#parent_name ⇒ Object
625
626
627
|
# File 'lib/rdoc/generators/html_generator.rb', line 625
def parent_name
@context.parent.full_name
end
|
#value_hash ⇒ Object
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
|
# File 'lib/rdoc/generators/html_generator.rb', line 641
def value_hash
class_attribute_values
add_table_of_sections
@values["charset"] = @options.charset
@values["style_url"] = style_url(path, @options.css)
d = markup(@context.)
@values["description"] = d unless d.empty?
ml = build_method_summary_list
@values["methods"] = ml unless ml.empty?
il = build_include_list(@context)
@values["includes"] = il unless il.empty?
@values["sections"] = @context.sections.map do |section|
secdata = {
"sectitle" => section.title,
"secsequence" => section.sequence,
"seccomment" => markup(section.)
}
al = build_alias_summary_list(section)
secdata["aliases"] = al unless al.empty?
co = build_constants_summary_list(section)
secdata["constants"] = co unless co.empty?
al = build_attribute_list(section)
secdata["attributes"] = al unless al.empty?
cl = build_class_list(0, @context, section)
secdata["classlist"] = cl unless cl.empty?
mdl = build_method_detail_list(section)
secdata["method_list"] = mdl unless mdl.empty?
secdata
end
@values
end
|