rdoc 2.2.1 → 2.3.0

data.tar.gz.sig

@@ -0,0 +1,2 @@
+s
+#��,�r��'n0ٓB��)��Mgy���|����P�;1���ؖβ�����JSR�w�@izW�H�F�ѿ.�=��{,��r��??ٲ����ha�\��ˁ���Ir$��ׁ�*'�S$��LOɸ!?db�cj��ůu�οE�~�I.����d�{)u��8 �x����/����䏂��st�Kw��w�g��֠4�1Pc�6%��aeB� (a�t�'d����"DW]YS��'�b���*�[F�*

data/.document

@@ -0,0 +1,4 @@
+History.txt
+README.txt
+RI.txt
+lib

data/History.txt

@@ -1,3 +1,38 @@
+=== 2.3.0 / 2009-01-28
+
+* 3 Major Enhancements
+  * Michael Granger's Darkfish generator is now the default for HTML output
+  * Various rdoc generation speedups by Hongli Lai.  Patches #22555, #22556,
+    #22557, #22562, #22565.
+  * rdoc/discover.rb files are loaded automatically from installed gems
+
+* 8 Minor Enhancements
+  * Added a space after the commas in ri class method lists.  RubyForge
+    enhancement #22182.
+  * Improved ri --interactive
+  * Generators can now override generated file locations
+  * Moved unmaintained CHM generator to it's own package
+  * Moved unmaintained extra HTML templates to their own package
+  * Removed experimental texinfo generator
+  * Converted to minitest
+  * Known classes and modules list outputs once per line now for grep
+
+* 11 Bug Fixes
+  * Fix missing superclass in ri output
+  * Fix an RDoc crash when told to parse an empty file
+  * Ignore nonexistent files instead of crashing
+  * .txt and .rdoc files are always considered text.  Patch #22897 by Aaron
+    Patterson.
+  * When merging ri data with a nonexistant directory, RDoc no longer crashes
+  * Fix visibility of methods in XML output.  Issue by Yehuda Katz.
+  * Fixed relative link generation
+  * Fix crash, RDoc now ignores comments above local variable assignments in
+    modules
+  * RDoc now only accepts adjacent comments for rb_define_module and
+    rb_define_class
+  * C file RDoc is no longer included in token stream
+  * Scan all gem paths to match gem name for ri output
+
 === 2.2.1 / 2008-09-24
 This version provides some minor fixes and enhancements to 2.2.0 intended
 to polish RDoc for Ruby 1.9.1.

data/Manifest.txt

@@ -1,31 +1,52 @@
+.document
 History.txt
 Manifest.txt
 README.txt
-Rakefile
 RI.txt
+Rakefile
 bin/rdoc
 bin/ri
 lib/rdoc.rb
+lib/rdoc/cache.rb
 lib/rdoc/code_objects.rb
 lib/rdoc/diagram.rb
 lib/rdoc/dot.rb
 lib/rdoc/generator.rb
-lib/rdoc/generator/chm.rb
-lib/rdoc/generator/chm/chm.rb
+lib/rdoc/generator/darkfish.rb
 lib/rdoc/generator/html.rb
 lib/rdoc/generator/html/common.rb
-lib/rdoc/generator/html/frameless.rb
-lib/rdoc/generator/html/hefss.rb
 lib/rdoc/generator/html/html.rb
-lib/rdoc/generator/html/kilmer.rb
-lib/rdoc/generator/html/kilmerfactory.rb
 lib/rdoc/generator/html/one_page_html.rb
 lib/rdoc/generator/ri.rb
-lib/rdoc/generator/texinfo.rb
-lib/rdoc/generator/texinfo/class.texinfo.erb
-lib/rdoc/generator/texinfo/file.texinfo.erb
-lib/rdoc/generator/texinfo/method.texinfo.erb
-lib/rdoc/generator/texinfo/texinfo.erb
+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/images/brick.png
+lib/rdoc/generator/template/darkfish/images/brick_link.png
+lib/rdoc/generator/template/darkfish/images/bug.png
+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/find.png
+lib/rdoc/generator/template/darkfish/images/loadingAnimation.gif
+lib/rdoc/generator/template/darkfish/images/macFFBgHack.png
+lib/rdoc/generator/template/darkfish/images/package.png
+lib/rdoc/generator/template/darkfish/images/page_green.png
+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_green.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/rdoc.css
 lib/rdoc/generator/xml.rb
 lib/rdoc/generator/xml/rdf.rb
 lib/rdoc/generator/xml/xml.rb
@@ -65,9 +86,9 @@ lib/rdoc/stats.rb
 lib/rdoc/template.rb
 lib/rdoc/tokenstream.rb
 test/binary.dat
-test/rdoc_markup_to_html_crossref_reference.rb
-test/test_rdoc_info_formatting.rb
-test/test_rdoc_info_sections.rb
+test/test.ja.rdoc
+test/test.ja.txt
+test/test_attribute_manager.rb
 test/test_rdoc_markup.rb
 test/test_rdoc_markup_attribute_manager.rb
 test/test_rdoc_markup_to_html.rb

data/README.txt

@@ -10,21 +10,11 @@ files.  RDoc includes the +rdoc+ and +ri+ tools for generating and displaying
 online documentation.
 
 At this point in time, RDoc 2.x is a work in progress and may incur further
-API changes beyond what has been made to the RDoc 1.0.1.  Command-line tools
-are largely unaffected, but internal APIs may shift rapidly.
+API changes beyond what has been made to RDoc 1.0.1.  Command-line tools are
+largely unaffected, but internal APIs may shift rapidly.
 
 See RDoc for a description of RDoc's markup and basic use.
 
-== TEMPLATE NOTE:
-
-RDoc comes with five built-in HTML templates.  We use a 3rd party template,
-however, for RDoc's own documentation site[http://rdoc.rubyforge.org].  This
-template is Hanna[http://github.com/mislav/hanna/tree/master].
-
-We strongly are considering making Hanna as RDoc's default template
-in a future release, but for now this template can be downloaded separately
-and used with the +-T+ option.
-
 == SYNOPSIS:
 
   gem 'rdoc'
@@ -32,31 +22,25 @@ and used with the +-T+ option.
   # ... see RDoc
 
 == BUGS:
----
-RDoc's Fortran 95 support is pretty broken right now.
-The rdoc-f95[http://www.gfd-dennou.org/library/dcmodel/rdoc-f95/] project has
-patches for RDoc 1.x that provide excellent Fortran 95 support.  Properly
-supporting Fortran 95 requires a rewrite of RDoc's markup engine, which
-is high on our list of goals.  The Fortran 95 issue can be tracked
-here[http://rubyforge.org/tracker/index.php?func=detail&aid=21542&group_id=627&atid=2475].
----
+
 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.
-The markup engine needs a rewrite, which can be tracked here[http://rubyforge.org/tracker/index.php?func=detail&aid=21540&group_id=627&atid=2475].
----
+
 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:
 
 == LICENSE:
 
-RDoc is Copyright (c) 2001-2003 Dave Thomas, The Pragmatic Programmers,
-portions (c) 2007-2008 Eric Hodel.  It is free software, and may be
-redistributed under the terms specified in the README file of the Ruby
-distribution.
+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.

data/Rakefile

@@ -9,6 +9,9 @@ Hoe.new "rdoc", RDoc::VERSION do |rdoc|
   rdoc.developer 'Phil Hagelberg', 'technomancy@gmail.com'
   rdoc.developer 'Tony Strauss', 'tony.strauss@designingpatterns.com'
   rdoc.remote_rdoc_dir = ''
+
+  rdoc.extra_dev_deps << ['minitest', '~> 1.3']
+  rdoc.spec_extras['required_rubygems_version'] = '>= 1.3'
 end
 
 # These tasks expect to have the following directory structure:

data/lib/rdoc.rb

@@ -372,7 +372,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = "2.2.1"
+  VERSION = "2.3.0"
 
   ##
   # Name of the dotfile that contains the description of files to be processed

data/lib/rdoc/cache.rb

@@ -0,0 +1,32 @@
+require 'thread'
+require 'singleton'
+
+##
+# A generic, thread-safe in-memory cache. It's used for caching
+# RDoc::TemplatePage objects when generating RDoc output.
+
+class RDoc::Cache
+
+  include Singleton
+
+  def initialize
+    @contents = {}
+    @lock = Mutex.new
+  end
+
+  # Checks whether there's a value in the cache with key +key+. If so, then
+  # that value will be returned. Otherwise, the given block will be run,
+  # and its return value will be put into the cache, and returned.
+  def cache(key)
+    @lock.synchronize do
+      @contents[key] ||= yield
+    end
+  end
+
+  def clear
+    @lock.synchronize do
+      @contents.clear
+    end
+  end
+end
+

data/lib/rdoc/code_objects.rb

@@ -1,6 +1,8 @@
 # We represent the various high-level code constructs that appear
 # in Ruby programs: classes, modules, methods, and so on.
 
+require 'thread'
+
 require 'rdoc/tokenstream'
 
 module RDoc
@@ -11,25 +13,42 @@ module RDoc
 
   class CodeObject
 
-    attr_accessor :parent
+    ##
+    # Our comment
 
-    # We are the model of the code, but we know that at some point
-    # we will be worked on by viewers. By implementing the Viewable
-    # protocol, viewers can associated themselves with these objects.
+    attr_reader :comment
 
-    attr_accessor :viewer
+    ##
+    # Do we document our children?
 
-    # are we done documenting (ie, did we come across a :enddoc:)?
+    attr_reader :document_children
+
+    ##
+    # Do we document ourselves?
+
+    attr_reader :document_self
+
+    ##
+    # Are we done documenting (ie, did we come across a :enddoc:)?
 
     attr_accessor :done_documenting
 
+    ##
+    # Our parent CodeObject
+
+    attr_accessor :parent
+
+    ##
     # Which section are we in
 
     attr_accessor :section
 
-    # do we document ourselves?
+    ##
+    # We are the model of the code, but we know that at some point we will be
+    # worked on by viewers. By implementing the Viewable protocol, viewers can
+    # associated themselves with these objects.
 
-    attr_reader :document_self
+    attr_accessor :viewer
 
     def initialize
       @document_self = true
@@ -38,68 +57,86 @@ module RDoc
       @done_documenting = false
     end
 
-    def document_self=(val)
-      @document_self = val
-      if !val
-	remove_methods_etc
-      end
+    ##
+    # Enables or disables documentation of this CodeObject.  Calls
+    # remove_methods_etc when disabling.
+
+    def document_self=(document_self)
+      @document_self = document_self
+      remove_methods_etc unless document_self
     end
 
-    # set and cleared by :startdoc: and :enddoc:, this is used to toggle
-    # the capturing of documentation
+    ##
+    # Enable capture of documentation
+
     def start_doc
       @document_self = true
       @document_children = true
     end
 
+    ##
+    # Disable capture of documentation
+
     def stop_doc
       @document_self = false
       @document_children = false
     end
 
-    # do we document ourselves and our children
-
-    attr_reader :document_children
+    ##
+    # Enables or disables documentation of this CodeObject's children.  Calls
+    # remove_classes_and_modules when disabling.
 
-    def document_children=(val)
-      @document_children = val
-      if !val
-	remove_classes_and_modules
-      end
+    def document_children=(document_children)
+      @document_children = document_children
+      remove_classes_and_modules unless document_children
     end
 
-    # Do we _force_ documentation, even is we wouldn't normally show the entity
+    ##
+    # Force documentation of this CodeObject
+
     attr_accessor :force_documentation
 
+    ##
+    # File name of our parent
+
     def parent_file_name
       @parent ? @parent.file_base_name : '(unknown)'
     end
 
+    ##
+    # Name of our parent
+
     def parent_name
       @parent ? @parent.name : '(unknown)'
     end
 
-    # Default callbacks to nothing, but this is overridden for classes
-    # and modules
+    ##
+    # Callback called upon disabling documentation of children.  See
+    # #document_children=
+
     def remove_classes_and_modules
     end
 
+    ##
+    # Callback called upon disabling documentation of ourself.  See
+    # #document_self=
+
     def remove_methods_etc
     end
 
-    # Access the code object's comment
-    attr_reader :comment
+    ##
+    # Replaces our comment with +comment+, unless it is empty.
 
-    # Update the comment, but don't overwrite a real comment with an empty one
     def comment=(comment)
       @comment = comment unless comment.empty?
     end
 
+    ##
     # There's a wee trick we pull. Comment blocks can have directives that
     # override the stuff we extract during the parse. So, we have a special
-    # class method, attr_overridable, that lets code objects list
-    # those directives. Wehn a comment is assigned, we then extract
-    # out any matching directives and update our object
+    # class method, attr_overridable, that lets code objects list those
+    # directives. When a comment is assigned, we then extract out any matching
+    # directives and update our object
 
     def self.attr_overridable(name, *aliases)
       @overridables ||= {}
@@ -137,11 +174,14 @@ module RDoc
       attr_reader :title, :comment, :sequence
 
       @@sequence = "SEC00000"
+      @@sequence_lock = Mutex.new
 
       def initialize(title, comment)
         @title = title
-        @@sequence.succ!
-        @sequence = @@sequence.dup
+        @@sequence_lock.synchronize do
+          @@sequence.succ!
+          @sequence = @@sequence.dup
+        end
         @comment = nil
         set_comment(comment)
       end
@@ -580,25 +620,33 @@ module RDoc
     attr_accessor :file_relative_name
     attr_accessor :file_absolute_name
     attr_accessor :diagram
+    attr_accessor :parser
 
+    @@lock = Mutex.new
     @@all_classes = {}
     @@all_modules = {}
     @@all_files   = {}
 
     def self.reset
-      @@all_classes = {}
-      @@all_modules = {}
-      @@all_files   = {}
+      @@lock.synchronize do
+        @@all_classes = {}
+        @@all_modules = {}
+        @@all_files   = {}
+      end
     end
 
     def initialize(file_name)
       super()
       @name = "TopLevel"
-      @file_relative_name    = file_name
-      @file_absolute_name    = file_name
-      @file_stat             = File.stat(file_name)
-      @diagram               = nil
-      @@all_files[file_name] = self
+      @file_relative_name = file_name
+      @file_absolute_name = file_name
+      @file_stat          = File.stat(file_name) rescue nil # HACK for testing
+      @diagram            = nil
+      @parser             = nil
+
+      @@lock.synchronize do
+        @@all_files[file_name] = self
+      end
     end
 
     def file_base_name
@@ -622,17 +670,25 @@ module RDoc
         cls.superclass = superclass unless cls.module?
         puts "Reusing class/module #{cls.full_name}" if $DEBUG_RDOC
       else
-        if class_type == NormalModule then
-          all = @@all_modules
-        else
-          all = @@all_classes
-        end
+        all = nil
+        
+        @@lock.synchronize do
+          if class_type == NormalModule then
+            all = @@all_modules
+          else
+            all = @@all_classes
+          end
 
-        cls = all[name]
+          cls = all[name]
+        end
 
         if !cls then
           cls = class_type.new name, superclass
-          all[name] = cls unless @done_documenting
+          unless @done_documenting
+            @@lock.synchronize do
+              all[name] = cls
+            end
+          end
         else
           # If the class has been encountered already, check that its
           # superclass has been set (it may not have been, depending on
@@ -653,19 +709,25 @@ module RDoc
     end
 
     def self.all_classes_and_modules
-      @@all_classes.values + @@all_modules.values
+      @@lock.synchronize do
+        @@all_classes.values + @@all_modules.values
+      end
     end
 
     def self.find_class_named(name)
-     @@all_classes.each_value do |c|
-        res = c.find_class_named(name) 
-        return res if res
+      @@lock.synchronize do
+        @@all_classes.each_value do |c|
+          res = c.find_class_named(name)
+          return res if res
+        end
       end
       nil
     end
 
     def self.find_file_named(name)
-      @@all_files[name]
+      @@lock.synchronize do
+        @@all_files[name]
+      end
     end
 
     def find_local_symbol(symbol)
@@ -673,8 +735,10 @@ module RDoc
     end
 
     def find_class_or_module_named(symbol)
-      @@all_classes.each_value {|c| return c if c.name == symbol}
-      @@all_modules.each_value {|m| return m if m.name == symbol}
+      @@lock.synchronize do
+        @@all_classes.each_value {|c| return c if c.name == symbol}
+        @@all_modules.each_value {|m| return m if m.name == symbol}
+      end
       nil
     end
 
@@ -766,9 +830,7 @@ module RDoc
     def superclass=(superclass)
       raise NoMethodError, "#{full_name} is a module" if module?
 
-      if @superclass.nil? or @superclass == 'Object' then
-        @superclass = superclass 
-      end
+      @superclass = superclass if @superclass.nil? or @superclass == 'Object'
     end
 
     def to_s