rdoc 3.6 → 3.6.1

data/History.txt

@@ -1,3 +1,11 @@
+=== 3.6.1 / 2011-05-15
+
+* Bug fixes
+  * Fix infinite loop created when re-encountering BasicObject.
+  * RDoc::Context#each_ancestor is now provided for duck-typing.
+  * rb_path2class() can now be used to discover the parent class in
+    rb_define_class_under.
+
 === 3.6 / 2011-05-13
 
 * Major Enhancements

data/lib/rdoc.rb

@@ -103,7 +103,7 @@ module RDoc
   ##
   # RDoc version you are using
 
-  VERSION = '3.6'
+  VERSION = '3.6.1'
 
   ##
   # Method visibilities

data/lib/rdoc/context.rb

@@ -373,6 +373,12 @@ class RDoc::Context < RDoc::CodeObject
       end
     end
 
+    # fix up superclass
+    superclass = nil if full_name == 'BasicObject'
+    superclass = nil if full_name == 'Object' and defined?(::BasicObject)
+    superclass = '::BasicObject' if
+      defined?(::BasicObject) and full_name == 'Object'
+
     # find the superclass full name
     if superclass then
       if superclass =~ /^:+/ then
@@ -657,6 +663,13 @@ class RDoc::Context < RDoc::CodeObject
     end
   end
 
+  ##
+  # Iterator for ancestors for duck-typing.  Does nothing.  See
+  # RDoc::ClassModule#each_ancestor.
+
+  def each_ancestor # :nodoc:
+  end
+
   ##
   # Iterator for attributes
 

data/lib/rdoc/parser/c.rb

@@ -218,13 +218,22 @@ class RDoc::Parser::C < RDoc::Parser
       handle_class_module(var_name, "module", class_name, nil, in_module)
     end
 
-    @content.scan(/([\w\.]+)\s* = \s*rb_define_class_under\s*
-                  \(
-                     \s*(\w+),
-                     \s*"(\w+)",
-                     \s*([\w\*\s\(\)\.\->]+)\s*  # for SWIG
-                  \s*\)/mx) do |var_name, in_module, class_name, parent|
-      handle_class_module(var_name, "class", class_name, parent, in_module)
+    @content.scan(/([\w\.]+)\s* =                  # var_name
+                   \s*rb_define_class_under\s*
+                   \(
+                     \s* (\w+),                    # under
+                     \s* "(\w+)",                  # class_name
+                     \s*
+                     (?:
+                       ([\w\*\s\(\)\.\->]+) |      # parent_name
+                       rb_path2class\("([\w:]+)"\) # path
+                     )
+                     \s*
+                   \)
+                  /mx) do |var_name, under, class_name, parent_name, path|
+      parent = path || parent_name
+
+      handle_class_module var_name, 'class', class_name, parent, under
     end
 
     @content.scan(/([\w\.]+)\s* = \s*rb_singleton_class\s*
@@ -650,8 +659,8 @@ class RDoc::Parser::C < RDoc::Parser
       enclosure = @classes[in_module] || @@enclosure_classes[in_module]
 
       if enclosure.nil? and enclosure = @known_classes[in_module] then
-        type = /^rb_m/ =~ in_module ? "module" : "class"
-        handle_class_module in_module, type, enclosure, nil, nil
+        enc_type = /^rb_m/ =~ in_module ? "module" : "class"
+        handle_class_module in_module, enc_type, enclosure, nil, nil
         enclosure = @classes[in_module]
       end
 
@@ -675,17 +684,21 @@ class RDoc::Parser::C < RDoc::Parser
       end
 
       cm = enclosure.add_class RDoc::NormalClass, class_name, parent_name
-
-      @stats.add_class cm
     else
       cm = enclosure.add_module RDoc::NormalModule, class_name
-      @stats.add_module cm
     end
 
     cm.record_location enclosure.top_level
 
     find_class_comment cm.full_name, cm
 
+    case cm
+    when RDoc::NormalClass
+      @stats.add_class cm
+    when RDoc::NormalModule
+      @stats.add_module cm
+    end
+
     @classes[var_name] = cm
     @@enclosure_classes[var_name] = cm
     @known_classes[var_name] = cm.full_name

data/test/test_rdoc_context.rb

@@ -105,6 +105,38 @@ class TestRDocContext < XrefTestCase
     assert_includes RDoc::TopLevel.classes.map { |k| k.full_name }, 'C1::Klass'
   end
 
+  def test_add_class_basic_object
+    skip 'BasicObject is 1.9 only' unless defined?(BasicObject)
+
+    @xref_data.add_class RDoc::NormalClass, 'BasicObject'
+
+    basic = @xref_data.find_module_named 'BasicObject'
+
+    assert_nil basic.superclass
+
+    @c1.add_class RDoc::NormalClass, 'BasicObject'
+
+    basic = @c1.find_module_named 'BasicObject'
+
+    assert_equal 'Object', basic.superclass
+  end
+
+  def test_add_class_object
+    root_class = defined?(BasicObject) ? 'BasicObject' : nil
+
+    @xref_data.add_class RDoc::NormalClass, 'Object'
+
+    object = @xref_data.find_module_named 'Object'
+
+    assert_equal root_class, object.superclass
+
+    @c1.add_class RDoc::NormalClass, 'Object'
+
+    object = @c1.find_module_named 'Object'
+
+    assert_equal 'Object', object.superclass.full_name
+  end
+
   def test_add_class_superclass
     @c1.add_class RDoc::NormalClass, 'Klass', 'Object'
     @c1.add_class RDoc::NormalClass, 'Klass', 'Other'

data/test/test_rdoc_parser_c.rb

@@ -236,27 +236,43 @@ VALUE cFoo = rb_define_class("Foo", rb_cObject);
     assert_equal "this is the Foo class", klass.comment
   end
 
-  def test_do_classes_singleton
+  def test_do_classes_class_under
     content = <<-EOF
-VALUE cFoo = rb_define_class("Foo", rb_cObject);
-VALUE cFooS = rb_singleton_class(cFoo);
+/* Document-class: Kernel::Foo
+ * this is the Foo class under Kernel
+ */
+VALUE cFoo = rb_define_class_under(rb_mKernel, "Foo", rb_cObject);
     EOF
 
-    util_get_class content, 'cFooS'
-
-    assert_equal 'Foo', @parser.singleton_classes['cFooS']
+    klass = util_get_class content, 'cFoo'
+    assert_equal 'Kernel::Foo', klass.full_name
+    assert_equal "this is the Foo class under Kernel", klass.comment
   end
 
-  def test_do_classes_class_under
+  def test_do_classes_class_under_rb_path2class
     content = <<-EOF
 /* Document-class: Kernel::Foo
- * this is the Foo class under Kernel
+ * this is Kernel::Foo < A::B
  */
-VALUE cFoo = rb_define_class_under(rb_mKernel, "Foo", rb_cObject);
+VALUE cFoo = rb_define_class_under(rb_mKernel, "Foo", rb_path2class("A::B"));
     EOF
 
     klass = util_get_class content, 'cFoo'
-    assert_equal "this is the Foo class under Kernel", klass.comment
+
+    assert_equal 'Kernel::Foo', klass.full_name
+    assert_equal 'A::B', klass.superclass
+    assert_equal 'this is Kernel::Foo < A::B', klass.comment
+  end
+
+  def test_do_classes_singleton
+    content = <<-EOF
+VALUE cFoo = rb_define_class("Foo", rb_cObject);
+VALUE cFooS = rb_singleton_class(cFoo);
+    EOF
+
+    util_get_class content, 'cFooS'
+
+    assert_equal 'Foo', @parser.singleton_classes['cFooS']
   end
 
   def test_do_classes_module

data/test/test_rdoc_ri_store.rb

@@ -215,6 +215,8 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
       },
     }
 
+    expected[:ancestors]['Object'] = %w[BasicObject] if defined?(::BasicObject)
+
     open File.join(@tmpdir, 'cache.ri'), 'rb' do |io|
       cache = Marshal.load io.read
 
@@ -250,8 +252,10 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert_directory File.join(@tmpdir, 'Object')
     assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri')
 
+    object_ancestors = defined?(::BasicObject) ? %w[BasicObject] : []
+
     assert_cache({}, {}, { 'Object' => ['attr_accessor attr'] }, %w[Object],
-                 'Object' => %w[])
+                 'Object' => object_ancestors)
 
     assert_equal @klass, @s.load_class('Object')
   end
@@ -303,8 +307,10 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert_directory File.join(@tmpdir, 'Object')
     assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri')
 
+    object_ancestors = defined?(::BasicObject) ? %w[BasicObject] : []
+
     assert_cache({}, {}, { 'Object' => ['attr_accessor attr'] }, %w[Object],
-                 'Object' => %w[])
+                 'Object' => object_ancestors)
 
     assert_equal @klass, @s.load_class('Object')
   end

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 29
   prerelease: 
   segments: 
   - 3
   - 6
-  version: "3.6"
+  - 1
+  version: 3.6.1
 platform: ruby
 authors: 
 - Eric Hodel
@@ -38,7 +39,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-05-14 00:00:00 Z
+date: 2011-05-15 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest