Updating Object in an ri data store now removes methods, etc. properly.

RDoc::Parser::Ruby lets the object model take care of document_self (mostly).

Author: drbrain

History.txt

@@ -3,6 +3,9 @@
 * Minor enhancements
   * RDoc::Parser::C can now discover methods on ENV and ARGF.
   * RDoc::Parser::C now knows about rb_cSocket and rb_mDL.
+* Bug fixes
+  * Updating Object in an ri data store with new data now removes methods,
+    includes, constants and aliases.
 
 === 3.7 / 2011-06-27
 

lib/rdoc/class_module.rb

@@ -115,7 +115,7 @@ def initialize(name, superclass = nil)
   # across multiple runs.
 
   def add_comment comment, location
-    return if comment.empty?
+    return if comment.empty? or not document_self
 
     original = comment
 
@@ -328,7 +328,10 @@ def merge class_module
       @comment = @comment_location = document
     end
 
-    merge_collections attributes, class_module.attributes do |add, attr|
+    cm = class_module
+    other_files = cm.in_files
+
+    merge_collections attributes, cm.attributes, other_files do |add, attr|
       if add then
         add_attribute attr
       else
@@ -337,7 +340,7 @@ def merge class_module
       end
     end
 
-    merge_collections constants, class_module.constants do |add, const|
+    merge_collections constants, cm.constants, other_files do |add, const|
       if add then
         add_constant const
       else
@@ -346,15 +349,15 @@ def merge class_module
       end
     end
 
-    merge_collections includes, class_module.includes do |add, incl|
+    merge_collections includes, cm.includes, other_files do |add, incl|
       if add then
         add_include incl
       else
         @includes.delete incl
       end
     end
 
-    merge_collections method_list, class_module.method_list do |add, meth|
+    merge_collections method_list, cm.method_list, other_files do |add, meth|
       if add then
         add_method meth
       else
@@ -367,15 +370,37 @@ def merge class_module
   end
 
   ##
-  # Merges collection +mine+ with +other+ preferring other.
-
-  def merge_collections mine, other, &block # :nodoc:
+  # Merges collection +mine+ with +other+ preferring other.  +other_files+ is
+  # used to help determine which items should be deleted.
+  #
+  # Yields whether the item should be added or removed (true or false) and the
+  # item to be added or removed.
+  #
+  #   merge_collections things, other.things, other.in_files do |add, thing|
+  #     if add then
+  #       # add the thing
+  #     else
+  #       # remove the thing
+  #     end
+  #   end
+
+  def merge_collections mine, other, other_files, &block # :nodoc:
     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
+
+      things.each do |thing|
+        yield false, thing
+      end
+
+      true
+    end
+
     other_things.each do |file, things|
       my_things[file].each { |thing| yield false, thing } if
-        my_things.include? file
+        my_things.include?(file)
 
       things.each do |thing|
         yield true, thing

lib/rdoc/parser/ruby.rb

@@ -478,7 +478,7 @@ def parse_attr(context, single, tk, comment)
 
       read_documentation_modifiers att, RDoc::ATTR_MODIFIERS
 
-      context.add_attribute att if att.document_self
+      context.add_attribute att
 
       @stats.add_attribute att
     else
@@ -499,6 +499,8 @@ def parse_attr_accessor(context, single, tk, comment)
 
     tmp = RDoc::CodeObject.new
     read_documentation_modifiers tmp, RDoc::ATTR_MODIFIERS
+    # TODO In most other places we let the context keep track of document_self
+    # and add found items appropriately but here we do not.  I'm not sure why.
     return unless tmp.document_self
 
     case tk.name
@@ -557,7 +559,7 @@ def parse_alias(context, single, tk, comment)
     al.line   = line_no
 
     read_documentation_modifiers al, RDoc::ATTR_MODIFIERS
-    context.add_alias al if al.document_self
+    context.add_alias al
     @stats.add_alias al
 
     al
@@ -633,7 +635,7 @@ def parse_class(container, single, tk, comment)
       cls.offset = offset
       cls.line   = line_no
 
-      cls.add_comment comment, @top_level if cls.document_self
+      cls.add_comment comment, @top_level
 
       @top_level.add_to_classes_or_modules cls
       @stats.add_class cls
@@ -657,7 +659,7 @@ def parse_class(container, single, tk, comment)
 
         # notify :nodoc: all if not a constant-named class/module
         # (and remove any comment)
-        unless name =~ /\A(::)?[A-Z]/
+        unless name =~ /\A(::)?[A-Z]/ then
           other.document_self = nil
           other.document_children = false
           other.clear_comment
@@ -758,7 +760,7 @@ def parse_constant(container, tk, comment)
     read_documentation_modifiers con, RDoc::CONSTANT_MODIFIERS
 
     @stats.add_constant con
-    container.add_constant con if con.document_self
+    container.add_constant con
     true
   end
 
@@ -797,7 +799,7 @@ def parse_comment(container, tk, comment)
 
       return unless meth.name
 
-      container.add_method meth if meth.document_self
+      container.add_method meth
 
       meth.comment = comment
 
@@ -818,7 +820,6 @@ def parse_comment(container, tk, comment)
       att.line      = line_no
 
       container.add_attribute att
-
       @stats.add_attribute att
     end
 
@@ -882,7 +883,6 @@ def parse_meta_attr(context, single, tk, comment)
 
     tmp = RDoc::CodeObject.new
     read_documentation_modifiers tmp, RDoc::ATTR_MODIFIERS
-    return unless tmp.document_self
 
     if comment.sub!(/^# +:?(attr(_reader|_writer|_accessor)?): *(\S*).*?\n/i, '') then
       rw = case $1
@@ -969,7 +969,7 @@ def parse_meta_method(container, single, tk, comment)
 
       extract_call_seq comment, meth
 
-      container.add_method meth if meth.document_self
+      container.add_method meth
 
       last_tk = tk
 
@@ -1238,7 +1238,7 @@ def parse_module(container, single, tk, comment)
     mod.record_location @top_level
 
     read_documentation_modifiers mod, RDoc::CLASS_MODIFIERS
-    mod.add_comment comment, @top_level if mod.document_self
+    mod.add_comment comment, @top_level
     parse_statements(mod)
 
     @top_level.add_to_classes_or_modules mod
@@ -1341,23 +1341,15 @@ def parse_statements(container, single = NORMAL, current_method = nil,
         end
 
       when TkDEF then
-        if container.document_self then
-          parse_method container, single, tk, comment
-        else
-          nest += 1
-        end
+        parse_method container, single, tk, comment
 
       when TkCONSTANT then
-        if container.document_self then
-          if not parse_constant container, tk, comment then
-            try_parse_comment = true
-          end
+        unless parse_constant container, tk, comment then
+          try_parse_comment = true
         end
 
       when TkALIAS then
-        if container.document_self and not current_method then
-          parse_alias container, single, tk, comment
-        end
+        parse_alias container, single, tk, comment unless current_method
 
       when TkYIELD then
         if current_method.nil? then
@@ -1395,12 +1387,11 @@ def parse_statements(container, single = NORMAL, current_method = nil,
           when /^attr_(reader|writer|accessor)$/ then
             parse_attr_accessor container, single, tk, comment
           when 'alias_method' then
-            parse_alias container, single, tk, comment if
-              container.document_self
+            parse_alias container, single, tk, comment
           when 'require', 'include' then
             # ignore
           else
-            if container.document_self and comment =~ /\A#\#$/ then
+            if comment =~ /\A#\#$/ then
               case comment
               when /^# +:?attr(_reader|_writer|_accessor)?:/ then
                 parse_meta_attr container, single, tk, comment
@@ -1523,11 +1514,12 @@ def parse_symbol_in_arg
   end
 
   ##
-  # Parses statements at the toplevel in +container+
+  # Parses statements in the top-level +container+
 
   def parse_top_level_statements(container)
     comment = collect_first_comment
     look_for_directives_in(container, comment)
+    # HACK move if to RDoc::Context#comment=
     container.comment = comment if container.document_self unless comment.empty?
     parse_statements container, NORMAL, nil, comment
   end

lib/rdoc/ri/store.rb

@@ -268,11 +268,7 @@ def save_class klass
     path = class_file full_name
 
     begin
-      disk_klass = nil
-
-      open path, 'rb' do |io|
-        disk_klass = Marshal.load io.read
-      end
+      disk_klass = load_class full_name
 
       klass = disk_klass.merge klass
     rescue Errno::ENOENT

lib/rdoc/top_level.rb

@@ -322,6 +322,7 @@ def == other
   # Adds +an_alias+ to +Object+ instead of +self+.
 
   def add_alias(an_alias)
+    object_class.record_location self
     return an_alias unless @document_self
     object_class.add_alias an_alias
   end
@@ -330,6 +331,7 @@ def add_alias(an_alias)
   # Adds +constant+ to +Object+ instead of +self+.
 
   def add_constant(constant)
+    object_class.record_location self
     return constant unless @document_self
     object_class.add_constant constant
   end
@@ -338,6 +340,7 @@ def add_constant(constant)
   # Adds +include+ to +Object+ instead of +self+.
 
   def add_include(include)
+    object_class.record_location self
     return include unless @document_self
     object_class.add_include include
   end
@@ -346,6 +349,7 @@ def add_include(include)
   # Adds +method+ to +Object+ instead of +self+.
 
   def add_method(method)
+    object_class.record_location self
     return method unless @document_self
     object_class.add_method method
   end

test/test_rdoc_class_module.rb

@@ -40,6 +40,17 @@ def test_add_comment
     assert_equal "comment 1\n---\ncomment 2\n---\n* comment 3", cm.comment
   end
 
+  def test_add_comment_stopdoc
+    tl = RDoc::TopLevel.new 'file.rb'
+
+    cm = RDoc::ClassModule.new 'Klass'
+    cm.stop_doc
+
+    cm.add_comment '# comment 1', tl
+
+    assert_empty cm.comment
+  end
+
   def test_ancestors
     assert_equal [@parent], @child.ancestors
   end
@@ -258,6 +269,33 @@ def test_merge_attributes_version_0
     assert_equal expected, cm1.attributes.sort
   end
 
+  def test_merge_collections_drop
+    tl = RDoc::TopLevel.new 'file'
+
+    cm1 = RDoc::ClassModule.new 'C'
+    cm1.record_location tl
+
+    const = cm1.add_constant RDoc::Constant.new('CONST', nil, nil)
+    const.record_location tl
+
+    cm2 = RDoc::ClassModule.new 'C'
+    cm2.record_location tl
+
+    added = []
+    removed = []
+
+    cm1.merge_collections cm1.constants, cm2.constants, cm2.in_files do |add, c|
+      if add then
+        added << c
+      else
+        removed << c
+      end
+    end
+
+    assert_empty added
+    assert_equal [const], removed
+  end
+
   def test_merge_comment
     tl1 = RDoc::TopLevel.new 'one.rb'
     tl2 = RDoc::TopLevel.new 'two.rb'