rdoc 3.9.5 → 3.10.pre.1

data/.autotest

@@ -1,7 +1,10 @@
-# vim: filetype=ruby
-
 require 'autotest/restart'
-require 'autotest/isolate'
+
+Autotest.add_hook :run_command do |at|
+  at.unit_diff = 'cat'
+
+  system "#{Gem.ruby} -rubygems #{Gem.bin_path 'rake', 'rake'} generate"
+end
 
 Autotest.add_hook :initialize do |at|
   at.testlib = 'minitest/unit' if at.respond_to? :testlib=

data/History.txt

@@ -1,30 +1,80 @@
-=== 3.9.5 / 2013-02-05
+=== 3.10 / ??
 
-* Bug fixes
-  * Fixed an XSS exploit in darkfish.js.  This could lead to cookie disclosure
-    to third parties.  See CVE-2013-0256.rdoc for full details including a
-    patch you can apply to generated RDoc documentation.
+* Major enhancements
+  * RDoc HTML output has been reorganized.
+    * The search from Володя Колесников's sdoc has been integrated.
+
+      The search index generation is a reusable component through
+      RDoc::Generator::JsonIndex
+    * The table of contents is now a separate page and now shows links to
+      headings inside a page or class.
+    * Class pages no longer show the namespace and no longer have file info
+      pages.
+    * HTML output is now using HTML 5.
+  * RDoc supports additional documentation types:
+    * TomDoc 1.0.0-rc1
+    * RD format
+
+    The default markup can be set via the <tt>--markup</tt> option.
+
+    The format of documentation in a particular file can be specified by the
+    +:markup:+ directive.  If the :markup: directive is in the first comment
+    it is used as the default for the entire file.  For other comments it
+    overrides the default markup format.
 
-=== 3.9.4 / 2011-08-26
+* Minor enhancements
+  * HTML headings now have ids matching their titles.
 
-* Bug fixes
-  * Applied typo and grammar fixes from Luke Gruber.  Ruby bug #5203
+      = Hello!
 
-=== 3.9.3 / 2011-08-23
+    Is rendered as
 
-* Bug fixes
-  * Add US-ASCII magic comments to work with <tt>ruby -Ku</tt>.  Issue #63 by
-    Travis D. Warlick, Jr.
-  * Image paths at HTTPS URLs are now turned into +<img>+ tags.  Pull
+      <h1 id="label-Hello%21">Hello!</h1>
+
+  * Labels for classes or methods can be linked-to by adding an <tt>@</tt>
+    following the class or method reference.  For example,
+    <tt>RDoc::Markup@Links</tt>
+
+    See RDoc::Markup@Links for further details.
+  * RDoc now looks for a <tt>format: parser_name</tt> magic comment to choose
+    alternate documentation formats.  The format comment must be in the first
+    three lines of the file (to allow for a shebang or modeline).
+  * RDoc makes an effort to syntax-highlight ruby code in verbatim sections.
+    See RDoc::Markup@Paragraphs+and+Verbatim
+  * Added RDoc::TopLevel#text? and RDoc::Parser::Text to indicate a
+    parsed file contains no ruby constructs.
+  * Added <tt>rdoc-label</tt> link scheme which allows bidirectional links.
+    See RDoc::Markup for details.
+  * Image paths at HTTPS URLs will now be turned into +<img>+ tags.  Pull
     Request #60 by James Mead
+  * Added RDoc::Comment which encapsulates comment-handling functionality.
+  * Added RDoc::Markup::PreProcess::post_process to allow arbitrary comment
+    munging.
+  * RDoc::RDoc::current is set for the entire RDoc run.
+  * Split rdoc/markup/inline into individual files for its component classes.
+  * Moved token stream HTML markup out of RDoc::AnyMethod#markup_code into
+    RDoc::TokenStream::to_html
+  * "Top" link in section headers is no longer inside the heading element.
+
+* Bug fixes
   * Markup defined by RDoc::Markup#add_special inside a <tt><tt></tt> is no
     longer converted.
+  * Performance of RDoc::RubyLex has been improved.  Ruby Bug #5202 by Ryan
+    Melton.
+  * Add US-ASCII magic comments to work with <tt>ruby -Ku</tt>.  Issue #63 by
+    Travis D. Warlick, Jr.
+  * Clicking a link in the method description now works.  Issue #61 by Alan
+    Hogan.
+  * Fixed RDoc::Markup::Parser for CRLF line endings.  Issue #67 by Marvin
+    Gülker.
+  * Fixed lexing of percent strings like %r{#}.  Issue #68 by eclectic923.
 
 === 3.9.2 / 2011-08-11
 
 * Bug fix
   * Loosened TIDYLINK regexp to allow any content in the link section like:
     <tt>{foo}[rdoc-ref:SomeClass]</tt>
+  * In HTML output headings are capped at <tt><h6></tt> again
 
 === 3.9.1 / 2011-07-31
 

data/LICENSE.rdoc

@@ -0,0 +1,57 @@
+RDoc is copyrighted free software.
+
+You can redistribute it and/or modify it under either the terms of the GPL
+version 2 (see the file GPL), or the conditions below:
+
+1. You may make and give away verbatim copies of the source form of the
+   software without restriction, provided that you duplicate all of the
+   original copyright notices and associated disclaimers.
+
+2. You may modify your copy of the software in any way, provided that
+   you do at least ONE of the following:
+
+   a. place your modifications in the Public Domain or otherwise
+      make them Freely Available, such as by posting said
+      modifications to Usenet or an equivalent medium, or by allowing
+      the author to include your modifications in the software.
+
+   b. use the modified software only within your corporation or
+      organization.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+3. You may distribute the software in object code or binary form,
+   provided that you do at least ONE of the following:
+
+   a. distribute the binaries and library files of the software,
+      together with instructions (in the manual page or equivalent)
+      on where to get the original distribution.
+
+   b. accompany the distribution with the machine-readable source of
+      the software.
+
+   c. give non-standard binaries non-standard names, with
+      instructions on where to get the original software distribution.
+
+   d. make other distribution arrangements with the author.
+
+4. You may modify and include the part of the software into any other
+   software (possibly commercial).  But some files in the distribution
+   are not written by the author, so that they are not under these terms.
+
+   For the list of those files and their copying conditions, see the
+   file LEGAL.
+
+5. The scripts and library files supplied as input to or produced as
+   output from the software do not automatically fall under the
+   copyright of the software, but belong to whomever generated them,
+   and may be sold commercially, and may be aggregated with this
+   software.
+
+6. THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT ANY EXPRESS OR
+   IMPLIED WARRANTIES, INCLUDING, WITHOUT LIMITATION, THE IMPLIED
+   WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+   PURPOSE.

data/Manifest.txt

@@ -1,12 +1,12 @@
 .autotest
 .document
-CVE-2013-0256.rdoc
 History.txt
-LICENSE.txt
+LICENSE.rdoc
 Manifest.txt
 README.txt
 RI.txt
 Rakefile
+TODO.rdoc
 bin/rdoc
 bin/ri
 lib/rdoc.rb
@@ -17,19 +17,35 @@ lib/rdoc/attr.rb
 lib/rdoc/class_module.rb
 lib/rdoc/code_object.rb
 lib/rdoc/code_objects.rb
+lib/rdoc/comment.rb
 lib/rdoc/constant.rb
 lib/rdoc/context.rb
+lib/rdoc/context/section.rb
 lib/rdoc/cross_reference.rb
 lib/rdoc/encoding.rb
 lib/rdoc/erbio.rb
 lib/rdoc/gauntlet.rb
 lib/rdoc/generator.rb
 lib/rdoc/generator/darkfish.rb
+lib/rdoc/generator/json_index.rb
 lib/rdoc/generator/markup.rb
 lib/rdoc/generator/ri.rb
 lib/rdoc/generator/template/darkfish/.document
-lib/rdoc/generator/template/darkfish/classpage.rhtml
-lib/rdoc/generator/template/darkfish/filepage.rhtml
+lib/rdoc/generator/template/darkfish/_footer.rhtml
+lib/rdoc/generator/template/darkfish/_head.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_VCS_info.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_classes.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_in_files.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_includes.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_methods.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_navigation.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_pages.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_parent.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_search.rhtml
+lib/rdoc/generator/template/darkfish/_sidebar_sections.rhtml
+lib/rdoc/generator/template/darkfish/class.rhtml
+lib/rdoc/generator/template/darkfish/fileinfo.rhtml
+lib/rdoc/generator/template/darkfish/images/add.png
 lib/rdoc/generator/template/darkfish/images/brick.png
 lib/rdoc/generator/template/darkfish/images/brick_link.png
 lib/rdoc/generator/template/darkfish/images/bug.png
@@ -37,6 +53,7 @@ lib/rdoc/generator/template/darkfish/images/bullet_black.png
 lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png
 lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png
 lib/rdoc/generator/template/darkfish/images/date.png
+lib/rdoc/generator/template/darkfish/images/delete.png
 lib/rdoc/generator/template/darkfish/images/find.png
 lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif
 lib/rdoc/generator/template/darkfish/images/macFFBgHack.png
@@ -46,26 +63,35 @@ lib/rdoc/generator/template/darkfish/images/page_white_text.png
 lib/rdoc/generator/template/darkfish/images/page_white_width.png
 lib/rdoc/generator/template/darkfish/images/plugin.png
 lib/rdoc/generator/template/darkfish/images/ruby.png
+lib/rdoc/generator/template/darkfish/images/tag_blue.png
 lib/rdoc/generator/template/darkfish/images/tag_green.png
+lib/rdoc/generator/template/darkfish/images/transparent.png
 lib/rdoc/generator/template/darkfish/images/wrench.png
 lib/rdoc/generator/template/darkfish/images/wrench_orange.png
 lib/rdoc/generator/template/darkfish/images/zoom.png
 lib/rdoc/generator/template/darkfish/index.rhtml
 lib/rdoc/generator/template/darkfish/js/darkfish.js
 lib/rdoc/generator/template/darkfish/js/jquery.js
-lib/rdoc/generator/template/darkfish/js/quicksearch.js
-lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js
+lib/rdoc/generator/template/darkfish/js/search.js
+lib/rdoc/generator/template/darkfish/page.rhtml
 lib/rdoc/generator/template/darkfish/rdoc.css
+lib/rdoc/generator/template/darkfish/table_of_contents.rhtml
+lib/rdoc/generator/template/json_index/js/navigation.js
+lib/rdoc/generator/template/json_index/js/searcher.js
 lib/rdoc/ghost_method.rb
 lib/rdoc/include.rb
 lib/rdoc/known_classes.rb
 lib/rdoc/markup.rb
+lib/rdoc/markup/attr_changer.rb
+lib/rdoc/markup/attr_span.rb
+lib/rdoc/markup/attribute.rb
 lib/rdoc/markup/attribute_manager.rb
 lib/rdoc/markup/blank_line.rb
 lib/rdoc/markup/document.rb
 lib/rdoc/markup/formatter.rb
 lib/rdoc/markup/formatter_test_case.rb
 lib/rdoc/markup/heading.rb
+lib/rdoc/markup/include.rb
 lib/rdoc/markup/indented_paragraph.rb
 lib/rdoc/markup/inline.rb
 lib/rdoc/markup/list.rb
@@ -75,12 +101,16 @@ lib/rdoc/markup/parser.rb
 lib/rdoc/markup/pre_process.rb
 lib/rdoc/markup/raw.rb
 lib/rdoc/markup/rule.rb
+lib/rdoc/markup/special.rb
 lib/rdoc/markup/text_formatter_test_case.rb
 lib/rdoc/markup/to_ansi.rb
 lib/rdoc/markup/to_bs.rb
 lib/rdoc/markup/to_html.rb
 lib/rdoc/markup/to_html_crossref.rb
+lib/rdoc/markup/to_html_snippet.rb
+lib/rdoc/markup/to_label.rb
 lib/rdoc/markup/to_rdoc.rb
+lib/rdoc/markup/to_table_of_contents.rb
 lib/rdoc/markup/to_test.rb
 lib/rdoc/markup/to_tt_only.rb
 lib/rdoc/markup/verbatim.rb
@@ -91,9 +121,15 @@ lib/rdoc/normal_module.rb
 lib/rdoc/options.rb
 lib/rdoc/parser.rb
 lib/rdoc/parser/c.rb
+lib/rdoc/parser/rd.rb
 lib/rdoc/parser/ruby.rb
 lib/rdoc/parser/ruby_tools.rb
 lib/rdoc/parser/simple.rb
+lib/rdoc/parser/text.rb
+lib/rdoc/rd.rb
+lib/rdoc/rd/block_parser.ry
+lib/rdoc/rd/inline.rb
+lib/rdoc/rd/inline_parser.ry
 lib/rdoc/rdoc.rb
 lib/rdoc/require.rb
 lib/rdoc/ri.rb
@@ -110,8 +146,10 @@ lib/rdoc/stats/normal.rb
 lib/rdoc/stats/quiet.rb
 lib/rdoc/stats/verbose.rb
 lib/rdoc/task.rb
+lib/rdoc/test_case.rb
 lib/rdoc/text.rb
 lib/rdoc/token_stream.rb
+lib/rdoc/tom_doc.rb
 lib/rdoc/top_level.rb
 test/README
 test/binary.dat
@@ -126,18 +164,23 @@ test/test_rdoc_any_method.rb
 test/test_rdoc_attr.rb
 test/test_rdoc_class_module.rb
 test/test_rdoc_code_object.rb
+test/test_rdoc_comment.rb
 test/test_rdoc_constant.rb
 test/test_rdoc_context.rb
 test/test_rdoc_context_section.rb
 test/test_rdoc_cross_reference.rb
 test/test_rdoc_encoding.rb
 test/test_rdoc_generator_darkfish.rb
+test/test_rdoc_generator_json_index.rb
+test/test_rdoc_generator_markup.rb
 test/test_rdoc_generator_ri.rb
 test/test_rdoc_include.rb
 test/test_rdoc_markup.rb
 test/test_rdoc_markup_attribute_manager.rb
 test/test_rdoc_markup_document.rb
 test/test_rdoc_markup_formatter.rb
+test/test_rdoc_markup_heading.rb
+test/test_rdoc_markup_include.rb
 test/test_rdoc_markup_indented_paragraph.rb
 test/test_rdoc_markup_paragraph.rb
 test/test_rdoc_markup_parser.rb
@@ -147,16 +190,25 @@ test/test_rdoc_markup_to_ansi.rb
 test/test_rdoc_markup_to_bs.rb
 test/test_rdoc_markup_to_html.rb
 test/test_rdoc_markup_to_html_crossref.rb
+test/test_rdoc_markup_to_html_snippet.rb
+test/test_rdoc_markup_to_label.rb
 test/test_rdoc_markup_to_rdoc.rb
+test/test_rdoc_markup_to_table_of_contents.rb
 test/test_rdoc_markup_to_tt_only.rb
+test/test_rdoc_markup_verbatim.rb
 test/test_rdoc_method_attr.rb
 test/test_rdoc_normal_class.rb
 test/test_rdoc_normal_module.rb
 test/test_rdoc_options.rb
 test/test_rdoc_parser.rb
 test/test_rdoc_parser_c.rb
+test/test_rdoc_parser_rd.rb
 test/test_rdoc_parser_ruby.rb
 test/test_rdoc_parser_simple.rb
+test/test_rdoc_rd.rb
+test/test_rdoc_rd_block_parser.rb
+test/test_rdoc_rd_inline.rb
+test/test_rdoc_rd_inline_parser.rb
 test/test_rdoc_rdoc.rb
 test/test_rdoc_require.rb
 test/test_rdoc_ri_driver.rb
@@ -168,6 +220,8 @@ test/test_rdoc_single_class.rb
 test/test_rdoc_stats.rb
 test/test_rdoc_task.rb
 test/test_rdoc_text.rb
+test/test_rdoc_token_stream.rb
+test/test_rdoc_tom_doc.rb
 test/test_rdoc_top_level.rb
 test/xref_data.rb
 test/xref_test_case.rb

data/Rakefile

@@ -1,9 +1,16 @@
+$:.unshift File.expand_path 'lib'
+require 'rdoc'
 require 'hoe'
-$:.unshift 'lib'
-require 'rdoc/rdoc'
+
+task :docs    => :generate
+task :test    => :generate
+
+PARSER_FILES = %w[
+  lib/rdoc/rd/block_parser.rb
+  lib/rdoc/rd/inline_parser.rb
+]
 
 Hoe.plugin :git
-Hoe.plugin :isolate
 Hoe.plugin :minitest
 Hoe.plugin :rdoc_tags
 
@@ -19,7 +26,6 @@ Hoe.spec 'rdoc' do
   rdoc_locations << 'docs.seattlerb.org:/data/www/docs.seattlerb.org/rdoc/'
   rdoc_locations << 'drbrain@rubyforge.org:/var/www/gforge-projects/rdoc/'
 
-
   spec_extras[:post_install_message] = <<-MESSAGE
 Depending on your version of ruby, you may need to install ruby rdoc/ri data:
 
@@ -30,22 +36,28 @@ Depending on your version of ruby, you may need to install ruby rdoc/ri data:
   MESSAGE
 
   self.testlib = :minitest
-  if respond_to? :isolate_dir= then # HACK Hoe issue #7
-    self.isolate_dir = 'tmp/isolate'
-  else
-    warn 'please: gem install isolate'
-  end
+
+  self.clean_globs += PARSER_FILES
 
   require_ruby_version '>= 1.8.7'
+  extra_deps     << ['json',     '~> 1.4']
+  extra_dev_deps << ['racc',     '~> 1.4']
   extra_dev_deps << ['minitest', '~> 2']
-  extra_dev_deps << ['isolate',  '~> 3']
-  extra_dev_deps << ['ZenTest',  '~> 4'] # for autotest/isolate
+  extra_dev_deps << ['ZenTest',  '~> 4']
 
-  extra_rdoc_files << 'Rakefile' << 'CVE-2013-0256.rdoc'
+  extra_rdoc_files << 'Rakefile'
   spec_extras['required_rubygems_version'] = '>= 1.3'
   spec_extras['homepage'] = 'http://docs.seattlerb.org/rdoc'
 end
 
+task 'generate' => PARSER_FILES
+
+rule '.rb' => '.ry' do |t|
+  racc = Gem.bin_path 'racc', 'racc'
+
+  ruby "-rubygems #{racc} -l -o #{t.name} #{t.source}"
+end
+
 # These tasks expect to have the following directory structure:
 #
 #   git/git.rubini.us/code # Rubinius git HEAD checkout

data/TODO.rdoc

@@ -0,0 +1,30 @@
+Some file contains some things that might happen in RDoc, or might not
+
+=== RDoc 3.10
+
+* Copy static files into doc dir for HTML
+* Add sections to the ToC
+
+=== RDoc 3.11
+
+* Reload the RDoc tree from an RI store
+  * Re-run generators
+  * Parse only changed files (like in ruby)
+* Page of Glory (or Shame) in HTML output showing documentation coverage
+  statistics.
+* Link to the parent-class implementation of methods that use super
+
+=== RDoc 4
+
+API changes to RDoc
+
+* Remove RDoc::RDocError
+* RDoc::TopLevel#add_method should automatically create the appropriate method
+  class rather than requiring one be passed in.
+* Remove #comment= from Context subclasses in favor of #add_comment
+* RDoc::CodeObject
+  * Move into own namespace
+  * Rename TopLevel to File
+  * Rename Context to Container
+  * Rename NormalClass to Class
+