rdoc 4.1.2 → 4.2.0

data/test/test_rdoc_markup_attribute_manager.rb

@@ -130,6 +130,9 @@ class TestRDocMarkupAttributeManager < RDoc::TestCase
     assert_equal(["cat ", @tt_on, "and", @tt_off, " dog"],
                   @am.flow("cat +and+ dog"))
 
+    assert_equal(["cat ", @tt_on, "X::Y", @tt_off, " dog"],
+                  @am.flow("cat +X::Y+ dog"))
+
     assert_equal(["cat ", @bold_on, "a_b_c", @bold_off, " dog"],
                   @am.flow("cat *a_b_c* dog"))
 
@@ -138,6 +141,9 @@ class TestRDocMarkupAttributeManager < RDoc::TestCase
 
     assert_equal(["cat ", @em_on, "_", @em_off, " dog"],
                   @am.flow("cat ___ dog"))
+
+    assert_equal(["cat and ", @em_on, "5", @em_off, " dogs"],
+                  @am.flow("cat and _5_ dogs"))
   end
 
   def test_bold

data/test/test_rdoc_markup_heading.rb

@@ -9,16 +9,16 @@ class TestRDocMarkupHeading < RDoc::TestCase
   end
 
   def test_aref
-    assert_equal 'label-Hello+Friend%21', @h.aref
+    assert_equal 'label-Hello+Friend-21', @h.aref
   end
 
   def test_label
-    assert_equal 'label-Hello+Friend%21', @h.label
-    assert_equal 'label-Hello+Friend%21', @h.label(nil)
+    assert_equal 'label-Hello+Friend-21', @h.label
+    assert_equal 'label-Hello+Friend-21', @h.label(nil)
 
     context = RDoc::NormalClass.new 'Foo'
 
-    assert_equal 'class-Foo-label-Hello+Friend%21', @h.label(context)
+    assert_equal 'class-Foo-label-Hello+Friend-21', @h.label(context)
   end
 
   def test_plain_html

data/test/test_rdoc_markup_pre_process.rb

@@ -17,7 +17,7 @@ class TestRDocMarkupPreProcess < RDoc::TestCase
   def teardown
     super
 
-    @tempfile.close
+    @tempfile.close!
   end
 
   def test_class_register

data/test/test_rdoc_markup_to_html.rb

@@ -24,7 +24,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
   def accept_heading
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
     expected = "\n<h5 id=\"label-Hello\">Hello#{links}</h5>\n"
 
     assert_equal expected, @to.res.join
@@ -32,35 +32,35 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
   def accept_heading_1
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", @to.res.join
   end
 
   def accept_heading_2
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h2 id=\"label-Hello\">Hello#{links}</h2>\n", @to.res.join
   end
 
   def accept_heading_3
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h3 id=\"label-Hello\">Hello#{links}</h3>\n", @to.res.join
   end
 
   def accept_heading_4
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h4 id=\"label-Hello\">Hello#{links}</h4>\n", @to.res.join
   end
 
   def accept_heading_b
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
     inner = "<strong>Hello</strong>"
 
     assert_equal "\n<h1 id=\"label-Hello\">#{inner}#{links}</h1>\n",
@@ -69,7 +69,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
   def accept_heading_suppressed_crossref
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h1 id=\"label-Hello\">Hello#{links}</h1>\n", @to.res.join
   end
@@ -292,7 +292,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
   end
 
   def accept_verbatim
-    assert_equal "\n<pre>hi\n  world</pre>\n", @to.res.join
+    assert_equal "\n<pre class=\"ruby\"><span class=\"ruby-identifier\">hi</span>\n  <span class=\"ruby-identifier\">world</span>\n</pre>\n", @to.res.join
   end
 
   def end_accepting
@@ -348,7 +348,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     @to.accept_heading @RM::Heading.new(7, 'Hello')
 
     links = '<span><a href="#label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h6 id=\"label-Hello\">Hello#{links}</h6>\n", @to.res.join
   end
@@ -360,7 +360,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     @to.accept_heading head(1, 'Hello')
 
     links = '<span><a href="#class-Foo-label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h1 id=\"class-Foo-label-Hello\">Hello#{links}</h1>\n",
                  @to.res.join
@@ -373,7 +373,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
     @to.accept_heading @RM::Heading.new(1, 'Hello')
 
     links = '<span><a href="#method-i-foo-label-Hello">&para;</a> ' +
-            '<a href="#documentation">&uarr;</a></span>'
+            '<a href="#top">&uarr;</a></span>'
 
     assert_equal "\n<h1 id=\"method-i-foo-label-Hello\">Hello#{links}</h1>\n",
                  @to.res.join
@@ -404,7 +404,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
     @to.accept_heading @RM::Heading.new(1, 'Hello')
 
-    assert_equal "\n<h1>Hello<span><a href=\"#label-Hello\">&para;</a> <a href=\"#documentation\">&uarr;</a></span></h1>\n", @to.res.join
+    assert_equal "\n<h1>Hello<span><a href=\"#label-Hello\">&para;</a> <a href=\"#top\">&uarr;</a></span></h1>\n", @to.res.join
   end
 
   def test_accept_heading_output_decoration_with_pipe
@@ -444,8 +444,7 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 
     expected = <<-EXPECTED
 
-<pre>#{inner}
-</pre>
+<pre>#{inner}</pre>
     EXPECTED
 
     assert_equal expected, @to.res.join
@@ -604,8 +603,9 @@ class TestRDocMarkupToHtml < RDoc::Markup::FormatterTestCase
 <ul><li>
 <p>one</p>
 
-<pre>verb1
-verb2</pre>
+<pre class=\"ruby\"><span class=\"ruby-identifier\">verb1</span>
+<span class=\"ruby-identifier\">verb2</span>
+</pre>
 </li><li>
 <p>two</p>
 </li></ul>
@@ -615,16 +615,36 @@ verb2</pre>
   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'
-    refute @to.parseable?('<% require "foo" %>'),    'ERB'
-    refute @to.parseable?('class="foo"'),      'HTML class'
+    valid_syntax = [
+      'def x() end',
+      'def x; end',
+      'class C; end',
+      "module M end",
+      'a # => blah',
+      'x { |y| nil }',
+      'x do |y| nil end',
+      '# only a comment',
+      'require "foo"',
+      'cls="foo"'
+    ]
+    invalid_syntax = [
+      'def x end',
+      'class C end',
+      'class C < end',
+      'module M < C end',
+      'a=># blah',
+      'x { |y| ... }',
+      'x do |y| ... end',
+      '// only a comment',
+      '<% require "foo" %>',
+      'class="foo"'
+    ]
+    valid_syntax.each do |t|
+      assert @to.parseable?(t), "valid syntax considered invalid: #{t}"
+    end
+    invalid_syntax.each do |t|
+      refute @to.parseable?(t), "invalid syntax considered valid: #{t}"
+    end
   end
 
   def test_to_html

data/test/test_rdoc_markup_to_html_snippet.rb

@@ -309,7 +309,7 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
   end
 
   def accept_verbatim
-    assert_equal "\n<pre>hi\n  world</pre>\n", @to.res.join
+    assert_equal "\n<pre class=\"ruby\"><span class=\"ruby-identifier\">hi</span>\n  <span class=\"ruby-identifier\">world</span>\n</pre>\n", @to.res.join
     assert_equal 10, @to.characters
   end
 
@@ -427,8 +427,7 @@ class TestRDocMarkupToHtmlSnippet < RDoc::Markup::FormatterTestCase
 
     expected = <<-EXPECTED
 
-<pre>#{inner}
-</pre>
+<pre>#{inner}</pre>
     EXPECTED
 
     assert_equal expected, @to.res.join
@@ -588,8 +587,9 @@ This routine modifies its +comment+ parameter.
     expected = <<-EXPECTED
 <p>Look for directives in a normal comment block:
 
-<pre># :stopdoc:
-#{inner}</pre>
+<pre class=\"ruby\"><span class=\"ruby-comment\"># :stopdoc:</span>
+<span class=\"ruby-comment\">#{inner}</span>
+</pre>
     EXPECTED
 
     actual = @to.convert rdoc
@@ -665,8 +665,9 @@ This routine modifies its +comment+ parameter.
     expected = <<-EXPECTED
 <p>one
 
-<pre>verb1
-verb2</pre>
+<pre class=\"ruby\"><span class=\"ruby-identifier\">verb1</span>
+<span class=\"ruby-identifier\">verb2</span>
+</pre>
 <p>two
 
     EXPECTED

data/test/test_rdoc_markup_to_label.rb

@@ -82,8 +82,8 @@ class TestRDocMarkupToLabel < RDoc::Markup::FormatterTestCase
     assert_equal 'some_method', @to.convert('some_method')
     assert_equal 'some_method', @to.convert('\\some_method')
 
-    assert_equal '%23some_method', @to.convert('#some_method')
-    assert_equal '%23some_method', @to.convert('\\#some_method')
+    assert_equal '23some_method', @to.convert('#some_method')
+    assert_equal '23some_method', @to.convert('\\#some_method')
   end
 
   def test_convert_em
@@ -92,11 +92,11 @@ class TestRDocMarkupToLabel < RDoc::Markup::FormatterTestCase
   end
 
   def test_convert_em_dash # for HTML conversion
-    assert_equal '--', @to.convert('--')
+    assert_equal '-', @to.convert('--')
   end
 
   def test_convert_escape
-    assert_equal 'a+%3E+b', @to.convert('a > b')
+    assert_equal 'a+-3E+b', @to.convert('a > b')
   end
 
   def test_convert_tidylink

data/test/test_rdoc_method_attr.rb

@@ -7,7 +7,6 @@ class TestRDocMethodAttr < XrefTestCase
   end
 
   def test_block_params_equal
-
     m = RDoc::MethodAttr.new(nil, 'foo')
 
     m.block_params = ''
@@ -148,11 +147,42 @@ class TestRDocMethodAttr < XrefTestCase
     assert_equal expected, @c1_m.search_record
   end
 
+  def test_spaceship
+    assert_nil @c1_m.<=>(RDoc::CodeObject.new)
+  end
+
   def test_equals2
     assert_equal @c1_m, @c1_m
     refute_equal @c1_m, @parent_m
   end
 
+  def test_pretty_print
+    temp_dir do |tmpdir|
+      s = RDoc::RI::Store.new tmpdir
+      s.rdoc = @rdoc
+
+      top_level = s.add_file 'file.rb'
+      meth_bang = RDoc::AnyMethod.new nil, 'method!'
+      meth_bang.record_location top_level
+
+      meth_bang_alias = RDoc::Alias.new nil, 'method!', 'method_bang', ''
+      meth_bang_alias.record_location top_level
+
+      klass = top_level.add_class RDoc::NormalClass, 'Object'
+      klass.add_method meth_bang
+
+      meth_bang.add_alias meth_bang_alias, klass
+
+      s.save
+
+      meth_alias_from_store = s.load_method 'Object', '#method_bang'
+
+      expected = "[RDoc::AnyMethod Object#method_bang public alias for method!]"
+      actual =  mu_pp meth_alias_from_store
+      assert_equal expected, actual
+    end
+  end
+
   def test_to_s
     assert_equal 'RDoc::AnyMethod: C1#m',  @c1_m.to_s
     assert_equal 'RDoc::AnyMethod: C2#b',  @c2_b.to_s

data/test/test_rdoc_normal_class.rb

@@ -15,8 +15,8 @@ class TestRDocNormalClass < XrefTestCase
 
   def test_ancestors_multilevel
     c1 = @top_level.add_class RDoc::NormalClass, 'Outer'
-    c2 = @top_level.add_class RDoc::NormalClass, 'Middle', c1
-    c3 = @top_level.add_class RDoc::NormalClass, 'Inner', c2
+    c2 = @top_level.add_class RDoc::NormalClass, 'Middle', c1.full_name
+    c3 = @top_level.add_class RDoc::NormalClass, 'Inner', c2.full_name
 
     assert_equal [c2, c1, 'Object'], c3.ancestors
   end
@@ -30,8 +30,8 @@ class TestRDocNormalClass < XrefTestCase
     incl = RDoc::Include.new 'Incl', ''
 
     c1 = @top_level.add_class RDoc::NormalClass, 'Outer'
-    c2 = @top_level.add_class RDoc::NormalClass, 'Middle', c1
-    c3 = @top_level.add_class RDoc::NormalClass, 'Inner', c2
+    c2 = @top_level.add_class RDoc::NormalClass, 'Middle', c1.full_name
+    c3 = @top_level.add_class RDoc::NormalClass, 'Inner', c2.full_name
     c3.add_include incl
 
     assert_equal [incl.name, c2], c3.direct_ancestors

data/test/test_rdoc_options.rb

@@ -67,6 +67,9 @@ class TestRDocOptions < RDoc::TestCase
       'exclude'              => [],
       'hyperlink_all'        => false,
       'line_numbers'         => false,
+      'locale'               => nil,
+      'locale_dir'           => 'locale',
+      'locale_name'          => nil,
       'main_page'            => nil,
       'markup'               => 'rdoc',
       'output_decoration'    => true,
@@ -334,6 +337,18 @@ rdoc_include:
                  e.message
   end
 
+  def test_parse_h
+    out, = capture_io do
+      begin
+        @options.parse %w[-h]
+      rescue SystemExit
+      end
+    end
+
+    assert_equal 1, out.scan(/HTML generator options:/).length
+    assert_equal 1, out.scan(/ri generator options:/).  length
+  end
+
   def test_parse_help
     out, = capture_io do
       begin
@@ -743,5 +758,9 @@ rdoc_include:
     assert out.include?(RDoc::VERSION)
   end
 
+  def test_visibility
+    @options.visibility = :all
+    assert_equal :private, @options.visibility
+  end
 end
 

data/test/test_rdoc_parser.rb

@@ -15,6 +15,19 @@ class TestRDocParser < RDoc::TestCase
     @options = RDoc::Options.new
   end
 
+  def test_class_binary_eh_ISO_2022_JP
+    iso_2022_jp = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.rd"
+
+    open iso_2022_jp, 'wb' do |io|
+      io.write "# coding: ISO-2022-JP\n"
+      io.write ":\e$B%3%^%s%I\e(B:\n"
+    end
+
+    refute @RP.binary? iso_2022_jp
+  ensure
+    File.unlink iso_2022_jp
+  end
+
   def test_class_binary_eh_marshal
     marshal = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.marshal"
     open marshal, 'wb' do |io|
@@ -96,7 +109,7 @@ class TestRDocParser < RDoc::TestCase
   def test_class_for_forbidden
     skip 'chmod not supported' if Gem.win_platform?
 
-    Tempfile.open 'forbidden' do |io|
+    tf = Tempfile.open 'forbidden' do |io|
       begin
         File.chmod 0000, io.path
         forbidden = @store.add_file io.path
@@ -107,7 +120,9 @@ class TestRDocParser < RDoc::TestCase
       ensure
         File.chmod 0400, io.path
       end
+      io
     end
+    tf.close! if tf.respond_to? :close!
   end
 
   def test_class_for_modeline

data/test/test_rdoc_parser_c.rb

@@ -58,7 +58,7 @@ class TestRDocParserC < RDoc::TestCase
   def teardown
     super
 
-    @tempfile.close
+    @tempfile.close!
   end
 
   def test_class_can_parse
@@ -1246,6 +1246,36 @@ Init_Foo(void) {
     assert_equal "a comment for Foo#bar", bar.comment.text
   end
 
+  def test_find_body_macro
+    content = <<-EOF
+/*
+ * a comment for other_function
+ */
+DLL_LOCAL VALUE
+other_function() {
+}
+
+void
+Init_Foo(void) {
+    VALUE foo = rb_define_class("Foo", rb_cObject);
+
+    rb_define_method(foo, "my_method", other_function, 0);
+}
+    EOF
+
+    klass = util_get_class content, 'foo'
+    other_function = klass.method_list.first
+
+    assert_equal 'my_method', other_function.name
+    assert_equal "a comment for other_function",
+                 other_function.comment.text
+    assert_equal '()', other_function.params
+
+    code = other_function.token_stream.first.text
+
+    assert_equal "DLL_LOCAL VALUE\nother_function() {\n}", code
+  end
+
   def test_find_modifiers_call_seq
     comment = RDoc::Comment.new <<-COMMENT
 call-seq: