rdoc 4.0.0.preview2.1 → 4.0.0.rc.2

data/lib/rdoc/tom_doc.rb

@@ -218,7 +218,7 @@ class RDoc::TomDoc < RDoc::Markup::Parser
                    @tokens << [:HEADER, 3, *token_pos(pos)]
 
                    [:TEXT, @s[1], *token_pos(pos)]
-                 when @s.scan(/([:\w]\w*)[ ]+- /) then
+                 when @s.scan(/([:\w][\w\[\]]*)[ ]+- /) then
                    [:NOTE, @s[1], *token_pos(pos)]
                  else
                    @s.scan(/.*/)

data/lib/rdoc/top_level.rb

@@ -187,6 +187,7 @@ class RDoc::TopLevel < RDoc::Context
 
   ##
   # Dumps this TopLevel for use by ri.  See also #marshal_load
+
   def marshal_dump
     [
       MARSHAL_VERSION,
@@ -226,7 +227,7 @@ class RDoc::TopLevel < RDoc::Context
 
   def page_name
     basename = File.basename @relative_name
-    basename =~ /\.[^.]*$/
+    basename =~ /\.(rb|rdoc|txt|md)$/i
 
     $` || basename
   end

data/test/test_rdoc_any_method.rb

@@ -100,24 +100,31 @@ method(a, b) { |c, d| ... }
     assert_equal section,        loaded.section
   end
 
-  def test_marshal_load
-    instance_method = Marshal.load Marshal.dump(@c1.method_list.last)
-
-    assert_equal 'C1#m',  instance_method.full_name
-    assert_equal 'C1',    instance_method.parent_name
-    assert_equal '(foo)', instance_method.params
-
+  def test_marshal_load_aliased_method
     aliased_method = Marshal.load Marshal.dump(@c2.method_list.last)
 
     assert_equal 'C2#a',  aliased_method.full_name
     assert_equal 'C2',    aliased_method.parent_name
     assert_equal '()',    aliased_method.params
+    assert                aliased_method.display?
+  end
 
+  def test_marshal_load_class_method
     class_method = Marshal.load Marshal.dump(@c1.method_list.first)
 
     assert_equal 'C1::m', class_method.full_name
     assert_equal 'C1',    class_method.parent_name
     assert_equal '()',    class_method.params
+    assert                class_method.display?
+  end
+
+  def test_marshal_load_instance_method
+    instance_method = Marshal.load Marshal.dump(@c1.method_list.last)
+
+    assert_equal 'C1#m',  instance_method.full_name
+    assert_equal 'C1',    instance_method.parent_name
+    assert_equal '(foo)', instance_method.params
+    assert                instance_method.display?
   end
 
   def test_marshal_load_version_0
@@ -163,6 +170,8 @@ method(a, b) { |c, d| ... }
     assert_equal nil,            loaded.file
     assert_equal cm,             loaded.parent
     assert_equal section,        loaded.section
+
+    assert loaded.display?
   end
 
   def test_name

data/test/test_rdoc_attr.rb

@@ -137,6 +137,8 @@ class TestRDocAttr < RDoc::TestCase
     # version 3
     assert_equal cm,           loaded.parent
     assert_equal section,      loaded.section
+
+    assert loaded.display?
   end
 
   def test_marshal_load_version_2
@@ -165,6 +167,8 @@ class TestRDocAttr < RDoc::TestCase
     # version 3
     assert_equal cm,           loaded.parent
     assert_equal section,      loaded.section
+
+    assert loaded.display?
   end
 
   def test_params

data/test/test_rdoc_class_module.rb

@@ -289,6 +289,8 @@ class TestRDocClassModule < XrefTestCase
 
     expected = { nil => s0 }
     assert_equal expected, loaded.sections_hash
+
+    assert loaded.display?
   end
 
   def test_marshal_load_version_1

data/test/test_rdoc_comment.rb

@@ -70,7 +70,7 @@ call-seq:
     comment = RDoc::Comment.new <<-COMMENT, @top_level
 # call-seq:
 #   bla => true or false
-# 
+#
 # moar comment
     COMMENT
 

data/test/test_rdoc_constant.rb

@@ -86,6 +86,8 @@ class TestRDocConstant < XrefTestCase
     assert_nil                   loaded.visibility
     assert_equal cm,             loaded.parent
     assert_equal section,        loaded.section
+
+    assert loaded.display?
   end
 
   def test_marshal_load_version_0
@@ -116,6 +118,8 @@ class TestRDocConstant < XrefTestCase
     assert_nil                   loaded.visibility
     assert_equal cm,             loaded.parent
     assert_equal section,        loaded.section
+
+    assert loaded.display?
   end
 
   def test_marshal_round_trip

data/test/test_rdoc_cross_reference.rb

@@ -16,6 +16,14 @@ class TestRDocCrossReference < XrefTestCase
     assert_equal name, @xref.resolve(name, name)
   end
 
+  def test_METHOD_REGEXP_STR
+    re = /#{RDoc::CrossReference::METHOD_REGEXP_STR}/
+
+    re =~ '==='
+
+    assert_equal '===', $&
+  end
+
   def test_resolve_C2
     @xref = RDoc::CrossReference.new @c2
 
@@ -129,6 +137,13 @@ class TestRDocCrossReference < XrefTestCase
     assert_ref @c2_c3_m, '::C2::C3#m(*)'
   end
 
+  def test_resolve_method_equals3
+    m = RDoc::AnyMethod.new '', '==='
+    @c1.add_method m
+
+    assert_ref m, '==='
+  end
+
   def test_resolve_page
     page = @store.add_file 'README.txt'
     page.parser = RDoc::Parser::Simple

data/test/test_rdoc_encoding.rb

@@ -164,7 +164,7 @@ class TestRDocEncoding < RDoc::TestCase
 
     RDoc::Encoding.set_encoding s
 
-    assert_equal "# more comments", s
+    assert_equal "#!/bin/ruby\n# more comments", s
   end
 
   def test_class_set_encoding_bad

data/test/test_rdoc_generator_markup.rb

@@ -37,7 +37,10 @@ class TestRDocGeneratorMarkup < RDoc::TestCase
   def test_description
     @comment = '= Hello'
 
-    assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n", description
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", description
   end
 
   def test_formatter

data/test/test_rdoc_markup_formatter.rb

@@ -48,6 +48,97 @@ class TestRDocMarkupFormatter < RDoc::TestCase
     @tt      = @attributes.bitmap_for :TT
   end
 
+  def test_class_gen_relative_url
+    def gen(from, to)
+      RDoc::Markup::ToHtml.gen_relative_url from, to
+    end
+
+    assert_equal 'a.html',    gen('a.html',   'a.html')
+    assert_equal 'b.html',    gen('a.html',   'b.html')
+
+    assert_equal 'd.html',    gen('a/c.html', 'a/d.html')
+    assert_equal '../a.html', gen('a/c.html', 'a.html')
+    assert_equal 'a/c.html',  gen('a.html',   'a/c.html')
+  end
+
+  def special_names
+    @attribute_manager.special.map do |_, mask|
+      @attributes.as_string mask
+    end
+  end
+
+  def test_add_special_RDOCLINK
+    @to.add_special_RDOCLINK
+
+    assert_includes special_names, 'RDOCLINK'
+  end
+
+  def test_add_special_TIDYLINK
+    @to.add_special_TIDYLINK
+
+    assert_includes special_names, 'TIDYLINK'
+  end
+
+  def test_parse_url
+    scheme, url, id = @to.parse_url 'example/foo'
+
+    assert_equal 'http',               scheme
+    assert_equal 'http://example/foo', url
+    assert_equal nil,                  id
+  end
+
+  def test_parse_url_anchor
+    scheme, url, id = @to.parse_url '#foottext-1'
+
+    assert_equal nil,           scheme
+    assert_equal '#foottext-1', url
+    assert_equal nil,           id
+  end
+
+  def test_parse_url_link
+    scheme, url, id = @to.parse_url 'link:README.txt'
+
+    assert_equal 'link',       scheme
+    assert_equal 'README.txt', url
+    assert_equal nil,          id
+  end
+
+  def test_parse_url_link_id
+    scheme, url, id = @to.parse_url 'link:README.txt#label-foo'
+
+    assert_equal 'link',                 scheme
+    assert_equal 'README.txt#label-foo', url
+    assert_equal nil,                    id
+  end
+
+  def test_parse_url_rdoc_label
+    scheme, url, id = @to.parse_url 'rdoc-label:foo'
+
+    assert_equal 'link', scheme
+    assert_equal '#foo', url
+    assert_equal nil,    id
+
+    scheme, url, id = @to.parse_url 'rdoc-label:foo:bar'
+
+    assert_equal 'link',      scheme
+    assert_equal '#foo',      url
+    assert_equal ' id="bar"', id
+  end
+
+  def test_parse_url_scheme
+    scheme, url, id = @to.parse_url 'http://example/foo'
+
+    assert_equal 'http',               scheme
+    assert_equal 'http://example/foo', url
+    assert_equal nil,                  id
+
+    scheme, url, id = @to.parse_url 'https://example/foo'
+
+    assert_equal 'https',               scheme
+    assert_equal 'https://example/foo', url
+    assert_equal nil,                   id
+  end
+
   def test_convert_tt_special
     converted = @to.convert '<code>AAA</code>'
 

data/test/test_rdoc_markup_to_html.rb

@@ -10,19 +10,6 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     @to = RDoc::Markup::ToHtml.new @options
   end
 
-  def test_class_gen_relative_url
-    def gen(from, to)
-      RDoc::Markup::ToHtml.gen_relative_url from, to
-    end
-
-    assert_equal 'a.html',    gen('a.html',   'a.html')
-    assert_equal 'b.html',    gen('a.html',   'b.html')
-
-    assert_equal 'd.html',    gen('a/c.html', 'a/d.html')
-    assert_equal '../a.html', gen('a/c.html', 'a.html')
-    assert_equal 'a/c.html',  gen('a.html',   'a/c.html')
-  end
-
   def accept_blank_line
     assert_empty @to.res.join
   end
@@ -36,32 +23,55 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_heading
-    assert_equal "\n<h5 id=\"label-Hello\">Hello</h5>\n", @to.res.join
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+    expected = "\n<h5 id=\"label-Hello\">Hello#{links}</h5>\n"
+
+    assert_equal expected, @to.res.join
   end
 
   def accept_heading_1
-    assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n", @to.res.join
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", @to.res.join
   end
 
   def accept_heading_2
-    assert_equal "\n<h2 id=\"label-Hello\">Hello</h2>\n", @to.res.join
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h2 id=\"label-Hello\">Hello#{links}</h2>\n", @to.res.join
   end
 
   def accept_heading_3
-    assert_equal "\n<h3 id=\"label-Hello\">Hello</h3>\n", @to.res.join
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h3 id=\"label-Hello\">Hello#{links}</h3>\n", @to.res.join
   end
 
   def accept_heading_4
-    assert_equal "\n<h4 id=\"label-Hello\">Hello</h4>\n", @to.res.join
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h4 id=\"label-Hello\">Hello#{links}</h4>\n", @to.res.join
   end
 
   def accept_heading_b
-    assert_equal "\n<h1 id=\"label-Hello\"><strong>Hello</strong></h1>\n",
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+    inner = "<strong>Hello</strong>"
+
+    assert_equal "\n<h1 id=\"label-Hello\">#{inner}#{links}</h1>\n",
                  @to.res.join
   end
 
   def accept_heading_suppressed_crossref
-    assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n", @to.res.join
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", @to.res.join
   end
 
   def accept_list_end_bullet
@@ -337,7 +347,10 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
     @to.accept_heading @RM::Heading.new(7, 'Hello')
 
-    assert_equal "\n<h6 id=\"label-Hello\">Hello</h6>\n", @to.res.join
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h6 id=\"label-Hello\">Hello#{links}</h6>\n", @to.res.join
   end
 
   def test_accept_heading_aref_class
@@ -346,7 +359,10 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
     @to.accept_heading @RM::Heading.new(1, 'Hello')
 
-    assert_equal "\n<h1 id=\"label-Hello\">Hello</h1>\n",
+    links = '<span><a href="#label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n",
                  @to.res.join
   end
 
@@ -356,10 +372,23 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
     @to.accept_heading @RM::Heading.new(1, 'Hello')
 
-    assert_equal "\n<h1 id=\"method-i-foo-label-Hello\">Hello</h1>\n",
+    links = '<span><a href="#method-i-foo-label-Hello">&para;</a> ' +
+            '<a href="#documentation">&uarr;</a></span>'
+
+    assert_equal "\n<h1 id=\"method-i-foo-label-Hello\">Hello#{links}</h1>\n",
                  @to.res.join
   end
 
+  def test_accept_heading_pipe
+    @options.pipe = true
+
+    @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_verbatim_parseable
     verb = @RM::Verbatim.new("class C\n", "end\n")
 

data/test/test_rdoc_markup_to_markdown.rb

@@ -348,5 +348,36 @@ words words words words
     assert_equal expected, @to.end_accepting
   end
 
+  def test_convert_RDOCLINK
+    result = @to.convert 'rdoc-garbage:C'
+
+    assert_equal "C\n", result
+  end
+
+  def test_convert_TIDYLINK
+    result = @to.convert \
+      '{DSL}[http://en.wikipedia.org/wiki/Domain-specific_language]'
+
+    expected = "[DSL](http://en.wikipedia.org/wiki/Domain-specific_language)\n"
+
+    assert_equal expected, result
+  end
+
+  def test_handle_rdoc_link_label_footmark
+    assert_equal '[^1]:', @to.handle_rdoc_link('rdoc-label:footmark-1:x')
+  end
+
+  def test_handle_rdoc_link_label_foottext
+    assert_equal '[^1]',   @to.handle_rdoc_link('rdoc-label:foottext-1:x')
+  end
+
+  def test_handle_rdoc_link_label_label
+    assert_equal '[x](#label-x)', @to.handle_rdoc_link('rdoc-label:label-x')
+  end
+
+  def test_handle_rdoc_link_ref
+    assert_equal 'x', @to.handle_rdoc_link('rdoc-ref:x')
+  end
+
 end