rdoc 2.3.0 → 2.4.0

data/.autotest

@@ -0,0 +1,14 @@
+# vim: filetype=ruby
+
+Autotest.add_hook :initialize do |at|
+  at.testlib = 'minitest/unit' if at.respond_to? :testlib=
+
+  def at.path_to_classname(s)
+    sep = File::SEPARATOR
+    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'
+  end
+end
+

data/History.txt

@@ -1,3 +1,30 @@
+=== 2.3.1 / ??
+
+* N Minor Enhancements
+  * `ri -f html` is now XHTML-happy
+  * Clarified RDoc::Markup link syntax.  Bug #23517 by Eric Armstrong.
+  * Number of threads to parse with is now configurable
+  * Darkfish can now use alternate templates from $LOAD_PATH via -T
+  * Removed F95 parser in favor of the rdoc-f95 gem
+  * Moved HTML and XML generators to unmaintained
+    * No gem will be provided as it's too difficult to make them work
+    * Removed options --one-file, --style=, --inline-source, --promiscuous,
+      --op-name
+  * Removed support for --accessor, use regular documentation or
+    the method directive instead.  See RDoc::Parser::Ruby
+  * Removed --ri-system as it is unused by Ruby's makefiles
+  * Added method list to index.html
+
+* N Bug Fixes
+  * nodoc'd classes no longer appear in the index.  Bug #23751 by Clifford
+    Heath.
+  * Fix 1.9 compatibility issues.  Bug #23815 by paddor.
+  * Darkfish now respects --charset
+  * RDoc no longer attempts to be lazy when building HTML.  This is a
+    workaround.  Bug #23893 by Stefano Crocco.
+  * RDoc doesn't crash with def (blah).foo() end
+  * RDoc doesn't crash with #define functions
+
 === 2.3.0 / 2009-01-28
 
 * 3 Major Enhancements

data/Manifest.txt

@@ -1,3 +1,4 @@
+.autotest
 .document
 History.txt
 Manifest.txt
@@ -7,16 +8,21 @@ Rakefile
 bin/rdoc
 bin/ri
 lib/rdoc.rb
+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/generator.rb
 lib/rdoc/generator/darkfish.rb
-lib/rdoc/generator/html.rb
-lib/rdoc/generator/html/common.rb
-lib/rdoc/generator/html/html.rb
-lib/rdoc/generator/html/one_page_html.rb
+lib/rdoc/generator/markup.rb
 lib/rdoc/generator/ri.rb
 lib/rdoc/generator/template/darkfish/.document
 lib/rdoc/generator/template/darkfish/classpage.rhtml
@@ -47,9 +53,8 @@ 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/rdoc.css
-lib/rdoc/generator/xml.rb
-lib/rdoc/generator/xml/rdf.rb
-lib/rdoc/generator/xml/xml.rb
+lib/rdoc/ghost_method.rb
+lib/rdoc/include.rb
 lib/rdoc/known_classes.rb
 lib/rdoc/markup.rb
 lib/rdoc/markup/attribute_manager.rb
@@ -64,14 +69,17 @@ lib/rdoc/markup/to_html_crossref.rb
 lib/rdoc/markup/to_latex.rb
 lib/rdoc/markup/to_test.rb
 lib/rdoc/markup/to_texinfo.rb
+lib/rdoc/meta_method.rb
+lib/rdoc/normal_class.rb
+lib/rdoc/normal_module.rb
 lib/rdoc/options.rb
 lib/rdoc/parser.rb
 lib/rdoc/parser/c.rb
-lib/rdoc/parser/f95.rb
 lib/rdoc/parser/perl.rb
 lib/rdoc/parser/ruby.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
@@ -82,23 +90,35 @@ lib/rdoc/ri/paths.rb
 lib/rdoc/ri/reader.rb
 lib/rdoc/ri/util.rb
 lib/rdoc/ri/writer.rb
+lib/rdoc/single_class.rb
 lib/rdoc/stats.rb
-lib/rdoc/template.rb
 lib/rdoc/tokenstream.rb
+lib/rdoc/top_level.rb
 test/binary.dat
 test/test.ja.rdoc
 test/test.ja.txt
 test/test_attribute_manager.rb
+test/test_rdoc_any_method.rb
+test/test_rdoc_code_object.rb
+test/test_rdoc_constant.rb
+test/test_rdoc_context.rb
+test/test_rdoc_include.rb
 test/test_rdoc_markup.rb
 test/test_rdoc_markup_attribute_manager.rb
 test/test_rdoc_markup_to_html.rb
 test/test_rdoc_markup_to_html_crossref.rb
+test/test_rdoc_normal_module.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_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_top_level.rb
+test/xref_data.rb
+test/xref_test_case.rb

data/Rakefile

@@ -1,5 +1,7 @@
 require 'hoe'
 
+$rdoc_rakefile = true
+
 $:.unshift 'lib'
 require 'rdoc'
 

data/bin/rdoc

@@ -16,7 +16,18 @@ begin
 rescue Interrupt
   $stderr.puts
   $stderr.puts "Interrupted"
-rescue RDoc::Error => e
-  $stderr.puts e.message
+  exit 1
+rescue Exception => e
+  if $DEBUG_RDOC then
+    $stderr.puts e.message
+    $stderr.puts "#{e.backtrace.join "\n\t"}"
+    $stderr.puts
+  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

@@ -223,7 +223,7 @@ $DEBUG_RDOC = nil
 #
 #   [\<b>text...</b>]    displays word in a *bold* font
 #   [\<em>text...</em>]  displays word in an _emphasized_ font
-#   [\\<i>text...</i>]    displays word in an <i>italicized</i> font
+#   [\<i>text...</i>]    displays word in an <i>italicized</i> font
 #   [\<tt>text...</tt>]  displays word in a +code+ font
 #
 #   Unlike conventional Wiki markup, general markup can cross line
@@ -233,7 +233,7 @@ $DEBUG_RDOC = nil
 #
 # * Hyperlinks to the web starting http:, mailto:, ftp:, or www. are
 #   recognized.  An HTTP url that references an external image file is
-#   converted into an inline <IMG..>.  Hyperlinks starting 'link:' are
+#   converted into an inline \<IMG..>.  Hyperlinks starting 'link:' are
 #   assumed to refer to local files whose path is relative to the --op
 #   directory.
 #
@@ -242,6 +242,14 @@ $DEBUG_RDOC = nil
 #   used as the target.  If +label+ contains multiple words,
 #   put it in braces: <em>{multi word label}[</em>url<em>]</em>.
 #
+#   Example hyperlinks:
+#
+#     link:RDoc.html
+#     http://rdoc.rubyforge.org
+#     mailto:user@example.com
+#     {RDoc Documentation}[http://rdoc.rubyforge.org]
+#     {RDoc Markup}[link:RDoc/Markup.html]
+#
 # == Directives
 #
 # [+:nodoc:+ / +:nodoc:+ all]
@@ -372,7 +380,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = "2.3.0"
+  VERSION = "2.4.0"
 
   ##
   # Name of the dotfile that contains the description of files to be processed

data/lib/rdoc/alias.rb

@@ -0,0 +1,54 @@
+require 'rdoc/code_object'
+
+##
+# Represent an alias, which is an old_name/new_name pair associated with a
+# particular context
+
+class RDoc::Alias < RDoc::CodeObject
+
+  ##
+  # Allow comments to be overridden
+
+  attr_writer :comment
+
+  ##
+  # Aliased name
+
+  attr_accessor :new_name
+
+  ##
+  # Aliasee's name
+
+  attr_accessor :old_name
+
+  ##
+  # Source file token stream
+
+  attr_accessor :text
+
+  ##
+  # Creates a new Alias with a token stream of +text+ that aliases +old_name+
+  # to +new_name+ and has +comment+
+
+  def initialize(text, old_name, new_name, comment)
+    super()
+    @text = text
+    @old_name = old_name
+    @new_name = new_name
+    self.comment = comment
+  end
+
+  def inspect # :nodoc:
+    "#<%s:0x%x %s.alias_method %s, %s>" % [
+      self.class, object_id,
+      parent.name, @old_name, @new_name,
+    ]
+  end
+
+  def to_s # :nodoc:
+    "alias: #{self.old_name} -> #{self.new_name}\n#{self.comment}"
+  end
+
+end
+
+

data/lib/rdoc/anon_class.rb

@@ -0,0 +1,10 @@
+require 'rdoc/class_module'
+
+##
+# An anonymous class like:
+#
+#   c = Class.new do end
+
+class RDoc::AnonClass < RDoc::ClassModule
+end
+

data/lib/rdoc/any_method.rb

@@ -0,0 +1,190 @@
+require 'rdoc/code_object'
+require 'rdoc/tokenstream'
+
+##
+# AnyMethod is the base class for objects representing methods
+
+class RDoc::AnyMethod < RDoc::CodeObject
+
+  ##
+  # Method name
+
+  attr_writer :name
+
+  ##
+  # public, protected, private
+
+  attr_accessor :visibility
+
+  ##
+  # Parameters yielded by the called block
+
+  attr_accessor :block_params
+
+  ##
+  # Don't rename \#initialize to \::new
+
+  attr_accessor :dont_rename_initialize
+
+  ##
+  # Is this a singleton method?
+
+  attr_accessor :singleton
+
+  ##
+  # Source file token stream
+
+  attr_reader :text
+
+  ##
+  # Array of other names for this method
+
+  attr_reader :aliases
+
+  ##
+  # Fragment reference for this method
+
+  attr_reader :aref
+
+  ##
+  # The method we're aliasing
+
+  attr_accessor :is_alias_for
+
+  ##
+  # Parameters for this method
+
+  attr_overridable :params, :param, :parameters, :parameter
+
+  ##
+  # Different ways to call this method
+
+  attr_accessor :call_seq
+
+  include RDoc::TokenStream
+
+  ##
+  # Resets method fragment reference counter
+
+  def self.reset
+    @@aref = 'M000000'
+  end
+
+  reset
+
+  def initialize(text, name)
+    super()
+    @text = text
+    @name = name
+    @token_stream  = nil
+    @visibility    = :public
+    @dont_rename_initialize = false
+    @block_params  = nil
+    @aliases       = []
+    @is_alias_for  = nil
+    @call_seq = nil
+
+    @aref  = @@aref
+    @@aref = @@aref.succ
+  end
+
+  ##
+  # Order by #singleton then #name
+
+  def <=>(other)
+    [@singleton ? 0 : 1, @name] <=> [other.singleton ? 0 : 1, other.name]
+  end
+
+  ##
+  # Adds +method+ as an alias for this method
+
+  def add_alias(method)
+    @aliases << method
+  end
+
+  ##
+  # HTML id-friendly method name
+
+  def html_name
+    @name.gsub(/[^a-z]+/, '-')
+  end
+
+  def inspect # :nodoc:
+    alias_for = @is_alias_for ? " (alias for #{@is_alias_for.name})" : nil
+      "#<%s:0x%x %s%s%s (%s)%s>" % [
+        self.class, object_id,
+        parent_name,
+        singleton ? '::' : '#',
+        name,
+        visibility,
+        alias_for,
+      ]
+  end
+
+  ##
+  # Full method name including namespace
+
+  def full_name
+    "#{@parent.full_name}#{pretty_name}"
+  end
+
+  ##
+  # Method name
+
+  def name
+    return @name if @name
+
+    @name = @call_seq[/^.*?\.(\w+)/, 1] || @call_seq
+  end
+
+  ##
+  # Pretty parameter list for this method
+
+  def param_seq
+    params = params.gsub(/\s*\#.*/, '')
+    params = params.tr("\n", " ").squeeze(" ")
+    params = "(#{params})" unless p[0] == ?(
+
+    if block = block_params then # yes, =
+      # If this method has explicit block parameters, remove any explicit
+      # &block
+      params.sub!(/,?\s*&\w+/)
+
+      block.gsub!(/\s*\#.*/, '')
+      block = block.tr("\n", " ").squeeze(" ")
+      if block[0] == ?(
+        block.sub!(/^\(/, '').sub!(/\)/, '')
+      end
+      params << " { |#{block}| ... }"
+    end
+
+    params
+  end
+
+  ##
+  # Path to this method
+
+  def path
+    "#{@parent.path}##{@aref}"
+  end
+
+  ##
+  # Method name with class/instance indicator
+
+  def pretty_name
+    "#{singleton ? '::' : '#'}#{@name}"
+  end
+
+  def to_s # :nodoc:
+    "#{self.class.name}: #{full_name} (#{@text})\n#{@comment}"
+  end
+
+  ##
+  # Type of method (class or instance)
+
+  def type
+    singleton ? 'class' : 'instance'
+  end
+
+end
+