rdoc 3.12.2 → 4.0.0.preview2

data/lib/rdoc/attr.rb

@@ -4,7 +4,13 @@
 
 class RDoc::Attr < RDoc::MethodAttr
 
-  MARSHAL_VERSION = 2 # :nodoc:
+  ##
+  # 3::
+  #   RDoc 4
+  #    Added parent name and class
+  #    Added section title
+
+  MARSHAL_VERSION = 3 # :nodoc:
 
   ##
   # Is the attribute readable ('R'), writable ('W') or both ('RW')?
@@ -55,6 +61,16 @@ class RDoc::Attr < RDoc::MethodAttr
     'attribute'
   end
 
+  ##
+  # Attributes never call super.  See RDoc::AnyMethod#calls_super
+  #
+  # An RDoc::Attr can show up in the method list in some situations (see
+  # Gem::ConfigFile)
+
+  def calls_super # :nodoc:
+    false
+  end
+
   ##
   # Returns attr_reader, attr_writer or attr_accessor as appropriate.
 
@@ -90,7 +106,10 @@ class RDoc::Attr < RDoc::MethodAttr
       @visibility,
       parse(@comment),
       singleton,
-      @file.absolute_name,
+      @file.relative_name,
+      @parent.full_name,
+      @parent.class,
+      @section.title
     ]
   end
 
@@ -102,17 +121,28 @@ class RDoc::Attr < RDoc::MethodAttr
   # * #parent_name
 
   def marshal_load array
-    version     = array[0]
-    @name       = array[1]
-    @full_name  = array[2]
-    @rw         = array[3]
-    @visibility = array[4]
-    @comment    = array[5]
-    @singleton  = array[6] || false # MARSHAL_VERSION == 0
+    @aliases      = []
+    @parent       = nil
+    @parent_name  = nil
+    @parent_class = nil
+    @section      = nil
+    @file         = nil
+
+    version        = array[0]
+    @name          = array[1]
+    @full_name     = array[2]
+    @rw            = array[3]
+    @visibility    = array[4]
+    @comment       = array[5]
+    @singleton     = array[6] || false # MARSHAL_VERSION == 0
+    #                      7 handled below
+    @parent_name   = array[8]
+    @parent_class  = array[9]
+    @section_title = array[10]
 
     @file = RDoc::TopLevel.new array[7] if version > 1
 
-    @parent_name = @full_name
+    @parent_name ||= @full_name.split('#', 2).first
   end
 
   def pretty_print q # :nodoc:
@@ -130,5 +160,14 @@ class RDoc::Attr < RDoc::MethodAttr
     "#{definition} #{name} in: #{parent}"
   end
 
+  ##
+  # Attributes do not have token streams.
+  #
+  # An RDoc::Attr can show up in the method list in some situations (see
+  # Gem::ConfigFile)
+
+  def token_stream # :nodoc:
+  end
+
 end
 

data/lib/rdoc/class_module.rb

@@ -11,8 +11,17 @@ class RDoc::ClassModule < RDoc::Context
   #   * Added file to constants
   #   * Added file to includes
   #   * Added file to methods
+  # 2::
+  #   RDoc 3.13
+  #   * Added extends
+  # 3::
+  #   RDoc 4.0
+  #   * Added sections
+  #   * Added in_files
+  #   * Added parent name
+  #   * Complete Constant dump
 
-  MARSHAL_VERSION = 1 # :nodoc:
+  MARSHAL_VERSION = 3 # :nodoc:
 
   ##
   # Constants that are aliases for this class or module
@@ -54,6 +63,7 @@ class RDoc::ClassModule < RDoc::Context
     klass.external_aliases.concat mod.external_aliases
     klass.constants.concat mod.constants
     klass.includes.concat mod.includes
+    klass.extends.concat mod.extends
 
     klass.methods_hash.update mod.methods_hash
     klass.constants_hash.update mod.constants_hash
@@ -82,6 +92,7 @@ class RDoc::ClassModule < RDoc::Context
      klass.external_aliases +
      klass.constants +
      klass.includes +
+     klass.extends +
      klass.classes +
      klass.modules).each do |obj|
       obj.parent = klass
@@ -128,6 +139,17 @@ class RDoc::ClassModule < RDoc::Context
     self.comment = original
   end
 
+  def add_things my_things, other_things # :nodoc:
+    other_things.each do |group, things|
+      my_things[group].each { |thing| yield false, thing } if
+        my_things.include? group
+
+      things.each do |thing|
+        yield true, thing
+      end
+    end
+  end
+
   ##
   # Ancestors list for this ClassModule: the list of included modules
   # (classes will add their superclass if any).
@@ -144,6 +166,11 @@ class RDoc::ClassModule < RDoc::Context
     includes.map { |i| i.module }.reverse
   end
 
+  ##
+  # Ancestors of this class or module only
+
+  alias direct_ancestors ancestors
+
   ##
   # Clears the comment. Used by the ruby parser.
 
@@ -173,7 +200,7 @@ class RDoc::ClassModule < RDoc::Context
   ##
   # Prepares this ClassModule for use by a generator.
   #
-  # See RDoc::TopLevel::complete
+  # See RDoc::Store#complete
 
   def complete min_visibility
     update_aliases
@@ -194,8 +221,11 @@ class RDoc::ClassModule < RDoc::Context
   # RDoc::ClassModule exists.
 
   def each_ancestor # :yields: module
+    return enum_for __method__ unless block_given?
+
     ancestors.each do |mod|
       next if String === mod
+      next if self == mod
       yield mod
     end
   end
@@ -229,8 +259,8 @@ class RDoc::ClassModule < RDoc::Context
   # Return the fully qualified name of this class or module
 
   def full_name
-    @full_name ||= if RDoc::ClassModule === @parent then
-                     "#{@parent.full_name}::#{@name}"
+    @full_name ||= if RDoc::ClassModule === parent then
+                     "#{parent.full_name}::#{@name}"
                    else
                      @name
                    end
@@ -264,13 +294,20 @@ class RDoc::ClassModule < RDoc::Context
       @superclass,
       parse(@comment_location),
       attrs,
-      constants.map do |const|
-        [const.name, parse(const.comment), const.file_name]
-      end,
+      constants,
       includes.map do |incl|
         [incl.name, parse(incl.comment), incl.file_name]
       end,
       method_types,
+      extends.map do |ext|
+        [ext.name, parse(ext.comment), ext.file_name]
+      end,
+      @sections.values,
+      @in_files.map do |tl|
+        tl.relative_name
+      end,
+      parent.full_name,
+      parent.class,
     ]
   end
 
@@ -282,6 +319,8 @@ class RDoc::ClassModule < RDoc::Context
     @parent            = nil
     @temporary_section = nil
     @visibility        = nil
+    @classes           = {}
+    @modules           = {}
 
     @name       = array[1]
     @full_name  = array[2]
@@ -305,9 +344,14 @@ class RDoc::ClassModule < RDoc::Context
       attr.record_location RDoc::TopLevel.new file
     end
 
-    array[6].each do |name, comment, file|
-      const = add_constant RDoc::Constant.new(name, nil, comment)
-      const.record_location RDoc::TopLevel.new file
+    array[6].each do |constant, comment, file|
+      case constant
+      when RDoc::Constant then
+        add_constant constant
+      else
+        constant = add_constant RDoc::Constant.new(constant, nil, comment)
+        constant.record_location RDoc::TopLevel.new file
+      end
     end
 
     array[7].each do |name, comment, file|
@@ -327,6 +371,27 @@ class RDoc::ClassModule < RDoc::Context
         end
       end
     end
+
+    array[9].each do |name, comment, file|
+      ext = add_extend RDoc::Extend.new(name, comment)
+      ext.record_location RDoc::TopLevel.new file
+    end if array[9] # Support Marshal version 1
+
+    sections = (array[10] || []).map do |section|
+      [section.title, section]
+    end
+
+    @sections = Hash[*sections.flatten]
+    @current_section = add_section nil
+
+    @in_files = []
+
+    (array[11] || []).each do |filename|
+      record_location RDoc::TopLevel.new filename
+    end
+
+    @parent_name  = array[12]
+    @parent_class = array[13]
   end
 
   ##
@@ -335,6 +400,9 @@ class RDoc::ClassModule < RDoc::Context
   # The data in +class_module+ is preferred over the receiver.
 
   def merge class_module
+    @parent      = class_module.parent
+    @parent_name = class_module.parent_name
+
     other_document = parse class_module.comment_location
 
     if other_document then
@@ -376,6 +444,16 @@ class RDoc::ClassModule < RDoc::Context
 
     @includes.uniq! # clean up
 
+    merge_collections extends, cm.extends, other_files do |add, ext|
+      if add then
+        add_extend ext
+      else
+        @extends.delete ext
+      end
+    end
+
+    @extends.uniq! # clean up
+
     merge_collections method_list, cm.method_list, other_files do |add, meth|
       if add then
         add_method meth
@@ -385,6 +463,8 @@ class RDoc::ClassModule < RDoc::Context
       end
     end
 
+    merge_sections cm
+
     self
   end
 
@@ -407,22 +487,46 @@ class RDoc::ClassModule < RDoc::Context
     my_things    = mine. group_by { |thing| thing.file }
     other_things = other.group_by { |thing| thing.file }
 
-    my_things.delete_if do |file, things|
-      next false unless other_files.include? file
+    remove_things my_things, other_files,  &block
+    add_things    my_things, other_things, &block
+  end
 
-      things.each do |thing|
-        yield false, thing
-      end
+  ##
+  # Merges the comments in this ClassModule with the comments in the other
+  # ClassModule +cm+.
 
-      true
+  def merge_sections cm # :nodoc:
+    my_sections    =    sections.group_by { |section| section.title }
+    other_sections = cm.sections.group_by { |section| section.title }
+
+    other_files = cm.in_files
+
+    remove_things my_sections, other_files do |_, section|
+      @sections.delete section.title
     end
 
-    other_things.each do |file, things|
-      my_things[file].each { |thing| yield false, thing } if
-        my_things.include?(file)
+    other_sections.each do |group, sections|
+      if my_sections.include? group
+        my_sections[group].each do |my_section|
+          other_section = cm.sections_hash[group]
 
-      things.each do |thing|
-        yield true, thing
+          my_comments    = my_section.comments
+          other_comments = other_section.comments
+
+          other_files = other_section.in_files
+
+          merge_collections my_comments, other_comments, other_files do |add, comment|
+            if add then
+              my_section.add_comment comment
+            else
+              my_section.remove_comment comment
+            end
+          end
+        end
+      else
+        sections.each do |section|
+          add_section group, section.comments
+        end
       end
     end
   end
@@ -471,10 +575,10 @@ class RDoc::ClassModule < RDoc::Context
   end
 
   ##
-  # Path to this class or module
+  # Path to this class or module for use with HTML generator output.
 
   def path
-    http_url RDoc::RDoc.current.generator.class_dir
+    http_url @store.rdoc.generator.class_dir
   end
 
   ##
@@ -508,12 +612,24 @@ class RDoc::ClassModule < RDoc::Context
 
     modules_hash.each_key do |name|
       full_name = prefix + name
-      modules_hash.delete name unless RDoc::TopLevel.all_modules_hash[full_name]
+      modules_hash.delete name unless @store.modules_hash[full_name]
     end
 
     classes_hash.each_key do |name|
       full_name = prefix + name
-      classes_hash.delete name unless RDoc::TopLevel.all_classes_hash[full_name]
+      classes_hash.delete name unless @store.classes_hash[full_name]
+    end
+  end
+
+  def remove_things my_things, other_files # :nodoc:
+    my_things.delete_if do |file, things|
+      next false unless other_files.include? file
+
+      things.each do |thing|
+        yield false, thing
+      end
+
+      true
     end
   end
 
@@ -532,12 +648,25 @@ class RDoc::ClassModule < RDoc::Context
     ]
   end
 
+  ##
+  # Sets the store for this class or module and its contained code objects.
+
+  def store= store
+    super
+
+    @attributes .each do |attr|  attr.store  = store end
+    @constants  .each do |const| const.store = store end
+    @includes   .each do |incl|  incl.store  = store end
+    @extends    .each do |ext|   ext.store   = store end
+    @method_list.each do |meth|  meth.store  = store end
+  end
+
   ##
   # Get the superclass of this class.  Attempts to retrieve the superclass
   # object, returns the name if it is not known.
 
   def superclass
-    RDoc::TopLevel.find_class_named(@superclass) || @superclass
+    @store.find_class_named(@superclass) || @superclass
   end
 
   ##
@@ -568,7 +697,7 @@ class RDoc::ClassModule < RDoc::Context
   # aliases through a constant.
   #
   # The aliased module/class is replaced in the children and in
-  # RDoc::TopLevel::all_modules_hash or RDoc::TopLevel::all_classes_hash
+  # RDoc::Store#modules_hash or RDoc::Store#classes_hash
   # by a copy that has <tt>RDoc::ClassModule#is_alias_for</tt> set to
   # the aliased module/class, and this copy is added to <tt>#aliases</tt>
   # of the aliased module/class.
@@ -583,16 +712,21 @@ class RDoc::ClassModule < RDoc::Context
       next unless cm = const.is_alias_for
       cm_alias = cm.dup
       cm_alias.name = const.name
-      cm_alias.parent = self
-      cm_alias.full_name = nil  # force update for new parent
+
+      # Don't move top-level aliases under Object, they look ugly there
+      unless RDoc::TopLevel === cm_alias.parent then
+        cm_alias.parent = self
+        cm_alias.full_name = nil # force update for new parent
+      end
+
       cm_alias.aliases.clear
       cm_alias.is_alias_for = cm
 
       if cm.module? then
-        RDoc::TopLevel.all_modules_hash[cm_alias.full_name] = cm_alias
+        @store.modules_hash[cm_alias.full_name] = cm_alias
         modules_hash[const.name] = cm_alias
       else
-        RDoc::TopLevel.all_classes_hash[cm_alias.full_name] = cm_alias
+        @store.classes_hash[cm_alias.full_name] = cm_alias
         classes_hash[const.name] = cm_alias
       end
 
@@ -609,11 +743,27 @@ class RDoc::ClassModule < RDoc::Context
   def update_includes
     includes.reject! do |include|
       mod = include.module
-      !(String === mod) && RDoc::TopLevel.all_modules_hash[mod.full_name].nil?
+      !(String === mod) && @store.modules_hash[mod.full_name].nil?
     end
 
     includes.uniq!
   end
 
+  ##
+  # Deletes from #extends those whose module has been removed from the
+  # documentation.
+  #--
+  # FIXME: like update_includes, extends are not reliably removed
+
+  def update_extends
+    extends.reject! do |ext|
+      mod = ext.module
+
+      !(String === mod) && @store.modules_hash[mod.full_name].nil?
+    end
+
+    extends.uniq!
+  end
+
 end