rdoc 3.9.5 → 3.10.pre.1

data/test/test_rdoc_rubygems_hook.rb

@@ -1,11 +1,12 @@
-require 'rubygems/test_case'
 require 'rubygems'
+require 'rubygems/test_case'
 require 'rdoc/rubygems_hook'
 
 class TestRDocRubygemsHook < Gem::TestCase
 
   def setup
     super
+
     skip 'requires RubyGems 1.9+' unless
       Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.9')
 

data/test/test_rdoc_stats.rb

@@ -1,26 +1,23 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc/stats'
-require 'rdoc/code_objects'
-require 'rdoc/markup'
-require 'rdoc/parser'
+require 'rdoc/test_case'
 
-class TestRDocStats < MiniTest::Unit::TestCase
+class TestRDocStats < RDoc::TestCase
 
   def setup
-    RDoc::TopLevel.reset
+    super
 
     @s = RDoc::Stats.new 0
+
+    @tl = RDoc::TopLevel.new 'file.rb'
+    @tl.parser = RDoc::Parser::Ruby
   end
 
   def test_report_attr
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     a = RDoc::Attr.new nil, 'a', 'RW', nil
-    a.record_location tl
+    a.record_location @tl
     c.add_attribute a
 
     RDoc::TopLevel.complete :public
@@ -40,13 +37,12 @@ end
   end
 
   def test_report_attr_documented
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     a = RDoc::Attr.new nil, 'a', 'RW', 'a'
-    a.record_location tl
+    a.record_location @tl
     c.add_attribute a
 
     RDoc::TopLevel.complete :public
@@ -57,13 +53,12 @@ end
   end
 
   def test_report_constant
-    tl = RDoc::TopLevel.new 'file.rb'
-    m = tl.add_module RDoc::NormalModule, 'M'
-    m.record_location tl
-    m.add_comment 'M', tl
+    m = @tl.add_module RDoc::NormalModule, 'M'
+    m.record_location @tl
+    m.add_comment 'M', @tl
 
     c = RDoc::Constant.new 'C', nil, nil
-    c.record_location tl
+    c.record_location @tl
     m.add_constant c
 
     RDoc::TopLevel.complete :public
@@ -84,16 +79,15 @@ end
   end
 
   def test_report_constant_alias
-    tl = RDoc::TopLevel.new 'file.rb'
-    mod = tl.add_module RDoc::NormalModule, 'M'
+    mod = @tl.add_module RDoc::NormalModule, 'M'
 
-    c = tl.add_class RDoc::NormalClass, 'C'
+    c = @tl.add_class RDoc::NormalClass, 'C'
     mod.add_constant c
 
     ca = RDoc::Constant.new 'CA', nil, nil
     ca.is_alias_for = c
 
-    tl.add_constant ca
+    @tl.add_constant ca
 
     RDoc::TopLevel.complete :public
 
@@ -105,13 +99,12 @@ end
   end
 
   def test_report_constant_documented
-    tl = RDoc::TopLevel.new 'file.rb'
-    m = tl.add_module RDoc::NormalModule, 'M'
-    m.record_location tl
+    m = @tl.add_module RDoc::NormalModule, 'M'
+    m.record_location @tl
     m.comment = 'M'
 
     c = RDoc::Constant.new 'C', nil, 'C'
-    c.record_location tl
+    c.record_location @tl
     m.add_constant c
 
     RDoc::TopLevel.complete :public
@@ -122,12 +115,11 @@ end
   end
 
   def test_report_class
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
 
     m = RDoc::AnyMethod.new nil, 'm'
-    m.record_location tl
+    m.record_location @tl
     c.add_method m
     m.comment = 'm'
 
@@ -149,13 +141,12 @@ end
   end
 
   def test_report_class_documented
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     m = RDoc::AnyMethod.new nil, 'm'
-    m.record_location tl
+    m.record_location @tl
     c.add_method m
     m.comment = 'm'
 
@@ -167,21 +158,20 @@ end
   end
 
   def test_report_class_documented_level_1
-    tl = RDoc::TopLevel.new 'file.rb'
-    c1 = tl.add_class RDoc::NormalClass, 'C1'
-    c1.record_location tl
-    c1.add_comment 'C1', tl
+    c1 = @tl.add_class RDoc::NormalClass, 'C1'
+    c1.record_location @tl
+    c1.add_comment 'C1', @tl
 
     m1 = RDoc::AnyMethod.new nil, 'm1'
-    m1.record_location tl
+    m1.record_location @tl
     c1.add_method m1
     m1.comment = 'm1'
 
-    c2 = tl.add_class RDoc::NormalClass, 'C2'
-    c2.record_location tl
+    c2 = @tl.add_class RDoc::NormalClass, 'C2'
+    c2.record_location @tl
 
     m2 = RDoc::AnyMethod.new nil, 'm2'
-    m2.record_location tl
+    m2.record_location @tl
     c2.add_method m2
     m2.comment = 'm2'
 
@@ -206,8 +196,7 @@ end
   end
 
   def test_report_class_empty
-    tl = RDoc::TopLevel.new 'file.rb'
-    tl.add_class RDoc::NormalClass, 'C'
+    @tl.add_class RDoc::NormalClass, 'C'
 
     RDoc::TopLevel.complete :public
 
@@ -225,13 +214,12 @@ The following items are not documented:
   end
 
   def test_report_class_empty_2
-    tl = RDoc::TopLevel.new 'file.rb'
-    c1 = tl.add_class RDoc::NormalClass, 'C1'
-    c1.record_location tl
+    c1 = @tl.add_class RDoc::NormalClass, 'C1'
+    c1.record_location @tl
 
-    c2 = tl.add_class RDoc::NormalClass, 'C2'
-    c2.record_location tl
-    c2.add_comment 'C2', tl
+    c2 = @tl.add_class RDoc::NormalClass, 'C2'
+    c2.record_location @tl
+    c2.add_comment 'C2', @tl
 
     RDoc::TopLevel.complete :public
 
@@ -253,12 +241,11 @@ end
   end
 
   def test_report_class_method_documented
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
 
     m = RDoc::AnyMethod.new nil, 'm'
-    m.record_location tl
+    m.record_location @tl
     c.add_method m
     m.comment = 'm'
 
@@ -288,17 +275,16 @@ end
   end
 
   def test_report_method
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     m1 = RDoc::AnyMethod.new nil, 'm1'
-    m1.record_location tl
+    m1.record_location @tl
     c.add_method m1
 
     m2 = RDoc::AnyMethod.new nil, 'm2'
-    m2.record_location tl
+    m2.record_location @tl
     c.add_method m2
     m2.comment = 'm2'
 
@@ -321,13 +307,12 @@ end
   end
 
   def test_report_method_documented
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     m = RDoc::AnyMethod.new nil, 'm'
-    m.record_location tl
+    m.record_location @tl
     c.add_method m
     m.comment = 'm'
 
@@ -339,19 +324,18 @@ end
   end
 
   def test_report_method_parameters
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     m1 = RDoc::AnyMethod.new nil, 'm1'
-    m1.record_location tl
+    m1.record_location @tl
     m1.params = '(p1, p2)'
     m1.comment = 'Stuff with +p1+'
     c.add_method m1
 
     m2 = RDoc::AnyMethod.new nil, 'm2'
-    m2.record_location tl
+    m2.record_location @tl
     c.add_method m2
     m2.comment = 'm2'
 
@@ -376,13 +360,13 @@ end
   end
 
   def test_report_method_parameters_documented
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    @tl.parser = RDoc::Parser::Ruby
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     m = RDoc::AnyMethod.new nil, 'm'
-    m.record_location tl
+    m.record_location @tl
     m.params = '(p1)'
     m.comment = 'Stuff with +p1+'
     c.add_method m
@@ -396,13 +380,12 @@ end
   end
 
   def test_report_method_parameters_yield
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     m = RDoc::AnyMethod.new nil, 'm'
-    m.record_location tl
+    m.record_location @tl
     m.call_seq = <<-SEQ
 m(a) { |c| ... }
 m(a, b) { |c, d| ... }
@@ -431,23 +414,22 @@ end
   end
 
   def test_summary
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
 
-    m = tl.add_module RDoc::NormalModule, 'M'
-    m.record_location tl
+    m = @tl.add_module RDoc::NormalModule, 'M'
+    m.record_location @tl
 
     a = RDoc::Attr.new nil, 'a', 'RW', nil
-    a.record_location tl
+    a.record_location @tl
     c.add_attribute a
 
     c_c = RDoc::Constant.new 'C', nil, nil
-    c_c.record_location tl
+    c_c.record_location @tl
     c.add_constant c_c
 
     m = RDoc::AnyMethod.new nil, 'm'
-    m.record_location tl
+    m.record_location @tl
     c.add_method m
 
     RDoc::TopLevel.complete :public
@@ -473,9 +455,8 @@ Total:      5 (5 undocumented)
   end
 
   def test_summary_level_false
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
 
     RDoc::TopLevel.complete :public
 
@@ -502,13 +483,12 @@ Total:      1 (1 undocumented)
   end
 
   def test_summary_level_1
-    tl = RDoc::TopLevel.new 'file.rb'
-    c = tl.add_class RDoc::NormalClass, 'C'
-    c.record_location tl
-    c.add_comment 'C', tl
+    c = @tl.add_class RDoc::NormalClass, 'C'
+    c.record_location @tl
+    c.add_comment 'C', @tl
 
     m = RDoc::AnyMethod.new nil, 'm'
-    m.record_location tl
+    m.record_location @tl
     m.params = '(p1, p2)'
     m.comment = 'Stuff with +p1+'
     c.add_method m

data/test/test_rdoc_task.rb

@@ -1,10 +1,11 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc/task'
+require 'rdoc/test_case'
+require 'rake'
 
-class TestRDocTask < MiniTest::Unit::TestCase
+class TestRDocTask < RDoc::TestCase
 
   def setup
+    super
+
     Rake::Task.clear
 
     @t = RDoc::Task.new

data/test/test_rdoc_text.rb

@@ -1,16 +1,17 @@
 # coding: utf-8
 
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc'
-require 'rdoc/text'
-require 'rdoc/markup'
-require 'rdoc/markup/formatter'
+require 'rdoc/test_case'
 
-class TestRDocText < MiniTest::Unit::TestCase
+class TestRDocText < RDoc::TestCase
 
   include RDoc::Text
 
+  def setup
+    super
+
+    @top_level = RDoc::TopLevel.new 'file.rb'
+  end
+
   def test_self_encode_fallback
     skip "Encoding not implemented" unless Object.const_defined? :Encoding
 
@@ -110,13 +111,19 @@ The comments associated with
     assert_equal Encoding::US_ASCII, result.encoding
   end
 
-  def test_markup
-    def formatter() RDoc::Markup::ToHtml.new end
+  def test_markup_string
+    out = markup('hi').gsub("\n", '')
+
+    assert_equal '<p>hi</p>', out
+  end
+
+  def test_markup_comment
+    out = markup(comment('hi')).gsub("\n", '')
 
-    assert_equal "<p>hi</p>", markup('hi').gsub("\n", '')
+    assert_equal '<p>hi</p>', out
   end
 
-  def test_normalize_comment
+  def test_normalize_comment_hash
     text = <<-TEXT
 ##
 # we don't worry too much.
@@ -127,6 +134,42 @@ The comments associated with
     expected = <<-EXPECTED.rstrip
 we don't worry too much.
 
+The comments associated with
+    EXPECTED
+
+    assert_equal expected, normalize_comment(text)
+  end
+
+  def test_normalize_comment_stars_single_space
+    text = <<-TEXT
+/*
+ * we don't worry too much.
+ * 
+ * The comments associated with
+ */
+    TEXT
+
+    expected = <<-EXPECTED.rstrip
+we don't worry too much.
+
+The comments associated with
+    EXPECTED
+
+    assert_equal expected, normalize_comment(text)
+  end
+
+  def test_normalize_comment_stars_single_double_space
+    text = <<-TEXT
+/*
+ *  we don't worry too much.
+ *  
+ *  The comments associated with
+ */
+    TEXT
+
+    expected = <<-EXPECTED.rstrip
+we don't worry too much.
+
 The comments associated with
     EXPECTED
 
@@ -137,6 +180,17 @@ The comments associated with
     assert_kind_of RDoc::Markup::Document, parse('hi')
   end
 
+  def test_parse_comment
+    expected = RDoc::Markup::Document.new
+    expected.file = @top_level
+
+    c = comment ''
+    parsed = parse c
+
+    assert_equal expected, parsed
+    assert_same parsed, parse(c)
+  end
+
   def test_parse_document
     assert_equal RDoc::Markup::Document.new, parse(RDoc::Markup::Document.new)
   end
@@ -149,10 +203,79 @@ The comments associated with
     assert_equal RDoc::Markup::Document.new, parse("#\n")
   end
 
+  def test_parse_format_rd
+    expected =
+      @RM::Document.new(
+        @RM::Paragraph.new('it <em>works</em>'))
+
+    parsed = parse 'it ((*works*))', 'rd'
+
+    assert_equal expected, parsed
+  end
+
+  def test_parse_format_tomdoc
+    expected =
+      @RM::Document.new(
+        @RM::Paragraph.new('It does a thing'),
+        @RM::BlankLine.new,
+        @RM::Heading.new(3, 'Examples'),
+        @RM::BlankLine.new,
+        @RM::Verbatim.new("1 + 1"))
+
+    text = <<-TOMDOC
+It does a thing
+
+Examples
+
+  1 + 1
+    TOMDOC
+
+    parsed = parse text, 'tomdoc'
+
+    assert_equal expected, parsed
+  end
+
   def test_parse_newline
     assert_equal RDoc::Markup::Document.new, parse("\n")
   end
 
+#  def test_snippet
+#    text = <<-TEXT
+#This is one-hundred characters or more of text in a single paragraph.  This
+#paragraph will be cut off some point after the one-hundredth character.
+#    TEXT
+#
+#    expected = text.gsub(/\r?\n/, ' ').sub(/ some point.*/, '')
+#
+#    assert_equal expected, snippet(text)
+#  end
+#
+#  def test_snippet_comment
+#    c = comment 'This is a comment'
+#
+#    assert_equal 'This is a comment', snippet(c)
+#  end
+#
+#  def test_snippet_no_space
+#    text = <<-TEXT.strip
+#This is one-hundred characters or more of text in a single paragraph.  This
+#paragraph will not be cut
+#    TEXT
+#
+#    expected = <<-EXPECTED.strip.gsub(/\r?\n/, ' ')
+#This is one-hundred characters or more of text in a single paragraph.  This
+#paragraph will not be cut
+#    EXPECTED
+#
+#    assert_equal expected, snippet(text)
+#  end
+#
+#  def test_snippet_short
+#    text = 'This is a comment'
+#
+#    assert_equal text.dup, snippet(text)
+#  end
+
   def test_strip_hashes
     text = <<-TEXT
 ##
@@ -309,6 +432,24 @@ The comments associated with
     assert_equal Encoding::BINARY, result.encoding
   end
 
+  def test_strip_stars_no_stars
+    text = <<-TEXT
+* we don't worry too much.
+
+The comments associated with
+
+    TEXT
+
+    expected = <<-EXPECTED
+* we don't worry too much.
+
+The comments associated with
+
+    EXPECTED
+
+    assert_equal expected, strip_stars(text)
+  end
+
   def test_to_html_apostrophe
     assert_equal '‘a', to_html("'a")
     assert_equal 'a’', to_html("a'")
@@ -393,5 +534,9 @@ The comments associated with
     assert_equal "mismatched <tt> tag\n", err
   end
 
+  def formatter()
+    RDoc::Markup::ToHtml.new
+  end
+
 end