rdoc 3.12.2 → 4.0.0.preview2

data/test/test_rdoc_task.rb

@@ -16,13 +16,13 @@ class TestRDocTask < RDoc::TestCase
   end
 
   def test_inline_source
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       assert @t.inline_source
     end
 
     assert_equal "RDoc::Task#inline_source is deprecated\n", err
 
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       @t.inline_source = false
     end
 

data/test/test_rdoc_text.rb

@@ -9,7 +9,16 @@ class TestRDocText < RDoc::TestCase
   def setup
     super
 
-    @top_level = RDoc::TopLevel.new 'file.rb'
+    @options = RDoc::Options.new
+
+    @top_level = @store.add_file 'file.rb'
+  end
+
+  def mu_pp obj
+    s = ''
+    s = PP.pp obj, s
+    s = s.force_encoding Encoding.default_external if defined? Encoding
+    s.chomp
   end
 
   def test_self_encode_fallback
@@ -144,7 +153,7 @@ The comments associated with
     text = <<-TEXT
 /*
  * we don't worry too much.
- * 
+ *
  * The comments associated with
  */
     TEXT
@@ -162,7 +171,7 @@ The comments associated with
     text = <<-TEXT
 /*
  *  we don't worry too much.
- *  
+ *
  *  The comments associated with
  */
     TEXT
@@ -203,6 +212,16 @@ The comments associated with
     assert_equal RDoc::Markup::Document.new, parse("#\n")
   end
 
+  def test_parse_format_markdown
+    expected =
+      @RM::Document.new(
+        @RM::Paragraph.new('it _works_'))
+
+    parsed = parse 'it *works*', 'markdown'
+
+    assert_equal expected, parsed
+  end
+
   def test_parse_format_rd
     expected =
       @RM::Document.new(
@@ -214,13 +233,16 @@ The comments associated with
   end
 
   def test_parse_format_tomdoc
+    code = verb('1 + 1')
+    code.format = :ruby
+
     expected =
-      @RM::Document.new(
-        @RM::Paragraph.new('It does a thing'),
-        @RM::BlankLine.new,
-        @RM::Heading.new(3, 'Examples'),
-        @RM::BlankLine.new,
-        @RM::Verbatim.new("1 + 1"))
+      doc(
+        para('It does a thing'),
+        blank_line,
+        head(3, 'Examples'),
+        blank_line,
+        code)
 
     text = <<-TOMDOC
 It does a thing
@@ -461,6 +483,10 @@ The comments associated with
     assert_equal 'S', to_html('\\S')
   end
 
+  def test_to_html_br
+    assert_equal '<br>', to_html('<br>')
+  end
+
   def test_to_html_copyright
     assert_equal '©', to_html('(c)')
   end
@@ -527,7 +553,7 @@ The comments associated with
   end
 
   def test_to_html_tt_tag_mismatch
-    _, err = capture_io do
+    _, err = verbose_capture_io do
       assert_equal '<tt>hi', to_html('<tt>hi')
     end
 
@@ -535,7 +561,7 @@ The comments associated with
   end
 
   def formatter()
-    RDoc::Markup::ToHtml.new
+    RDoc::Markup::ToHtml.new @options
   end
 
 end

data/test/test_rdoc_tom_doc.rb

@@ -5,7 +5,7 @@ class TestRDocTomDoc < RDoc::TestCase
   def setup
     super
 
-    @top_level = RDoc::TopLevel.new 'file.rb'
+    @top_level = @store.add_file 'file.rb'
 
     @TD = RDoc::TomDoc
     @td = @TD.new
@@ -67,11 +67,11 @@ here - something
     assert_equal "method_<here>(args)\n", signature
 
     expected =
-      @RM::Document.new(
-        @RM::Heading.new(3, 'Signature'),
-        @RM::List.new(:NOTE,
-          @RM::ListItem.new('here',
-            @RM::Paragraph.new('something'))))
+      doc(
+        head(3, 'Signature'),
+        list(:NOTE,
+          item(%w[here],
+            para('something'))))
     expected.file = @top_level
 
     assert_equal expected, c.parse
@@ -115,11 +115,11 @@ here - something
     assert_equal "method_<here>(args)\n", signature
 
     expected =
-      @RM::Document.new(
-        @RM::Heading.new(3, 'Signature'),
-        @RM::List.new(:NOTE,
-          @RM::ListItem.new('here',
-            @RM::Paragraph.new('something'))))
+      doc(
+        head(3, 'Signature'),
+        list(:NOTE,
+          item(%w[here],
+            para('something'))))
     expected.file = @top_level
 
     assert_equal expected, c.parse
@@ -144,17 +144,14 @@ description - arguments description
     TEXT
 
     expected =
-      @RM::Document.new(
-        @RM::Paragraph.new('Create new Arg object.'),
-        @RM::BlankLine.new,
-        @RM::List.new(
-          :NOTE,
-          @RM::ListItem.new(
-            'name',
-            @RM::Paragraph.new('name of argument')),
-          @RM::ListItem.new(
-            'description',
-            @RM::Paragraph.new('arguments description'))))
+      doc(
+        para('Create new Arg object.'),
+        blank_line,
+        list(:NOTE,
+          item(%w[name],
+            para('name of argument')),
+          item(%w[description],
+            para('arguments description'))))
 
     assert_equal expected, @TD.parse(text)
   end
@@ -168,15 +165,12 @@ foo - A comment goes here
     TEXT
 
     expected =
-      @RM::Document.new(
-        @RM::Paragraph.new('Do some stuff'),
-        @RM::BlankLine.new,
-        @RM::List.new(
-          :NOTE,
-          @RM::ListItem.new(
-            'foo',
-            @RM::Paragraph.new(
-              'A comment goes here', 'and is more than one line'))))
+      doc(
+        para('Do some stuff'),
+        blank_line,
+        list(:NOTE,
+          item(%w[foo],
+            para('A comment goes here', 'and is more than one line'))))
 
     assert_equal expected, @TD.parse(text)
   end
@@ -190,19 +184,15 @@ foo - A comment goes here
     TEXT
 
     expected =
-      @RM::Document.new(
-        @RM::Paragraph.new('Do some stuff'),
-        @RM::BlankLine.new,
-        @RM::List.new(
-          :NOTE,
-          @RM::ListItem.new(
-            'foo',
-            @RM::Paragraph.new('A comment goes here'),
-            @RM::List.new(
-              :NOTE,
-              @RM::ListItem.new(
-                ':bar',
-                @RM::Paragraph.new('bar documentation'))))))
+      doc(
+        para('Do some stuff'),
+        blank_line,
+        list(:NOTE,
+          item(%w[foo],
+            para('A comment goes here'),
+            list(:NOTE,
+              item(%w[:bar],
+                para('bar documentation'))))))
 
     assert_equal expected, @TD.parse(text)
   end
@@ -216,13 +206,16 @@ Examples
   1 + 1
     TEXT
 
+    code = verb("1 + 1\n")
+    code.format = :ruby
+
     expected =
-      @RM::Document.new(
-        @RM::Paragraph.new('Do some stuff'),
-        @RM::BlankLine.new,
-        @RM::Heading.new(3, 'Examples'),
-        @RM::BlankLine.new,
-        @RM::Verbatim.new("1 + 1\n"))
+      doc(
+        para('Do some stuff'),
+        blank_line,
+        head(3, 'Examples'),
+        blank_line,
+        code)
 
     document = @TD.parse(text)
     assert_equal expected, document
@@ -242,21 +235,25 @@ Signature
   foo(args)
     TEXT
 
+    code1 = verb("1 + 1\n")
+    code1.format = :ruby
+
+    code2 = verb("foo(args)\n")
+
     expected =
-      @RM::Document.new(
-        @RM::Paragraph.new('Do some stuff'),
-        @RM::BlankLine.new,
-        @RM::Heading.new(3, 'Examples'),
-        @RM::BlankLine.new,
-        @RM::Verbatim.new("1 + 1\n"),
-        @RM::Heading.new(3, 'Signature'),
-        @RM::BlankLine.new,
-        @RM::Verbatim.new("foo(args)\n"))
+      doc(
+        para('Do some stuff'),
+        blank_line,
+        head(3, 'Examples'),
+        blank_line,
+        code1,
+        head(3, 'Signature'),
+        blank_line,
+        code2)
+
+    document = @TD.parse text
 
-    document = @TD.parse(text)
     assert_equal expected, document
-    assert document.parts[4].ruby?
-    refute document.parts.last.ruby?
   end
 
   def test_parse_returns

data/test/test_rdoc_top_level.rb

@@ -5,112 +5,29 @@ class TestRDocTopLevel < XrefTestCase
   def setup
     super
 
-    @top_level = RDoc::TopLevel.new 'path/top_level.rb'
+    @top_level = @store.add_file 'path/top_level.rb'
     @top_level.parser = RDoc::Parser::Ruby
   end
 
-  def test_class_all_classes_and_modules
-    expected = %w[
-      C1 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4 C5 C5::C1
-      Child
-      M1 M1::M2
-      Parent
-    ]
-
-    assert_equal expected,
-                 RDoc::TopLevel.all_classes_and_modules.map { |m| m.full_name }.sort
-  end
-
-  def test_class_classes
-    expected = %w[
-      C1 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4 C5 C5::C1
-      Child Parent
-    ]
-
-    assert_equal expected, RDoc::TopLevel.classes.map { |m| m.full_name }.sort
-  end
-
-  def test_class_complete
-    @c2.add_module_alias @c2_c3, 'A1', @top_level
-
-    RDoc::TopLevel.complete :public
-
-    a1 = @xref_data.find_class_or_module 'C2::A1'
-
-    assert_equal 'C2::A1', a1.full_name
-    refute_empty a1.aliases
-  end
-
-  def test_class_files
-    assert_equal %w[path/top_level.rb xref_data.rb],
-                 RDoc::TopLevel.files.map { |m| m.full_name }.sort
-  end
-
-  def test_class_find_class_named
-    assert_equal @c1, RDoc::TopLevel.find_class_named('C1')
-
-    assert_equal @c2_c3, RDoc::TopLevel.find_class_named('C2::C3')
-  end
-
-  def test_class_find_class_named_from
-    assert_equal @c5_c1, RDoc::TopLevel.find_class_named_from('C1', 'C5')
-
-    assert_equal @c1,    RDoc::TopLevel.find_class_named_from('C1', 'C4')
-  end
-
-  def test_class_find_class_or_module
-    assert_equal @m1, RDoc::TopLevel.find_class_or_module('M1')
-    assert_equal @c1, RDoc::TopLevel.find_class_or_module('C1')
-
-    assert_equal @m1, RDoc::TopLevel.find_class_or_module('::M1')
-    assert_equal @c1, RDoc::TopLevel.find_class_or_module('::C1')
-  end
-
-  def test_class_find_file_named
-    assert_equal @xref_data, RDoc::TopLevel.find_file_named(@file_name)
-  end
+  def test_initialize
+    t = RDoc::TopLevel.new 'path/file.rb'
 
-  def test_class_find_module_named
-    assert_equal @m1,    RDoc::TopLevel.find_module_named('M1')
-    assert_equal @m1_m2, RDoc::TopLevel.find_module_named('M1::M2')
+    assert_equal 'path/file.rb', t.absolute_name
+    assert_equal 'path/file.rb', t.relative_name
   end
 
-  def test_class_modules
-    assert_equal %w[M1 M1::M2],
-                 RDoc::TopLevel.modules.map { |m| m.full_name }.sort
-  end
-
-  def test_class_new
-    tl1 = RDoc::TopLevel.new 'file.rb'
-    tl2 = RDoc::TopLevel.new 'file.rb'
-    tl3 = RDoc::TopLevel.new 'other.rb'
-
-    assert_same tl1, tl2
-    refute_same tl1, tl3
-  end
-
-  def test_class_page
-    page = RDoc::TopLevel.new 'PAGE.txt'
-    page.parser = RDoc::Parser::Simple
-
-    assert_nil RDoc::TopLevel.page 'no such page'
+  def test_initialize_relative
+    t = RDoc::TopLevel.new 'path/file.rb', 'file.rb'
 
-    assert_equal page, RDoc::TopLevel.page('PAGE')
-  end
-
-  def test_class_reset
-    RDoc::TopLevel.reset
-
-    assert_empty RDoc::TopLevel.classes
-    assert_empty RDoc::TopLevel.modules
-    assert_empty RDoc::TopLevel.files
+    assert_equal 'path/file.rb', t.absolute_name
+    assert_equal 'file.rb',      t.relative_name
   end
 
   def test_add_alias
     a = RDoc::Alias.new nil, 'old', 'new', nil
     @top_level.add_alias a
 
-    object = RDoc::TopLevel.find_class_named 'Object'
+    object = @store.find_class_named 'Object'
     expected = { '#old' => [a] }
     assert_equal expected, object.unmatched_alias_lists
     assert_includes object.in_files, @top_level
@@ -122,7 +39,7 @@ class TestRDocTopLevel < XrefTestCase
     a = RDoc::Alias.new nil, 'old', 'new', nil
     @top_level.add_alias a
 
-    object = RDoc::TopLevel.find_class_named('Object')
+    object = @store.find_class_named('Object')
     assert_empty object.unmatched_alias_lists
     assert_includes object.in_files, @top_level
   end
@@ -131,7 +48,7 @@ class TestRDocTopLevel < XrefTestCase
     const = RDoc::Constant.new 'C', nil, nil
     @top_level.add_constant const
 
-    object = RDoc::TopLevel.find_class_named 'Object'
+    object = @store.find_class_named 'Object'
     assert_equal [const], object.constants
     assert_includes object.in_files, @top_level
   end
@@ -142,7 +59,7 @@ class TestRDocTopLevel < XrefTestCase
     const = RDoc::Constant.new 'C', nil, nil
     @top_level.add_constant const
 
-    object = RDoc::TopLevel.find_class_named 'Object'
+    object = @store.find_class_named 'Object'
     assert_empty object.constants
     assert_includes object.in_files, @top_level
   end
@@ -151,7 +68,7 @@ class TestRDocTopLevel < XrefTestCase
     include = RDoc::Include.new 'C', nil
     @top_level.add_include include
 
-    object = RDoc::TopLevel.find_class_named 'Object'
+    object = @store.find_class_named 'Object'
     assert_equal [include], object.includes
     assert_includes object.in_files, @top_level
   end
@@ -162,7 +79,7 @@ class TestRDocTopLevel < XrefTestCase
     include = RDoc::Include.new 'C', nil
     @top_level.add_include include
 
-    object = RDoc::TopLevel.find_class_named('Object')
+    object = @store.find_class_named('Object')
     assert_empty object.includes
     assert_includes object.in_files, @top_level
   end
@@ -171,7 +88,7 @@ class TestRDocTopLevel < XrefTestCase
     method = RDoc::AnyMethod.new nil, 'm'
     @top_level.add_method method
 
-    object = RDoc::TopLevel.find_class_named 'Object'
+    object = @store.find_class_named 'Object'
     assert_equal [method], object.method_list
     assert_includes object.in_files, @top_level
   end
@@ -182,7 +99,7 @@ class TestRDocTopLevel < XrefTestCase
     method = RDoc::AnyMethod.new nil, 'm'
     @top_level.add_method method
 
-    object = RDoc::TopLevel.find_class_named('Object')
+    object = @store.find_class_named('Object')
     assert_empty object.method_list
     assert_includes object.in_files, @top_level
   end
@@ -194,15 +111,15 @@ class TestRDocTopLevel < XrefTestCase
   def test_display_eh
     refute @top_level.display?
 
-    page = RDoc::TopLevel.new 'README.txt'
+    page = @store.add_file 'README.txt'
     page.parser = RDoc::Parser::Simple
 
     assert page.display?
   end
 
   def test_eql_eh
-    top_level2 = RDoc::TopLevel.new 'path/top_level.rb'
-    other_level = RDoc::TopLevel.new 'path/other_level.rb'
+    top_level2 = @store.add_file 'path/top_level.rb'
+    other_level = @store.add_file 'path/other_level.rb'
 
     assert_operator @top_level, :eql?, top_level2
 
@@ -210,8 +127,8 @@ class TestRDocTopLevel < XrefTestCase
   end
 
   def test_equals2
-    top_level2 = RDoc::TopLevel.new 'path/top_level.rb'
-    other_level = RDoc::TopLevel.new 'path/other_level.rb'
+    top_level2 = @store.add_file 'path/top_level.rb'
+    other_level = @store.add_file 'path/other_level.rb'
 
     assert_equal @top_level, top_level2
 
@@ -230,8 +147,8 @@ class TestRDocTopLevel < XrefTestCase
   end
 
   def test_hash
-    tl2 = RDoc::TopLevel.new 'path/top_level.rb'
-    tl3 = RDoc::TopLevel.new 'other/top_level.rb'
+    tl2 = @store.add_file 'path/top_level.rb'
+    tl3 = @store.add_file 'other/top_level.rb'
 
     assert_equal @top_level.hash, tl2.hash
     refute_equal @top_level.hash, tl3.hash
@@ -249,6 +166,47 @@ class TestRDocTopLevel < XrefTestCase
     assert_equal 0, @top_level.last_modified
   end
 
+  def test_marshal_dump
+    page = @store.add_file 'README.txt'
+    page.parser = RDoc::Parser::Simple
+    page.comment = RDoc::Comment.new 'This is a page', page
+
+    loaded = Marshal.load Marshal.dump page
+
+    comment = RDoc::Markup::Document.new(
+                RDoc::Markup::Paragraph.new('This is a page'))
+    comment.file = loaded
+
+    assert_equal page, loaded
+
+    assert_equal 'README.txt', loaded.absolute_name
+    assert_equal 'README.txt', loaded.relative_name
+
+    assert_equal RDoc::Parser::Simple, loaded.parser
+
+    assert_equal comment, loaded.comment
+  end
+
+  def test_marshal_load_version_0
+    loaded = Marshal.load "\x04\bU:\x13RDoc::TopLevel" +
+                          "[\ti\x00I\"\x0FREADME.txt\x06:\x06EF" +
+                          "c\x19RDoc::Parser::Simple" +
+                          "o:\eRDoc::Markup::Document\a:\v@parts" +
+                          "[\x06o:\x1CRDoc::Markup::Paragraph\x06;\b" +
+                          "[\x06I\"\x13This is a page\x06;\x06F:\n@file@\a"
+
+    comment = RDoc::Markup::Document.new(
+                RDoc::Markup::Paragraph.new('This is a page'))
+    comment.file = loaded
+
+    assert_equal 'README.txt', loaded.absolute_name
+    assert_equal 'README.txt', loaded.relative_name
+
+    assert_equal RDoc::Parser::Simple, loaded.parser
+
+    assert_equal comment, loaded.comment
+  end
+
   def test_name
     assert_equal 'top_level.rb', @top_level.name
   end
@@ -256,11 +214,11 @@ class TestRDocTopLevel < XrefTestCase
   def test_page_name
     assert_equal 'top_level', @top_level.page_name
 
-    tl = RDoc::TopLevel.new 'README.ja.rdoc'
+    tl = @store.add_file 'README.ja.rdoc'
 
     assert_equal 'README.ja', tl.page_name
 
-    tl = RDoc::TopLevel.new 'Rakefile'
+    tl = @store.add_file 'Rakefile'
 
     assert_equal 'Rakefile', tl.page_name
   end
@@ -270,7 +228,7 @@ class TestRDocTopLevel < XrefTestCase
   end
 
   def test_search_record_page
-    page = RDoc::TopLevel.new 'README.txt'
+    page = @store.add_file 'README.txt'
     page.parser = RDoc::Parser::Simple
     page.comment = 'This is a comment.'
 
@@ -290,12 +248,12 @@ class TestRDocTopLevel < XrefTestCase
   def test_text_eh
     refute @xref_data.text?
 
-    rd = RDoc::TopLevel.new 'rd_format.rd'
+    rd = @store.add_file 'rd_format.rd'
     rd.parser = RDoc::Parser::RD
 
     assert rd.text?
 
-    simple = RDoc::TopLevel.new 'simple.txt'
+    simple = @store.add_file 'simple.txt'
     simple.parser = RDoc::Parser::Simple
 
     assert simple.text?
@@ -304,7 +262,7 @@ class TestRDocTopLevel < XrefTestCase
   def test_text_eh_no_parser
     refute @xref_data.text?
 
-    rd = RDoc::TopLevel.new 'rd_format.rd'
+    rd = @store.add_file 'rd_format.rd'
 
     refute rd.text?
   end