rdoc 2.4.3 → 2.5

data/lib/rdoc/code_object.rb

@@ -1,11 +1,16 @@
 require 'rdoc'
+require 'rdoc/text'
 
 ##
+# Base class for the RDoc code tree.
+#
 # We contain the common stuff for contexts (which are containers) and other
 # elements (methods, attributes and so on)
 
 class RDoc::CodeObject
 
+  include RDoc::Text
+
   ##
   # Our comment
 
@@ -71,11 +76,13 @@ class RDoc::CodeObject
   # Creates a new CodeObject that will document itself and its children
 
   def initialize
-    @comment = nil
-    @document_children = true
-    @document_self = true
-    @done_documenting = false
+    @comment = ''
+
+    @document_children   = true
+    @document_self       = true
+    @done_documenting    = false
     @force_documentation = false
+
     @parent = nil
   end
 
@@ -83,7 +90,16 @@ class RDoc::CodeObject
   # Replaces our comment with +comment+, unless it is empty.
 
   def comment=(comment)
-    @comment = comment unless comment.empty?
+    @comment = case comment
+               when NilClass               then ''
+               when RDoc::Markup::Document then comment
+               else
+                 if comment and not comment.empty? then
+                   normalize_comment comment
+                 else
+                   @comment
+                 end
+               end
   end
 
   ##
@@ -104,6 +120,13 @@ class RDoc::CodeObject
     remove_methods_etc unless document_self
   end
 
+  ##
+  # Does this class have a comment with content or is document_self false.
+
+  def documented?
+    !(@document_self and @comment.empty?)
+  end
+
   ##
   # File name of our parent
 

data/lib/rdoc/constant.rb

@@ -25,6 +25,28 @@ class RDoc::Constant < RDoc::CodeObject
     self.comment = comment
   end
 
+  ##
+  # Constants are ordered by name
+
+  def <=> other
+    return unless self.class === other
+
+    [parent_name, name] <=> [other.parent_name, other.name]
+  end
+
+  def == other
+    self.class == other.class and
+      @parent == other.parent and
+      @name == other.name
+  end
+
+  def inspect # :nodoc:
+      "#<%s:0x%x %s::%s>" % [
+        self.class, object_id,
+        parent_name, @name,
+      ]
+  end
+
   ##
   # Path to this constant
 

data/lib/rdoc/context.rb

@@ -1,4 +1,3 @@
-require 'thread'
 require 'rdoc/code_object'
 
 ##
@@ -8,6 +7,8 @@ require 'rdoc/code_object'
 
 class RDoc::Context < RDoc::CodeObject
 
+  include Comparable
+
   ##
   # Types of methods
 
@@ -107,7 +108,6 @@ class RDoc::Context < RDoc::CodeObject
     attr_reader :title
 
     @@sequence = "SEC00000"
-    @@sequence_lock = Mutex.new
 
     ##
     # Creates a new section with +title+ and +comment+
@@ -116,10 +116,8 @@ class RDoc::Context < RDoc::CodeObject
       @parent = parent
       @title = title
 
-      @@sequence_lock.synchronize do
-        @@sequence.succ!
-        @sequence = @@sequence.dup
-      end
+      @@sequence.succ!
+      @sequence = @@sequence.dup
 
       set_comment comment
     end
@@ -239,16 +237,24 @@ class RDoc::Context < RDoc::CodeObject
   end
 
   ##
-  # Adds +an_alias+ pointing to +meth+
+  # Turns +an_alias+ into an AnyMethod that points to +meth+
 
   def add_alias_impl(an_alias, meth)
     new_meth = RDoc::AnyMethod.new an_alias.text, an_alias.new_name
     new_meth.is_alias_for = meth
     new_meth.singleton    = meth.singleton
     new_meth.params       = meth.params
-    new_meth.comment = "Alias for \##{meth.name}"
+
+    new_meth.comment      = an_alias.comment
+
     meth.add_alias new_meth
+
     add_method new_meth
+
+    # aliases don't use ongoing visibility
+    new_meth.visibility = meth.visibility
+
+    new_meth
   end
 
   ##
@@ -268,25 +274,30 @@ class RDoc::Context < RDoc::CodeObject
   def add_class(class_type, name, superclass = 'Object')
     klass = add_class_or_module @classes, class_type, name, superclass
 
+    existing = klass.superclass
+    existing = existing.name if existing and not String === existing
+
+    if superclass != existing and superclass != 'Object' then
+      klass.superclass = superclass
+    end
+
     # If the parser encounters Container::Item before encountering
     # Container, then it assumes that Container is a module.  This may not
     # be the case, so remove Container from the module list if present and
     # transfer any contained classes and modules to the new class.
 
-    RDoc::TopLevel.lock.synchronize do
-      mod = RDoc::TopLevel.modules_hash.delete klass.full_name
+    mod = RDoc::TopLevel.modules_hash.delete klass.full_name
 
-      if mod then
-        klass.classes_hash.update mod.classes_hash
-        klass.modules_hash.update mod.modules_hash
-        klass.method_list.concat mod.method_list
-
-        @modules.delete klass.name
-      end
+    if mod then
+      klass.classes_hash.update mod.classes_hash
+      klass.modules_hash.update mod.modules_hash
+      klass.method_list.concat mod.method_list
 
-      RDoc::TopLevel.classes_hash[klass.full_name] = klass
+      @modules.delete klass.name
     end
 
+    RDoc::TopLevel.classes_hash[klass.full_name] = klass
+
     klass
   end
 
@@ -295,27 +306,20 @@ class RDoc::Context < RDoc::CodeObject
   # classes Hash +collection+.
 
   def add_class_or_module(collection, class_type, name, superclass = nil)
-    full_name = if RDoc::TopLevel === self then # HACK
-                  name
-                else
-                  "#{self.full_name}::#{name}"
-                end
+    full_name = child_name name
+
     mod = collection[name]
 
     if mod then
       mod.superclass = superclass unless mod.module?
     else
-      all = nil
-
-      RDoc::TopLevel.lock.synchronize do
-        all = if class_type == RDoc::NormalModule then
-                RDoc::TopLevel.modules_hash
-              else
-                RDoc::TopLevel.classes_hash
-              end
+      all = if class_type == RDoc::NormalModule then
+              RDoc::TopLevel.modules_hash
+            else
+              RDoc::TopLevel.classes_hash
+            end
 
-        mod = all[full_name]
-      end
+      mod = all[full_name]
 
       unless mod then
         mod = class_type.new name, superclass
@@ -329,9 +333,7 @@ class RDoc::Context < RDoc::CodeObject
       end
 
       unless @done_documenting then
-        RDoc::TopLevel.lock.synchronize do
-          all[full_name] = mod
-        end
+        all[full_name] = mod
         collection[name] = mod
       end
 
@@ -384,6 +386,29 @@ class RDoc::Context < RDoc::CodeObject
     add_class_or_module @modules, class_type, name, nil
   end
 
+  ##
+  # Adds an alias from +from+ to +name+
+
+  def add_module_alias from, name
+    to_name = child_name name
+
+    unless @done_documenting then
+      if from.module? then
+        RDoc::TopLevel.modules_hash
+      else
+        RDoc::TopLevel.classes_hash
+      end[to_name] = from
+
+      if from.module? then
+        @modules
+      else
+        @classes
+      end[name] = from
+    end
+
+    from
+  end
+
   ##
   # Adds +require+ to this context's top level
 
@@ -404,6 +429,17 @@ class RDoc::Context < RDoc::CodeObject
     thing.section = @current_section
   end
 
+  ##
+  # Creates the full name for a child with +name+
+
+  def child_name name
+    if RDoc::TopLevel === self then
+      name
+    else
+      "#{self.full_name}::#{name}"
+    end
+  end
+
   ##
   # Array of classes in this context
 
@@ -436,7 +472,7 @@ class RDoc::Context < RDoc::CodeObject
   # Iterator for attributes
 
   def each_attribute # :yields: attribute
-    @attributes.each {|a| yield a}
+    @attributes.each { |a| yield a }
   end
 
   ##
@@ -582,6 +618,13 @@ class RDoc::Context < RDoc::CodeObject
     result
   end
 
+  ##
+  # The full name for this context.  This method is overridden by subclasses.
+
+  def full_name
+    '(unknown)'
+  end
+
   ##
   # URL for this with a +prefix+
 

data/lib/rdoc/gauntlet.rb

@@ -0,0 +1,48 @@
+require 'rdoc/rdoc'
+require 'gauntlet'
+require 'fileutils'
+
+##
+# Allows for testing of RDoc against every gem
+
+class RDoc::Gauntlet < Gauntlet
+
+  def run name
+    next if self.data[name]
+
+    ri_dir = File.expand_path "~/.gauntlet/data/ri/#{name}"
+    FileUtils.rm_rf ri_dir if File.exist? ri_dir
+
+    yaml = File.read 'gemspec'
+    spec = Gem::Specification.from_yaml yaml
+
+    args = %W[--ri --op #{ri_dir}]
+    args.push(*spec.rdoc_options)
+    args << spec.require_paths
+    args << spec.extra_rdoc_files
+    args = args.flatten.map { |a| a.to_s }
+    args.delete '--quiet'
+
+    puts "#{name} - rdoc #{args.join ' '}"
+
+    self.dirty = true
+    r = RDoc::RDoc.new
+
+    begin
+      r.document args
+      self.data[name] = true
+      puts 'passed'
+    rescue StandardError, RDoc::Error => e
+      puts "failed - (#{e.class}) #{e.message}"
+      self.data[name] = false
+    end
+  rescue Gem::Exception
+    puts "bad gem #{name}"
+  ensure
+    puts
+  end
+
+end
+
+RDoc::Gauntlet.new.run_the_gauntlet if $0 == __FILE__
+

data/lib/rdoc/generator/darkfish.rb

@@ -2,18 +2,17 @@
 # vim: noet ts=2 sts=8 sw=2
 
 require 'rubygems'
-gem 'rdoc', '>= 2.4' unless defined? $rdoc_rakefile
+gem 'rdoc', '>= 2.4' unless ENV['RDOC_TEST'] or defined?($rdoc_rakefile)
 
 require 'pp'
 require 'pathname'
 require 'fileutils'
 require 'erb'
-require 'yaml'
 
-require 'rdoc/rdoc'
-require 'rdoc/generator'
 require 'rdoc/generator/markup'
 
+$DARKFISH_DRYRUN = false # TODO make me non-global
+
 #
 #  Darkfish RDoc HTML Generator
 #  
@@ -98,12 +97,11 @@ class RDoc::Generator::Darkfish
 	### Initialize a few instance variables before we start
 	def initialize( options )
 		@options = options
-		@options.diagram = false
 
 		template = @options.template || 'darkfish'
 
 		template_dir = $LOAD_PATH.map do |path|
-			File.join path, GENERATOR_DIR, 'template', template
+			File.join File.expand_path(path), GENERATOR_DIR, 'template', template
 		end.find do |dir|
 			File.directory? dir
 		end
@@ -151,7 +149,7 @@ class RDoc::Generator::Darkfish
 	### directory.
 	def write_style_sheet
 		debug_msg "Copying static files"
-		options = { :verbose => $DEBUG_RDOC, :noop => $dryrun }
+		options = { :verbose => $DEBUG_RDOC, :noop => $DARKFISH_DRYRUN }
 
 		FileUtils.cp @template_dir + 'rdoc.css', '.', options
 
@@ -223,12 +221,14 @@ class RDoc::Generator::Darkfish
 	### Generate an index page which lists all the classes which
 	### are documented.
 	def generate_index
+		template_file = @template_dir + 'index.rhtml'
+		return unless template_file.exist?
+
 		debug_msg "Rendering the index page..."
 
-		templatefile = @template_dir + 'index.rhtml'
-		template_src = templatefile.read
+		template_src = template_file.read
 		template = ERB.new( template_src, nil, '<>' )
-		template.filename = templatefile.to_s
+		template.filename = template_file.to_s
 		context = binding()
 
 		output = nil
@@ -237,14 +237,14 @@ class RDoc::Generator::Darkfish
 			output = template.result( context )
 		rescue NoMethodError => err
 			raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
-				templatefile,
+				template_file,
 				err.message,
 				eval( "_erbout[-50,50]", context )
 			], err.backtrace
 		end
 
 		outfile = @basedir + @options.op_dir + 'index.html'
-		unless $dryrun
+		unless $DARKFISH_DRYRUN
 			debug_msg "Outputting to %s" % [outfile.expand_path]
 			outfile.open( 'w', 0644 ) do |fh|
 				fh.print( output )
@@ -256,8 +256,9 @@ class RDoc::Generator::Darkfish
 
 	### Generate a documentation file for each class
 	def generate_class_files
+		template_file = @template_dir + 'classpage.rhtml'
+		return unless template_file.exist?
 		debug_msg "Generating class documentation in #@outputdir"
-		templatefile = @template_dir + 'classpage.rhtml'
 
 		@classes.each do |klass|
 			debug_msg "  working on %s (%s)" % [ klass.full_name, klass.path ]
@@ -266,14 +267,15 @@ class RDoc::Generator::Darkfish
 			svninfo    = self.get_svninfo( klass )
 
 			debug_msg "  rendering #{outfile}"
-			self.render_template( templatefile, binding(), outfile )
+			self.render_template( template_file, binding(), outfile )
 		end
 	end
 
 	### Generate a documentation file for each file
 	def generate_file_files
+		template_file = @template_dir + 'filepage.rhtml'
+		return unless template_file.exist?
 		debug_msg "Generating file documentation in #@outputdir"
-		templatefile = @template_dir + 'filepage.rhtml'
 
 		@files.each do |file|
 			outfile     = @outputdir + file.path
@@ -282,7 +284,7 @@ class RDoc::Generator::Darkfish
 			context     = binding()
 
 			debug_msg "  rendering #{outfile}"
-			self.render_template( templatefile, binding(), outfile )
+			self.render_template( template_file, binding(), outfile )
 		end
 	end
 
@@ -335,26 +337,26 @@ class RDoc::Generator::Darkfish
 	end
 
 
-	### Load and render the erb template in the given +templatefile+ within the
+	### Load and render the erb template in the given +template_file+ within the
 	### specified +context+ (a Binding object) and write it out to +outfile+.
-	### Both +templatefile+ and +outfile+ should be Pathname-like objects.
+	### Both +template_file+ and +outfile+ should be Pathname-like objects.
 
-	def render_template( templatefile, context, outfile )
-		template_src = templatefile.read
+	def render_template( template_file, context, outfile )
+		template_src = template_file.read
 		template = ERB.new( template_src, nil, '<>' )
-		template.filename = templatefile.to_s
+		template.filename = template_file.to_s
 
 		output = begin
 							 template.result( context )
 						 rescue NoMethodError => err
 							 raise RDoc::Error, "Error while evaluating %s: %s (at %p)" % [
-								 templatefile.to_s,
+								 template_file.to_s,
 								 err.message,
 								 eval( "_erbout[-50,50]", context )
 							 ], err.backtrace
 						 end
 
-		unless $dryrun
+		unless $DARKFISH_DRYRUN
 			outfile.dirname.mkpath
 			outfile.open( 'w', 0644 ) do |ofh|
 				ofh.print( output )