rdoc 2.2.1 → 2.3.0

data/lib/rdoc/generator.rb

@@ -3,6 +3,7 @@ require 'rdoc'
 require 'rdoc/options'
 require 'rdoc/markup/to_html_crossref'
 require 'rdoc/template'
+require 'rdoc/cache'
 
 module RDoc::Generator
 
@@ -127,28 +128,41 @@ module RDoc::Generator
     # * a complete list of all hyperlinkable terms (file, class, module, and
     #   method names)
 
-    def self.build_indices(toplevels, options)
+    def self.build_indices(toplevels, options, template_cache = nil)
       files = []
       classes = []
+      template_cache ||= RDoc::Cache.instance
+
+      file_dir = if defined? options.generator::FILE_DIR then
+                   options.generator::FILE_DIR
+                 else
+                   RDoc::Generator::FILE_DIR
+                 end
 
       toplevels.each do |toplevel|
-        files << RDoc::Generator::File.new(toplevel, options,
-                                           RDoc::Generator::FILE_DIR)
+        files << RDoc::Generator::File.new(template_cache, toplevel, options,
+                                           file_dir)
       end
 
+      class_dir = if defined? options.generator::CLASS_DIR then
+                   options.generator::CLASS_DIR
+                 else
+                   RDoc::Generator::CLASS_DIR
+                 end
+
       RDoc::TopLevel.all_classes_and_modules.each do |cls|
-        build_class_list(classes, options, cls, files[0], 
-                         RDoc::Generator::CLASS_DIR)
+        build_class_list(template_cache, classes, options, cls, files[0], 
+                         class_dir)
       end
 
       return files, classes
     end
 
-    def self.build_class_list(classes, options, from, html_file, class_dir)
-      classes << RDoc::Generator::Class.new(from, html_file, class_dir, options)
+    def self.build_class_list(template_cache, classes, options, from, html_file, class_dir)
+      classes << RDoc::Generator::Class.new(template_cache, from, html_file, class_dir, options)
 
       from.each_classmodule do |mod|
-        build_class_list(classes, options, mod, html_file, class_dir)
+        build_class_list(template_cache, classes, options, mod, html_file, class_dir)
       end
     end
 
@@ -214,8 +228,8 @@ module RDoc::Generator
 
       @methods.sort.map do |meth|
         {
-          "name" => CGI.escapeHTML(meth.name),
-          "aref" => "##{meth.aref}"
+          :name => CGI.escapeHTML(meth.name),
+          :aref => "##{meth.aref}"
         }
       end
     end
@@ -229,12 +243,12 @@ module RDoc::Generator
         next unless al.section == section
 
         res = {
-          'old_name' => al.old_name,
-          'new_name' => al.new_name,
+          :old_name => al.old_name,
+          :new_name => al.new_name,
         }
 
         if al.comment and not al.comment.empty? then
-          res['desc'] = markup al.comment, true
+          res[:desc] = markup al.comment, true
         end
 
         res
@@ -249,12 +263,12 @@ module RDoc::Generator
         next unless co.section == section
 
         res = {
-          'name'  => co.name,
-          'value' => CGI.escapeHTML(co.value)
+          :name  => co.name,
+          :value => CGI.escapeHTML(co.value)
         }
 
         if co.comment and not co.comment.empty? then
-          res['desc'] = markup co.comment, true
+          res[:desc] = markup co.comment, true
         end
 
         res
@@ -303,9 +317,9 @@ module RDoc::Generator
         h_name = CGI.escapeHTML(i.name)
         if ref and ref.document_self
           path = url(ref.path)
-          res << { "name" => h_name, "aref" => path }
+          res << { :name => h_name, :aref => path }
         else
-          res << { "name" => h_name }
+          res << { :name => h_name }
         end
       end
       res
@@ -333,38 +347,38 @@ module RDoc::Generator
             row = {}
 
             if m.call_seq then
-              row["callseq"] = m.call_seq.gsub(/->/, '&rarr;')
+              row[:callseq] = m.call_seq.gsub(/->/, '&rarr;')
             else
-              row["name"]        = CGI.escapeHTML(m.name)
-              row["params"]      = m.params
+              row[:name]        = CGI.escapeHTML(m.name)
+              row[:params]      = m.params
             end
 
             desc = m.description.strip
-            row["m_desc"]      = desc unless desc.empty?
-            row["aref"]        = m.aref
-            row["visibility"]  = m.visibility.to_s
+            row[:m_desc]      = desc unless desc.empty?
+            row[:aref]        = m.aref
+            row[:visibility]  = m.visibility.to_s
 
             alias_names = []
 
             m.aliases.each do |other|
               if other.viewer then # won't be if the alias is private
                 alias_names << {
-                  'name' => other.name,
-                  'aref'  => other.viewer.as_href(path)
+                  :name => other.name,
+                  :aref  => other.viewer.as_href(path)
                 }
               end
             end
 
-            row["aka"] = alias_names unless alias_names.empty?
+            row[:aka] = alias_names unless alias_names.empty?
 
             if @options.inline_source then
               code = m.source_code
-              row["sourcecode"] = code if code
+              row[:sourcecode] = code if code
             else
               code = m.src_url
               if code then
-                row["codeurl"] = code
-                row["imgurl"]  = m.img_url
+                row[:codeurl] = code
+                row[:imgurl]  = m.img_url
               end
             end
 
@@ -373,9 +387,9 @@ module RDoc::Generator
 
           if res.size > 0 then
             outer << {
-              "type"     => vis.to_s.capitalize,
-              "category" => singleton ? "Class" : "Instance",
-              "methods"  => res
+              :type     => vis.to_s.capitalize,
+              :category => singleton ? "Class" : "Instance",
+              :methods  => res
             }
           end
         end
@@ -464,13 +478,13 @@ module RDoc::Generator
       @context.sections.each do |section|
         if section.title then
           toc << {
-            'secname' => section.title,
-            'href'    => section.sequence
+            :secname => section.title,
+            :href    => section.sequence
           }
         end
       end
 
-      @values['toc'] = toc unless toc.empty?
+      @values[:toc] = toc unless toc.empty?
     end
 
   end
@@ -484,9 +498,10 @@ module RDoc::Generator
     attr_reader :path
     attr_reader :values
 
-    def initialize(context, html_file, prefix, options)
+    def initialize(template_cache, context, html_file, prefix, options)
       super context, options
 
+      @template_cache = template_cache
       @html_file = html_file
       @html_class = self
       @is_module = context.module?
@@ -514,7 +529,9 @@ module RDoc::Generator
 
       path.gsub!(/<<\s*(\w*)/, 'from-\1') if path['<<']
 
-      ::File.join(prefix, path.split("::")) + ".html"
+      path = [prefix] + path.split('::')
+
+      ::File.join(*path.compact) + ".html"
     end
 
     def name
@@ -532,56 +549,57 @@ module RDoc::Generator
     def write_on(f, file_list, class_list, method_list, overrides = {})
       value_hash
 
-      @values['file_list'] = file_list
-      @values['class_list'] = class_list
-      @values['method_list'] = method_list
+      @values[:file_list] = file_list
+      @values[:class_list] = class_list
+      @values[:method_list] = method_list
 
       @values.update overrides
 
-      template = RDoc::TemplatePage.new(@template::BODY,
-                                        @template::CLASS_PAGE,
-                                        @template::METHOD_LIST)
-
-      template.write_html_on(f, @values)
+      template_page = @template_cache.cache(@template) do
+        RDoc::TemplatePage.new(@template::BODY,
+                               @template::CLASS_PAGE,
+                               @template::METHOD_LIST)
+      end
+      template_page.write_html_on(f, @values)
     end
 
     def value_hash
       class_attribute_values
       add_table_of_sections
 
-      @values["charset"] = @options.charset
-      @values["style_url"] = style_url(path, @options.css)
+      @values[:charset] = @options.charset
+      @values[:style_url] = style_url(path, @options.css)
 
       d = markup(@context.comment)
-      @values["description"] = d unless d.empty?
+      @values[:description] = d unless d.empty?
 
       ml = build_method_summary_list @path
-      @values["methods"] = ml unless ml.empty?
+      @values[:methods] = ml unless ml.empty?
 
       il = build_include_list @context
-      @values["includes"] = il unless il.empty?
+      @values[:includes] = il unless il.empty?
 
-      @values["sections"] = @context.sections.map do |section|
+      @values[:sections] = @context.sections.map do |section|
         secdata = {
-          "sectitle" => section.title,
-          "secsequence" => section.sequence,
-          "seccomment" => markup(section.comment),
+          :sectitle    => section.title,
+          :secsequence => section.sequence,
+          :seccomment  => markup(section.comment),
         }
 
         al = build_alias_summary_list section
-        secdata["aliases"] = al unless al.empty?
+        secdata[:aliases] = al unless al.empty?
 
         co = build_constants_summary_list section
-        secdata["constants"] = co unless co.empty?
+        secdata[:constants] = co unless co.empty?
 
         al = build_attribute_list section
-        secdata["attributes"] = al unless al.empty?
+        secdata[:attributes] = al unless al.empty?
 
         cl = build_class_list 0, @context, section
-        secdata["classlist"] = cl unless cl.empty?
+        secdata[:classlist] = cl unless cl.empty?
 
         mdl = build_method_detail_list section
-        secdata["method_list"] = mdl unless mdl.empty?
+        secdata[:method_list] = mdl unless mdl.empty?
 
         secdata
       end
@@ -597,13 +615,13 @@ module RDoc::Generator
            @options.show_all then
 
           entry = {
-            "name"   => CGI.escapeHTML(att.name),
-            "rw"     => att.rw,
-            "a_desc" => markup(att.comment, true)
+            :name   => CGI.escapeHTML(att.name),
+            :rw     => att.rw,
+            :a_desc => markup(att.comment, true)
           }
 
           unless att.visibility == :public or att.visibility == :protected then
-            entry["rw"] << "-"
+            entry[:rw] << "-"
           end
 
           entry
@@ -614,22 +632,22 @@ module RDoc::Generator
     def class_attribute_values
       h_name = CGI.escapeHTML(name)
 
-      @values["href"]      = @path
-      @values["classmod"]  = @is_module ? "Module" : "Class"
-      @values["title"]     = "#{@values['classmod']}: #{h_name} [#{@options.title}]"
+      @values[:href]      = @path
+      @values[:classmod]  = @is_module ? "Module" : "Class"
+      @values[:title]     = "#{@values['classmod']}: #{h_name} [#{@options.title}]"
 
       c = @context
       c = c.parent while c and not c.diagram
 
       if c and c.diagram then
-        @values["diagram"] = diagram_reference(c.diagram)
+        @values[:diagram] = diagram_reference(c.diagram)
       end
 
-      @values["full_name"] = h_name
+      @values[:full_name] = h_name
 
       if not @context.module? and @context.superclass then
         parent_class = @context.superclass
-        @values["parent"] = CGI.escapeHTML(parent_class)
+        @values[:parent] = CGI.escapeHTML(parent_class)
 
         if parent_name
           lookup = parent_name + "::" + parent_class
@@ -640,7 +658,7 @@ module RDoc::Generator
         parent_url = AllReferences[lookup] || AllReferences[parent_class]
 
         if parent_url and parent_url.document_self
-          @values["par_url"] = aref_to(parent_url.path)
+          @values[:par_url] = aref_to(parent_url.path)
         end
       end
 
@@ -649,23 +667,49 @@ module RDoc::Generator
         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
+        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 )
+          res[:cvsurl] = cvs_url( @options.webcvs, full_path )
         end
 
         files << res
       end
 
-      @values['infiles'] = files
+      @values[:infiles] = files
     end
 
     def <=>(other)
       self.name <=> other.name
     end
 
+    def inspect
+      "#<#{self.class} name: #{name} path: #{@path}>"
+    end
+
+    def pretty_print(q)
+      q.group 1, "#<#{self.class} ", '>' do
+        q.text 'name: '
+        q.pp name
+        q.text ','
+        q.breakable
+
+        q.text 'path: '
+        q.pp @path
+        q.text ','
+        q.breakable
+
+        q.text 'values: '
+        q.pp @values
+        q.text ','
+        q.breakable
+
+        q.text 'methods: '
+        q.pp @methods
+      end
+    end
+
   end
 
   ##
@@ -680,10 +724,11 @@ module RDoc::Generator
     attr_reader :name
     attr_reader :values
 
-    def initialize(context, options, file_dir)
+    def initialize(template_cache, context, options, file_dir)
       super context, options
 
       @values = {}
+      @template_cache = template_cache
 
       if options.all_one_file
         @path = filename_to_label
@@ -699,7 +744,9 @@ module RDoc::Generator
     end
 
     def http_url(file_dir)
-      ::File.join file_dir, "#{@context.file_relative_name.tr '.', '_'}.html"
+      path = [file_dir, "#{@context.file_relative_name.tr '.', '_'}.html"]
+
+      ::File.join path.compact
     end
 
     def filename_to_label
@@ -720,50 +767,45 @@ module RDoc::Generator
       file_attribute_values
       add_table_of_sections
 
-      @values["charset"]   = @options.charset
-      @values["href"]      = path
-      @values["style_url"] = style_url(path, @options.css)
+      @values[:charset]   = @options.charset
+      @values[:href]      = path
+      @values[:parser]    = @context.parser
+      @values[:style_url] = style_url(path, @options.css)
 
       if @context.comment
         d = markup(@context.comment)
-        @values["description"] = d if d.size > 0
+        @values[:description] = d if d.size > 0
       end
 
       ml = build_method_summary_list
-      @values["methods"] = ml unless ml.empty?
+      @values[:methods] = ml unless ml.empty?
 
       il = build_include_list(@context)
-      @values["includes"] = il unless il.empty?
+      @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[:requires] = rl unless rl.empty?
 
+      file_context = @context unless @options.promiscuous
 
-      @values["sections"] = @context.sections.map do |section|
-
+      @values[:sections] = @context.sections.map do |section|
         secdata = {
-          "sectitle" => section.title,
-          "secsequence" => section.sequence,
-          "seccomment" => markup(section.comment)
+          :sectitle => section.title,
+          :secsequence => section.sequence,
+          :seccomment => markup(section.comment)
         }
 
         cl = build_class_list(0, @context, section, file_context)
-        secdata["classlist"] = cl unless cl.empty?
+        secdata[:classlist] = cl unless cl.empty?
 
         mdl = build_method_detail_list(section)
-        secdata["method_list"] = mdl unless mdl.empty?
+        secdata[:method_list] = mdl unless mdl.empty?
 
         al = build_alias_summary_list(section)
-        secdata["aliases"] = al unless al.empty?
+        secdata[:aliases] = al unless al.empty?
 
         co = build_constants_summary_list(section)
-        secdata["constants"] = co unless co.empty?
+        secdata[:constants] = co unless co.empty?
 
         secdata
       end
@@ -774,35 +816,36 @@ module RDoc::Generator
     def write_on(f, file_list, class_list, method_list, overrides = {})
       value_hash
 
-      @values['file_list'] = file_list
-      @values['class_list'] = class_list
-      @values['method_list'] = method_list
+      @values[:file_list] = file_list
+      @values[:class_list] = class_list
+      @values[:method_list] = method_list
 
       @values.update overrides
 
-      template = RDoc::TemplatePage.new(@template::BODY,
-                                        @template::FILE_PAGE,
-                                        @template::METHOD_LIST)
-
-      template.write_html_on(f, @values)
+      template_page = @template_cache.cache(@template) do
+        RDoc::TemplatePage.new(@template::BODY,
+                               @template::FILE_PAGE,
+                               @template::METHOD_LIST)
+      end
+      template_page.write_html_on(f, @values)
     end
 
     def file_attribute_values
       full_path = @context.file_absolute_name
       short_name = ::File.basename full_path
 
-      @values["title"] = CGI.escapeHTML("File: #{short_name} [#{@options.title}]")
+      @values[:title] = CGI.escapeHTML("File: #{short_name} [#{@options.title}]")
 
       if @context.diagram then
-        @values["diagram"] = diagram_reference(@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
+      @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 then
-        @values["cvsurl"] = cvs_url @options.webcvs, @values["full_path"]
+        @values[:cvsurl] = cvs_url @options.webcvs, @values[:full_path]
       end
     end
 
@@ -810,6 +853,27 @@ module RDoc::Generator
       self.name <=> other.name
     end
 
+    def inspect
+      "#<#{self.class} name: #{@name} path: #{@path}>"
+    end
+
+    def pretty_print(q)
+      q.group 1, "#<#{self.class} ", '>' do
+        q.text 'name: '
+        q.pp @name
+        q.text ','
+        q.breakable
+
+        q.text 'path: '
+        q.pp @path
+        q.text ','
+        q.breakable
+
+        q.text 'values: '
+        q.pp @values
+      end
+    end
+
   end
 
   class Method
@@ -849,15 +913,16 @@ module RDoc::Generator
 
       context.viewer = self
 
-      if (ts = @context.token_stream)
-        @source_code = markup_code(ts)
-        unless @options.inline_source
-          @src_url = create_source_code_file(@source_code)
+      if ts = @context.token_stream then
+        @source_code = markup_code ts
+
+        unless @options.inline_source then
+          @src_url = create_source_code_file @source_code
           @img_url = RDoc::Markup::ToHtml.gen_relative_url path, 'source.png'
         end
       end
 
-      AllReferences.add(name, self)
+      AllReferences.add name, self
     end
 
     ##
@@ -982,10 +1047,10 @@ module RDoc::Generator
 
       open file_path, 'w' do |f|
         values = {
-          'title'     => CGI.escapeHTML(index_name),
-          'code'      => code_body,
-          'style_url' => style_url(file_path, @options.css),
-          'charset'   => @options.charset
+          :title     => CGI.escapeHTML(index_name),
+          :code      => code_body,
+          :style_url => style_url(file_path, @options.css),
+          :charset   => @options.charset
         }
         template.write_html_on(f, values)
       end
@@ -1039,22 +1104,20 @@ module RDoc::Generator
     #    # File xxxxx, line dddd
 
     def add_line_numbers(src)
-      if src =~ /\A.*, line (\d+)/
+      if src =~ /\A.*, line (\d+)/ then
         first = $1.to_i - 1
         last  = first + src.count("\n")
         size = last.to_s.length
-        fmt = "%#{size}d: "
-        is_first_line = true
-        line_num = first
+
+        line = first
         src.gsub!(/^/) do
-          if is_first_line then
-            is_first_line = false
-            res = " " * (size+2)
-          else
-            res = sprintf(fmt, line_num)
-          end
+          res = if line == first then
+                  " " * (size + 2)
+                else
+                  "%#{size}d: " % line
+                end
 
-          line_num += 1
+          line += 1
           res
         end
       end