rdoc 2.2.1 → 2.3.0

data/lib/rdoc/generator/xml.rb

@@ -1,10 +1,13 @@
 require 'rdoc/generator/html'
+require 'rdoc/cache'
 
 ##
 # Generate XML output as one big file
 
 class RDoc::Generator::XML < RDoc::Generator::HTML
 
+  RDoc::RDoc.add_generator self
+
   ##
   # Standard generator factory
 
@@ -41,19 +44,23 @@ class RDoc::Generator::XML < RDoc::Generator::HTML
   #   class, module, and method names)
 
   def build_indices
+    template_cache = RDoc::Cache.instance
+
     @info.each do |toplevel|
-      @files << RDoc::Generator::File.new(toplevel, @options, RDoc::Generator::FILE_DIR)
+      @files << RDoc::Generator::File.new(template_cache, toplevel, @options,
+                                          RDoc::Generator::FILE_DIR)
     end
 
     RDoc::TopLevel.all_classes_and_modules.each do |cls|
-      build_class_list(cls, @files[0], RDoc::Generator::CLASS_DIR)
+      build_class_list(template_cache, cls, @files[0], RDoc::Generator::CLASS_DIR)
     end
   end
 
-  def build_class_list(from, html_file, class_dir)
-    @classes << RDoc::Generator::Class.new(from, html_file, class_dir, @options)
+  def build_class_list(template_cache, 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(mod, html_file, class_dir)
+      build_class_list(template_cache, mod, html_file, class_dir)
     end
   end
 
@@ -63,9 +70,9 @@ class RDoc::Generator::XML < RDoc::Generator::HTML
 
   def generate_xml
     values = {
-      'charset' => @options.charset,
-      'files'   => gen_into(@files),
-      'classes' => gen_into(@classes)
+      :charset => @options.charset,
+      :files   => gen_into(@files),
+      :classes => gen_into(@classes)
     }
 
     template = RDoc::TemplatePage.new @template::ONE_PAGE
@@ -102,14 +109,14 @@ class RDoc::Generator::XML < RDoc::Generator::HTML
     res = []
     collection.sort.each do |f|
       if f.document_self
-        res << { "href" => f.path, "name" => f.index_name }
+        res << { :href => f.path, :name => f.index_name }
       end
     end
 
     return {
-      "entries" => res,
-      'list_title' => title,
-      'index_url'  => main_url,
+      :entries => res,
+      :list_title => title,
+      :index_url  => main_url,
     }
   end
 

data/lib/rdoc/generator/xml/rdf.rb

@@ -3,67 +3,67 @@ require 'rdoc/generator/xml'
 module RDoc::Generator::XML::RDF
 
   CONTENTS_RDF = <<-EOF
-<% if defined? classes and classes["description"] then %>
+<% if defined? classes and classes[:description] then %>
     <description rd:parseType="Literal">
-<%= classes["description"] %>
+<%= classes[:description] %>
     </description>
 <% end %>
 
-<% if defined? files and files["requires"] then %>
-<% files["requires"].each do |requires| %>
-         <rd:required-file rd:name="<%= requires["name"] %>" />
-<% end # files["requires"] %>
+<% if defined? files and files[:requires] then %>
+<% files[:requires].each do |requires| %>
+         <rd:required-file rd:name="<%= requires[:name] %>" />
+<% end # files[:requires] %>
 <% end %>
 
-<% if defined? classes and classes["includes"] then %>
+<% if defined? classes and classes[:includes] then %>
       <IncludedModuleList>
-<% classes["includes"].each do |includes| %>
-        <included-module rd:name="<%= includes["name"] %>"  />
-<% end # includes["includes"] %>
+<% classes[:includes].each do |includes| %>
+        <included-module rd:name="<%= includes[:name] %>"  />
+<% end # includes[:includes] %>
       </IncludedModuleList>
 <% end %>
 
-<% if defined? classes and classes["sections"] then %>
-<% classes["sections"].each do |sections| %>
-<% if sections["attributes"] then %>
-<% sections["attributes"].each do |attributes| %>
+<% if defined? classes and classes[:sections] then %>
+<% classes[:sections].each do |sections| %>
+<% if sections[:attributes] then %>
+<% sections[:attributes].each do |attributes| %>
         <contents>
-        <Attribute rd:name="<%= attributes["name"] %>">
-<% if attributes["rw"] then %>
-          <attribute-rw><%= attributes["rw"] %></attribute-rw>
+        <Attribute rd:name="<%= attributes[:name] %>">
+<% if attributes[:rw] then %>
+          <attribute-rw><%= attributes[:rw] %></attribute-rw>
 <% end %>
-          <description rdf:parseType="Literal"><%= attributes["a_desc"] %></description>
+          <description rdf:parseType="Literal"><%= attributes[:a_desc] %></description>
         </Attribute>
         </contents>
-<% end # sections["attributes"] %>
+<% end # sections[:attributes] %>
 <% end %>
 
-<% if sections["method_list"] then %>
-<% sections["method_list"].each do |method_list| %>
-<% if method_list["methods"] then %>
-<% method_list["methods"].each do |methods| %>
+<% if sections[:method_list] then %>
+<% sections[:method_list].each do |method_list| %>
+<% if method_list[:methods] then %>
+<% method_list[:methods].each do |methods| %>
 	<contents>
-        <Method rd:name="<%= methods["name"] %>" rd:visibility="<%= methods["type"] %>"
-                rd:category="<%= methods["category"] %>" rd:id="<%= methods["aref"] %>">
-          <parameters><%= methods["params"] %></parameters>
-<% if methods["m_desc"] then %>
+        <Method rd:name="<%= methods[:name] %>" rd:visibility="<%= methods[:type] %>"
+                rd:category="<%= methods[:category] %>" rd:id="<%= methods[:aref] %>">
+          <parameters><%= methods[:params] %></parameters>
+<% if methods[:m_desc] then %>
           <description rdf:parseType="Literal">
-<%= methods["m_desc"] %>
+<%= methods[:m_desc] %>
           </description>
 <% end %>
-<% if methods["sourcecode"] then %>
+<% if methods[:sourcecode] then %>
           <source-code-listing rdf:parseType="Literal">
-<%= methods["sourcecode"] %>
+<%= methods[:sourcecode] %>
           </source-code-listing>
 <% end %>
         </Method>
        </contents>
-<% end # method_list["methods"] %>
+<% end # method_list[:methods] %>
 <% end %>
-<% end # sections["method_list"] %>
+<% end # sections[:method_list] %>
 <% end %>
      <!-- end method list -->
-<% end # classes["sections"] %>
+<% end # classes[:sections] %>
 <% end %>
   EOF
 
@@ -75,36 +75,36 @@ module RDoc::Generator::XML::RDF
         xmlns:rd="http://pragprog.com/rdoc/rdoc.rdf#">
 
 <!-- RDoc -->
-<% values["files"].each do |files| %>
-  <rd:File rd:name="<%= files["short_name"] %>" rd:id="<%= files["href"] %>">
-      <path><%= files["full_path"] %></path>
-      <dtm-modified><%= files["dtm_modified"] %></dtm-modified>
+<% values[:files].each do |files| %>
+  <rd:File rd:name="<%= files[:short_name] %>" rd:id="<%= files[:href] %>">
+      <path><%= files[:full_path] %></path>
+      <dtm-modified><%= files[:dtm_modified] %></dtm-modified>
 } + CONTENTS_RDF + %{
   </rd:File>
-<% end # values["files"] %>
-<% values["classes"].each do |classes| %>
-  <<%= values["classmod"] %> rd:name="<%= classes["full_name"] %>" rd:id="<%= classes["full_name"] %>">
+<% end # values[:files] %>
+<% values[:classes].each do |classes| %>
+  <<%= values[:classmod] %> rd:name="<%= classes[:full_name] %>" rd:id="<%= classes[:full_name] %>">
     <classmod-info>
-<% if classes["infiles"] then %>
+<% if classes[:infiles] then %>
       <InFiles>
-<% classes["infiles"].each do |infiles| %>
+<% classes[:infiles].each do |infiles| %>
         <infile>
-          <File rd:name="<%= infiles["full_path"] %>"
-<% if infiles["full_path_url"] then %>
-                rdf:about="<%= infiles["full_path_url"] %>"
+          <File rd:name="<%= infiles[:full_path] %>"
+<% if infiles[:full_path_url] then %>
+                rdf:about="<%= infiles[:full_path_url] %>"
 <% end %>
            />
          </infile>
-<% end # classes["infiles"] %>
+<% end # classes[:infiles] %>
       </InFiles>
 <% end %>
-<% if classes["parent"] then %>
-     <superclass><%= href classes["par_url"], classes["parent"] %></superclass>
+<% if classes[:parent] then %>
+     <superclass><%= href classes[:par_url], classes[:parent] %></superclass>
 <% end %>
     </classmod-info>
 } + CONTENTS_RDF + %{
-  </<%= classes["classmod"] %>>
-<% end # values["classes"] %>
+  </<%= classes[:classmod] %>>
+<% end # values[:classes] %>
 <!-- /RDoc -->
 </rdf:RDF>
 }

data/lib/rdoc/generator/xml/xml.rb

@@ -3,83 +3,83 @@ require 'rdoc/generator/xml'
 module RDoc::Generator::XML::XML
 
   CONTENTS_XML = <<-EOF
-<% if defined? classes and classes["description"] then %>
+<% if defined? classes and classes[:description] then %>
     <description>
-<%= classes["description"] %>
+<%= classes[:description] %>
     </description>
 <% end %>
     <contents>
-<% if defined? files and files["requires"] then %>
+<% if defined? files and files[:requires] then %>
       <required-file-list>
-<% files["requires"].each do |requires| %>
-         <required-file name="<%= requires["name"] %>"
-<% if requires["aref"] then %>
-                        href="<%= requires["aref"] %>"
+<% files[:requires].each do |requires| %>
+         <required-file name="<%= requires[:name] %>"
+<% if requires[:aref] then %>
+                        href="<%= requires[:aref] %>"
 <% end %>
          />
-<% end %><%# files["requires"] %>
+<% end %><%# files[:requires] %>
       </required-file-list>
 <% end %>
-<% if defined? classes and classes["sections"] then %>
-<% classes["sections"].each do |sections| %>
-<% if sections["constants"] then %>
+<% if defined? classes and classes[:sections] then %>
+<% classes[:sections].each do |sections| %>
+<% if sections[:constants] then %>
       <constant-list>
-<% sections["constants"].each do |constant| %>
-        <constant name="<%= constant["name"] %>">
-<% if constant["value"] then %>
-          <value><%= constant["value"] %></value>
+<% sections[:constants].each do |constant| %>
+        <constant name="<%= constant[:name] %>">
+<% if constant[:value] then %>
+          <value><%= constant[:value] %></value>
 <% end %>
-          <description><%= constant["a_desc"] %></description>
+          <description><%= constant[:a_desc] %></description>
         </constant>
-<% end %><%# sections["constants"] %>
+<% end %><%# sections[:constants] %>
       </constant-list>
 <% end %>
-<% if sections["attributes"] then %>
+<% if sections[:attributes] then %>
       <attribute-list>
-<% sections["attributes"].each do |attributes| %>
-        <attribute name="<%= attributes["name"] %>">
-<% if attributes["rw"] then %>
-          <attribute-rw><%= attributes["rw"] %></attribute-rw>
+<% sections[:attributes].each do |attributes| %>
+        <attribute name="<%= attributes[:name] %>">
+<% if attributes[:rw] then %>
+          <attribute-rw><%= attributes[:rw] %></attribute-rw>
 <% end %>
-          <description><%= attributes["a_desc"] %></description>
+          <description><%= attributes[:a_desc] %></description>
         </attribute>
-<% end %><%# sections["attributes"] %>
+<% end %><%# sections[:attributes] %>
       </attribute-list>
 <% end %>
-<% if sections["method_list"] then %>
+<% if sections[:method_list] then %>
       <method-list>
-<% sections["method_list"].each do |method_list| %>
-<% if method_list["methods"] then %>
-<% method_list["methods"].each do |methods| %>
-        <method name="<%= methods["name"] %>" type="<%= methods["type"] %>" category="<%= methods["category"] %>" id="<%= methods["aref"] %>">
-          <parameters><%= methods["params"] %></parameters>
-<% if methods["m_desc"] then %>
+<% sections[:method_list].each do |method_list| %>
+<% if method_list[:methods] then %>
+<% method_list[:methods].each do |methods| %>
+        <method name="<%= methods[:name] %>" type="<%= method_list[:type] %>" category="<%= method_list[:category] %>" id="<%= methods[:aref] %>">
+          <parameters><%= methods[:params] %></parameters>
+<% if methods[:m_desc] then %>
           <description>
-<%= methods["m_desc"] %>
+<%= methods[:m_desc] %>
           </description>
 <% end %>
-<% if methods["sourcecode"] then %>
+<% if methods[:sourcecode] then %>
           <source-code-listing>
-<%= methods["sourcecode"] %>
+<%= methods[:sourcecode] %>
           </source-code-listing>
 <% end %>
         </method>
-<% end %><%# method_list["methods"] %>
+<% end %><%# method_list[:methods] %>
 <% end %>
-<% end %><%# sections["method_list"] %>
+<% end %><%# sections[:method_list] %>
       </method-list>
 <% end %>
-<% end %><%# classes["sections"] %>
+<% end %><%# classes[:sections] %>
 <% end %>
-<% if defined? classes and classes["includes"] then %>
+<% if defined? classes and classes[:includes] then %>
       <included-module-list>
-<% classes["includes"].each do |includes| %>
-        <included-module name="<%= includes["name"] %>"
-<% if includes["aref"] then %>
-                         href="<%= includes["aref"] %>"
+<% classes[:includes].each do |includes| %>
+        <included-module name="<%= includes[:name] %>"
+<% if includes[:aref] then %>
+                         href="<%= includes[:aref] %>"
 <% end %>
         />
-<% end %><%# classes["includes"] %>
+<% end %><%# classes[:includes] %>
       </included-module-list>
 <% end %>
     </contents>
@@ -88,34 +88,34 @@ module RDoc::Generator::XML::XML
   ONE_PAGE = %{<?xml version="1.0" encoding="utf-8"?>
 <rdoc>
 <file-list>
-<% values["files"].each do |files| %>
-  <file name="<%= files["short_name"] %>" id="<%= files["href"] %>">
+<% values[:files].each do |files| %>
+  <file name="<%= files[:short_name] %>" id="<%= files[:href] %>">
     <file-info>
-      <path><%= files["full_path"] %></path>
-      <dtm-modified><%= files["dtm_modified"] %></dtm-modified>
+      <path><%= files[:full_path] %></path>
+      <dtm-modified><%= files[:dtm_modified] %></dtm-modified>
     </file-info>
 } + CONTENTS_XML + %{
   </file>
-<% end %><%# values["files"] %>
+<% end %><%# values[:files] %>
 </file-list>
 <class-module-list>
-<% values["classes"].each do |classes| %>
-  <<%= classes["classmod"] %> name="<%= classes["full_name"] %>" id="<%= classes["full_name"] %>">
+<% values[:classes].each do |classes| %>
+  <<%= classes[:classmod] %> name="<%= classes[:full_name] %>" id="<%= classes[:full_name] %>">
     <classmod-info>
-<% if classes["infiles"] then %>
+<% if classes[:infiles] then %>
       <infiles>
-<% classes["infiles"].each do |infiles|  %>
-        <infile><%= href infiles["full_path_url"], infiles["full_path"] %></infile>
-<% end %><%# classes["infiles"] %>
+<% classes[:infiles].each do |infiles|  %>
+        <infile><%= href infiles[:full_path_url], infiles[:full_path] %></infile>
+<% end %><%# classes[:infiles] %>
       </infiles>
 <% end %>
-<% if classes["parent"] then %>
-     <superclass><%= href classes["par_url"], classes["parent"] %></superclass>
+<% if classes[:parent] then %>
+     <superclass><%= href classes[:par_url], classes[:parent] %></superclass>
 <% end %>
     </classmod-info>
 } + CONTENTS_XML + %{
-  </<%= classes["classmod"] %>>
-<% end %><%# values["classes"] %>
+  </<%= classes[:classmod] %>>
+<% end %><%# values[:classes] %>
 </class-module-list>
 </rdoc>
 }

data/lib/rdoc/known_classes.rb

@@ -62,7 +62,6 @@ module RDoc
     "rb_mGC"               => "GC",
     "rb_mKernel"           => "Kernel",
     "rb_mMath"             => "Math",
-    "rb_mPrecision"        => "Precision",
     "rb_mProcess"          => "Process"
   }
 

data/lib/rdoc/markup/preprocess.rb

@@ -44,15 +44,16 @@ class RDoc::Markup::PreProcess
 
   def include_file(name, indent)
     if full_name = find_include_file(name) then
-      content = File.open(full_name) {|f| f.read}
+      content = File.read full_name
+
       # strip leading '#'s, but only if all lines start with them
-      if content =~ /^[^#]/
+      if content =~ /^[^#]/ then
         content.gsub(/^/, indent)
       else
         content.gsub(/^#?/, indent)
       end
     else
-      $stderr.puts "Couldn't find file to include: '#{name}'"
+      $stderr.puts "Couldn't find file to include '#{name}' from #{@input_file_name}"
       ''
     end
   end

data/lib/rdoc/markup/to_html.rb

@@ -44,6 +44,9 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
     from = from.split "/"
     to   = to.split "/"
 
+    from.delete '.'
+    to.delete '.'
+
     while from.size > 0 and to.size > 0 and from[0] == to[0] do
       from.shift
       to.shift
@@ -309,7 +312,7 @@ class RDoc::Markup::ToHtml < RDoc::Markup::Formatter
 
     # convert -- to em-dash, (-- to en-dash)
       gsub(/---?/, '&#8212;'). #gsub(/--/, '&#8211;').
-      
+
     # convert ... to elipsis (and make sure .... becomes .<elipsis>)
       gsub(/\.\.\.\./, '.&#8230;').gsub(/\.\.\./, '&#8230;').