rdoc 2.4.3 → 2.5

data/.autotest

@@ -1,5 +1,7 @@
 # vim: filetype=ruby
 
+require 'autotest/restart'
+
 Autotest.add_hook :initialize do |at|
   at.testlib = 'minitest/unit' if at.respond_to? :testlib=
 
@@ -8,7 +10,7 @@ Autotest.add_hook :initialize do |at|
     f = s.sub(/^test#{sep}/, '').sub(/\.rb$/, '').split(sep)
     f = f.map { |path| path.split(/_|(\d+)/).map { |seg| seg.capitalize }.join }
     f = f.map { |path| path =~ /^Test/ ? path : "Test#{path}"  }
-    f.join('::').sub 'Rdoc', 'RDoc'
+    f.join('::').sub('Rdoc', 'RDoc').sub('Ri', 'RI')
   end
 end
 

data/History.txt

@@ -1,3 +1,71 @@
+=== 2.5 / 2010-03-31
+
+*NOTE*:
+
+You'll need to:
+
+  gem install rdoc-data
+
+then run:
+
+  rdoc-data
+
+to have ri data for core and stdlib like Array or Kernel or Date.
+
+* 9 Major Enhancements
+  * Darkfish now has a "Home" button
+  * ri no longer displays the value of a constant.  There's no easy way to
+    make them presentable.  Use irb or ruby -e instead.  Ruby Bug #549.
+  * New ri data format now uses Marshal and pre-builds caches
+    * No support for old ri data format, too hard to maintain
+    * To upgrade your core ri documentation, install the rdoc-data gem and run
+      rdoc-data
+  * RDoc now displays how well you've documented your library
+  * New recursive-descent parser for RDoc::Markup.  See RDoc::Markup::Parser
+  * Updated ruby_lex and ruby_token
+  * Removed threading support, RDoc is not thread-safe
+  * Removed many unsupported options to rdoc
+  * Future versions of RDoc will not support Ruby 1.8.6.  Bugs filed for
+    1.8.6-only issues will be (largely) rejected.
+
+* 17 Minor Enhancements
+  * Source Parsing
+   * RDoc now supports module aliasing via constant assignment.
+   * RDoc now tracks superclasses correctly.  Fixes File < IO for core docs.
+   * RDoc now ignores methods inside methods.
+   * RDoc now ignores Marshal and other binray files.
+   * Removed "Skipping require of dynamic string" warning.
+   * C parser now handles Document-method better.  Bug #27329.
+   * API enhancements for writing parsers like the Ruby parser, see
+     RDoc::Parser::RubyTools
+  * ri
+    * Uses pager over less and more for Debian.  Ruby Bug #1171.
+    * ri will use the RI_PAGER environment variable to find a pager.
+    * ri data generator now supports SIGINFO (^T)
+  * When rdoc is in debug mode, ^C now prints a backtrace
+  * RDoc::Markup::AttributeManager no longer uses global state.
+  * RDoc::RDoc no longer passes around options.  Patch #27167.
+  * Darkfish won't generate a file if its template is missing.  Patch #25857.
+  * Improved some wording for the RDoc main page.  Patch #27264, #27268.
+  * Removed diagram generation support (to return in the future).
+  * Removed external support for RDoc::Task.
+
+* 12 Bug Fixes
+  * The :attr: directives now use the name given to create an attribute.  See
+    RDoc::Parser::Ruby#parse_meta_attr.
+  * Fix crossrefs on paths with '-'.  Ruby Bug #883.
+  * Fix ruby parser for alias with = in the name.  Bug #27522.
+  * Images are no longer executable.  Bug #27156.
+  * --op is no longer overridden by --ri.  Bug #27054.
+  * :method: now works when at the end of a class.  Bug #26910.
+  * Preserve elipsis from call-seq in Darkfish.  Patch #26974.
+  * Emacs-style <tt>coding:</tt> is handled properly.  Patch #27388.
+  * RDoc::RubyLex now parses UTF-8 identifiers.  Bug #26946, #26947.
+  * Fixed namespace lookup rules.  Bug #26161.
+  * Worked around bug in Selenium where they hide a .jar in a .txt file.
+    Filed Selenium bug #27789.
+  * Alias comments are no longer hidden.  Reported by Adam Avilla.
+
 === 2.4.3 / 2009-04-01
 
 * 2 Bug Fixes

data/LICENSE.txt

@@ -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,6 +1,7 @@
 .autotest
 .document
 History.txt
+LICENSE.txt
 Manifest.txt
 README.txt
 RI.txt
@@ -12,14 +13,12 @@ lib/rdoc/alias.rb
 lib/rdoc/anon_class.rb
 lib/rdoc/any_method.rb
 lib/rdoc/attr.rb
-lib/rdoc/cache.rb
 lib/rdoc/class_module.rb
 lib/rdoc/code_object.rb
 lib/rdoc/code_objects.rb
 lib/rdoc/constant.rb
 lib/rdoc/context.rb
-lib/rdoc/diagram.rb
-lib/rdoc/dot.rb
+lib/rdoc/gauntlet.rb
 lib/rdoc/generator.rb
 lib/rdoc/generator/darkfish.rb
 lib/rdoc/generator/markup.rb
@@ -58,17 +57,25 @@ lib/rdoc/include.rb
 lib/rdoc/known_classes.rb
 lib/rdoc/markup.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/fragments.rb
+lib/rdoc/markup/formatter_test_case.rb
+lib/rdoc/markup/heading.rb
 lib/rdoc/markup/inline.rb
-lib/rdoc/markup/lines.rb
+lib/rdoc/markup/list.rb
+lib/rdoc/markup/list_item.rb
+lib/rdoc/markup/paragraph.rb
+lib/rdoc/markup/parser.rb
 lib/rdoc/markup/preprocess.rb
-lib/rdoc/markup/to_flow.rb
+lib/rdoc/markup/rule.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_latex.rb
+lib/rdoc/markup/to_rdoc.rb
 lib/rdoc/markup/to_test.rb
-lib/rdoc/markup/to_texinfo.rb
+lib/rdoc/markup/verbatim.rb
 lib/rdoc/meta_method.rb
 lib/rdoc/normal_class.rb
 lib/rdoc/normal_module.rb
@@ -77,50 +84,61 @@ lib/rdoc/parser.rb
 lib/rdoc/parser/c.rb
 lib/rdoc/parser/perl.rb
 lib/rdoc/parser/ruby.rb
+lib/rdoc/parser/ruby_tools.rb
 lib/rdoc/parser/simple.rb
 lib/rdoc/rdoc.rb
 lib/rdoc/require.rb
 lib/rdoc/ri.rb
-lib/rdoc/ri/cache.rb
-lib/rdoc/ri/descriptions.rb
-lib/rdoc/ri/display.rb
 lib/rdoc/ri/driver.rb
 lib/rdoc/ri/formatter.rb
 lib/rdoc/ri/paths.rb
-lib/rdoc/ri/reader.rb
-lib/rdoc/ri/util.rb
-lib/rdoc/ri/writer.rb
+lib/rdoc/ri/store.rb
+lib/rdoc/ruby_lex.rb
+lib/rdoc/ruby_token.rb
 lib/rdoc/single_class.rb
 lib/rdoc/stats.rb
 lib/rdoc/task.rb
+lib/rdoc/text.rb
 lib/rdoc/tokenstream.rb
 lib/rdoc/top_level.rb
 test/binary.dat
+test/hidden.zip.txt
 test/test.ja.rdoc
 test/test.ja.txt
 test/test_attribute_manager.rb
 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_constant.rb
 test/test_rdoc_context.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_paragraph.rb
+test/test_rdoc_markup_parser.rb
+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_rdoc.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_perl.rb
 test/test_rdoc_parser_ruby.rb
+test/test_rdoc_parser_simple.rb
+test/test_rdoc_rdoc.rb
 test/test_rdoc_require.rb
-test/test_rdoc_ri_attribute_formatter.rb
-test/test_rdoc_ri_default_display.rb
 test/test_rdoc_ri_driver.rb
-test/test_rdoc_ri_formatter.rb
-test/test_rdoc_ri_html_formatter.rb
-test/test_rdoc_ri_overstrike_formatter.rb
+test/test_rdoc_ri_paths.rb
+test/test_rdoc_ri_store.rb
 test/test_rdoc_task.rb
+test/test_rdoc_text.rb
 test/test_rdoc_top_level.rb
 test/xref_data.rb
 test/xref_test_case.rb

data/README.txt

@@ -24,16 +24,6 @@ See RDoc for a description of RDoc's markup and basic use.
 
 == BUGS:
 
-The markup engine has lots of little bugs.  In particular:
-* Escaping does not work for all markup.
-* Typesetting is not always correct.
-* Some output formats (ri, for example) do not correctly handle all of the
-  markup.
-
-RDoc has some subtle bugs processing classes that are split across multiple
-files (bugs that may or may not manifest depending on the order in which
-the files are encountered).  This issue can be tracked here[http://rubyforge.org/tracker/index.php?func=detail&aid=22135&group_id=627&atid=2475].
-
 If you find a bug, please report it at the RDoc project's
 tracker[http://rubyforge.org/tracker/?group_id=627] on RubyForge:
 
@@ -43,5 +33,5 @@ RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers.
 Portions (c) 2007-2009 Eric Hodel.  Portions copyright others, see individual
 files for details.
 
-It is free software, and may be redistributed under the terms specified in the
-README file of the Ruby distribution.
+It is free software, and may be redistributed under the terms specified in
+LICENSE.txt.

data/Rakefile

@@ -1,21 +1,21 @@
 require 'hoe'
+$:.unshift 'lib'
+require 'rdoc/rdoc'
 
 $rdoc_rakefile = true
 
-$:.unshift 'lib'
-require 'rdoc'
+Hoe.spec 'rdoc' do
+  developer 'Eric Hodel', 'drbrain@segment7.net'
+  developer 'Dave Thomas', ''
+  developer 'Phil Hagelberg', 'technomancy@gmail.com'
+  developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
 
-Hoe.new "rdoc", RDoc::VERSION do |rdoc|
-  rdoc.developer 'Eric Hodel', 'drbrain@segment7.net'
-  rdoc.developer 'Dave Thomas', ''
-  rdoc.developer 'Phil Hagelberg', 'technomancy@gmail.com'
-  rdoc.developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
-  rdoc.remote_rdoc_dir = ''
-  rdoc.testlib = :minitest
+  self.remote_rdoc_dir = ''
+  self.testlib = :minitest
 
-  rdoc.extra_dev_deps << ['minitest', '~> 1.3']
-  rdoc.spec_extras['required_rubygems_version'] = '>= 1.3'
-  rdoc.spec_extras['homepage'] = 'http://rdoc.rubyforge.org'
+  extra_dev_deps << ['minitest', '~> 1.3']
+  spec_extras['required_rubygems_version'] = '>= 1.3'
+  spec_extras['homepage'] = 'http://rdoc.rubyforge.org'
 end
 
 # These tasks expect to have the following directory structure:

data/bin/rdoc

@@ -13,10 +13,6 @@ require 'rdoc/rdoc'
 begin
   r = RDoc::RDoc.new
   r.document ARGV
-rescue Interrupt
-  $stderr.puts
-  $stderr.puts "Interrupted"
-  exit 1
 rescue SystemExit
   raise
 rescue Exception => e
@@ -24,12 +20,16 @@ rescue Exception => e
     $stderr.puts e.message
     $stderr.puts "#{e.backtrace.join "\n\t"}"
     $stderr.puts
+  elsif Interrupt === e then
+    $stderr.puts
+    $stderr.puts 'Interrupted'
   else
     $stderr.puts "uh-oh! RDoc had a problem:"
     $stderr.puts e.message
     $stderr.puts
     $stderr.puts "run with --debug for full backtrace"
   end
+
   exit 1
 end
 

data/lib/rdoc.rb

@@ -19,7 +19,8 @@ $DEBUG_RDOC = nil
 #
 # * If you want to use RDoc to create documentation for your Ruby source files,
 #   read on.
-# * If you want to include extensions written in C, see RDoc::Parser::C
+# * If you want to generate documentation for extensions written in C, see
+#   RDoc::Parser::C
 # * If you want to drive RDoc programmatically, see RDoc::RDoc.
 # * If you want to use the library to format text blocks into HTML, have a look
 #   at RDoc::Markup.
@@ -33,6 +34,7 @@ $DEBUG_RDOC = nil
 #   % rdoc [options] [names...]
 #
 # For an up-to-date option summary, type
+#
 #   % rdoc --help
 #
 # A typical use might be to generate documentation for a package of Ruby
@@ -72,7 +74,7 @@ $DEBUG_RDOC = nil
 # always will override those in +RDOCOPT+.
 #
 # Run:
-# 
+#
 #   rdoc --help
 #
 # for full details on rdoc's options.
@@ -219,7 +221,7 @@ $DEBUG_RDOC = nil
 #   [<tt>\<b>text...</b></tt>]    displays word in a *bold* font
 #   [<tt>\<em>text...</em></tt>]  displays word in an _emphasized_ font
 #   [<tt>\<i>text...</i></tt>]    displays word in an <i>italicized</i> font
-#   [<tt>\<tt>text...\</tt></tt>]  displays word in a +code+ font
+#   [<tt>\<tt>text...\</tt></tt>] displays word in a +code+ font
 #
 #   Unlike conventional Wiki markup, general markup can cross line
 #   boundaries.  You can turn off the interpretation of markup by
@@ -330,6 +332,8 @@ $DEBUG_RDOC = nil
 #   last.  If you don't specify a +:startdoc:+ by the end of the container,
 #   disables documentation for the entire class or module.
 #
+# Further directives can be found in RDoc::Parser::Ruby and RDoc::Parser::C
+#
 # == Other stuff
 #
 # RDoc is currently being maintained by Eric Hodel <drbrain@segment7.net>
@@ -342,9 +346,6 @@ $DEBUG_RDOC = nil
 #   work of Keiju ISHITSUKA of Nippon Rational Inc, who produced the Ruby
 #   parser for irb and the rtags package.
 #
-# * Code to diagram classes and modules was written by Sergey A Yanovitsky
-#   (Jah) of Enticla.
-#
 # * Charset patch from MoonWolf.
 #
 # * Rich Kilmer wrote the kilmer.rb output template.
@@ -370,12 +371,19 @@ module RDoc
 
   class Error < RuntimeError; end
 
-  RDocError = Error # :nodoc:
+  def self.const_missing const_name # :nodoc:
+    if const_name.to_s == 'RDocError' then
+      warn "RDoc::RDocError is deprecated"
+      return Error
+    end
+
+    super
+  end
 
   ##
   # RDoc version you are using
 
-  VERSION = '2.4.3'
+  VERSION = '2.5'
 
   ##
   # Name of the dotfile that contains the description of files to be processed
@@ -383,14 +391,29 @@ module RDoc
 
   DOT_DOC_FILENAME = ".document"
 
+  ##
+  # General RDoc modifiers
+
   GENERAL_MODIFIERS = %w[nodoc].freeze
 
+  ##
+  # RDoc modifiers for classes
+
   CLASS_MODIFIERS = GENERAL_MODIFIERS
 
-  ATTR_MODIFIERS  = GENERAL_MODIFIERS
+  ##
+  # RDoc modifiers for attributes
+
+  ATTR_MODIFIERS = GENERAL_MODIFIERS
+
+  ##
+  # RDoc modifiers for constants
 
   CONSTANT_MODIFIERS = GENERAL_MODIFIERS
 
+  ##
+  # RDoc modifiers for methods
+
   METHOD_MODIFIERS = GENERAL_MODIFIERS +
     %w[arg args yield yields notnew not-new not_new doc]