rdoc 3.8 → 3.9

data/test/test_rdoc_markup_to_html.rb

@@ -306,6 +306,14 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
                  @to.gen_url('link:example', 'example')
   end
 
+  def test_handle_special_HYPERLINK_link
+    special = RDoc::Markup::Special.new 0, 'link:README.txt'
+
+    link = @to.handle_special_HYPERLINK special
+
+    assert_equal '<a href="README.txt">README.txt</a>', link
+  end
+
   def test_list_verbatim_2
     str = "* one\n    verb1\n    verb2\n* two\n"
 

data/test/test_rdoc_markup_to_html_crossref.rb

@@ -10,159 +10,86 @@ class TestRDocMarkupToHtmlCrossref < XrefTestCase
   def setup
     super
 
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'index.html', @c1, true
+    @to = RDoc::Markup::ToHtmlCrossref.new 'index.html', @c1, true
   end
 
-  def assert_ref(path, ref)
-    assert_equal "\n<p><a href=\"#{path}\">#{ref}</a></p>\n", @xref.convert(ref)
-  end
+  def test_convert_CROSSREF
+    result = @to.convert 'C1'
 
-  def refute_ref(body, ref)
-    assert_equal "\n<p>#{body}</p>\n", @xref.convert(ref)
+    assert_equal "\n<p><a href=\"C1.html\">C1</a></p>\n", result
   end
 
-  def test_handle_special_CROSSREF_C2
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C2.html', @c2, true
-
-    refute_ref '#m', '#m'
+  def test_convert_HYPERLINK_rdoc_ref
+    result = @to.convert 'rdoc-ref:C1'
 
-    assert_ref '../C1.html#method-c-m', 'C1::m'
-    assert_ref '../C2/C3.html', 'C2::C3'
-    assert_ref '../C2/C3.html#method-i-m', 'C2::C3#m'
-    assert_ref '../C2/C3/H1.html', 'C3::H1'
-    assert_ref '../C4.html', 'C4'
-
-    assert_ref '../C3/H2.html', 'C3::H2'
-    refute_ref 'H1', 'H1'
+    assert_equal "\n<p><a href=\"C1.html\">C1</a></p>\n", result
   end
 
-  def test_handle_special_CROSSREF_C2_C3
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C2/C3.html', @c2_c3, true
-
-    assert_ref '../../C2/C3.html#method-i-m', '#m'
-
-    assert_ref '../../C2/C3.html', 'C3'
-    assert_ref '../../C2/C3.html#method-i-m', 'C3#m'
-
-    assert_ref '../../C2/C3/H1.html', 'H1'
-    assert_ref '../../C2/C3/H1.html', 'C3::H1'
-
-    assert_ref '../../C4.html', 'C4'
-
-    assert_ref '../../C3/H2.html', 'C3::H2'
+  def test_handle_special_CROSSREF
+    assert_equal "<a href=\"C2/C3.html\">C2::C3</a>", SPECIAL('C2::C3')
   end
 
-  def test_handle_special_CROSSREF_C3
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C3.html', @c3, true
-
-    assert_ref '../C3.html', 'C3'
-
-    refute_ref '#m',   '#m'
-    refute_ref 'C3#m', 'C3#m'
-
-    assert_ref '../C3/H1.html', 'H1'
-
-    assert_ref '../C3/H1.html', 'C3::H1'
-    assert_ref '../C3/H2.html', 'C3::H2'
-
-    assert_ref '../C4.html', 'C4'
-  end
-
-  def test_handle_special_CROSSREF_C4
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C4.html', @c4, true
+  def test_handle_special_CROSSREF_show_hash_false
+    @to.show_hash = false
 
-    # C4 ref inside a C4 containing a C4 should resolve to the contained class
-    assert_ref '../C4/C4.html', 'C4'
+    assert_equal "<a href=\"C1.html#method-i-m\">m</a>",
+                 SPECIAL('#m')
   end
 
-  def test_handle_special_CROSSREF_C4_C4
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C4/C4.html', @c4_c4, true
+  def test_handle_special_HYPERLINK_rdoc
+    RDoc::TopLevel.new 'README.txt'
+    @to = RDoc::Markup::ToHtmlCrossref.new 'C2.html', @c2, true
 
-    # A C4 reference inside a C4 class contained within a C4 class should
-    # resolve to the inner C4 class.
-    assert_ref '../../C4/C4.html', 'C4'
-  end
+    link = @to.handle_special_HYPERLINK hyper 'C2::C3'
 
-  def test_handle_special_CROSSREF_class
-    assert_ref 'C1.html', 'C1'
-    refute_ref 'H1', 'H1'
+    assert_equal '<a href="C2/C3.html">C2::C3</a>', link
 
-    assert_ref 'C2.html',       'C2'
-    assert_ref 'C2/C3.html',    'C2::C3'
-    assert_ref 'C2/C3/H1.html', 'C2::C3::H1'
+    link = @to.handle_special_HYPERLINK hyper 'C4'
 
-    assert_ref 'C3.html',    '::C3'
-    assert_ref 'C3/H1.html', '::C3::H1'
+    assert_equal '<a href="C4.html">C4</a>', link
 
-    assert_ref 'C4/C4.html', 'C4::C4'
-  end
+    link = @to.handle_special_HYPERLINK hyper 'README.txt'
 
-  def test_handle_special_CROSSREF_file
-    assert_ref 'xref_data_rb.html', 'xref_data.rb'
+    assert_equal '<a href="README_txt.html">README.txt</a>', link
   end
 
-  def test_handle_special_CROSSREF_method
-    refute_ref 'm', 'm'
-    assert_ref 'C1.html#method-i-m', '#m'
-    assert_ref 'C1.html#method-c-m', '::m'
-
-    assert_ref 'C1.html#method-i-m', 'C1#m'
-    assert_ref 'C1.html#method-c-m', 'C1.m'
-    assert_ref 'C1.html#method-c-m', 'C1::m'
+  def test_handle_special_TIDYLINK_rdoc
+    RDoc::TopLevel.new 'README.txt'
+    @to = RDoc::Markup::ToHtmlCrossref.new 'C2.html', @c2, true
 
-    assert_ref 'C1.html#method-i-m', 'C1#m'
-    assert_ref 'C1.html#method-i-m', 'C1#m()'
-    assert_ref 'C1.html#method-i-m', 'C1#m(*)'
+    link = @to.handle_special_TIDYLINK tidy 'C2::C3'
 
-    assert_ref 'C1.html#method-c-m', 'C1.m'
-    assert_ref 'C1.html#method-c-m', 'C1.m()'
-    assert_ref 'C1.html#method-c-m', 'C1.m(*)'
+    assert_equal '<a href="C2/C3.html">tidy</a>', link
 
-    assert_ref 'C1.html#method-c-m', 'C1::m'
-    assert_ref 'C1.html#method-c-m', 'C1::m()'
-    assert_ref 'C1.html#method-c-m', 'C1::m(*)'
+    link = @to.handle_special_TIDYLINK tidy 'C4'
 
-    assert_ref 'C2/C3.html#method-i-m', 'C2::C3#m'
+    assert_equal '<a href="C4.html">tidy</a>', link
 
-    assert_ref 'C2/C3.html#method-i-m', 'C2::C3.m'
+    link = @to.handle_special_TIDYLINK tidy 'README.txt'
 
-    # TODO stop escaping - HTML5 allows anything but space
-    assert_ref 'C2/C3/H1.html#method-i-m-3F', 'C2::C3::H1#m?'
-
-    assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m'
-    assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m()'
-    assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m(*)'
+    assert_equal '<a href="README_txt.html">tidy</a>', link
   end
 
-  def test_handle_special_CROSSREF_no_ref
-    assert_equal '', @xref.convert('')
-
-    refute_ref 'bogus', 'bogus'
-    refute_ref 'bogus', '\bogus'
-    refute_ref '\bogus', '\\\bogus'
-
-    refute_ref '#n',    '\#n'
-    refute_ref '#n()',  '\#n()'
-    refute_ref '#n(*)', '\#n(*)'
+  def test_link
+    assert_equal 'n', @to.link('n', 'n')
 
-    refute_ref 'C1',   '\C1'
-    refute_ref '::C3', '\::C3'
+    assert_equal '<a href="C1.html#method-c-m">m</a>', @to.link('m', 'm')
+  end
 
-    refute_ref '::C3::H1#n',    '::C3::H1#n'
-    refute_ref '::C3::H1#n(*)', '::C3::H1#n(*)'
-    refute_ref '::C3::H1#n',    '\::C3::H1#n'
+  def SPECIAL text
+    @to.handle_special_CROSSREF special text
   end
 
-  def test_handle_special_CROSSREF_show_hash_false
-    @xref.show_hash = false
+  def hyper reference
+    RDoc::Markup::Special.new 0, "rdoc-ref:#{reference}"
+  end
 
-    assert_equal "\n<p><a href=\"C1.html#method-i-m\">m</a></p>\n",
-                 @xref.convert('#m')
+  def special text
+    RDoc::Markup::Special.new 0, text
   end
 
-  def test_handle_special_CROSSREF_special
-    assert_equal "\n<p><a href=\"C2/C3.html\">C2::C3</a>;method(*)</p>\n",
-                 @xref.convert('C2::C3;method(*)')
+  def tidy reference
+    RDoc::Markup::Special.new 0, "{tidy}[rdoc-ref:#{reference}]"
   end
 
 end

data/test/test_rdoc_parser_ruby.rb

@@ -313,22 +313,6 @@ class C; end
                  comment
   end
 
-  def test_look_for_directives_in_enddoc
-    util_parser ""
-
-    @parser.look_for_directives_in @top_level, "# :enddoc:\n"
-
-    assert @top_level.done_documenting
-  end
-
-  def test_look_for_directives_in_main
-    util_parser ""
-
-    @parser.look_for_directives_in @top_level, "# :main: new main page\n"
-
-    assert_equal 'new main page', @options.main_page
-  end
-
   def test_look_for_directives_in_method
     util_parser ""
 
@@ -345,31 +329,6 @@ class C; end
     assert_equal "# :singleton-method: my_method\n", comment
   end
 
-  def test_look_for_directives_in_startdoc
-    util_parser ""
-
-    @top_level.stop_doc
-    assert !@top_level.document_self
-    assert !@top_level.document_children
-
-    @parser.look_for_directives_in @top_level, "# :startdoc:\n"
-
-    assert @top_level.document_self
-    assert @top_level.document_children
-  end
-
-  def test_look_for_directives_in_stopdoc
-    util_parser ""
-
-    assert @top_level.document_self
-    assert @top_level.document_children
-
-    @parser.look_for_directives_in @top_level, "# :stopdoc:\n"
-
-    assert !@top_level.document_self
-    assert !@top_level.document_children
-  end
-
   def test_look_for_directives_in_section
     util_parser ""
 
@@ -384,14 +343,6 @@ class C; end
     assert_equal '', comment
   end
 
-  def test_look_for_directives_in_title
-    util_parser ""
-
-    @parser.look_for_directives_in @top_level, "# :title: new title\n"
-
-    assert_equal 'new title', @options.title
-  end
-
   def test_look_for_directives_in_unhandled
     util_parser ""
 
@@ -797,12 +748,7 @@ end
 
     @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment
 
-    foo = @top_level.classes.first
-    assert_equal 'Foo', foo.full_name
-    assert_equal 'my class', foo.comment
-    assert_equal [@top_level], foo.in_files
-    assert_equal 0, foo.offset
-    assert_equal 1, foo.line
+    assert_empty @top_level.classes.first.comment
   end
 
   def test_parse_multi_ghost_methods
@@ -2227,6 +2173,45 @@ end
     assert_empty @top_level.comment
   end
 
+  def test_parse_top_level_statements_stopdoc_integration
+    content = <<-CONTENT
+# :stopdoc:
+
+class Example
+  def method_name
+  end
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.parse_top_level_statements @top_level
+
+    assert_equal 1, @top_level.classes.length
+    assert_empty @top_level.modules
+
+    assert @top_level.find_module_named('Example').ignored?
+  end
+
+  # This tests parse_comment
+  def test_parse_top_level_statements_constant_nodoc_integration
+    content = <<-CONTENT
+class A
+  C = A # :nodoc:
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.parse_top_level_statements @top_level
+
+    klass = @top_level.find_module_named('A')
+
+    c = klass.constants.first
+
+    assert_nil c.document_self, 'C should not be documented'
+  end
+
   def test_parse_yield_in_braces_with_parens
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level

data/test/test_rdoc_ri_driver.rb

@@ -5,6 +5,7 @@ require 'tmpdir'
 require 'fileutils'
 require 'stringio'
 require 'rdoc/ri/driver'
+require 'rdoc/rdoc'
 
 class TestRDocRIDriver < MiniTest::Unit::TestCase
 
@@ -223,7 +224,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_add_method_list_none
     out = @RM::Document.new
 
-    @driver.add_method_list out, nil, 'Class'
+    @driver.add_method_list out, [], 'Class'
 
     assert_equal @RM::Document.new, out
   end
@@ -249,6 +250,46 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
     assert_equal expected, @driver.classes
   end
 
+  def test_class_document
+    util_store
+
+    tl1 = RDoc::TopLevel.new 'one.rb'
+    tl2 = RDoc::TopLevel.new 'two.rb'
+
+    @cFoo.add_comment 'one', tl1
+    @cFoo.add_comment 'two', tl2
+    @store.save_class @cFoo
+
+    found = [
+      [@store, @store.load_class(@cFoo.full_name)]
+    ]
+
+    out = @driver.class_document @cFoo.full_name, found, [], []
+
+    expected = @RM::Document.new
+    @driver.add_class expected, 'Foo', []
+    @driver.add_includes expected, []
+    @driver.add_from expected, @store
+    expected << @RM::Rule.new(1)
+
+    doc = @RM::Document.new(@RM::Paragraph.new('one'))
+    doc.file = 'one.rb'
+    expected.push doc
+    expected << @RM::BlankLine.new
+    doc = @RM::Document.new(@RM::Paragraph.new('two'))
+    doc.file = 'two.rb'
+    expected.push doc
+
+    expected << @RM::Rule.new(1)
+    expected << @RM::Heading.new(1, 'Instance methods:')
+    expected << @RM::BlankLine.new
+    expected << @RM::Verbatim.new('inherit')
+    expected << @RM::Verbatim.new('override')
+    expected << @RM::BlankLine.new
+
+    assert_equal expected, out
+  end
+
   def test_complete
     store = RDoc::RI::Store.new @home_ri
     store.cache[:ancestors] = {
@@ -633,8 +674,24 @@ Foo::Bar#bother
   def test_list_methods_matching
     util_store
 
-    assert_equal %w[Foo::Bar#attr Foo::Bar#blah Foo::Bar#bother Foo::Bar::new],
-                 @driver.list_methods_matching('Foo::Bar.')
+    assert_equal %w[
+        Foo::Bar#attr
+        Foo::Bar#blah
+        Foo::Bar#bother
+        Foo::Bar::new
+      ],
+      @driver.list_methods_matching('Foo::Bar.').sort
+  end
+
+  def test_list_methods_matching_inherit
+    util_multi_store
+
+    assert_equal %w[
+        Bar#baz
+        Bar#inherit
+        Bar#override
+      ],
+      @driver.list_methods_matching('Bar.').sort
   end
 
   def test_list_methods_matching_regexp
@@ -805,6 +862,42 @@ Foo::Bar#bother
     assert_equal 'baz',      meth,  'Foo::Bar#baz method'
   end
 
+  def test_parse_name_special
+    specials = %w[
+      %
+      &
+      *
+      +
+      +@
+      -
+      -@
+      /
+      <
+      <<
+      <=
+      <=>
+      ==
+      ===
+      =>
+      =~
+      >
+      >>
+      []
+      []=
+      ^
+      `
+      |
+      ~
+      ~@
+    ]
+
+    specials.each do |special|
+      parsed = @driver.parse_name special
+
+      assert_equal ['', '.', special], parsed
+    end
+  end
+
   def _test_setup_pager # this test doesn't do anything anymore :(
     @driver.use_stdout = false
 
@@ -864,29 +957,28 @@ Foo::Bar#bother
 
   def util_multi_store
     util_store
+
     @store1 = @store
 
+    @top_level = RDoc::TopLevel.new 'file.rb'
+
     @home_ri2 = "#{@home_ri}2"
     @store2 = RDoc::RI::Store.new @home_ri2
 
     # as if seen in a namespace like class Ambiguous::Other
-    @mAmbiguous = RDoc::NormalModule.new 'Ambiguous'
+    @mAmbiguous = @top_level.add_module RDoc::NormalModule, 'Ambiguous'
 
-    @cFoo = RDoc::NormalClass.new 'Foo'
+    @cFoo = @top_level.add_class RDoc::NormalClass, 'Foo'
 
-    @cBar = RDoc::NormalClass.new 'Bar'
-    @cBar.superclass = 'Foo'
-    @cFoo_Baz = RDoc::NormalClass.new 'Baz'
-    @cFoo_Baz.parent = @cFoo
+    @cBar = @top_level.add_class RDoc::NormalClass, 'Bar', 'Foo'
+    @cFoo_Baz = @cFoo.add_class RDoc::NormalClass, 'Baz'
 
-    @baz = RDoc::AnyMethod.new nil, 'baz'
+    @baz = @cBar.add_method RDoc::AnyMethod.new(nil, 'baz')
     @baz.record_location @top_level
-    @cBar.add_method @baz
 
-    @override = RDoc::AnyMethod.new nil, 'override'
+    @override = @cBar.add_method RDoc::AnyMethod.new(nil, 'override')
     @override.comment = 'must be displayed'
     @override.record_location @top_level
-    @cBar.add_method @override
 
     @store2.save_class @mAmbiguous
     @store2.save_class @cBar
@@ -898,6 +990,8 @@ Foo::Bar#bother
     @store2.save_cache
 
     @driver.stores = [@store1, @store2]
+
+    RDoc::RDoc.reset
   end
 
   def util_store
@@ -905,53 +999,42 @@ Foo::Bar#bother
 
     @top_level = RDoc::TopLevel.new 'file.rb'
 
-    @cFoo       = RDoc::NormalClass.new 'Foo'
-    @mInc       = RDoc::NormalModule.new 'Inc'
-    @cAmbiguous = RDoc::NormalClass.new 'Ambiguous'
+    @cFoo = @top_level.add_class RDoc::NormalClass, 'Foo'
+    @mInc = @top_level.add_module RDoc::NormalModule, 'Inc'
+    @cAmbiguous = @top_level.add_class RDoc::NormalClass, 'Ambiguous'
 
     doc = @RM::Document.new @RM::Paragraph.new('Include thingy')
-
-    @cFooInc = RDoc::Include.new 'Inc', doc
+    @cFooInc = @cFoo.add_include RDoc::Include.new('Inc', doc)
     @cFooInc.record_location @top_level
-    @cFoo.add_include @cFooInc
 
-    @cFoo_Bar = RDoc::NormalClass.new 'Bar'
-    @cFoo_Bar.parent = @cFoo
+    @cFoo_Bar = @cFoo.add_class RDoc::NormalClass, 'Bar'
 
-    @blah = RDoc::AnyMethod.new nil, 'blah'
+    @blah = @cFoo_Bar.add_method RDoc::AnyMethod.new(nil, 'blah')
     @blah.call_seq = "blah(5) => 5\nblah(6) => 6\n"
     @blah.record_location @top_level
 
-    @bother = RDoc::AnyMethod.new nil, 'bother'
+    @bother = @cFoo_Bar.add_method RDoc::AnyMethod.new(nil, 'bother')
     @bother.block_params = "stuff"
     @bother.params = "(things)"
     @bother.record_location @top_level
 
-    @new  = RDoc::AnyMethod.new nil, 'new'
+    @new = @cFoo_Bar.add_method RDoc::AnyMethod.new nil, 'new'
     @new.record_location @top_level
     @new.singleton = true
 
-    @cFoo_Bar.add_method @blah
-    @cFoo_Bar.add_method @bother
-    @cFoo_Bar.add_method @new
-
-    @attr = RDoc::Attr.new nil, 'attr', 'RW', ''
+    @attr = @cFoo_Bar.add_attribute RDoc::Attr.new nil, 'attr', 'RW', ''
     @attr.record_location @top_level
 
-    @cFoo_Bar.add_attribute @attr
-
-    @cFoo_Baz = RDoc::NormalClass.new 'Baz'
-    @cFoo_Baz.parent = @cFoo
+    @cFoo_Baz = @cFoo.add_class RDoc::NormalClass, 'Baz'
+    @cFoo_Baz.record_location @top_level
 
-    @inherit = RDoc::AnyMethod.new nil, 'inherit'
+    @inherit = @cFoo.add_method RDoc::AnyMethod.new(nil, 'inherit')
     @inherit.record_location @top_level
-    @cFoo.add_method @inherit
 
     # overriden by Bar in multi_store
-    @overriden = RDoc::AnyMethod.new nil, 'override'
+    @overriden = @cFoo.add_method RDoc::AnyMethod.new(nil, 'override')
     @overriden.comment = 'must not be displayed'
     @overriden.record_location @top_level
-    @cFoo.add_method @overriden
 
     @store.save_class @cFoo
     @store.save_class @cFoo_Bar
@@ -970,6 +1053,8 @@ Foo::Bar#bother
     @store.save_cache
 
     @driver.stores = [@store]
+
+    RDoc::RDoc.reset
   end
 
 end