rdoc 3.12.2 → 4.0.0.preview2

data/test/test_rdoc_markup_to_ansi.rb

@@ -15,6 +15,10 @@ class TestRDocMarkupToAnsi < RDoc::Markup::TextFormatterTestCase
     assert_equal "\e[0m\n", @to.res.join
   end
 
+  def accept_block_quote
+    assert_equal "\e[0m> quote\n", @to.res.join
+  end
+
   def accept_document
     assert_equal "\e[0mhello\n", @to.res.join
   end
@@ -242,10 +246,28 @@ class TestRDocMarkupToAnsi < RDoc::Markup::TextFormatterTestCase
                  @to.res.join
   end
 
+  def accept_list_item_start_note_multi_description
+    assert_equal "\e[0mlabel:\n  description one\n\n  description two\n\n",
+                 @to.res.join
+  end
+
+  def accept_list_item_start_note_multi_label
+    assert_equal "\e[0mone\ntwo:\n  two headers\n\n",
+                 @to.res.join
+  end
+
   def accept_paragraph_b
     assert_equal "\e[0mreg \e[1mbold words\e[m reg\n", @to.end_accepting
   end
 
+  def accept_paragraph_br
+    assert_equal "\e[0mone\ntwo\n", @to.end_accepting
+  end
+
+  def accept_paragraph_break
+    assert_equal "\e[0mhello\nworld\n", @to.end_accepting
+  end
+
   def accept_paragraph_i
     assert_equal "\e[0mreg \e[4mitalic words\e[m reg\n", @to.end_accepting
   end
@@ -334,8 +356,7 @@ bar ::
     NOTE_LIST
 
     expected = <<-EXPECTED
-\e[0m
-foo:
+\e[0mfoo
 bar:
   hi
 

data/test/test_rdoc_markup_to_bs.rb

@@ -15,6 +15,10 @@ class TestRDocMarkupToBs < RDoc::Markup::TextFormatterTestCase
     assert_equal "\n", @to.res.join
   end
 
+  def accept_block_quote
+    assert_equal "> quote\n", @to.res.join
+  end
+
   def accept_document
     assert_equal "hello\n", @to.res.join
   end
@@ -249,12 +253,32 @@ class TestRDocMarkupToBs < RDoc::Markup::TextFormatterTestCase
     assert_equal "teletype:\n  teletype description\n\n", @to.res.join
   end
 
+  def accept_list_item_start_note_multi_description
+    assert_equal "label:\n  description one\n\n  description two\n\n",
+                 @to.res.join
+  end
+
+  def accept_list_item_start_note_multi_label
+    assert_equal "one\ntwo:\n  two headers\n\n", @to.res.join
+  end
+
   def accept_paragraph_b
     skip "No String#chars, upgrade your ruby" unless ''.respond_to? :chars
     assert_equal "reg b\bbo\bol\bld\bd \b w\bwo\bor\brd\bds\bs reg\n",
                  @to.end_accepting
   end
 
+  def accept_paragraph_br
+    skip "No String#chars, upgrade your ruby" unless ''.respond_to? :chars
+    assert_equal "one\ntwo\n", @to.end_accepting
+  end
+
+  def accept_paragraph_break
+    skip "No String#chars, upgrade your ruby" unless ''.respond_to? :chars
+    assert_equal "hello\nworld\n",
+                 @to.end_accepting
+  end
+
   def accept_paragraph_i
     skip "No String#chars, upgrade your ruby" unless ''.respond_to? :chars
     assert_equal "reg _\bi_\bt_\ba_\bl_\bi_\bc_\b _\bw_\bo_\br_\bd_\bs reg\n",

data/test/test_rdoc_markup_to_html.rb

@@ -7,7 +7,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   def setup
     super
 
-    @to = RDoc::Markup::ToHtml.new
+    @to = RDoc::Markup::ToHtml.new @options
   end
 
   def test_class_gen_relative_url
@@ -27,6 +27,10 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_empty @to.res.join
   end
 
+  def accept_block_quote
+    assert_equal "\n<blockquote>\n<p>quote</p>\n</blockquote>\n", @to.res.join
+  end
+
   def accept_document
     assert_equal "\n<p>hello</p>\n", @to.res.join
   end
@@ -154,6 +158,31 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal expected, @to.res.join
   end
 
+  def accept_list_item_start_note_multi_description
+    expected = <<-EXPECTED
+<dl class="rdoc-list note-list"><dt>label
+<dd>
+<p>description one</p>
+</dd><dd>
+<p>description two</p>
+</dd></dl>
+    EXPECTED
+
+    assert_equal expected, @to.res.join
+  end
+
+  def accept_list_item_start_note_multi_label
+    expected = <<-EXPECTED
+<dl class="rdoc-list note-list"><dt>one
+<dt>two
+<dd>
+<p>two headers</p>
+</dd></dl>
+    EXPECTED
+
+    assert_equal expected, @to.res.join
+  end
+
   def accept_list_item_start_number
     assert_equal "<ol><li>", @to.res.join
   end
@@ -212,6 +241,14 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal "\n<p>reg <strong>bold words</strong> reg</p>\n", @to.res.join
   end
 
+  def accept_paragraph_br
+    assert_equal "\n<p>one<br>two</p>\n", @to.res.join
+  end
+
+  def accept_paragraph_break
+    assert_equal "\n<p>hello<br>\nworld</p>\n", @to.res.join
+  end
+
   def accept_paragraph_i
     assert_equal "\n<p>reg <em>italic words</em> reg</p>\n", @to.res.join
   end
@@ -324,11 +361,6 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   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
@@ -345,19 +377,16 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   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 % 09 # => blah\n")
 
     @to.start_accepting
     @to.accept_verbatim verb
 
+    inner = CGI.escapeHTML "a % 09 # => blah"
+
     expected = <<-EXPECTED
 
-<pre>a % 09 # =&gt; blah
+<pre>#{inner}
 </pre>
     EXPECTED
 
@@ -365,11 +394,6 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   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
 
@@ -419,6 +443,12 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     assert_equal "\n<p>C</p>\n", result
   end
 
+  def test_convert_TIDYLINK_footnote
+    result = @to.convert 'text{*1}[rdoc-label:foottext-1:footmark-1]'
+
+    assert_equal "\n<p>text<a id=\"footmark-1\" href=\"#foottext-1\">*1</a></p>\n", result
+  end
+
   def test_convert_TIDYLINK_rdoc_label
     result = @to.convert '{foo}[rdoc-label:foottext-1]'
 
@@ -446,11 +476,11 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
                  @to.gen_url('rdoc-label:foottext-1:footmark-1', 'example')
   end
 
-  def test_gem_url_image_url
+  def test_gen_url_image_url
     assert_equal '<img src="http://example.com/image.png" />', @to.gen_url('http://example.com/image.png', 'ignored')
   end
 
-  def test_gem_url_ssl_image_url
+  def test_gen_url_ssl_image_url
     assert_equal '<img src="https://example.com/image.png" />', @to.gen_url('https://example.com/image.png', 'ignored')
   end
 
@@ -497,6 +527,7 @@ verb2</pre>
     refute @to.parseable?('* 1'),              '* 1'
     refute @to.parseable?('# only a comment'), '# only a comment'
     refute @to.parseable?('<% require "foo" %>'),    'ERB'
+    refute @to.parseable?('class="foo"'),      'HTML class'
   end
 
   def test_to_html

data/test/test_rdoc_markup_to_html_crossref.rb

@@ -5,7 +5,9 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
   def setup
     super
 
-    @to = RDoc::Markup::ToHtmlCrossref.new 'index.html', @c1, true
+    @options.hyperlink_all = true
+
+    @to = RDoc::Markup::ToHtmlCrossref.new @options, 'index.html', @c1
   end
 
   def test_convert_CROSSREF
@@ -117,10 +119,10 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
   end
 
   def test_handle_special_HYPERLINK_rdoc
-    readme = RDoc::TopLevel.new 'README.txt'
+    readme = @store.add_file 'README.txt'
     readme.parser = RDoc::Parser::Simple
 
-    @to = RDoc::Markup::ToHtmlCrossref.new 'C2.html', @c2, true
+    @to = RDoc::Markup::ToHtmlCrossref.new @options, 'C2.html', @c2
 
     link = @to.handle_special_HYPERLINK hyper 'C2::C3'
 
@@ -136,10 +138,10 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
   end
 
   def test_handle_special_TIDYLINK_rdoc
-    readme = RDoc::TopLevel.new 'README.txt'
+    readme = @store.add_file 'README.txt'
     readme.parser = RDoc::Parser::Simple
 
-    @to = RDoc::Markup::ToHtmlCrossref.new 'C2.html', @c2, true
+    @to = RDoc::Markup::ToHtmlCrossref.new @options, 'C2.html', @c2
 
     link = @to.handle_special_TIDYLINK tidy 'C2::C3'
 
@@ -165,6 +167,22 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
                  link, 'C1#m@foo'
   end
 
+  def test_to_html_CROSSREF_email
+    @options.hyperlink_all = false
+
+    @to = RDoc::Markup::ToHtmlCrossref.new @options, 'index.html', @c1
+
+    result = @to.to_html 'first.last@example.com'
+
+    assert_equal 'first.last@example.com', result
+  end
+
+  def test_to_html_CROSSREF_email_hyperlink_all
+    result = @to.to_html 'first.last@example.com'
+
+    assert_equal 'first.last@example.com', result
+  end
+
   def test_link
     assert_equal 'n', @to.link('n', 'n')
 

data/test/test_rdoc_markup_to_html_snippet.rb

@@ -7,7 +7,7 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
   def setup
     super
 
-    @to = RDoc::Markup::ToHtmlSnippet.new 100, 100
+    @to = RDoc::Markup::ToHtmlSnippet.new @options, 100, 100
     @ellipsis = @to.to_html '...'
   end
 
@@ -15,6 +15,12 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
     assert_empty @to.res.join
   end
 
+  def accept_block_quote
+    assert_equal "\n<blockquote><p>quote\n</blockquote>\n", @to.res.join
+
+    assert_equal 5, @to.characters
+  end
+
   def accept_document
     assert_equal "<p>hello\n", @to.res.join
     assert_equal 5, @to.characters
@@ -165,6 +171,27 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
     assert_equal 29, @to.characters
   end
 
+  def accept_list_item_start_note_multi_description
+    expected = <<-EXPECTED
+<p>label &mdash; description one
+<p>description two
+
+    EXPECTED
+
+    assert_equal expected, @to.res.join
+    assert_equal 37, @to.characters
+  end
+
+  def accept_list_item_start_note_multi_label
+    expected = <<-EXPECTED
+<p>one, two &mdash; two headers
+
+    EXPECTED
+
+    assert_equal expected, @to.res.join
+    assert_equal 18, @to.characters
+  end
+
   def accept_list_item_start_number
     assert_equal "<p>", @to.res.join
     assert_equal 0, @to.characters
@@ -235,6 +262,18 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
     assert_equal 18, @to.characters
   end
 
+  def accept_paragraph_br
+    assert_equal "<p>one<br>two\n", @to.res.join
+
+    assert_equal 6, @to.characters
+  end
+
+  def accept_paragraph_break
+    assert_equal "<p>hello<br>\nworld\n", @to.res.join
+
+    assert_equal 11, @to.characters
+  end
+
   def accept_paragraph_i
     assert_equal "<p>reg <em>italic words</em> reg\n", @to.res.join
 
@@ -384,9 +423,11 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
     @to.start_accepting
     @to.accept_verbatim verb
 
+    inner = CGI.escapeHTML "a % 09 # => blah"
+
     expected = <<-EXPECTED
 
-<pre>a % 09 # =&gt; blah
+<pre>#{inner}
 </pre>
     EXPECTED
 
@@ -395,7 +436,7 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
   end
 
   def test_add_paragraph
-    @to = RDoc::Markup::ToHtmlSnippet.new 0, 3
+    @to = RDoc::Markup::ToHtmlSnippet.new @options, 0, 3
     assert_throws :done do
       @to.add_paragraph
       @to.add_paragraph
@@ -424,8 +465,8 @@ and an ellipsis must follow
 
     actual = @to.convert rdoc
 
-    assert_equal 111, @to.characters
     assert_equal expected, actual
+    assert_equal 111, @to.characters, 'snippet character length'
   end
 
   def test_convert_limit_2
@@ -444,11 +485,11 @@ be guessed, raises an error if +name+ couldn't be guessed.
     actual = @to.convert rdoc
 
     assert_equal expected, actual
-    assert_equal 159, @to.characters
+    assert_equal 159, @to.characters, 'snippet character length'
   end
 
   def test_convert_limit_paragraphs
-    @to = RDoc::Markup::ToHtmlSnippet.new 100, 3
+    @to = RDoc::Markup::ToHtmlSnippet.new @options, 100, 3
 
     rdoc = <<-RDOC
 = \RDoc - Ruby Documentation System
@@ -479,7 +520,7 @@ See RDoc for a description of RDoc's markup and basic use.
   end
 
   def test_convert_limit_in_tag
-    @to = RDoc::Markup::ToHtmlSnippet.new 4
+    @to = RDoc::Markup::ToHtmlSnippet.new @options, 4
     rdoc = "* ab *c* d\n"
 
     expected = "<p>ab <strong>c</strong> #{@ellipsis}\n\n"
@@ -558,7 +599,7 @@ This routine modifies its +comment+ parameter.
   end
 
   def test_convert_limit_over
-    @to = RDoc::Markup::ToHtmlSnippet.new 4
+    @to = RDoc::Markup::ToHtmlSnippet.new @options, 4
     rdoc = "* text\n" * 2
 
     expected = "<p>text\n"

data/test/test_rdoc_markup_to_joined_paragraph.rb

@@ -0,0 +1,32 @@
+require 'rdoc/test_case'
+
+class TestRDocMarkupToJoinedParagraph < RDoc::TestCase
+
+  def setup
+    super
+
+    @to = RDoc::Markup::ToJoinedParagraph.new
+  end
+
+  def test_accept_paragraph
+    parsed = para('hello', ' ', 'world')
+
+    @to.accept_paragraph parsed
+
+    expected = para('hello world')
+
+    assert_equal expected, parsed
+  end
+
+  def test_accept_paragraph_break
+    parsed = para('hello', ' ', 'world', hard_break, 'everyone')
+
+    @to.accept_paragraph parsed
+
+    expected = para('hello world', hard_break, 'everyone')
+
+    assert_equal expected, parsed
+  end
+
+end
+