Class: Generators::HtmlFile

Inherits:
ContextUser show all
Defined in:
lib/rdoc/generators/html_generator.rb

Overview

Handles the mapping of a file's information to HTML. In reality, a file corresponds to a TopLevel object, containing modules, classes, and top-level methods. In theory it could contain attributes and aliases, but we ignore these for now.

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, options, file_dir) ⇒ HtmlFile

Returns a new instance of HtmlFile.



774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
 
# File 'lib/rdoc/generators/html_generator.rb', line 774

def initialize(context, options, file_dir)
  super(context, options)

  @values = {}

  if options.all_one_file
    @path = filename_to_label
  else
    @path = http_url(file_dir)
  end

  @name = @context.file_relative_name

  collect_methods
  AllReferences.add(name, self)
  context.viewer = self
end

Instance Attribute Details

#name ⇒ Object (readonly)

Returns the value of attribute name



772
773
774
 
# File 'lib/rdoc/generators/html_generator.rb', line 772

def name
  @name
end

#path ⇒ Object (readonly)

Returns the value of attribute path



771
772
773
 
# File 'lib/rdoc/generators/html_generator.rb', line 771

def path
  @path
end

Instance Method Details

#<=>(other) ⇒ Object 



891
892
893
 
# File 'lib/rdoc/generators/html_generator.rb', line 891

def <=>(other)
  self.name <=> other.name
end

#file_attribute_values ⇒ Object 



872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
 
# File 'lib/rdoc/generators/html_generator.rb', line 872

def file_attribute_values
  full_path = @context.file_absolute_name
  short_name = File.basename(full_path)
  
  @values["title"] = CGI.escapeHTML("File: #{short_name}")

  if @context.diagram
    @values["diagram"] = diagram_reference(@context.diagram)
  end

  @values["short_name"]   = CGI.escapeHTML(short_name)
  @values["full_path"]    = CGI.escapeHTML(full_path)
  @values["dtm_modified"] = @context.file_stat.mtime.to_s

  if @options.webcvs
    @values["cvsurl"] = cvs_url( @options.webcvs, @values["full_path"] )
  end
end

#filename_to_label ⇒ Object 



797
798
799
 
# File 'lib/rdoc/generators/html_generator.rb', line 797

def filename_to_label
  @context.file_relative_name.gsub(/%|\/|\?|\#/) {|s| '%' + ("%x" % s[0]) }
end

#http_url(file_dir) ⇒ Object 



792
793
794
795
 
# File 'lib/rdoc/generators/html_generator.rb', line 792

def http_url(file_dir)
  File.join(file_dir, @context.file_relative_name.tr('.', '_')) +
    ".html"
end

#index_name ⇒ Object 



801
802
803
 
# File 'lib/rdoc/generators/html_generator.rb', line 801

def index_name
  name
end

#parent_name ⇒ Object 



805
806
807
 
# File 'lib/rdoc/generators/html_generator.rb', line 805

def parent_name
  nil
end

#value_hash ⇒ Object 



809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
 
# File 'lib/rdoc/generators/html_generator.rb', line 809

def value_hash
  file_attribute_values
  add_table_of_sections

  @values["charset"]   = @options.charset
  @values["href"]      = path
  @values["style_url"] = style_url(path, @options.css)

  if @context.comment
    d = markup(@context.comment)
    @values["description"] = d if d.size > 0
  end

  ml = build_method_summary_list
  @values["methods"] = ml unless ml.empty?

  il = build_include_list(@context)
  @values["includes"] = il unless il.empty?

  rl = build_requires_list(@context)
  @values["requires"] = rl unless rl.empty?

  if @options.promiscuous
    file_context = nil
  else
    file_context = @context
  end


  @values["sections"] = @context.sections.map do |section|

    secdata = {
      "sectitle" => section.title,
      "secsequence" => section.sequence,
      "seccomment" => markup(section.comment)
    }

    cl = build_class_list(0, @context, section, file_context)
    @values["classlist"] = cl unless cl.empty?

    mdl = build_method_detail_list(section)
    secdata["method_list"] = mdl unless mdl.empty?

    al = build_alias_summary_list(section)
    secdata["aliases"] = al unless al.empty?
    
    co = build_constants_summary_list(section)
    @values["constants"] = co unless co.empty?

    secdata
  end
  
  @values
end

#write_on(f) ⇒ Object 



864
865
866
867
868
869
870
 
# File 'lib/rdoc/generators/html_generator.rb', line 864

def write_on(f)
  value_hash
  template = TemplatePage.new(RDoc::Page::BODY,
                              RDoc::Page::FILE_PAGE,
                              RDoc::Page::METHOD_LIST)
  template.write_html_on(f, @values)
end