rdoc 2.4.3 → 2.5

data/test/test_rdoc_normal_class.rb

@@ -0,0 +1,17 @@
+require 'test/xref_test_case'
+
+class TestRDocNormalClass < XrefTestCase
+
+  def test_ancestors_class
+    top_level = RDoc::TopLevel.new 'file.rb'
+    klass = top_level.add_class RDoc::NormalClass, 'Klass'
+    incl = RDoc::Include.new 'Incl', ''
+
+    sub_klass = klass.add_class RDoc::NormalClass, 'SubClass', 'Klass'
+    sub_klass.add_include incl
+
+    assert_equal [incl, klass], sub_klass.ancestors
+  end
+
+end
+

data/test/test_rdoc_normal_module.rb

@@ -8,14 +8,14 @@ class TestRDocNormalModule < XrefTestCase
     @mod = RDoc::NormalModule.new 'Mod'
   end
 
-  def test_comment_equals
-    @mod.comment = '# comment 1'
+  def test_ancestors_module
+    top_level = RDoc::TopLevel.new 'file.rb'
+    mod = top_level.add_module RDoc::NormalModule, 'Mod'
+    incl = RDoc::Include.new 'Incl', ''
 
-    assert_equal '# comment 1', @mod.comment
+    mod.add_include incl
 
-    @mod.comment = '# comment 2'
-
-    assert_equal "# comment 1\n# ---\n# comment 2", @mod.comment
+    assert_equal [incl], mod.ancestors
   end
 
   def test_module_eh

data/test/test_rdoc_options.rb

@@ -0,0 +1,41 @@
+require 'rubygems'
+require 'minitest/autorun'
+require 'rdoc/options'
+
+class TestRDocOptions < MiniTest::Unit::TestCase
+
+  def setup
+    @options = RDoc::Options.new
+  end
+
+  def test_parse_ignore_invalid
+    out, err = capture_io do
+      @options.parse %w[--ignore-invalid --bogus]
+    end
+
+    refute_match %r%^Usage: %, err
+    assert_match %r%^invalid option: --bogus%, err
+  end
+
+  def test_parse_ignore_invalid_default
+    out, err = capture_io do
+      @options.parse %w[--bogus]
+    end
+
+    refute_match %r%^Usage: %, err
+    assert_match %r%^invalid option: --bogus%, err
+  end
+
+  def test_parse_ignore_invalid_no
+    out, err = capture_io do
+      assert_raises SystemExit do
+        @options.parse %w[--no-ignore-invalid --bogus]
+      end
+    end
+
+    assert_match %r%^Usage: %, err
+    assert_match %r%^invalid option: --bogus%, err
+  end
+
+end
+

data/test/test_rdoc_parser.rb

@@ -1,29 +1,82 @@
 require 'rubygems'
-require 'minitest/unit'
+require 'minitest/autorun'
 require 'rdoc/parser'
 require 'rdoc/parser/ruby'
+require 'tmpdir'
 
 class TestRDocParser < MiniTest::Unit::TestCase
-  def test_can_parse
-    assert_equal(RDoc::Parser.can_parse(__FILE__), RDoc::Parser::Ruby)
 
-    readme_file_name = File.join(File.dirname(__FILE__), "..", "README.txt")
+  def setup
+    @RP = RDoc::Parser
+    @binary_dat = File.expand_path '../binary.dat', __FILE__
+  end
+
+  def test_class_binary_eh_erb
+    erb = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.erb"
+    open erb, 'wb' do |io|
+      io.write 'blah blah <%= stuff %> <% more stuff %>'
+    end
+
+    assert @RP.binary?(erb)
+
+    erb_rb = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.erb.rb"
+    open erb_rb, 'wb' do |io|
+      io.write 'blah blah <%= stuff %>'
+    end
+
+    refute @RP.binary?(erb_rb)
+  ensure
+    File.unlink erb
+    File.unlink erb_rb if erb_rb
+  end
+
+  def test_class_binary_eh_marshal
+    marshal = File.join Dir.tmpdir, "test_rdoc_parser_#{$$}.marshal"
+    open marshal, 'wb' do |io|
+      io.write Marshal.dump('')
+      io.write 'lots of text ' * 500
+    end
+
+    assert @RP.binary?(marshal)
+  ensure
+    File.unlink marshal
+  end
+
+  def test_class_can_parse
+    assert_equal @RP.can_parse(__FILE__), @RP::Ruby
+
+    readme_file_name = File.expand_path '../README.txt', __FILE__
 
     unless File.exist? readme_file_name then # HACK for tests in trunk :/
-      readme_file_name = File.join File.dirname(__FILE__), '..', '..', 'README'
+      readme_file_name = File.expand_path '../../README.txt', __FILE__
     end
 
-    assert_equal(RDoc::Parser.can_parse(readme_file_name), RDoc::Parser::Simple)
+    assert_equal @RP.can_parse(readme_file_name), @RP::Simple
 
-    binary_file_name = File.join(File.dirname(__FILE__), "binary.dat")
-    assert_equal(RDoc::Parser.can_parse(binary_file_name), nil)
+    assert_nil @RP.can_parse(@binary_dat)
+
+    jtest_file_name = File.expand_path '../test.ja.txt', __FILE__
+    assert_equal @RP::Simple, @RP.can_parse(jtest_file_name)
+
+    jtest_rdoc_file_name = File.expand_path '../test.ja.rdoc', __FILE__
+    assert_equal @RP::Simple, @RP.can_parse(jtest_rdoc_file_name)
+  end
 
-    jtest_file_name = File.join(File.dirname(__FILE__), "test.ja.txt")
-    assert_equal(RDoc::Parser::Simple, RDoc::Parser.can_parse(jtest_file_name))
+  ##
+  # Selenium hides a .jar file using a .txt extension.
 
-    jtest_rdoc_file_name = File.join(File.dirname(__FILE__), "test.ja.rdoc")
-    assert_equal(RDoc::Parser::Simple, RDoc::Parser.can_parse(jtest_rdoc_file_name))
+  def test_class_can_parse_zip
+    hidden_zip = File.expand_path '../hidden.zip.txt', __FILE__
+    assert_nil @RP.can_parse(hidden_zip)
   end
+
+  def test_class_for_binary
+    rp = @RP.dup
+
+    def rp.can_parse(*args) nil end
+
+    assert_nil @RP.for(nil, @binary_dat, nil, nil, nil)
+  end
+
 end
 
-MiniTest::Unit.autorun

data/test/test_rdoc_parser_c.rb

@@ -35,11 +35,25 @@ class TestRDocParserC < MiniTest::Unit::TestCase
 /* Document-class: Foo
  * this is the Foo boot class
  */
+VALUE cFoo = boot_defclass("Foo", rb_cObject);
+    EOF
+
+    klass = util_get_class content, 'cFoo'
+    assert_equal "this is the Foo boot class", klass.comment
+    assert_equal 'Object', klass.superclass
+  end
+
+  def test_do_classes_boot_class_nil
+    content = <<-EOF
+/* Document-class: Foo
+ * this is the Foo boot class
+ */
 VALUE cFoo = boot_defclass("Foo", 0);
     EOF
 
     klass = util_get_class content, 'cFoo'
-    assert_equal "   this is the Foo boot class\n   ", klass.comment
+    assert_equal "this is the Foo boot class", klass.comment
+    assert_equal nil, klass.superclass
   end
 
   def test_do_classes_class
@@ -51,7 +65,7 @@ VALUE cFoo = rb_define_class("Foo", rb_cObject);
     EOF
 
     klass = util_get_class content, 'cFoo'
-    assert_equal "   this is the Foo class\n   ", klass.comment
+    assert_equal "this is the Foo class", klass.comment
   end
 
   def test_do_classes_class_under
@@ -63,7 +77,7 @@ VALUE cFoo = rb_define_class_under(rb_mKernel, "Foo", rb_cObject);
     EOF
 
     klass = util_get_class content, 'cFoo'
-    assert_equal "   this is the Foo class under Kernel\n   ", klass.comment
+    assert_equal "this is the Foo class under Kernel", klass.comment
   end
 
   def test_do_classes_module
@@ -75,7 +89,7 @@ VALUE mFoo = rb_define_module("Foo");
     EOF
 
     klass = util_get_class content, 'mFoo'
-    assert_equal "   this is the Foo module\n   ", klass.comment
+    assert_equal "this is the Foo module", klass.comment
   end
 
   def test_do_classes_module_under
@@ -87,7 +101,7 @@ VALUE mFoo = rb_define_module_under(rb_mKernel, "Foo");
     EOF
 
     klass = util_get_class content, 'mFoo'
-    assert_equal "   this is the Foo module under Kernel\n   ", klass.comment
+    assert_equal "this is the Foo module under Kernel", klass.comment
   end
 
   def test_do_constants
@@ -103,7 +117,7 @@ void Init_foo(){
    /* Huzzah!: What you cheer when you roll a perfect game */
    rb_define_const(cFoo, "CHEER", rb_str_new2("Huzzah!"));
 
-   /* TEST\:TEST: Checking to see if escaped semicolon works */
+   /* TEST\:TEST: Checking to see if escaped colon works */
    rb_define_const(cFoo, "TEST", rb_str_new2("TEST:TEST"));
 
    /* \\: The file separator on MS Windows */
@@ -153,48 +167,35 @@ void Init_foo(){
 
     constants = constants.map { |c| [c.name, c.value, c.comment] }
 
-    assert_equal ['PERFECT', '300',
-                  "\n      The highest possible score in bowling   \n   "],
+    assert_equal ['PERFECT', '300', 'The highest possible score in bowling   '],
                  constants.shift
     assert_equal ['CHEER', 'Huzzah!',
-                  "\n      What you cheer when you roll a perfect game   \n   "],
+                  'What you cheer when you roll a perfect game   '],
                  constants.shift
     assert_equal ['TEST', 'TEST:TEST',
-                  "\n      Checking to see if escaped semicolon works   \n   "],
+                  'Checking to see if escaped colon works   '],
                  constants.shift
     assert_equal ['MSEPARATOR', '\\',
-                  "\n      The file separator on MS Windows   \n   "],
+                  'The file separator on MS Windows   '],
                  constants.shift
     assert_equal ['SEPARATOR', '/',
-                  "\n      The file separator on Unix   \n   "],
+                  'The file separator on Unix   '],
                  constants.shift
     assert_equal ['STUFF', 'C:\\Program Files\\Stuff',
-                  "\n      A directory on MS Windows   \n   "],
+                  'A directory on MS Windows   '],
                  constants.shift
     assert_equal ['NOSEMI', 'INT2FIX(99)',
-                  "\n      Default definition   \n   "],
+                  'Default definition   '],
                  constants.shift
-    assert_equal ['NOCOMMENT', 'rb_str_new2("No comment")', nil],
+    assert_equal ['NOCOMMENT', 'rb_str_new2("No comment")', ''],
                  constants.shift
 
     comment = <<-EOF.chomp
-
-     
-      Multiline comment goes here because this comment spans multiple lines.
-      Multiline comment goes here because this comment spans multiple lines.
-      
-   
-    EOF
-    assert_equal ['MULTILINE', 'INT2FIX(1)', comment], constants.shift
-    assert_equal ['MULTILINE_VALUE', '1', comment], constants.shift
-
-    comment = <<-EOF.chomp
-
-      Multiline comment goes here because this comment spans multiple lines.
-      Multiline comment goes here because this comment spans multiple lines.
-      
-   
+Multiline comment goes here because this comment spans multiple lines.
+Multiline comment goes here because this comment spans multiple lines.
     EOF
+    assert_equal ['MULTILINE',           'INT2FIX(1)', comment], constants.shift
+    assert_equal ['MULTILINE_VALUE',     '1',          comment], constants.shift
     assert_equal ['MULTILINE_NOT_EMPTY', 'INT2FIX(1)', comment], constants.shift
 
     assert constants.empty?, constants.inspect
@@ -213,7 +214,7 @@ Init_Foo(void) {
 
     klass = util_get_class content, 'foo'
 
-    assert_equal "  \n   a comment for class Foo\n   \n", klass.comment
+    assert_equal "a comment for class Foo", klass.comment
   end
 
   def test_find_class_comment_define_class
@@ -226,7 +227,7 @@ VALUE foo = rb_define_class("Foo", rb_cObject);
 
     klass = util_get_class content, 'foo'
 
-    assert_equal "  \n   a comment for class Foo\n   \n", klass.comment
+    assert_equal "a comment for class Foo", klass.comment
   end
 
   def test_find_class_comment_define_class_Init_Foo
@@ -245,7 +246,26 @@ Init_Foo(void) {
 
     klass = util_get_class content, 'foo'
 
-    assert_equal "  \n   a comment for class Foo on Init\n   \n", klass.comment
+    assert_equal "a comment for class Foo on Init", klass.comment
+  end
+
+  def test_find_class_comment_define_class_Init_Foo_no_void
+    content = <<-EOF
+/*
+ * a comment for class Foo on Init
+ */
+void
+Init_Foo() {
+    /*
+     * a comment for class Foo on rb_define_class
+     */
+    VALUE foo = rb_define_class("Foo", rb_cObject);
+}
+    EOF
+
+    klass = util_get_class content, 'foo'
+
+    assert_equal "a comment for class Foo on Init", klass.comment
   end
 
   def test_find_class_comment_define_class_bogus_comment
@@ -289,7 +309,7 @@ Init_Foo(void) {
     other_function = klass.method_list.first
 
     assert_equal 'my_method', other_function.name
-    assert_equal "  \n   a comment for other_function\n   \n",
+    assert_equal "a comment for other_function",
                  other_function.comment
     assert_equal '()', other_function.params
 
@@ -322,7 +342,7 @@ Init_Foo(void) {
     other_function = klass.method_list.first
 
     assert_equal 'my_method', other_function.name
-    assert_equal "  \n   a comment for other_function\n   \n     \n",
+    assert_equal "a comment for other_function",
                  other_function.comment
     assert_equal '()', other_function.params
 
@@ -331,6 +351,41 @@ Init_Foo(void) {
     assert_equal "#define other_function rb_other_function", code
   end
 
+  def test_find_body_document_method
+    content = <<-EOF
+/*
+ * Document-method: bar
+ * Document-method: baz
+ *
+ * a comment for bar
+ */
+VALUE
+bar() {
+}
+
+void
+Init_Foo(void) {
+    VALUE foo = rb_define_class("Foo", rb_cObject);
+
+    rb_define_method(foo, "bar", bar, 0);
+    rb_define_method(foo, "baz", bar, 0);
+}
+    EOF
+
+    klass = util_get_class content, 'foo'
+    assert_equal 2, klass.method_list.length
+
+    methods = klass.method_list.sort
+
+    bar = methods.first
+    assert_equal 'Foo#bar', bar.full_name
+    assert_equal "a comment for bar", bar.comment
+
+    baz = methods.last
+    assert_equal 'Foo#baz', baz.full_name
+    assert_equal "a comment for bar", bar.comment
+  end
+
   def test_define_method
     content = <<-EOF
 /*Method Comment! */
@@ -355,7 +410,7 @@ Init_IO(void) {
     klass = util_get_class content, 'rb_cIO'
     read_method = klass.method_list.first
     assert_equal "read", read_method.name
-    assert_equal "  Method Comment!   \n", read_method.comment
+    assert_equal "Method Comment!   ", read_method.comment
   end
 
   def test_define_method_private
@@ -383,7 +438,7 @@ Init_IO(void) {
     read_method = klass.method_list.first
     assert_equal 'IO#read', read_method.full_name
     assert_equal :private, read_method.visibility
-    assert_equal "  Method Comment!   \n", read_method.comment
+    assert_equal "Method Comment!   ", read_method.comment
   end
 
   def util_get_class(content, name)

data/test/test_rdoc_parser_perl.rb

@@ -1,7 +1,7 @@
 require 'stringio'
 require 'tempfile'
 require 'rubygems'
-require 'minitest/unit'
+require 'minitest/autorun'
 require 'rdoc/options'
 require 'rdoc/parser/perl'
 
@@ -55,7 +55,7 @@ This just contains plain old documentation
 =end
     EOF
     comment = util_get_comment content
-    assert_equal "\nThis just contains plain old documentation\n\n", comment
+    assert_equal 'This just contains plain old documentation', comment
   end
 
   # Get the comment of the @top_level when it has processed the input.
@@ -71,4 +71,3 @@ This just contains plain old documentation
 
 end
 
-MiniTest::Unit.autorun