rdoc 2.4.3 → 2.5

data/lib/rdoc/generator/markup.rb

@@ -1,9 +1,10 @@
+require 'rdoc/text'
 require 'rdoc/code_objects'
 require 'rdoc/generator'
 require 'rdoc/markup/to_html_crossref'
 
 ##
-# Handle common HTML markup tasks for various CodeObjects
+# Handle common RDoc::Markup tasks for various CodeObjects
 
 module RDoc::Generator::Markup
 
@@ -29,7 +30,7 @@ module RDoc::Generator::Markup
   end
 
   ##
-  # RDoc::Markup formatter object
+  # Creates an RDoc::Markup::ToHtmlCrossref formatter
 
   def formatter
     return @formatter if defined? @formatter
@@ -39,30 +40,6 @@ module RDoc::Generator::Markup
     @formatter = RDoc::Markup::ToHtmlCrossref.new this.path, this, show_hash
   end
 
-  ##
-  # Convert a string in markup format into HTML.
-
-  def markup(str, remove_para = false)
-    return '' unless str
-
-    # Convert leading comment markers to spaces, but only if all non-blank
-    # lines have them
-    if str =~ /^(?>\s*)[^\#]/ then
-      content = str
-    else
-      content = str.gsub(/^\s*(#+)/) { $1.tr '#', ' ' }
-    end
-
-    res = formatter.convert content
-
-    if remove_para then
-      res.sub!(/^<p>/, '')
-      res.sub!(/<\/p>$/, '')
-    end
-
-    res
-  end
-
   ##
   # Build a webcvs URL starting for the given +url+ with +full_path+ appended
   # as the destination path.  If +url+ contains '%s' +full_path+ will be
@@ -99,7 +76,7 @@ class RDoc::AnyMethod
         res = if line == first then
                 " " * (size + 2)
               else
-                "%#{size}d: " % line
+                "%2$*1$d: " % [size, line]
               end
 
         line += 1
@@ -134,7 +111,7 @@ class RDoc::AnyMethod
                 nil
               end
 
-      text = CGI.escapeHTML(t.text)
+      text = CGI.escapeHTML t.text
 
       if style
         src << "<span class=\"#{style}\">#{text}</span>"
@@ -143,7 +120,7 @@ class RDoc::AnyMethod
       end
     end
 
-    add_line_numbers src if RDoc::RDoc.current.options.include_line_numbers
+    add_line_numbers src
 
     src
   end

data/lib/rdoc/generator/ri.rb

@@ -1,229 +1,79 @@
 require 'rdoc/generator'
-require 'rdoc/markup/to_flow'
+require 'rdoc/ri'
 
-require 'rdoc/ri/cache'
-require 'rdoc/ri/reader'
-require 'rdoc/ri/writer'
-require 'rdoc/ri/descriptions'
+##
+# Generates ri data files
 
 class RDoc::Generator::RI
 
   RDoc::RDoc.add_generator self
 
-  ##
-  # Generator may need to return specific subclasses depending on the
-  # options they are passed. Because of this we create them using a factory
-
-  def self.for(options)
-    new(options)
+  def self.for options
+    new options
   end
 
   ##
   # Set up a new ri generator
 
-  def initialize(options) #:not-new:
-    @options   = options
-    @ri_writer = RDoc::RI::Writer.new "."
-    @markup    = RDoc::Markup.new
-    @to_flow   = RDoc::Markup::ToFlow.new
-
-    @generated = {}
+  def initialize options #:not-new:
+    @options     = options
+    @store       = RDoc::RI::Store.new '.'
+    @old_siginfo = nil
+    @current     = nil
   end
 
   ##
-  # Build the initial indices and output objects based on an array of
-  # TopLevel objects containing the extracted information.
-
-  def generate(top_levels)
-    RDoc::TopLevel.all_classes_and_modules.each do |cls|
-      process_class cls
-    end
-  end
-
-  def process_class(from_class)
-    generate_class_info(from_class)
-
-    # now recurse into this class' constituent classes
-    from_class.each_classmodule do |mod|
-      process_class(mod)
-    end
-  end
-
-  def generate_class_info(cls)
-    case cls
-    when RDoc::NormalModule then
-      cls_desc = RDoc::RI::ModuleDescription.new
-    else
-      cls_desc = RDoc::RI::ClassDescription.new
-      superclass = cls.superclass
-      superclass = superclass.full_name unless String === superclass
-      cls_desc.superclass = superclass
-    end
+  # Build the initial indices and output objects based on an array of TopLevel
+  # objects containing the extracted information.
 
-    cls_desc.name        = cls.name
-    cls_desc.full_name   = cls.full_name
-    cls_desc.comment     = markup(cls.comment)
+  def generate top_levels
+    install_siginfo_handler
 
-    cls_desc.attributes = cls.attributes.sort.map do |a|
-      RDoc::RI::Attribute.new(a.name, a.rw, markup(a.comment))
-    end
-
-    cls_desc.constants = cls.constants.map do |c|
-      RDoc::RI::Constant.new(c.name, c.value, markup(c.comment))
-    end
-
-    cls_desc.includes = cls.includes.map do |i|
-      RDoc::RI::IncludedModule.new(i.name)
-    end
-
-    class_methods, instance_methods = method_list(cls)
+    RDoc::TopLevel.all_classes_and_modules.each do |klass|
+      @current = "#{klass.class}: #{klass.full_name}"
 
-    cls_desc.class_methods = class_methods.map do |m|
-      RDoc::RI::MethodSummary.new(m.name)
-    end
-
-    cls_desc.instance_methods = instance_methods.map do |m|
-      RDoc::RI::MethodSummary.new(m.name)
-    end
+      @store.save_class klass
 
-    update_or_replace(cls_desc)
-
-    class_methods.each do |m|
-      generate_method_info(cls_desc, m)
-    end
+      klass.each_method do |method|
+        @current = "#{method.class}: #{method.full_name}"
+        @store.save_method klass, method
+      end
 
-    instance_methods.each do |m|
-      generate_method_info(cls_desc, m)
+      klass.each_attribute do |attribute|
+        @store.save_method klass, attribute
+      end
     end
-  end
 
-  def generate_method_info(cls_desc, method)
-    meth_desc = RDoc::RI::MethodDescription.new
-    meth_desc.name = method.name
-    meth_desc.full_name = cls_desc.full_name
-    if method.singleton
-      meth_desc.full_name += "::"
-    else
-      meth_desc.full_name += "#"
-    end
-    meth_desc.full_name << method.name
+    @current = 'saving cache'
 
-    meth_desc.comment = markup(method.comment)
-    meth_desc.params = params_of(method)
-    meth_desc.visibility = method.visibility.to_s
-    meth_desc.is_singleton = method.singleton
-    meth_desc.block_params = method.block_params
+    @store.save_cache
 
-    meth_desc.aliases = method.aliases.map do |a|
-      RDoc::RI::AliasName.new(a.name)
-    end
+  ensure
+    @current = nil
 
-    @ri_writer.add_method(cls_desc, meth_desc)
+    remove_siginfo_handler
   end
 
-  private
-
   ##
-  # Returns a list of class and instance methods that we'll be documenting
-
-  def method_list(cls)
-    list = cls.method_list
-    unless @options.show_all
-      list = list.find_all do |m|
-        m.visibility == :public || m.visibility == :protected || m.force_documentation
-      end
-    end
+  # Installs a siginfo handler that prints the current filename.
 
-    c = []
-    i = []
-    list.sort.each do |m|
-      if m.singleton
-        c << m
-      else
-        i << m
-      end
-    end
-    return c,i
-  end
+  def install_siginfo_handler
+    return unless Signal.list.key? 'INFO'
 
-  def params_of(method)
-    if method.call_seq
-      method.call_seq
-    else
-      params = method.params || ""
-
-      p = params.gsub(/\s*\#.*/, '')
-      p = p.tr("\n", " ").squeeze(" ")
-      p = "(" + p + ")" unless p[0] == ?(
-
-      if (block = method.block_params)
-        block.gsub!(/\s*\#.*/, '')
-        block = block.tr("\n", " ").squeeze(" ")
-        if block[0] == ?(
-          block.sub!(/^\(/, '').sub!(/\)/, '')
-        end
-        p << " {|#{block.strip}| ...}"
-      end
-      p
+    @old_siginfo = trap 'INFO' do
+      puts @current if @current
     end
   end
 
-  def markup(comment)
-    return nil if !comment || comment.empty?
-
-    # Convert leading comment markers to spaces, but only
-    # if all non-blank lines have them
-
-    if comment =~ /^(?>\s*)[^\#]/
-      content = comment
-    else
-      content = comment.gsub(/^\s*(#+)/)  { $1.tr('#',' ') }
-    end
-    @markup.convert(content, @to_flow)
-  end
-
   ##
-  # By default we replace existing classes with the same name. If the
-  # --merge option was given, we instead merge this definition into an
-  # existing class. We add our methods, aliases, etc to that class, but do
-  # not change the class's description.
-
-  def update_or_replace(cls_desc)
-    old_cls = nil
-
-    if @options.merge
-      rdr = RDoc::RI::Reader.new RDoc::RI::Cache.new(@options.op_dir)
-
-      namespace = rdr.top_level_namespace
-      namespace = rdr.lookup_namespace_in(cls_desc.name, namespace)
-      if namespace.empty?
-        $stderr.puts "You asked me to merge this source into existing "
-        $stderr.puts "documentation. This file references a class or "
-        $stderr.puts "module called #{cls_desc.name} which I don't"
-        $stderr.puts "have existing documentation for."
-        $stderr.puts
-        $stderr.puts "Perhaps you need to generate its documentation first"
-        exit 1
-      else
-        old_cls = namespace[0]
-      end
-    end
-
-    prev_cls = @generated[cls_desc.full_name]
+  # Removes a siginfo handler and replaces the previous
 
-    if old_cls and not prev_cls then
-      old_desc = rdr.get_class old_cls
-      cls_desc.merge_in old_desc
-    end
-
-    if prev_cls then
-      cls_desc.merge_in prev_cls
-    end
+  def remove_siginfo_handler
+    return unless Signal.list.key? 'INFO'
 
-    @generated[cls_desc.full_name] = cls_desc
+    handler = @old_siginfo || 'DEFAULT'
 
-    @ri_writer.remove_class cls_desc
-    @ri_writer.add_class cls_desc
+    trap 'INFO', handler
   end
 
 end

data/lib/rdoc/generator/template/darkfish/classpage.rhtml

@@ -22,6 +22,16 @@
 <body class="<%= klass.type %>">
 
 	<div id="metadata">
+		<div id="home-metadata">
+			<div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="<%= rel_prefix %>/index.html">Home</a>
+          <a href="<%= rel_prefix %>/index.html#classes">Classes</a>
+          <a href="<%= rel_prefix %>/index.html#methods">Methods</a>
+        </h3>
+			</div>
+		</div>
+
 		<div id="file-metadata">
 			<div id="file-list-section" class="section">
 				<h3 class="section-header">In Files</h3>
@@ -217,7 +227,7 @@
 
 				<div class="method-heading">
 				<% if method.call_seq %>
-					<span class="method-callseq"><%= method.call_seq.strip.gsub(/->/, '&rarr;').gsub( /^\w.*?\./m, '') %></span>
+					<span class="method-callseq"><%= method.call_seq.strip.gsub(/->/, '&rarr;').gsub( /^\w.+\./m, '') %></span>
 					<span class="method-click-advice">click to toggle source</span>
 				<% else %>
 					<span class="method-name"><%= h method.name %></span><span
@@ -250,6 +260,12 @@
 					end.join(", ") %>
 				</div>
 				<% end %>
+
+				<% if method.is_alias_for then %>
+				<div class="aliases">
+          Alias for: <a href="<%= klass.aref_to method.is_alias_for.path %>"><%= h method.is_alias_for.name %></a>
+				</div>
+				<% end %>
 			</div>
 
 		<% end %>

data/lib/rdoc/generator/template/darkfish/filepage.rhtml

@@ -23,6 +23,16 @@
 <% if file.parser == RDoc::Parser::Simple %>
 <body class="file">
 	<div id="metadata">
+		<div id="home-metadata">
+			<div id="home-section" class="section">
+        <h3 class="section-header">
+          <a href="<%= rel_prefix %>/index.html">Home</a>
+          <a href="<%= rel_prefix %>/index.html#classes">Classes</a>
+          <a href="<%= rel_prefix %>/index.html#methods">Methods</a>
+        </h3>
+			</div>
+		</div>
+
 		<div id="project-metadata">
 			<% simple_files = @files.select { |f| f.parser == RDoc::Parser::Simple } %>
 			<% unless simple_files.empty? then %>

data/lib/rdoc/generator/template/darkfish/index.rhtml

@@ -39,14 +39,14 @@
 	</ul>
 	<% end %>
 
-	<h2>Classes/Modules</h2>
+	<h2 id="classes">Classes/Modules</h2>
 	<ul>
 		<% @modsort.each do |klass| %>
 		<li class="<%= klass.type %>"><a href="<%= klass.path %>"><%= klass.full_name %></a></li>
 		<% end %>
 	</ul>
 
-	<h2>Methods</h2>
+	<h2 id="methods">Methods</h2>
 	<ul>
 		<% RDoc::TopLevel.all_classes_and_modules.map do |mod|
 				 mod.method_list