rdoc 3.6.1 → 3.7

data/test/test_rdoc_rdoc.rb

@@ -16,12 +16,27 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
 
     @stats = RDoc::Stats.new 0, 0
     @rdoc.instance_variable_set :@stats, @stats
-
-    @tempfile = Tempfile.new 'test_rdoc_rdoc'
   end
 
-  def teardown
-    @tempfile.close rescue nil # HACK for 1.8.6
+  def test_class_reset
+    tl = RDoc::TopLevel.new 'file.rb'
+    tl.add_class RDoc::NormalClass, 'C'
+    tl.add_class RDoc::NormalModule, 'M'
+
+    c = RDoc::Parser::C
+    enclosure_classes = c.send :class_variable_get, :@@enclosure_classes
+    enclosure_classes['A'] = 'B'
+    known_bodies = c.send :class_variable_get, :@@known_bodies
+    known_bodies['A'] = 'B'
+
+    RDoc::RDoc.reset
+
+    assert_empty RDoc::TopLevel.all_classes_hash
+    assert_empty RDoc::TopLevel.all_files_hash
+    assert_empty RDoc::TopLevel.all_modules_hash
+
+    assert_empty c.send :class_variable_get, :@@enclosure_classes
+    assert_empty c.send :class_variable_get, :@@known_bodies
   end
 
   def test_gather_files
@@ -47,6 +62,20 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
     assert_empty files
   end
 
+  def test_parse_file_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+    @rdoc.options.encoding = Encoding::ISO_8859_1
+
+    Tempfile.open 'test.txt' do |io|
+      io.write 'hi'
+      io.rewind
+
+      top_level = @rdoc.parse_file io.path
+
+      assert_equal Encoding::ISO_8859_1, top_level.absolute_name.encoding
+    end
+  end
+
   def test_remove_unparseable
     file_list = %w[
       blah.class
@@ -120,14 +149,16 @@ class TestRDocRDoc < MiniTest::Unit::TestCase
   end
 
   def test_setup_output_dir_exists_file
-    path = @tempfile.path
+    Tempfile.open 'test_rdoc_rdoc' do |tempfile|
+      path = tempfile.path
 
-    e = assert_raises RDoc::Error do
-      @rdoc.setup_output_dir path, false
-    end
+      e = assert_raises RDoc::Error do
+        @rdoc.setup_output_dir path, false
+      end
 
-    assert_match(%r%#{Regexp.escape path} exists and is not a directory%,
-                 e.message)
+      assert_match(%r%#{Regexp.escape path} exists and is not a directory%,
+                   e.message)
+    end
   end
 
   def test_setup_output_dir_exists_not_rdoc

data/test/test_rdoc_ri_driver.rb

@@ -22,11 +22,11 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
     ENV['HOME'] = @tmpdir
     ENV.delete 'RI'
 
-    options = RDoc::RI::Driver.process_args []
-    options[:home] = @tmpdir
-    options[:use_stdout] = true
-    options[:formatter] = @RM::ToRdoc
-    @driver = RDoc::RI::Driver.new options
+    @options = RDoc::RI::Driver.process_args []
+    @options[:home] = @tmpdir
+    @options[:use_stdout] = true
+    @options[:formatter] = @RM::ToRdoc
+    @driver = RDoc::RI::Driver.new @options
   end
 
   def teardown
@@ -191,12 +191,30 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_add_method_list
     out = @RM::Document.new
 
-    @driver.add_method_list out, %w[new], 'Class methods'
+    @driver.add_method_list out, %w[new parse], 'Class methods'
 
     expected = @RM::Document.new(
       @RM::Heading.new(1, 'Class methods:'),
       @RM::BlankLine.new,
       @RM::Verbatim.new('new'),
+      @RM::Verbatim.new('parse'),
+      @RM::BlankLine.new)
+
+    assert_equal expected, out
+  end
+
+  def test_add_method_list_interative
+    @options[:interactive] = true
+    driver = RDoc::RI::Driver.new @options
+
+    out = @RM::Document.new
+
+    driver.add_method_list out, %w[new parse], 'Class methods'
+
+    expected = @RM::Document.new(
+      @RM::Heading.new(1, 'Class methods:'),
+      @RM::BlankLine.new,
+      @RM::IndentedParagraph.new(2, 'new, parse'),
       @RM::BlankLine.new)
 
     assert_equal expected, out
@@ -272,6 +290,8 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_complete_classes
     util_store
 
+    assert_equal %w[                       ], @driver.complete('[')
+    assert_equal %w[                       ], @driver.complete('[::')
     assert_equal %w[Foo                    ], @driver.complete('F')
     assert_equal %w[Foo:: Foo::Bar Foo::Baz], @driver.complete('Foo::')
     assert_equal %w[      Foo::Bar Foo::Baz], @driver.complete('Foo::B')
@@ -621,11 +641,13 @@ Foo::Bar#bother
     util_store
 
     index = RDoc::AnyMethod.new nil, '[]'
+    index.record_location @top_level
     @cFoo.add_method index
     @store.save_method @cFoo, index
 
     c_index = RDoc::AnyMethod.new nil, '[]'
     c_index.singleton = true
+    c_index.record_location @top_level
     @cFoo.add_method c_index
     @store.save_method @cFoo, c_index
 
@@ -858,10 +880,12 @@ Foo::Bar#bother
     @cFoo_Baz.parent = @cFoo
 
     @baz = RDoc::AnyMethod.new nil, 'baz'
+    @baz.record_location @top_level
     @cBar.add_method @baz
 
     @override = RDoc::AnyMethod.new nil, 'override'
     @override.comment = 'must be displayed'
+    @override.record_location @top_level
     @cBar.add_method @override
 
     @store2.save_class @mAmbiguous
@@ -879,6 +903,8 @@ Foo::Bar#bother
   def util_store
     @store = RDoc::RI::Store.new @home_ri
 
+    @top_level = RDoc::TopLevel.new 'file.rb'
+
     @cFoo       = RDoc::NormalClass.new 'Foo'
     @mInc       = RDoc::NormalModule.new 'Inc'
     @cAmbiguous = RDoc::NormalClass.new 'Ambiguous'
@@ -886,6 +912,7 @@ Foo::Bar#bother
     doc = @RM::Document.new @RM::Paragraph.new('Include thingy')
 
     @cFooInc = RDoc::Include.new 'Inc', doc
+    @cFooInc.record_location @top_level
     @cFoo.add_include @cFooInc
 
     @cFoo_Bar = RDoc::NormalClass.new 'Bar'
@@ -893,12 +920,15 @@ Foo::Bar#bother
 
     @blah = RDoc::AnyMethod.new nil, 'blah'
     @blah.call_seq = "blah(5) => 5\nblah(6) => 6\n"
+    @blah.record_location @top_level
 
     @bother = RDoc::AnyMethod.new nil, 'bother'
-    @bother.params = "(things)"
     @bother.block_params = "stuff"
+    @bother.params = "(things)"
+    @bother.record_location @top_level
 
     @new  = RDoc::AnyMethod.new nil, 'new'
+    @new.record_location @top_level
     @new.singleton = true
 
     @cFoo_Bar.add_method @blah
@@ -906,6 +936,7 @@ Foo::Bar#bother
     @cFoo_Bar.add_method @new
 
     @attr = RDoc::Attr.new nil, 'attr', 'RW', ''
+    @attr.record_location @top_level
 
     @cFoo_Bar.add_attribute @attr
 
@@ -913,11 +944,13 @@ Foo::Bar#bother
     @cFoo_Baz.parent = @cFoo
 
     @inherit = RDoc::AnyMethod.new nil, 'inherit'
+    @inherit.record_location @top_level
     @cFoo.add_method @inherit
 
     # overriden by Bar in multi_store
     @overriden = RDoc::AnyMethod.new nil, 'override'
     @overriden.comment = 'must not be displayed'
+    @overriden.record_location @top_level
     @cFoo.add_method @overriden
 
     @store.save_class @cFoo

data/test/test_rdoc_ri_store.rb

@@ -4,9 +4,12 @@ require 'rdoc/ri'
 require 'rdoc/markup'
 require 'tmpdir'
 require 'fileutils'
+require 'pp'
 
 class TestRDocRIStore < MiniTest::Unit::TestCase
 
+  OBJECT_ANCESTORS = defined?(::BasicObject) ? %w[BasicObject] : []
+
   def setup
     RDoc::TopLevel.reset
 
@@ -16,15 +19,20 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     @top_level = RDoc::TopLevel.new 'file.rb'
 
     @klass = @top_level.add_class RDoc::NormalClass, 'Object'
-    @klass.comment = 'original'
+    @klass.add_comment 'original', @top_level
 
     @cmeth = RDoc::AnyMethod.new nil, 'cmethod'
     @cmeth.singleton = true
+    @cmeth.record_location @top_level
 
     @meth = RDoc::AnyMethod.new nil, 'method'
+    @meth.record_location @top_level
+
     @meth_bang = RDoc::AnyMethod.new nil, 'method!'
+    @meth_bang.record_location @top_level
 
     @attr = RDoc::Attr.new nil, 'attr', 'RW', ''
+    @attr.record_location @top_level
 
     @klass.add_method @cmeth
     @klass.add_method @meth
@@ -33,7 +41,10 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
 
     @nest_klass = @klass.add_class RDoc::NormalClass, 'SubClass'
     @nest_meth = RDoc::AnyMethod.new nil, 'method'
+    @nest_meth.record_location @top_level
+
     @nest_incl = RDoc::Include.new 'Incl', ''
+    @nest_incl.record_location @top_level
 
     @nest_klass.add_method @nest_meth
     @nest_klass.add_include @nest_incl
@@ -45,15 +56,32 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     FileUtils.rm_rf @tmpdir
   end
 
+  def mu_pp obj
+    s = ''
+    s = PP.pp obj, s
+    s.force_encoding Encoding.default_external if defined? Encoding
+    s.chomp
+  end
+
   def assert_cache imethods, cmethods, attrs, modules, ancestors = {}
+    imethods ||= { 'Object' => %w[method method!] }
+    cmethods ||= { 'Object' => %w[cmethod] }
+    attrs    ||= { 'Object' => ['attr_accessor attr'] }
+
+    # this is sort-of a hack
+    @s.clean_cache_collection ancestors
+
     expected = {
+      :ancestors        => ancestors,
+      :attributes       => attrs,
       :class_methods    => cmethods,
+      :encoding         => nil,
       :instance_methods => imethods,
-      :attributes       => attrs,
       :modules          => modules,
-      :ancestors        => ancestors
     }
 
+    @s.save_cache
+
     assert_equal expected, @s.cache
   end
 
@@ -138,8 +166,9 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
 
   def test_load_cache
     cache = {
-      :methods => %w[Object#method],
-      :modules => %w[Object],
+      :encoding => :encoding_value,
+      :methods  => %w[Object#method],
+      :modules  => %w[Object],
     }
 
     Dir.mkdir @tmpdir
@@ -151,6 +180,32 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     @s.load_cache
 
     assert_equal cache, @s.cache
+
+    assert_equal :encoding_value, @s.encoding
+  end
+
+  def test_load_cache_encoding_differs
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    cache = {
+      :encoding => Encoding::ISO_8859_1,
+      :methods  => %w[Object#method],
+      :modules  => %w[Object],
+    }
+
+    Dir.mkdir @tmpdir
+
+    open File.join(@tmpdir, 'cache.ri'), 'wb' do |io|
+      Marshal.dump cache, io
+    end
+
+    @s.encoding = Encoding::UTF_8
+
+    @s.load_cache
+
+    assert_equal cache, @s.cache
+
+    assert_equal Encoding::UTF_8, @s.encoding
   end
 
   def test_load_cache_no_cache
@@ -158,6 +213,7 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
       :ancestors        => {},
       :attributes       => {},
       :class_methods    => {},
+      :encoding         => nil,
       :instance_methods => {},
       :modules          => [],
     }
@@ -199,6 +255,7 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     @s.save_method @klass, @meth
     @s.save_method @klass, @cmeth
     @s.save_class @nest_klass
+    @s.encoding = :encoding_value
 
     @s.save_cache
 
@@ -207,12 +264,15 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     expected = {
       :attributes => { 'Object' => ['attr_accessor attr'] },
       :class_methods => { 'Object' => %w[cmethod] },
-      :instance_methods => { 'Object' => %w[method] },
+      :instance_methods => {
+        'Object' => %w[method method!],
+        'Object::SubClass' => %w[method],
+      },
       :modules => %w[Object Object::SubClass],
       :ancestors => {
-        'Object'           => %w[],
         'Object::SubClass' => %w[Incl Object],
       },
+      :encoding => :encoding_value,
     }
 
     expected[:ancestors]['Object'] = %w[BasicObject] if defined?(::BasicObject)
@@ -252,10 +312,7 @@ 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' => object_ancestors)
+    assert_cache nil, nil, nil, %w[Object], 'Object' => OBJECT_ANCESTORS
 
     assert_equal @klass, @s.load_class('Object')
   end
@@ -268,12 +325,45 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert_directory File.join(@tmpdir, 'Object')
     assert_file File.join(@tmpdir, 'Object', 'cdesc-Object.ri')
 
-    assert_cache({}, {}, { 'Object' => ['attr_accessor attr'] }, %w[Object],
-                 'Object' => %w[])
+    assert_cache(nil, nil, nil, %w[Object])
 
     assert_equal @klass, @s.load_class('Object')
   end
 
+  def test_save_class_delete
+    # save original
+    @s.save_class @klass
+    @s.save_method @klass, @meth
+    @s.save_method @klass, @meth_bang
+    @s.save_method @klass, @cmeth
+    @s.save_cache
+
+    klass = RDoc::NormalClass.new 'Object'
+
+    meth = klass.add_method RDoc::AnyMethod.new(nil, 'replace')
+    meth.record_location @top_level
+
+    # load original, save newly updated class
+    @s = RDoc::RI::Store.new @tmpdir
+    @s.load_cache
+    @s.save_class klass
+    @s.save_cache
+
+    # load from disk again
+    @s = RDoc::RI::Store.new @tmpdir
+    @s.load_cache
+
+    @s.load_class 'Object'
+
+    assert_cache({ 'Object' => %w[replace] }, {},
+                 { 'Object' => %w[attr_accessor\ attr] }, %w[Object],
+                 'Object' => OBJECT_ANCESTORS)
+
+    refute File.exist? @s.method_file(@klass.full_name, @meth.full_name)
+    refute File.exist? @s.method_file(@klass.full_name, @meth_bang.full_name)
+    refute File.exist? @s.method_file(@klass.full_name, @cmeth.full_name)
+  end
+
   def test_save_class_dry_run
     @s.dry_run = true
 
@@ -287,16 +377,17 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     @s.save_class @klass
 
     klass = RDoc::NormalClass.new 'Object'
-    klass.comment = 'new class'
+    klass.add_comment 'new comment', @top_level
 
     s = RDoc::RI::Store.new @tmpdir
     s.save_class klass
 
     s = RDoc::RI::Store.new @tmpdir
 
-    document = @RM::Document.new(
-      @RM::Paragraph.new('original'),
-      @RM::Paragraph.new('new class'))
+    inner = @RM::Document.new @RM::Paragraph.new 'new comment'
+    inner.file = @top_level.absolute_name
+
+    document = @RM::Document.new inner
 
     assert_equal document, s.load_class('Object').comment
   end
@@ -307,10 +398,7 @@ 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' => object_ancestors)
+    assert_cache nil, nil, nil, %w[Object], 'Object' => OBJECT_ANCESTORS
 
     assert_equal @klass, @s.load_class('Object')
   end
@@ -321,8 +409,8 @@ class TestRDocRIStore < MiniTest::Unit::TestCase
     assert_directory File.join(@tmpdir, 'Object', 'SubClass')
     assert_file File.join(@tmpdir, 'Object', 'SubClass', 'cdesc-SubClass.ri')
 
-    assert_cache({}, {}, {}, %w[Object::SubClass],
-                 'Object::SubClass' => %w[Incl Object])
+    assert_cache({ 'Object::SubClass' => %w[method] }, {}, {},
+                 %w[Object::SubClass], 'Object::SubClass' => %w[Incl Object])
   end
 
   def test_save_method