rdoc 3.12.2 → 4.0.0.preview2

data/lib/rdoc/generator/json_index.rb

@@ -15,9 +15,9 @@ require 'json'
 #       @json_index = RDoc::Generator::JsonIndex.new self, options
 #     end
 #
-#     def generate top_levels
+#     def generate
 #       # ...
-#       @json_index.generate top_levels
+#       @json_index.generate
 #     end
 #   end
 #
@@ -88,7 +88,8 @@ class RDoc::Generator::JsonIndex
 
   def initialize parent_generator, options
     @parent_generator = parent_generator
-    @options = options
+    @store            = parent_generator.store
+    @options          = options
 
     @template_dir = File.expand_path '../template/json_index', __FILE__
     @base_dir = @parent_generator.base_dir
@@ -98,6 +99,19 @@ class RDoc::Generator::JsonIndex
     @index   = nil
   end
 
+  ##
+  # Builds the JSON index as a Hash.
+
+  def build_index
+    reset @store.all_files.sort, @store.all_classes_and_modules.sort
+
+    index_classes
+    index_methods
+    index_pages
+
+    { :index => @index }
+  end
+
   ##
   # Output progress information if debugging is enabled
 
@@ -107,19 +121,13 @@ class RDoc::Generator::JsonIndex
   end
 
   ##
-  # Creates the JSON index.
+  # Writes the JSON index to disk
 
-  def generate top_levels
+  def generate
     debug_msg "Generating JSON index"
 
-    reset top_levels.sort, RDoc::TopLevel.all_classes_and_modules.sort
-
-    index_classes
-    index_methods
-    index_pages
-
     debug_msg "  writing search index to %s" % SEARCH_INDEX_FILE
-    data = { :index => @index }
+    data = build_index
 
     return if @options.dry_run
 

data/lib/rdoc/generator/markup.rb

@@ -1,4 +1,3 @@
-
 ##
 # Handle common RDoc::Markup tasks for various CodeObjects
 #
@@ -34,12 +33,10 @@ module RDoc::Generator::Markup
   def formatter
     return @formatter if defined? @formatter
 
-    show_hash = RDoc::RDoc.current.options.show_hash
-    hyperlink_all = RDoc::RDoc.current.options.hyperlink_all
+    options = @store.rdoc.options
     this = RDoc::Context === self ? self : @parent
 
-    @formatter = RDoc::Markup::ToHtmlCrossref.new(this.path, this, show_hash,
-                                                  hyperlink_all)
+    @formatter = RDoc::Markup::ToHtmlCrossref.new options, this.path, this
     @formatter.code_object = self
     @formatter
   end
@@ -47,7 +44,7 @@ module RDoc::Generator::Markup
   ##
   # 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
-  # sprintf'd into +url+ instead.
+  # will replace the %s using sprintf on the +url+.
 
   def cvs_url(url, full_path)
     if /%s/ =~ url then
@@ -65,7 +62,7 @@ class RDoc::CodeObject
 
 end
 
-class RDoc::AnyMethod
+class RDoc::MethodAttr
 
   @add_line_numbers = false
 
@@ -83,7 +80,8 @@ class RDoc::AnyMethod
   #
   #   # File xxxxx, line dddd
   #
-  # If it has, line numbers are added an ', line dddd' is removed.
+  # If it has this comment then line numbers are added to +src+ and the <tt>,
+  # line dddd</tt> portion of the comment is removed.
 
   def add_line_numbers(src)
     return unless src.sub!(/\A(.*)(, line (\d+))/, '\1')
@@ -127,7 +125,7 @@ class RDoc::AnyMethod
     end
     src.gsub!(/^#{' ' * indent}/, '') if indent > 0
 
-    add_line_numbers(src) if self.class.add_line_numbers
+    add_line_numbers(src) if RDoc::MethodAttr.add_line_numbers
 
     src
   end
@@ -158,12 +156,12 @@ class RDoc::TopLevel
   # command line option to set.
 
   def cvs_url
-    url = RDoc::RDoc.current.options.webcvs
+    url = @store.rdoc.options.webcvs
 
     if /%s/ =~ url then
-      url % @absolute_name
+      url % @relative_name
     else
-      url + @absolute_name
+      url + @relative_name
     end
   end
 

data/lib/rdoc/generator/ri.rb

@@ -13,70 +13,17 @@ class RDoc::Generator::RI
   ##
   # Set up a new ri generator
 
-  def initialize options #:not-new:
-    @options     = options
-    @old_siginfo = nil
-    @current     = nil
-
-    @store          = RDoc::RI::Store.new '.'
-    @store.dry_run  = @options.dry_run
-    @store.encoding = @options.encoding if @options.respond_to? :encoding
+  def initialize store, options #:not-new:
+    @options    = options
+    @store      = store
+    @store.path = '.'
   end
 
   ##
-  # Build the initial indices and output objects based on an array of TopLevel
-  # objects containing the extracted information.
-
-  def generate top_levels
-    install_siginfo_handler
-
-    @store.load_cache
-
-    RDoc::TopLevel.all_classes_and_modules.each do |klass|
-      @current = "#{klass.class}: #{klass.full_name}"
-
-      @store.save_class klass
-
-      klass.each_method do |method|
-        @current = "#{method.class}: #{method.full_name}"
-        @store.save_method klass, method
-      end
-
-      klass.each_attribute do |attribute|
-        @store.save_method klass, attribute
-      end
-    end
-
-    @current = 'saving cache'
-
-    @store.save_cache
-
-  ensure
-    @current = nil
-
-    remove_siginfo_handler
-  end
-
-  ##
-  # Installs a siginfo handler that prints the current filename.
-
-  def install_siginfo_handler
-    return unless Signal.list.key? 'INFO'
-
-    @old_siginfo = trap 'INFO' do
-      puts @current if @current
-    end
-  end
-
-  ##
-  # Removes a siginfo handler and replaces the previous
-
-  def remove_siginfo_handler
-    return unless Signal.list.key? 'INFO'
-
-    handler = @old_siginfo || 'DEFAULT'
+  # Writes the parsed data store to disk for use by ri.
 
-    trap 'INFO', handler
+  def generate
+    @store.save
   end
 
 end

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

@@ -2,15 +2,15 @@
 
 <title><%= h @title %></title>
 
-<link type="text/css" media="screen" href="<%= rel_prefix %>/rdoc.css" rel="stylesheet">
+<link type="text/css" media="screen" href="<%= asset_rel_prefix %>/rdoc.css" rel="stylesheet">
 
 <script type="text/javascript">
   var rdoc_rel_prefix = "<%= rel_prefix %>/";
 </script>
 
-<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/jquery.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/navigation.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/search_index.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/search.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/searcher.js"></script>
-<script type="text/javascript" charset="utf-8" src="<%= rel_prefix %>/js/darkfish.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/jquery.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/navigation.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= search_index_rel_prefix %>/js/search_index.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/search.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/searcher.js"></script>
+<script type="text/javascript" charset="utf-8" src="<%= asset_rel_prefix %>/js/darkfish.js"></script>

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

@@ -0,0 +1,16 @@
+<% unless klass.extends.empty? then %>
+<!-- Extension Modules -->
+<nav id="extends-section" class="section">
+  <h3 class="section-header">Extended With Modules</h3>
+
+  <ul class="link-list">
+    <% klass.each_extend do |ext| %>
+  <% unless String === ext.module then %>
+    <li><a class="extend" href="<%= klass.aref_to ext.module.path %>"><%= ext.module.full_name %></a>
+  <% else %>
+    <li><span class="extend"><%= ext.name %></span>
+  <% end %>
+  <% end %>
+  </ul>
+</nav>
+<% end %>

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

@@ -2,7 +2,7 @@
   <h3 class="section-header">Defined In</h3>
   <ul>
 <% klass.in_files.each do |tl| %>
-    <li><%= h tl.absolute_name %>
+    <li><%= h tl.relative_name %>
 <% end %>
   </ul>
 </nav>

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

@@ -0,0 +1,14 @@
+<nav id="home-section" class="section">
+  <h3 class="section-header">Documentation</h3>
+
+  <ul>
+  <% installed.each do |name, href, exists| %>
+    <li class="folder">
+    <% if exists then %>
+      <a href="<%= href %>"><%= h name %></a>
+    <% else %>
+      <%= h name %>
+    <% end %>
+  <% end %>
+  </ul>
+</nav>

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

@@ -5,7 +5,7 @@
 
   <ul class="link-list">
     <% klass.each_method do |meth| %>
-    <li><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
+    <li <% if meth.calls_super %>class="calls-super" <% end %>><a href="#<%= meth.aref %>"><%= meth.singleton ? '::' : '#' %><%= h meth.name %></a>
     <% end %>
   </ul>
 </nav>

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

@@ -0,0 +1,13 @@
+<% table = current.parse(current.comment).table_of_contents
+   if table.length > 1 then %>
+<div id="table-of-contents">
+  <nav class="section">
+    <h3 class="section-header">Table of Contents</h3>
+    <ul>
+<%   table.each do |heading| %>
+      <li><a href="#<%= heading.aref %>"><%= heading.plain_html %></a>
+<%   end %>
+    </ul>
+  </nav>
+</div>
+<% end %>

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

@@ -4,6 +4,8 @@
 
   <%= render '_sidebar_search.rhtml' %>
 
+  <%= render '_sidebar_table_of_contents.rhtml' %>
+
   <div id="file-metadata">
     <%= render '_sidebar_in_files.rhtml' %>
     <%= render '_sidebar_VCS_info.rhtml' %>
@@ -13,6 +15,7 @@
     <%= render '_sidebar_sections.rhtml' %>
     <%= render '_sidebar_parent.rhtml' %>
     <%= render '_sidebar_includes.rhtml' %>
+    <%= render '_sidebar_extends.rhtml' %>
     <%= render '_sidebar_methods.rhtml' %>
   </div>
 
@@ -109,7 +112,7 @@
                   gsub( /^\w+\./m, '')).
                   gsub(/(.*)[-=]&gt;/, '\1&rarr;') %>
           </span>
-          <% if i == 0 then %>
+          <% if i == 0 and method.token_stream then %>
           <span class="method-click-advice">click to toggle source</span>
           <% end %>
         </div>
@@ -118,7 +121,9 @@
         <div class="method-heading">
           <span class="method-name"><%= h method.name %></span><span
             class="method-args"><%= method.param_seq %></span>
+          <% if method.token_stream then %>
           <span class="method-click-advice">click to toggle source</span>
+          <% end %>
         </div>
         <% end %>
 
@@ -128,6 +133,15 @@
           <% else %>
           <p class="missing-docs">(Not documented)
           <% end %>
+          <% if method.calls_super then %>
+            <div class="method-calls-super">
+              Calls superclass method
+              <%=
+                  method.superclass_method ?
+                  method.formatter.link(method.superclass_method.full_name, method.superclass_method.full_name) : nil
+              %>
+            </div>
+          <% end %>
 
           <% if method.token_stream then %>
           <div class="method-source-code" id="<%= method.html_name %>-source">

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

@@ -10,10 +10,10 @@
   </div>
 </nav>
 
-<% if @options.main_page && main_page = @files.find { |f| f.full_name == @options.main_page } then %>
 <div id="documentation" class="description">
-  <%= main_page.description %>
-</div>
+<% if @options.main_page && main_page = @files.find { |f| f.full_name == @options.main_page } then %>
+<%= main_page.description %>
 <% else %>
 <p>This is the API documentation for <%= @title %>.
 <% end %>
+</div>

data/lib/rdoc/generator/template/darkfish/js/darkfish.js

@@ -109,15 +109,13 @@ function hookSearch() {
 function highlightTarget( anchor ) {
   console.debug( "Highlighting target '%s'.", anchor );
 
-  $("a[name]").each( function() {
-    if ( $(this).attr("name") == anchor ) {
-      if ( !$(this).parent().parent().hasClass('target-section') ) {
-        console.debug( "Wrapping the target-section" );
-        $('div.method-detail').unwrap( 'div.target-section' );
-        $(this).parent().wrap( '<div class="target-section"></div>' );
-      } else {
-        console.debug( "Already wrapped." );
-      }
+  $("a[name=" + anchor + "]").each( function() {
+    if ( !$(this).parent().parent().hasClass('target-section') ) {
+      console.debug( "Wrapping the target-section" );
+      $('div.method-detail').unwrap( 'div.target-section' );
+      $(this).parent().wrap( '<div class="target-section"></div>' );
+    } else {
+      console.debug( "Already wrapped." );
     }
   });
 };

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

@@ -4,6 +4,8 @@
 
   <%= render '_sidebar_search.rhtml' %>
 
+  <%= render '_sidebar_table_of_contents.rhtml' %>
+
   <div id="project-metadata">
     <%= render '_sidebar_pages.rhtml' %>
     <%= render '_sidebar_classes.rhtml' %>

data/lib/rdoc/generator/template/darkfish/rdoc.css

@@ -6,6 +6,7 @@
  *
  */
 
+/* vim: ft=css et sw=2 ts=2 sts=2 */
 /* Base Green is: #6C8C22 */
 
 * { padding: 0; margin: 0; }
@@ -42,6 +43,16 @@ pre {
   padding: 0.5em 0;
 }
 
+blockquote {
+  background: #ddd;
+  margin: 1em;
+  padding: 0.25em;
+}
+
+blockquote > :first-child {
+  margin-top: 0 !important;
+}
+
 /* @group Generic Classes */
 
 .initially-hidden {
@@ -193,6 +204,15 @@ pre {
   list-style-image: url(images/page_green.png);
 }
 
+#table-of-contents {
+  margin-top: 2em;
+}
+
+#table-of-contents ul {
+  padding-left: 28px;
+  list-style-image: url(images/tag_blue.png);
+}
+
 dl.svninfo {
   color: #666;
   margin: 0;
@@ -203,7 +223,9 @@ dl.svninfo dt {
 
 ul.link-list li {
   white-space: nowrap;
+  line-height: 20px;
 }
+
 ul.link-list .type {
   font-size: 8px;
   text-transform: uppercase;
@@ -213,6 +235,10 @@ ul.link-list .type {
   -webkit-border-radius: 5px;
 }
 
+.calls-super {
+  background: url(images/arrow_up.png) no-repeat right center;
+}
+
 /* @end */
 
 /* @group Class Metadata Section */
@@ -385,6 +411,11 @@ ul.link-list .type {
   display: none;
 }
 
+#documentation .method-description .method-calls-super {
+  color: #333;
+  font-weight: bolder;
+}
+
 #documentation .method-detail {
   margin: 0.5em 0;
   padding: 0.5em 0;