rdoc 2.4.3 → 2.5

data/test/test_rdoc_markup_to_html.rb

@@ -1,14 +1,16 @@
 require 'rubygems'
-require 'minitest/unit'
-require 'rdoc/markup'
+require 'rdoc/markup/formatter_test_case'
 require 'rdoc/markup/to_html'
+require 'minitest/autorun'
 
-class TestRDocMarkupToHtml < MiniTest::Unit::TestCase
+class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
+
+  add_visitor_tests
 
   def setup
-    @m = RDoc::Markup.new
-    @am = RDoc::Markup::AttributeManager.new
-    @th = RDoc::Markup::ToHtml.new
+    super
+
+    @to = RDoc::Markup::ToHtml.new
   end
 
   def test_class_gen_relative_url
@@ -24,25 +26,189 @@ class TestRDocMarkupToHtml < MiniTest::Unit::TestCase
     assert_equal 'a/c.html',  gen('a.html',   'a/c.html')
   end
 
+  def accept_blank_line
+    assert_empty @to.res.join
+  end
+
+  def accept_heading
+    assert_equal "<h5>Hello</h5>\n", @to.res.join
+  end
+
+  def accept_list_end_bullet
+    assert_equal [], @to.list
+    assert_equal [], @to.in_list_entry
+
+    assert_equal "<ul>\n</ul>\n", @to.res.join
+  end
+
+  def accept_list_end_label
+    assert_equal [], @to.list
+    assert_equal [], @to.in_list_entry
+
+    assert_equal "<dl>\n</dl>\n", @to.res.join
+  end
+
+  def accept_list_end_lalpha
+    assert_equal [], @to.list
+    assert_equal [], @to.in_list_entry
+
+    assert_equal "<ol style=\"display: lower-alpha\">\n</ol>\n", @to.res.join
+  end
+
+  def accept_list_end_number
+    assert_equal [], @to.list
+    assert_equal [], @to.in_list_entry
+
+    assert_equal "<ol>\n</ol>\n", @to.res.join
+  end
+
+  def accept_list_end_note
+    assert_equal [], @to.list
+    assert_equal [], @to.in_list_entry
+
+    assert_equal "<table>\n</table>\n", @to.res.join
+  end
+
+  def accept_list_end_ualpha
+    assert_equal [], @to.list
+    assert_equal [], @to.in_list_entry
+
+    assert_equal "<ol style=\"display: upper-alpha\">\n</ol>\n", @to.res.join
+  end
+
+  def accept_list_item_end_bullet
+    assert_equal %w[</li>], @to.in_list_entry
+  end
+
+  def accept_list_item_end_label
+    assert_equal %w[</dd>], @to.in_list_entry
+  end
+
+  def accept_list_item_end_lalpha
+    assert_equal %w[</li>], @to.in_list_entry
+  end
+
+  def accept_list_item_end_note
+    assert_equal %w[</td></tr>], @to.in_list_entry
+  end
+
+  def accept_list_item_end_number
+    assert_equal %w[</li>], @to.in_list_entry
+  end
+
+  def accept_list_item_end_ualpha
+    assert_equal %w[</li>], @to.in_list_entry
+  end
+
+  def accept_list_item_start_bullet
+    assert_equal "<ul>\n<li>", @to.res.join
+  end
+
+  def accept_list_item_start_label
+    assert_equal "<dl>\n<dt>cat</dt><dd>", @to.res.join
+  end
+
+  def accept_list_item_start_lalpha
+    assert_equal "<ol style=\"display: lower-alpha\">\n<li>", @to.res.join
+  end
+
+  def accept_list_item_start_note
+    assert_equal "<table>\n<tr><td valign=\"top\">cat</td><td>", @to.res.join
+  end
+
+  def accept_list_item_start_number
+    assert_equal "<ol>\n<li>", @to.res.join
+  end
+
+  def accept_list_item_start_ualpha
+    assert_equal "<ol style=\"display: upper-alpha\">\n<li>", @to.res.join
+  end
+
+  def accept_list_start_bullet
+    assert_equal [:BULLET], @to.list
+    assert_equal [false], @to.in_list_entry
+
+    assert_equal "<ul>\n", @to.res.join
+  end
+
+  def accept_list_start_label
+    assert_equal [:LABEL], @to.list
+    assert_equal [false], @to.in_list_entry
+
+    assert_equal "<dl>\n", @to.res.join
+  end
+
+  def accept_list_start_lalpha
+    assert_equal [:LALPHA], @to.list
+    assert_equal [false], @to.in_list_entry
+
+    assert_equal "<ol style=\"display: lower-alpha\">\n", @to.res.join
+  end
+
+  def accept_list_start_note
+    assert_equal [:NOTE], @to.list
+    assert_equal [false], @to.in_list_entry
+
+    assert_equal "<table>\n", @to.res.join
+  end
+
+  def accept_list_start_number
+    assert_equal [:NUMBER], @to.list
+    assert_equal [false], @to.in_list_entry
+
+    assert_equal "<ol>\n", @to.res.join
+  end
+
+  def accept_list_start_ualpha
+    assert_equal [:UALPHA], @to.list
+    assert_equal [false], @to.in_list_entry
+
+    assert_equal "<ol style=\"display: upper-alpha\">\n", @to.res.join
+  end
+
+  def accept_paragraph
+    assert_equal "<p>\nhi\n</p>\n", @to.res.join
+  end
+
+  def accept_rule
+    assert_equal '<hr style="height: 4px"></hr>', @to.res.join
+  end
+
+  def accept_verbatim
+    assert_equal "<pre>\n  hi\n  world\n</pre>\n", @to.res.join
+  end
+
+  def end_accepting
+    assert_equal 'hi', @to.end_accepting
+  end
+
+  def start_accepting
+    assert_equal [], @to.res
+    assert_equal [], @to.in_list_entry
+    assert_equal [], @to.list
+  end
+
   def test_list_verbatim
     str = "* one\n    verb1\n    verb2\n* two\n"
 
     expected = <<-EXPECTED
 <ul>
-<li>one
-
+<li><p>
+one
+</p>
 <pre>
   verb1
   verb2
 </pre>
 </li>
-<li>two
-
+<li><p>
+two
+</p>
 </li>
 </ul>
     EXPECTED
 
-    assert_equal expected, @m.convert(str, @th)
+    assert_equal expected, @m.convert(str, @to)
   end
 
   def test_tt_formatting
@@ -64,18 +230,17 @@ class TestRDocMarkupToHtml < MiniTest::Unit::TestCase
     assert_equal "<p>\ncat&#8217;s-\n</p>\n", util_format("cat\'s-")
   end
 
-  def util_fragment(text)
-    RDoc::Markup::Fragment.new 0, nil, nil, text
+  def util_paragraph(text)
+    RDoc::Markup::Paragraph.new text
   end
 
   def util_format(text)
-    fragment = util_fragment text
+    paragraph = util_paragraph text
 
-    @th.start_accepting
-    @th.accept_paragraph @am, fragment
-    @th.end_accepting
+    @to.start_accepting
+    @to.accept_paragraph paragraph
+    @to.end_accepting
   end
 
 end
 
-MiniTest::Unit.autorun

data/test/test_rdoc_markup_to_html_crossref.rb

@@ -1,5 +1,5 @@
 require 'rubygems'
-require 'minitest/unit'
+require 'minitest/autorun'
 require 'rdoc/rdoc'
 require 'rdoc/code_objects'
 require 'rdoc/markup/to_html_crossref'
@@ -157,5 +157,3 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
 
 end
 
-MiniTest::Unit.autorun
-

data/test/test_rdoc_markup_to_rdoc.rb

@@ -0,0 +1,426 @@
+require 'rubygems'
+require 'rdoc/markup/formatter_test_case'
+require 'rdoc/markup/to_rdoc'
+require 'minitest/autorun'
+
+class TestRDocMarkupToRdoc < RDoc::Markup::FormatterTestCase
+
+  add_visitor_tests
+
+  def setup
+    super
+    
+    @to = RDoc::Markup::ToRdoc.new
+  end
+
+  def accept_blank_line
+    assert_equal "\n", @to.res.join
+  end
+
+  def accept_heading
+    assert_equal "===== Hello\n", @to.res.join
+  end
+
+  def accept_list_end_bullet
+    assert_empty @to.list_index
+    assert_empty @to.list_type
+    assert_empty @to.list_width
+  end
+
+  def accept_list_end_label
+    assert_empty @to.list_index
+    assert_empty @to.list_type
+    assert_empty @to.list_width
+  end
+
+  def accept_list_end_lalpha
+    assert_empty @to.list_index
+    assert_empty @to.list_type
+    assert_empty @to.list_width
+  end
+
+  def accept_list_end_note
+    assert_empty @to.list_index
+    assert_empty @to.list_type
+    assert_empty @to.list_width
+  end
+
+  def accept_list_end_number
+    assert_empty @to.list_index
+    assert_empty @to.list_type
+    assert_empty @to.list_width
+  end
+
+  def accept_list_end_ualpha
+    assert_empty @to.list_index
+    assert_empty @to.list_type
+    assert_empty @to.list_width
+  end
+
+  def accept_list_item_end_bullet
+    assert_equal 0, @to.indent, 'indent'
+  end
+
+  def accept_list_item_end_label
+    assert_equal "\n", @to.res.join
+    assert_equal 0, @to.indent, 'indent'
+  end
+
+  def accept_list_item_end_lalpha
+    assert_equal 0, @to.indent, 'indent'
+    assert_equal 'b', @to.list_index.last
+  end
+
+  def accept_list_item_end_note
+    assert_equal "\n", @to.res.join
+    assert_equal 0, @to.indent, 'indent'
+  end
+
+  def accept_list_item_end_number
+    assert_equal 0, @to.indent, 'indent'
+    assert_equal 2, @to.list_index.last
+  end
+
+  def accept_list_item_end_ualpha
+    assert_equal 0, @to.indent, 'indent'
+    assert_equal 'B', @to.list_index.last
+  end
+
+  def accept_list_item_start_bullet
+    assert_equal [""], @to.res
+    assert_equal '* ', @to.prefix
+  end
+
+  def accept_list_item_start_label
+    assert_equal [""], @to.res
+    assert_equal "cat:\n  ", @to.prefix
+
+    assert_equal 2, @to.indent
+  end
+
+  def accept_list_item_start_lalpha
+    assert_equal [""], @to.res
+    assert_equal 'a. ', @to.prefix
+
+    assert_equal 'a', @to.list_index.last
+    assert_equal 3, @to.indent
+  end
+
+  def accept_list_item_start_note
+    assert_equal [""], @to.res
+    assert_equal "cat:\n  ", @to.prefix
+
+    assert_equal 2, @to.indent
+  end
+
+  def accept_list_item_start_number
+    assert_equal [""], @to.res
+    assert_equal '1. ', @to.prefix
+
+    assert_equal 1, @to.list_index.last
+    assert_equal 3, @to.indent
+  end
+
+  def accept_list_item_start_ualpha
+    assert_equal [""], @to.res
+    assert_equal 'A. ', @to.prefix
+
+    assert_equal 'A', @to.list_index.last
+    assert_equal 3, @to.indent
+  end
+
+  def accept_list_start_bullet
+    assert_equal "",   @to.res.join
+    assert_equal [nil],     @to.list_index
+    assert_equal [:BULLET], @to.list_type
+    assert_equal [1],       @to.list_width
+  end
+
+  def accept_list_start_label
+    assert_equal "",  @to.res.join
+    assert_equal [nil],    @to.list_index
+    assert_equal [:LABEL], @to.list_type
+    assert_equal [2],      @to.list_width
+  end
+
+  def accept_list_start_lalpha
+    assert_equal "",   @to.res.join
+    assert_equal ['a'],     @to.list_index
+    assert_equal [:LALPHA], @to.list_type
+    assert_equal [1],       @to.list_width
+  end
+
+  def accept_list_start_note
+    assert_equal "", @to.res.join
+    assert_equal [nil],   @to.list_index
+    assert_equal [:NOTE], @to.list_type
+    assert_equal [2],     @to.list_width
+  end
+
+  def accept_list_start_number
+    assert_equal "",   @to.res.join
+    assert_equal [1],       @to.list_index
+    assert_equal [:NUMBER], @to.list_type
+    assert_equal [1],       @to.list_width
+  end
+
+  def accept_list_start_ualpha
+    assert_equal "",   @to.res.join
+    assert_equal ['A'],     @to.list_index
+    assert_equal [:UALPHA], @to.list_type
+    assert_equal [1],       @to.list_width
+  end
+
+  def accept_paragraph
+    assert_equal "hi\n", @to.res.join
+  end
+
+  def accept_rule
+    assert_equal "#{'-' * 78}\n", @to.res.join
+  end
+
+  def accept_verbatim # FormatterTestCase doesn't set indent for ToAnsi
+    assert_equal "  hi\n  world\n\n", @to.res.join
+  end
+
+  def end_accepting
+    assert_equal "hi", @to.end_accepting
+  end
+
+  def start_accepting
+    assert_equal 0, @to.indent
+    assert_equal [""], @to.res
+    assert_empty @to.list_index
+    assert_empty @to.list_type
+    assert_empty @to.list_width
+  end
+
+  def test_accept_heading_1
+    @to.start_accepting
+    @to.accept_heading @RM::Heading.new(1, 'Hello')
+
+    assert_equal "= Hello\n", @to.end_accepting
+  end
+
+  def test_accept_heading_2
+    @to.start_accepting
+    @to.accept_heading @RM::Heading.new(2, 'Hello')
+
+    assert_equal "== Hello\n", @to.end_accepting
+  end
+
+  def test_accept_heading_3
+    @to.start_accepting
+    @to.accept_heading @RM::Heading.new(3, 'Hello')
+
+    assert_equal "=== Hello\n", @to.end_accepting
+  end
+
+  def test_accept_heading_4
+    @to.start_accepting
+    @to.accept_heading @RM::Heading.new(4, 'Hello')
+
+    assert_equal "==== Hello\n", @to.end_accepting
+  end
+
+  def test_accept_heading_indent
+    @to.start_accepting
+    @to.indent = 3
+    @to.accept_heading @RM::Heading.new(1, 'Hello')
+
+    assert_equal "   = Hello\n", @to.end_accepting
+  end
+
+  def test_accept_heading_b
+    @to.start_accepting
+    @to.indent = 3
+    @to.accept_heading @RM::Heading.new(1, '*Hello*')
+
+    assert_equal "   = <b>Hello</b>\n", @to.end_accepting
+  end
+
+  def test_accept_list_item_start_note_2
+    list = @RM::List.new(:NOTE,
+             @RM::ListItem.new('<tt>teletype</tt>',
+                               @RM::Paragraph.new('teletype description')))
+
+    @to.start_accepting
+
+    list.accept @to
+
+    expected = "<tt>teletype</tt>:\n  teletype description\n\n"
+
+    assert_equal expected, @to.end_accepting
+  end
+
+  def test_accept_paragraph_b
+    @to.start_accepting
+    @to.accept_paragraph @RM::Paragraph.new('reg <b>bold words</b> reg')
+
+    expected = "reg <b>bold words</b> reg\n"
+
+    assert_equal expected, @to.end_accepting
+  end
+
+  def test_accept_paragraph_i
+    @to.start_accepting
+    @to.accept_paragraph @RM::Paragraph.new('reg <em>italic words</em> reg')
+
+    expected = "reg <em>italic words</em> reg\n"
+
+    assert_equal expected, @to.end_accepting
+  end
+
+  def test_accept_paragraph_indent
+    @to.start_accepting
+    @to.indent = 3
+    @to.accept_paragraph @RM::Paragraph.new('words ' * 30)
+
+    expected = <<-EXPECTED
+   words words words words words words words words words words words words
+   words words words words words words words words words words words words
+   words words words words words words 
+    EXPECTED
+
+    assert_equal expected, @to.end_accepting
+  end
+
+  def test_accept_paragraph_plus
+    @to.start_accepting
+    @to.accept_paragraph @RM::Paragraph.new('regular +teletype+ regular')
+
+    expected = "regular <tt>teletype</tt> regular\n"
+
+    assert_equal expected, @to.end_accepting
+  end
+
+  def test_accept_paragraph_star
+    @to.start_accepting
+    @to.accept_paragraph @RM::Paragraph.new('regular *bold* regular')
+
+    expected = "regular <b>bold</b> regular\n"
+
+    assert_equal expected, @to.end_accepting
+  end
+
+  def test_accept_paragraph_underscore
+    @to.start_accepting
+    @to.accept_paragraph @RM::Paragraph.new('regular _italic_ regular')
+
+    expected = "regular <em>italic</em> regular\n"
+
+    assert_equal expected, @to.end_accepting
+  end
+
+  def test_accept_paragraph_wrap
+    @to.start_accepting
+    @to.accept_paragraph @RM::Paragraph.new('words ' * 30)
+
+    expected = <<-EXPECTED
+words words words words words words words words words words words words words
+words words words words words words words words words words words words words
+words words words words 
+    EXPECTED
+
+    assert_equal expected, @to.end_accepting
+  end
+
+  def test_accept_rule_indent
+    @to.start_accepting
+    @to.indent = 3
+
+    @to.accept_rule @RM::Rule.new(1)
+
+    assert_equal "   #{'-' * 75}\n", @to.end_accepting
+  end
+
+  def test_accept_verbatim_indent
+    @to.start_accepting
+
+    @to.indent = 2
+
+    @to.accept_verbatim @RM::Verbatim.new('    ', 'hi', "\n",
+                                          '     ', 'world', "\n")
+
+    assert_equal "    hi\n     world\n\n", @to.end_accepting
+  end
+
+  def test_accept_verbatim_big_indent
+    @to.start_accepting
+
+    @to.indent = 2
+
+    @to.accept_verbatim @RM::Verbatim.new('    ', 'hi', "\n",
+                                          '    ', 'world', "\n")
+
+    assert_equal "    hi\n    world\n\n", @to.end_accepting
+  end
+
+  def test_attributes
+    assert_equal 'Dog', @to.attributes("\\Dog")
+  end
+
+  def test_list_nested
+    doc = @RM::Document.new(
+            @RM::List.new(:BULLET,
+              @RM::ListItem.new(nil,
+                @RM::Paragraph.new('l1'),
+                @RM::List.new(:BULLET,
+                  @RM::ListItem.new(nil,
+                    @RM::Paragraph.new('l1.1')))),
+              @RM::ListItem.new(nil,
+                @RM::Paragraph.new('l2'))))
+
+    output = doc.accept @to
+
+    expected = <<-EXPECTED
+* l1
+  * l1.1
+* l2
+    EXPECTED
+
+    assert_equal expected, output
+  end
+
+  def test_list_verbatim # HACK overblown
+    doc = @RM::Document.new(
+            @RM::List.new(:BULLET,
+              @RM::ListItem.new(nil,
+                @RM::Paragraph.new('list', 'stuff'),
+                @RM::BlankLine.new(),
+                @RM::Verbatim.new('   ', '*', ' ', 'list', "\n",
+                                  '     ', 'with', "\n",
+                                  "\n",
+                                  '     ', 'second', "\n",
+                                  "\n",
+                                  '     ', '1.', ' ', 'indented', "\n",
+                                  '     ', '2.', ' ', 'numbered', "\n",
+                                  "\n",
+                                  '     ', 'third', "\n",
+                                  "\n",
+                                  '   ', '*', ' ', 'second', "\n"))))
+
+    output = doc.accept @to
+
+    expected = <<-EXPECTED
+* list stuff
+
+    * list
+      with
+
+      second
+
+      1. indented
+      2. numbered
+
+      third
+
+    * second
+
+    EXPECTED
+
+    assert_equal expected, output
+  end
+
+end
+