rdoc 3.9.5 → 3.10.pre.1

data/test/test_rdoc_markup_pre_process.rb

@@ -1,16 +1,11 @@
 # coding: utf-8
 
-require 'tempfile'
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc/markup/pre_process'
-require 'rdoc/code_objects'
-require 'rdoc/options'
+require 'rdoc/test_case'
 
-class TestRDocMarkupPreProcess < MiniTest::Unit::TestCase
+class TestRDocMarkupPreProcess < RDoc::TestCase
 
   def setup
-    RDoc::Markup::PreProcess.registered.clear
+    super
 
     @tempfile = Tempfile.new 'test_rdoc_markup_pre_process'
     @file_name = File.basename @tempfile.path
@@ -20,11 +15,23 @@ class TestRDocMarkupPreProcess < MiniTest::Unit::TestCase
   end
 
   def teardown
-    RDoc::Markup::PreProcess.registered.clear
+    super
 
     @tempfile.close
   end
 
+  def test_class_register
+    RDoc::Markup::PreProcess.register 'for_test' do raise 'fail' end
+
+    assert_equal %w[for_test], RDoc::Markup::PreProcess.registered.keys
+  end
+
+  def test_class_post_process
+    RDoc::Markup::PreProcess.post_process do end
+
+    assert_equal 1, RDoc::Markup::PreProcess.post_processors.length
+  end
+
   def test_include_file
     @tempfile.write <<-INCLUDE
 # -*- mode: rdoc; coding: utf-8; fill-column: 74; -*-
@@ -83,6 +90,50 @@ contents of a string.
     assert_equal "#\n", text
   end
 
+  def test_handle_comment
+    text = "# :main: M\n"
+    c = comment text
+
+    out = @pp.handle c
+
+    assert_same out, text
+    assert_equal "#\n", text
+  end
+
+  def test_handle_markup
+    c = comment ':markup: rd'
+
+    @pp.handle c
+
+    assert_equal 'rd', c.format
+  end
+
+  def test_handle_markup_empty
+    c = comment ':markup:'
+
+    @pp.handle c
+
+    assert_equal 'rdoc', c.format
+  end
+
+  def test_handle_post_process
+    cd = RDoc::CodeObject.new
+
+    RDoc::Markup::PreProcess.post_process do |text, code_object|
+      code_object.metadata[:stuff] = text
+
+      :junk
+    end
+
+    text = "# a b c\n"
+
+    out = @pp.handle text, cd
+
+    assert_same out, text
+    assert_equal "# a b c\n", text
+    assert_equal "# a b c\n", cd.metadata[:stuff]
+  end
+
   def test_handle_unregistered
     text = "# :x: y\n"
     out = @pp.handle text

data/test/test_rdoc_markup_raw.rb

@@ -1,12 +1,10 @@
-require 'pp'
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc/markup'
+require 'rdoc/test_case'
 
-class TestRDocMarkupRaw < MiniTest::Unit::TestCase
+class TestRDocMarkupRaw < RDoc::TestCase
 
   def setup
-    @RM = RDoc::Markup
+    super
+
     @p = @RM::Raw.new
   end
 

data/test/test_rdoc_markup_to_ansi.rb

@@ -1,7 +1,4 @@
-require 'rubygems'
-require 'rdoc/markup/text_formatter_test_case'
-require 'rdoc/markup/to_ansi'
-require 'minitest/autorun'
+require 'rdoc/test_case'
 
 class TestRDocMarkupToAnsi < RDoc::Markup::TextFormatterTestCase
 

data/test/test_rdoc_markup_to_bs.rb

@@ -1,7 +1,4 @@
-require 'rubygems'
-require 'rdoc/markup/text_formatter_test_case'
-require 'rdoc/markup/to_bs'
-require 'minitest/autorun'
+require 'rdoc/test_case'
 
 class TestRDocMarkupToBs < RDoc::Markup::TextFormatterTestCase
 

data/test/test_rdoc_markup_to_html.rb

@@ -1,7 +1,4 @@
-require 'rubygems'
-require 'rdoc/markup/formatter_test_case'
-require 'rdoc/markup/to_html'
-require 'minitest/autorun'
+require 'rdoc/test_case'
 
 class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
@@ -35,31 +32,32 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_heading
-    assert_equal "\n<h5>Hello</h5>\n", @to.res.join
+    assert_equal "\n<h5 id=\"label-Hello\">Hello</h5>\n", @to.res.join
   end
 
   def accept_heading_1
-    assert_equal "\n<h1>Hello</h1>\n", @to.res.join
+    assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n", @to.res.join
   end
 
   def accept_heading_2
-    assert_equal "\n<h2>Hello</h2>\n", @to.res.join
+    assert_equal "\n<h2 id=\"label-Hello\">Hello</h2>\n", @to.res.join
   end
 
   def accept_heading_3
-    assert_equal "\n<h3>Hello</h3>\n", @to.res.join
+    assert_equal "\n<h3 id=\"label-Hello\">Hello</h3>\n", @to.res.join
   end
 
   def accept_heading_4
-    assert_equal "\n<h4>Hello</h4>\n", @to.res.join
+    assert_equal "\n<h4 id=\"label-Hello\">Hello</h4>\n", @to.res.join
   end
 
   def accept_heading_b
-    assert_equal "\n<h1><b>Hello</b></h1>\n", @to.res.join
+    assert_equal "\n<h1 id=\"label-Hello\"><strong>Hello</strong></h1>\n",
+                 @to.res.join
   end
 
   def accept_heading_suppressed_crossref
-    assert_equal "\n<h1>Hello</h1>\n", @to.res.join
+    assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n", @to.res.join
   end
 
   def accept_list_end_bullet
@@ -73,14 +71,14 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal [], @to.list
     assert_equal [], @to.in_list_entry
 
-    assert_equal "<dl class=\"rdoc-list\"></dl>\n", @to.res.join
+    assert_equal "<dl class=\"rdoc-list label-list\"></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\"></ol>\n", @to.res.join
+    assert_equal "<ol style=\"list-style-type: lower-alpha\"></ol>\n", @to.res.join
   end
 
   def accept_list_end_number
@@ -94,14 +92,14 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal [], @to.list
     assert_equal [], @to.in_list_entry
 
-    assert_equal "<table class=\"rdoc-list\"></table>\n", @to.res.join
+    assert_equal "<dl class=\"rdoc-list note-list\"></dl>\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\"></ol>\n", @to.res.join
+    assert_equal "<ol style=\"list-style-type: upper-alpha\"></ol>\n", @to.res.join
   end
 
   def accept_list_item_end_bullet
@@ -117,7 +115,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_list_item_end_note
-    assert_equal %w[</td></tr>], @to.in_list_entry
+    assert_equal %w[</dd>], @to.in_list_entry
   end
 
   def accept_list_item_end_number
@@ -133,24 +131,24 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_list_item_start_label
-    assert_equal "<dl class=\"rdoc-list\"><dt>cat</dt>\n<dd>", @to.res.join
+    assert_equal "<dl class=\"rdoc-list label-list\"><dt>cat\n<dd>", @to.res.join
   end
 
   def accept_list_item_start_lalpha
-    assert_equal "<ol style=\"display: lower-alpha\"><li>", @to.res.join
+    assert_equal "<ol style=\"list-style-type: lower-alpha\"><li>", @to.res.join
   end
 
   def accept_list_item_start_note
-    assert_equal "<table class=\"rdoc-list\"><tr><td class=\"rdoc-term\"><p>cat</p></td>\n<td>",
+    assert_equal "<dl class=\"rdoc-list note-list\"><dt>cat\n<dd>",
                  @to.res.join
   end
 
   def accept_list_item_start_note_2
     expected = <<-EXPECTED
-<table class="rdoc-list"><tr><td class="rdoc-term"><p><tt>teletype</tt></p></td>
-<td>
+<dl class="rdoc-list note-list"><dt><code>teletype</code>
+<dd>
 <p>teletype description</p>
-</td></tr></table>
+</dd></dl>
     EXPECTED
 
     assert_equal expected, @to.res.join
@@ -161,7 +159,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_list_item_start_ualpha
-    assert_equal "<ol style=\"display: upper-alpha\"><li>", @to.res.join
+    assert_equal "<ol style=\"list-style-type: upper-alpha\"><li>", @to.res.join
   end
 
   def accept_list_start_bullet
@@ -175,21 +173,21 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal [:LABEL], @to.list
     assert_equal [false], @to.in_list_entry
 
-    assert_equal '<dl class="rdoc-list">', @to.res.join
+    assert_equal '<dl class="rdoc-list label-list">', @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\">", @to.res.join
+    assert_equal "<ol style=\"list-style-type: lower-alpha\">", @to.res.join
   end
 
   def accept_list_start_note
     assert_equal [:NOTE], @to.list
     assert_equal [false], @to.in_list_entry
 
-    assert_equal "<table class=\"rdoc-list\">", @to.res.join
+    assert_equal "<dl class=\"rdoc-list note-list\">", @to.res.join
   end
 
   def accept_list_start_number
@@ -203,7 +201,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal [:UALPHA], @to.list
     assert_equal [false], @to.in_list_entry
 
-    assert_equal "<ol style=\"display: upper-alpha\">", @to.res.join
+    assert_equal "<ol style=\"list-style-type: upper-alpha\">", @to.res.join
   end
 
   def accept_paragraph
@@ -211,7 +209,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_paragraph_b
-    assert_equal "\n<p>reg <b>bold words</b> reg</p>\n", @to.res.join
+    assert_equal "\n<p>reg <strong>bold words</strong> reg</p>\n", @to.res.join
   end
 
   def accept_paragraph_i
@@ -219,11 +217,11 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_paragraph_plus
-    assert_equal "\n<p>reg <tt>teletype</tt> reg</p>\n", @to.res.join
+    assert_equal "\n<p>reg <code>teletype</code> reg</p>\n", @to.res.join
   end
 
   def accept_paragraph_star
-    assert_equal "\n<p>reg <b>bold</b> reg</p>\n", @to.res.join
+    assert_equal "\n<p>reg <strong>bold</strong> reg</p>\n", @to.res.join
   end
 
   def accept_paragraph_underscore
@@ -297,15 +295,145 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal expected, @to.end_accepting
   end
 
+  def test_accept_heading_7
+    @to.start_accepting
+
+    @to.accept_heading @RM::Heading.new(7, 'Hello')
+
+    assert_equal "\n<h6 id=\"label-Hello\">Hello</h6>\n", @to.res.join
+  end
+
+  def test_accept_heading_aref_class
+    @to.code_object = RDoc::NormalClass.new 'Foo'
+    @to.start_accepting
+
+    @to.accept_heading @RM::Heading.new(1, 'Hello')
+
+    assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n",
+                 @to.res.join
+  end
+
+  def test_accept_heading_aref_method
+    @to.code_object = RDoc::AnyMethod.new nil, 'foo'
+    @to.start_accepting
+
+    @to.accept_heading @RM::Heading.new(1, 'Hello')
+
+    assert_equal "\n<h1 id=\"method-i-foo-label-Hello\">Hello</h1>\n",
+                 @to.res.join
+  end
+
+  def test_accept_verbatim_parseable
+    options = RDoc::Options.new
+    rdoc = RDoc::RDoc.new
+    rdoc.options = options
+    RDoc::RDoc.current = rdoc
+
+    verb = @RM::Verbatim.new("class C\n", "end\n")
+
+    @to.start_accepting
+    @to.accept_verbatim verb
+
+    expected = <<-EXPECTED
+
+<pre class="ruby"><span class="ruby-keyword">class</span> <span class="ruby-constant">C</span>
+<span class="ruby-keyword">end</span>
+</pre>
+    EXPECTED
+
+    assert_equal expected, @to.res.join
+  end
+
+  def test_accept_verbatim_parseable_error
+    options = RDoc::Options.new
+    rdoc = RDoc::RDoc.new
+    rdoc.options = options
+    RDoc::RDoc.current = rdoc
+
+    verb = @RM::Verbatim.new("a %z'foo' # => blah\n")
+
+    @to.start_accepting
+    @to.accept_verbatim verb
+
+    expected = <<-EXPECTED
+
+<pre>a %z'foo' # =&gt; blah
+</pre>
+    EXPECTED
+
+    assert_equal expected, @to.res.join
+  end
+
+  def test_accept_verbatim_ruby
+    options = RDoc::Options.new
+    rdoc = RDoc::RDoc.new
+    rdoc.options = options
+    RDoc::RDoc.current = rdoc
+
+    verb = @RM::Verbatim.new("1 + 1\n")
+    verb.format = :ruby
+
+    @to.start_accepting
+    @to.accept_verbatim verb
+
+    expected = <<-EXPECTED
+
+<pre class="ruby"><span class="ruby-value">1</span> <span class="ruby-operator">+</span> <span class="ruby-value">1</span>
+</pre>
+    EXPECTED
+
+    assert_equal expected, @to.res.join
+  end
+
   def test_convert_string
     assert_equal '&lt;&gt;', @to.convert_string('<>')
   end
 
+  def test_convert_RDOCLINK_label_label
+    result = @to.convert 'rdoc-label:label-One'
+
+    assert_equal "\n<p><a href=\"#label-One\">One</a></p>\n", result
+  end
+
+  def test_convert_RDOCLINK_label_foottext
+    result = @to.convert 'rdoc-label:foottext-1'
+
+    assert_equal "\n<p><a href=\"#foottext-1\">*1</a></p>\n", result
+  end
+
+  def test_convert_RDOCLINK_label_footmark
+    result = @to.convert 'rdoc-label:footmark-1'
+
+    assert_equal "\n<p><a href=\"#footmark-1\">^1</a></p>\n", result
+  end
+
+  def test_convert_RDOCLINK_ref
+    result = @to.convert 'rdoc-ref:C'
+
+    assert_equal "\n<p>C</p>\n", result
+  end
+
+  def test_convert_TIDYLINK_rdoc_label
+    result = @to.convert '{foo}[rdoc-label:foottext-1]'
+
+    assert_equal "\n<p><a href=\"#foottext-1\">foo</a></p>\n", result
+  end
+
   def test_gen_url
     assert_equal '<a href="example">example</a>',
                  @to.gen_url('link:example', 'example')
   end
 
+  def test_gen_url_rdoc_label
+    assert_equal '<a href="#foottext-1">example</a>',
+                 @to.gen_url('rdoc-label:foottext-1', 'example')
+  end
+
+  def test_gen_url_rdoc_label_id
+    assert_equal '<a id="footmark-1" href="#foottext-1">example</a>',
+                 @to.gen_url('rdoc-label:foottext-1:footmark-1', 'example')
+  end
+
   def test_gem_url_image_url
     assert_equal '<img src="http://example.com/image.png" />', @to.gen_url('http://example.com/image.png', 'ignored')
   end
@@ -339,8 +467,19 @@ verb2</pre>
     assert_equal expected, @m.convert(str, @to)
   end
 
+  def test_parseable_eh
+    assert @to.parseable?('def x() end'),      'def'
+    assert @to.parseable?('class C end'),      'class'
+    assert @to.parseable?('module M end'),     'module'
+    assert @to.parseable?('a # => blah'),      '=>'
+    assert @to.parseable?('x { |y| ... }'),    '{ |x|'
+    assert @to.parseable?('x do |y| ... end'), 'do |x|'
+    refute @to.parseable?('* 1'),              '* 1'
+    refute @to.parseable?('# only a comment'), '# only a comment'
+  end
+
   def test_to_html
-    assert_equal "\n<p><tt>--</tt></p>\n", util_format("<tt>--</tt>")
+    assert_equal "\n<p><code>--</code></p>\n", util_format("<tt>--</tt>")
   end
 
   def util_format text