rdoc 3.12.2 → 4.0.0.preview2

data/test/test_rdoc_code_object.rb

@@ -174,7 +174,7 @@ class TestRDocCodeObject < XrefTestCase
   def test_file_name
     assert_equal nil, @co.file_name
 
-    @co.record_location RDoc::TopLevel.new 'lib/file.rb'
+    @co.record_location @store.add_file 'lib/file.rb'
 
     assert_equal 'lib/file.rb', @co.file_name
   end
@@ -263,6 +263,26 @@ class TestRDocCodeObject < XrefTestCase
     refute @co.ignored?
   end
 
+  def test_section
+    parent = RDoc::Context.new
+    section = parent.sections.first
+
+    @co.parent = parent
+    @co.instance_variable_set :@section, section
+
+    assert_equal section, @co.section
+
+    @co.instance_variable_set :@section, nil
+    @co.instance_variable_set :@section_title, nil
+
+    assert_equal section, @co.section
+
+    @co.instance_variable_set :@section, nil
+    @co.instance_variable_set :@section_title, 'new title'
+
+    assert_equal 'new title', @co.section.title
+  end
+
   def test_start_doc
     @co.document_self = false
     @co.document_children = false

data/test/test_rdoc_comment.rb

@@ -7,7 +7,7 @@ class TestRDocComment < RDoc::TestCase
   def setup
     super
 
-    @top_level = RDoc::TopLevel.new 'file.rb'
+    @top_level = @store.add_file 'file.rb'
     @comment = RDoc::Comment.new
     @comment.location = @top_level
     @comment.text = 'this is a comment'

data/test/test_rdoc_constant.rb

@@ -8,6 +8,138 @@ class TestRDocConstant < XrefTestCase
     @const = @c1.constants.first
   end
 
+  def test_full_name
+    assert_equal 'C1::CONST', @const.full_name
+  end
+
+  def test_is_alias_for
+    top_level = @store.add_file 'file.rb'
+
+    c = RDoc::Constant.new 'CONST', nil, 'comment'
+    top_level.add_constant c
+
+    assert_nil c.is_alias_for
+
+    c.is_alias_for = 'C1'
+
+    assert_equal @c1, c.is_alias_for
+
+    c.is_alias_for = 'unknown'
+
+    assert_equal 'unknown', c.is_alias_for
+  end
+
+  def test_marshal_dump
+    top_level = @store.add_file 'file.rb'
+
+    c = RDoc::Constant.new 'CONST', nil, 'this is a comment'
+    c.record_location top_level
+
+    aliased = top_level.add_class RDoc::NormalClass, 'Aliased'
+    c.is_alias_for = aliased
+
+    cm = top_level.add_class RDoc::NormalClass, 'Klass'
+    cm.add_constant c
+
+    section = cm.sections.first
+
+    loaded = Marshal.load Marshal.dump c
+    loaded.store = @store
+
+    comment = doc(para('this is a comment'))
+
+    assert_equal c, loaded
+
+    assert_equal aliased,        loaded.is_alias_for
+    assert_equal comment,        loaded.comment
+    assert_equal top_level,      loaded.file
+    assert_equal 'Klass::CONST', loaded.full_name
+    assert_equal 'CONST',        loaded.name
+    assert_nil                   loaded.visibility
+    assert_equal cm,             loaded.parent
+    assert_equal section,        loaded.section
+  end
+
+  def test_marshal_load
+    top_level = @store.add_file 'file.rb'
+
+    c = RDoc::Constant.new 'CONST', nil, 'this is a comment'
+    c.record_location top_level
+
+    cm = top_level.add_class RDoc::NormalClass, 'Klass'
+    cm.add_constant c
+
+    section = cm.sections.first
+
+    loaded = Marshal.load Marshal.dump c
+    loaded.store = @store
+
+    comment = doc(para('this is a comment'))
+
+    assert_equal c, loaded
+
+    assert_nil                   loaded.is_alias_for
+    assert_equal comment,        loaded.comment
+    assert_equal top_level,      loaded.file
+    assert_equal 'Klass::CONST', loaded.full_name
+    assert_equal 'CONST',        loaded.name
+    assert_nil                   loaded.visibility
+    assert_equal cm,             loaded.parent
+    assert_equal section,        loaded.section
+  end
+
+  def test_marshal_load_version_0
+    top_level = @store.add_file 'file.rb'
+
+    aliased = top_level.add_class RDoc::NormalClass, 'Aliased'
+    cm      = top_level.add_class RDoc::NormalClass, 'Klass'
+    section = cm.sections.first
+
+    loaded = Marshal.load "\x04\bU:\x13RDoc::Constant[\x0Fi\x00I" +
+                          "\"\nCONST\x06:\x06ETI\"\x11Klass::CONST\x06" +
+                          ";\x06T0I\"\fAliased\x06;\x06To" +
+                          ":\eRDoc::Markup::Document\a:\v@parts[\x06o" +
+                          ":\x1CRDoc::Markup::Paragraph\x06;\b[\x06I" +
+                          "\"\x16this is a comment\x06;\x06T:\n@file0I" +
+                          "\"\ffile.rb\x06;\x06TI\"\nKlass\x06" +
+                          ";\x06Tc\x16RDoc::NormalClass0"
+
+    loaded.store = @store
+
+    comment = doc(para('this is a comment'))
+
+    assert_equal aliased,        loaded.is_alias_for
+    assert_equal comment,        loaded.comment
+    assert_equal top_level,      loaded.file
+    assert_equal 'Klass::CONST', loaded.full_name
+    assert_equal 'CONST',        loaded.name
+    assert_nil                   loaded.visibility
+    assert_equal cm,             loaded.parent
+    assert_equal section,        loaded.section
+  end
+
+  def test_marshal_round_trip
+    top_level = @store.add_file 'file.rb'
+
+    c = RDoc::Constant.new 'CONST', nil, 'this is a comment'
+    c.record_location top_level
+    c.is_alias_for = 'Unknown'
+
+    cm = top_level.add_class RDoc::NormalClass, 'Klass'
+    cm.add_constant c
+
+    section = cm.sections.first
+
+    loaded = Marshal.load Marshal.dump c
+    loaded.store = @store
+
+    reloaded = Marshal.load Marshal.dump loaded
+    reloaded.store = @store
+
+    assert_equal section,   reloaded.section
+    assert_equal 'Unknown', reloaded.is_alias_for
+  end
+
   def test_path
     assert_equal 'C1.html#CONST', @const.path
   end

data/test/test_rdoc_context.rb

@@ -6,6 +6,8 @@ class TestRDocContext < XrefTestCase
     super
 
     @context = RDoc::Context.new
+    @context.store = @store
+
     @enumerator = # 1.8 vs 1.9
       Object.const_defined?(:Enumerator) ? Enumerator : Enumerable::Enumerator
   end
@@ -40,7 +42,7 @@ class TestRDocContext < XrefTestCase
   end
 
   def test_add_alias_method_attr
-    top_level = RDoc::TopLevel.new 'file.rb'
+    top_level = @store.add_file 'file.rb'
 
     attr = RDoc::Attr.new nil, 'old_name', 'R', ''
 
@@ -60,7 +62,7 @@ class TestRDocContext < XrefTestCase
   end
 
   def test_add_alias_method
-    top_level = RDoc::TopLevel.new 'file.rb'
+    top_level = @store.add_file 'file.rb'
 
     meth = RDoc::AnyMethod.new nil, 'old_name'
     meth.singleton = false
@@ -103,7 +105,7 @@ class TestRDocContext < XrefTestCase
     @c1.add_class RDoc::NormalClass, 'Klass', 'Object'
 
     assert_includes @c1.classes.map { |k| k.full_name }, 'C1::Klass'
-    assert_includes RDoc::TopLevel.classes.map { |k| k.full_name }, 'C1::Klass'
+    assert_includes @store.all_classes.map { |k| k.full_name }, 'C1::Klass'
   end
 
   def test_add_class_basic_object
@@ -142,7 +144,7 @@ class TestRDocContext < XrefTestCase
     @c1.add_class RDoc::NormalClass, 'Klass', 'Object'
 
     assert_includes @c1.classes.map { |k| k.full_name }, 'C1::Klass'
-    assert_includes RDoc::TopLevel.classes.map { |k| k.full_name }, 'C1::Klass'
+    assert_includes @store.all_classes.map { |k| k.full_name }, 'C1::Klass'
   end
 
   def test_add_class_superclass
@@ -163,9 +165,9 @@ class TestRDocContext < XrefTestCase
     refute_includes @c1.modules.map { |k| k.full_name }, 'C1::Klass',
                     'c1 modules'
 
-    assert_includes RDoc::TopLevel.classes.map { |k| k.full_name }, 'C1::Klass',
+    assert_includes @store.all_classes.map { |k| k.full_name }, 'C1::Klass',
                     'TopLevel classes'
-    refute_includes RDoc::TopLevel.modules.map { |k| k.full_name }, 'C1::Klass',
+    refute_includes @store.all_modules.map { |k| k.full_name }, 'C1::Klass',
                     'TopLevel modules'
   end
 
@@ -176,6 +178,13 @@ class TestRDocContext < XrefTestCase
     assert_equal [const], @context.constants
   end
 
+  def test_add_extend
+    ext = RDoc::Extend.new 'Name', 'comment'
+    @context.add_extend ext
+
+    assert_equal [ext], @context.extends
+  end
+
   def test_add_include
     incl = RDoc::Include.new 'Name', 'comment'
     @context.add_include incl
@@ -207,6 +216,34 @@ class TestRDocContext < XrefTestCase
     assert_equal %w[old_name new_name], @context.method_list.map { |m| m.name }
   end
 
+  def test_add_method_duplicate
+    @store.rdoc.options.verbosity = 2
+
+    meth1 = RDoc::AnyMethod.new nil, 'name'
+    meth1.record_location @store.add_file 'first.rb'
+    meth1.visibility = nil
+    meth1.comment = comment 'first'
+
+    @context.add_method meth1
+
+    meth2 = RDoc::AnyMethod.new nil, 'name'
+    meth2.record_location @store.add_file 'second.rb'
+    meth2.comment = comment 'second'
+
+    _, err = verbose_capture_io do
+      @context.add_method meth2
+    end
+
+    expected = 'Duplicate method (unknown)#name in file second.rb, ' \
+               'previously in file first.rb'
+
+    assert_equal expected, err.chomp
+
+    method = @context.method_list.first
+
+    assert_equal 'first', method.comment.text
+  end
+
   def test_add_module
     @c1.add_module RDoc::NormalModule, 'Mod'
 
@@ -214,18 +251,35 @@ class TestRDocContext < XrefTestCase
   end
 
   def test_add_module_alias
-    tl = RDoc::TopLevel.new 'file.rb'
+    tl = @store.add_file 'file.rb'
 
     c3_c4 = @c2.add_module_alias @c2_c3, 'C4', tl
 
-    c4 = @c2.find_module_named('C4')
-
     alias_constant = @c2.constants.first
 
-    assert_equal c4, c3_c4
+    assert_equal 'C2::C4', c3_c4.full_name
     assert_equal tl, alias_constant.file
   end
 
+  def test_add_module_alias_top_level
+    store = RDoc::Store.new
+
+    top_level = store.add_file 'file.rb'
+
+    klass  = top_level.add_class RDoc::NormalClass, 'Klass'
+    klass.comment = 'klass comment'
+
+    object = top_level.add_class RDoc::NormalClass, 'Object'
+
+    top_level.add_module_alias klass, 'A', top_level
+
+    refute_empty object.constants
+
+    constant = object.constants.first
+
+    assert_equal 'klass comment', constant.comment
+  end
+
   def test_add_module_class
     k = @c1.add_class RDoc::NormalClass, 'Klass', nil
     m = @c1.add_module RDoc::NormalModule, 'Klass'
@@ -245,18 +299,20 @@ class TestRDocContext < XrefTestCase
   def test_add_section
     default_section = @context.sections.first
 
-    @context.add_section nil, RDoc::Comment.new('# comment', @top_level)
+    @context.add_section nil, comment('comment', @top_level)
 
     assert_equal 1, @context.sections.length
-    assert_equal '# comment', @context.sections.first.comment.text
+    assert_equal [comment("comment", @top_level)],
+                 @context.sections.first.comments
 
-    @context.add_section nil, RDoc::Comment.new('# new comment', @top_level)
+    @context.add_section nil, comment('new comment', @top_level)
 
     assert_equal 1, @context.sections.length
-    assert_equal "# comment\n# ---\n# new comment",
-                 @context.sections.first.comment.text
+    assert_equal [comment('comment', @top_level),
+                  comment('new comment', @top_level)],
+                 @context.sections.first.comments
 
-    @context.add_section 'other', RDoc::Comment.new('', @top_level)
+    @context.add_section 'other', comment('', @top_level)
 
     assert_equal 2, @context.sections.length
 
@@ -340,7 +396,7 @@ class TestRDocContext < XrefTestCase
 
   def test_classes
     assert_equal %w[C2::C3], @c2.classes.map { |k| k.full_name }
-    assert_equal %w[C3::H1 C3::H2], @c3.classes.map { |k| k.full_name }
+    assert_equal %w[C3::H1 C3::H2], @c3.classes.map { |k| k.full_name }.sort
   end
 
   def test_current_section
@@ -357,7 +413,7 @@ class TestRDocContext < XrefTestCase
   def test_defined_in_eh
     assert @c1.defined_in?(@c1.top_level)
 
-    refute @c1.defined_in?(RDoc::TopLevel.new('name.rb'))
+    refute @c1.defined_in?(@store.add_file('name.rb'))
   end
 
   def test_equals2
@@ -475,6 +531,16 @@ class TestRDocContext < XrefTestCase
     assert_equal @c1__m, @c1.find_symbol('::m')
   end
 
+  def test_find_symbol_module
+    assert_nil @m1_m2.find_symbol_module 'N'
+    assert_nil @m1_m2.find_symbol_module 'M2::M1'
+
+    @m1_m2.parent = nil # loaded from legacy ri store
+
+    assert_nil @m1_m2.find_symbol_module 'N'
+    assert_nil @m1_m2.find_symbol_module 'M2::M1'
+  end
+
   def test_fully_documented_eh
     context = RDoc::Context.new
 

data/test/test_rdoc_context_section.rb

@@ -5,32 +5,53 @@ class TestRDocContextSection < RDoc::TestCase
   def setup
     super
 
+    @top_level = @store.add_file 'file.rb'
+
+    @klass = @top_level.add_class RDoc::NormalClass, 'Object'
+
     @S = RDoc::Context::Section
-    @s = @S.new nil, 'section', comment('# comment')
+    @s = @S.new @klass, 'section', comment('# comment', @top_level)
   end
 
-  def test_aref
-    assert_equal 'section', @s.aref
+  def mu_pp obj
+    s = ''
+    s = PP.pp obj, s
+    s.force_encoding Encoding.default_external if defined? Encoding
+    s.chomp
+  end
 
-    assert_equal '5Buntitled-5D', @S.new(nil, nil, nil).aref
+  def test_add_comment
+    file1 = @store.add_file 'file1.rb'
 
-    assert_equal 'one+two', @S.new(nil, 'one two', nil).aref
-  end
+    klass = file1.add_class RDoc::NormalClass, 'Klass'
+
+    c1 = RDoc::Comment.new "# :section: section\n", file1
+    c2 = RDoc::Comment.new "# hello\n",             file1
+    c3 = RDoc::Comment.new "# world\n",             file1
+
+    s = @S.new klass, 'section', c1
+
+    assert_empty s.comments
 
-  def test_comment_equals
-    @s.comment = RDoc::Comment.new "# :section: section\n"
+    s.add_comment nil
 
-    assert_equal "# comment", @s.comment.text
+    assert_empty s.comments
 
-    @s.comment = RDoc::Comment.new "# :section: section\n# other"
+    s.add_comment c2
 
-    assert_equal "# comment\n# ---\n# other", @s.comment.text
+    assert_equal [c2], s.comments
 
-    s = @S.new nil, nil, nil
+    s.add_comment c3
 
-    s.comment = RDoc::Comment.new "# :section:\n# other"
+    assert_equal [c2, c3], s.comments
+  end
+
+  def test_aref
+    assert_equal 'section', @s.aref
+
+    assert_equal '5Buntitled-5D', @S.new(nil, nil, nil).aref
 
-    assert_equal "# other", s.comment.text
+    assert_equal 'one+two', @S.new(nil, 'one two', nil).aref
   end
 
   def test_extract_comment
@@ -41,8 +62,71 @@ class TestRDocContextSection < RDoc::TestCase
                  @s.extract_comment(comment("# a\n# :section: b\n# c")).text
   end
 
+  def test_marshal_dump
+    loaded = Marshal.load Marshal.dump @s
+
+    expected = RDoc::Comment.new('comment', @top_level).parse
+    expected = doc(expected)
+
+    assert_equal 'section', loaded.title
+    assert_equal expected,  loaded.comments
+    assert_nil              loaded.parent, 'parent is set manually'
+  end
+
+  def test_marshal_dump_no_comment
+    s = @S.new @klass, 'section', comment('')
+
+    loaded = Marshal.load Marshal.dump s
+
+    assert_equal 'section', loaded.title
+    assert_empty            loaded.comments
+    assert_nil              loaded.parent, 'parent is set manually'
+  end
+
+  def test_marshal_load_version_0
+    loaded = Marshal.load "\x04\bU:\eRDoc::Context::Section" +
+                          "[\bi\x00I\"\fsection\x06:\x06EFo" +
+                          ":\eRDoc::Markup::Document\a:\v@parts" +
+                          "[\x06o;\a\a;\b[\x06o" +
+                          ":\x1CRDoc::Markup::Paragraph\x06;\b" +
+                          "[\x06I\"\fcomment\x06;\x06F:\n@fileI" +
+                          "\"\ffile.rb\x06;\x06F;\n0"
+
+    expected = doc RDoc::Comment.new('comment', @top_level).parse
+
+    assert_equal 'section', loaded.title
+    assert_equal expected,  loaded.comments
+    assert_nil              loaded.parent, 'parent is set manually'
+  end
+
+  def test_remove_comment_array
+    other = @store.add_file 'other.rb'
+
+    other_comment = comment('bogus', other)
+
+    @s.add_comment other_comment
+
+    @s.remove_comment comment('bogus', @top_level)
+
+    assert_equal [other_comment], @s.comments
+  end
+
+  def test_remove_comment_document
+    other = @store.add_file 'other.rb'
+
+    other_comment = comment('bogus', other)
+
+    @s.add_comment other_comment
+
+    loaded = Marshal.load Marshal.dump @s
+
+    loaded.remove_comment comment('bogus', @top_level)
+
+    assert_equal doc(other_comment.parse), loaded.comments
+  end
+
   def test_sequence
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       assert_match(/\ASEC\d{5}\Z/, @s.sequence)
     end