rdoc 3.9.5 → 3.10.pre.1

data/lib/rdoc/top_level.rb

@@ -1,5 +1,3 @@
-require 'rdoc/context'
-
 ##
 # A TopLevel context is a representation of the contents of a single file
 
@@ -118,7 +116,7 @@ class RDoc::TopLevel < RDoc::Context
     @all_files_hash.each_key do |file_name|
       tl = @all_files_hash[file_name]
 
-      unless RDoc::Parser::Simple === tl.parser then
+      unless tl.text? then
         tl.modules_hash.clear
         tl.classes_hash.clear
 
@@ -313,7 +311,7 @@ class RDoc::TopLevel < RDoc::Context
   # An RDoc::TopLevel is equal to another with the same absolute_name
 
   def == other
-    other.class === self and @absolute_name == other.absolute_name
+    self.class === other and @absolute_name == other.absolute_name
   end
 
   alias eql? ==
@@ -448,6 +446,16 @@ class RDoc::TopLevel < RDoc::Context
     end
   end
 
+  ##
+  # Base name of this file without the extension
+
+  def page_name
+    basename = File.basename @absolute_name
+    basename =~ /\.[^.]*$/
+
+    $` || basename
+  end
+
   ##
   # Path to this file
 
@@ -466,6 +474,30 @@ class RDoc::TopLevel < RDoc::Context
     end
   end
 
+  ##
+  # Search record used by RDoc::Generator::JsonIndex
+
+  def search_record
+    return unless @parser < RDoc::Parser::Text
+
+    [
+      page_name,
+      '',
+      page_name,
+      '',
+      path,
+      '',
+      snippet(@comment),
+    ]
+  end
+
+  ##
+  # Is this TopLevel from a text file instead of a source code file?
+
+  def text?
+    @parser.ancestors.include? RDoc::Parser::Text
+  end
+
   def to_s # :nodoc:
     "file #{full_name}"
   end

data/test/test_attribute_manager.rb

@@ -1,27 +1,24 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc'
-require 'rdoc/markup'
-require 'rdoc/markup/formatter'
-require 'rdoc/markup/attribute_manager'
+require 'rdoc/test_case'
 
-class TestAttributeManager < MiniTest::Unit::TestCase # HACK fix test name
+class TestAttributeManager < RDoc::TestCase # HACK fix test name
 
   def setup
+    super
+
     @am = RDoc::Markup::AttributeManager.new
     @klass = RDoc::Markup::AttributeManager
     @formatter = RDoc::Markup::Formatter.new
     @formatter.add_tag :BOLD, '<B>', '</B>'
     @formatter.add_tag :EM, '<EM>', '</EM>'
-    @formatter.add_tag :TT, '<TT>', '</TT>'
+    @formatter.add_tag :TT, '<CODE>', '</CODE>'
   end
 
   def test_convert_attrs_ignores_code
-    assert_equal 'foo <TT>__send__</TT> bar', output('foo <code>__send__</code> bar')
+    assert_equal 'foo <CODE>__send__</CODE> bar', output('foo <code>__send__</code> bar')
   end
 
   def test_convert_attrs_ignores_tt
-    assert_equal 'foo <TT>__send__</TT> bar', output('foo <tt>__send__</tt> bar')
+    assert_equal 'foo <CODE>__send__</CODE> bar', output('foo <tt>__send__</tt> bar')
   end
 
   def test_convert_attrs_preserves_double
@@ -30,7 +27,7 @@ class TestAttributeManager < MiniTest::Unit::TestCase # HACK fix test name
   end
 
   def test_convert_attrs_does_not_ignore_after_tt
-    assert_equal 'the <TT>IF:</TT><EM>key</EM> directive', output('the <tt>IF:</tt>_key_ directive')
+    assert_equal 'the <CODE>IF:</CODE><EM>key</EM> directive', output('the <tt>IF:</tt>_key_ directive')
   end
 
   def test_initial_word_pairs
@@ -80,31 +77,31 @@ class TestAttributeManager < MiniTest::Unit::TestCase # HACK fix test name
   end
 
   def test_escapes
-    assert_equal '<TT>text</TT>',   output('<tt>text</tt>')
-    assert_equal '<tt>text</tt>',   output('\\<tt>text</tt>')
-    assert_equal '<tt>',            output('\\<tt>')
-    assert_equal '<TT><tt></TT>',   output('<tt>\\<tt></tt>')
-    assert_equal '<TT>\\<tt></TT>', output('<tt>\\\\<tt></tt>')
-    assert_equal '<B>text</B>',     output('*text*')
-    assert_equal '*text*',          output('\\*text*')
-    assert_equal '\\',              output('\\')
-    assert_equal '\\text',          output('\\text')
-    assert_equal '\\\\text',        output('\\\\text')
-    assert_equal 'text \\ text',    output('text \\ text')
-
-    assert_equal 'and <TT>\\s</TT> matches space',
+    assert_equal '<CODE>text</CODE>',   output('<tt>text</tt>')
+    assert_equal '<tt>text</tt>',       output('\\<tt>text</tt>')
+    assert_equal '<tt>',                output('\\<tt>')
+    assert_equal '<CODE><tt></CODE>',   output('<tt>\\<tt></tt>')
+    assert_equal '<CODE>\\<tt></CODE>', output('<tt>\\\\<tt></tt>')
+    assert_equal '<B>text</B>',         output('*text*')
+    assert_equal '*text*',              output('\\*text*')
+    assert_equal '\\',                  output('\\')
+    assert_equal '\\text',              output('\\text')
+    assert_equal '\\\\text',            output('\\\\text')
+    assert_equal 'text \\ text',        output('text \\ text')
+
+    assert_equal 'and <CODE>\\s</CODE> matches space',
                  output('and <tt>\\s</tt> matches space')
-    assert_equal 'use <TT><tt>text</TT></tt> for code',
+    assert_equal 'use <CODE><tt>text</CODE></tt> for code',
                  output('use <tt>\\<tt>text</tt></tt> for code')
-    assert_equal 'use <TT><tt>text</tt></TT> for code',
+    assert_equal 'use <CODE><tt>text</tt></CODE> for code',
                  output('use <tt>\\<tt>text\\</tt></tt> for code')
     assert_equal 'use <tt><tt>text</tt></tt> for code',
                  output('use \\<tt>\\<tt>text</tt></tt> for code')
-    assert_equal 'use <tt><TT>text</TT></tt> for code',
+    assert_equal 'use <tt><CODE>text</CODE></tt> for code',
                  output('use \\<tt><tt>text</tt></tt> for code')
-    assert_equal 'use <TT>+text+</TT> for code',
+    assert_equal 'use <CODE>+text+</CODE> for code',
                  output('use <tt>\\+text+</tt> for code')
-    assert_equal 'use <tt><TT>text</TT></tt> for code',
+    assert_equal 'use <tt><CODE>text</CODE></tt> for code',
                  output('use \\<tt>+text+</tt> for code')
     assert_equal 'illegal <tag>not</tag> changed',
                  output('illegal <tag>not</tag> changed')

data/test/test_rdoc_any_method.rb

@@ -1,8 +1,6 @@
 require File.expand_path '../xref_test_case', __FILE__
-require 'rdoc/code_objects'
-require 'rdoc/generator/markup'
 
-class RDocAnyMethodTest < XrefTestCase
+class TestRDocAnyMethod < XrefTestCase
 
   def test_aref
     m = RDoc::AnyMethod.new nil, 'method?'
@@ -47,34 +45,12 @@ method(a, b) { |c, d| ... }
   def test_markup_code
     tokens = [
       RDoc::RubyToken::TkCONSTANT. new(0, 0, 0, 'CONSTANT'),
-      RDoc::RubyToken::TkDEF.       new(0, 0, 0, 'KW'),
-      RDoc::RubyToken::TkIVAR.     new(0, 0, 0, 'IVAR'),
-      RDoc::RubyToken::TkOp.       new(0, 0, 0, 'Op'),
-      RDoc::RubyToken::TkId.       new(0, 0, 0, 'Id'),
-      RDoc::RubyToken::TkNode.     new(0, 0, 0, 'Node'),
-      RDoc::RubyToken::TkCOMMENT.  new(0, 0, 0, 'COMMENT'),
-      RDoc::RubyToken::TkREGEXP.   new(0, 0, 0, 'REGEXP'),
-      RDoc::RubyToken::TkSTRING.   new(0, 0, 0, 'STRING'),
-      RDoc::RubyToken::TkVal.      new(0, 0, 0, 'Val'),
-      RDoc::RubyToken::TkBACKSLASH.new(0, 0, 0, '\\'),
     ]
 
     @c2_a.collect_tokens
     @c2_a.add_tokens(*tokens)
 
-    expected = [
-      '<span class="ruby-constant">CONSTANT</span>',
-      '<span class="ruby-keyword">KW</span>',
-      '<span class="ruby-ivar">IVAR</span>',
-      '<span class="ruby-operator">Op</span>',
-      '<span class="ruby-identifier">Id</span>',
-      '<span class="ruby-node">Node</span>',
-      '<span class="ruby-comment">COMMENT</span>',
-      '<span class="ruby-regexp">REGEXP</span>',
-      '<span class="ruby-string">STRING</span>',
-      '<span class="ruby-value">Val</span>',
-      '\\'
-    ].join
+    expected = '<span class="ruby-constant">CONSTANT</span>'
 
     assert_equal expected, @c2_a.markup_code
   end

data/test/test_rdoc_attr.rb

@@ -1,10 +1,10 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc/rdoc'
+require 'rdoc/test_case'
 
-class TestRDocAttr < MiniTest::Unit::TestCase
+class TestRDocAttr < RDoc::TestCase
 
   def setup
+    super
+
     @a = RDoc::Attr.new nil, 'attr', 'RW', ''
   end
 

data/test/test_rdoc_class_module.rb

@@ -1,14 +1,7 @@
-require 'pp'
 require File.expand_path '../xref_test_case', __FILE__
 
 class TestRDocClassModule < XrefTestCase
 
-  def setup
-    super
-
-    @RM = RDoc::Markup
-  end
-
   def mu_pp obj
     s = ''
     s = PP.pp obj, s
@@ -40,6 +33,14 @@ class TestRDocClassModule < XrefTestCase
     assert_equal "comment 1\n---\ncomment 2\n---\n* comment 3", cm.comment
   end
 
+  def test_add_comment_comment
+    cm = RDoc::ClassModule.new 'Klass'
+
+    cm.add_comment comment('comment'), @top_level
+
+    assert_equal 'comment', cm.comment.text
+  end
+
   def test_add_comment_stopdoc
     tl = RDoc::TopLevel.new 'file.rb'
 
@@ -70,6 +71,30 @@ class TestRDocClassModule < XrefTestCase
     assert_equal "comment 1\n---\ncomment 2\n---\n* comment 3", cm.comment
   end
 
+  def test_comment_equals_comment
+    cm = RDoc::ClassModule.new 'Klass'
+
+    cm.comment = comment 'comment'
+
+    assert_equal 'comment', cm.comment.text
+  end
+
+  def test_docuent_self_or_methods
+    assert @c1.document_self_or_methods
+
+    @c1.document_self = false
+
+    assert @c1.document_self_or_methods
+
+    @c1_m.document_self = false
+
+    assert @c1.document_self_or_methods
+
+    @c1__m.document_self = false
+
+    refute @c1.document_self_or_methods
+  end
+
   def test_each_ancestor
     ancestors = []
 
@@ -133,7 +158,7 @@ class TestRDocClassModule < XrefTestCase
 
     inner = RDoc::Markup::Document.new(
       RDoc::Markup::Paragraph.new('this is a comment'))
-    inner.file = tl.absolute_name
+    inner.file = tl
 
     comment = RDoc::Markup::Document.new inner
 
@@ -550,15 +575,40 @@ class TestRDocClassModule < XrefTestCase
     cm.add_comment 'comment 2', tl2
 
     doc1 = @RM::Document.new @RM::Paragraph.new 'comment 1'
-    doc1.file = tl1.absolute_name
+    doc1.file = tl1
     doc2 = @RM::Document.new @RM::Paragraph.new 'comment 2'
-    doc2.file = tl2.absolute_name
+    doc2.file = tl2
 
     expected = @RM::Document.new doc1, doc2
 
     assert_equal expected, cm.parse(cm.comment_location)
   end
 
+  def test_parse_comment
+    tl1 = RDoc::TopLevel.new 'one.rb'
+
+    cm = RDoc::ClassModule.new 'Klass'
+    cm.comment = comment 'comment 1', tl1
+
+    doc = @RM::Document.new @RM::Paragraph.new 'comment 1'
+    doc.file = tl1
+
+    assert_equal doc, cm.parse(cm.comment)
+  end
+
+  def test_parse_comment_format
+    tl1 = RDoc::TopLevel.new 'one.rb'
+
+    cm = RDoc::ClassModule.new 'Klass'
+    cm.comment = comment 'comment ((*1*))', tl1
+    cm.comment.format = 'rd'
+
+    doc = @RM::Document.new @RM::Paragraph.new 'comment <em>1</em>'
+    doc.file = tl1
+
+    assert_equal doc, cm.parse(cm.comment)
+  end
+
   def test_parse_comment_location
     tl1 = RDoc::TopLevel.new 'one.rb'
     tl2 = RDoc::TopLevel.new 'two.rb'
@@ -570,9 +620,9 @@ class TestRDocClassModule < XrefTestCase
     cm = Marshal.load Marshal.dump cm
 
     doc1 = @RM::Document.new @RM::Paragraph.new 'comment 1'
-    doc1.file = tl1.absolute_name
+    doc1.file = tl1
     doc2 = @RM::Document.new @RM::Paragraph.new 'comment 2'
-    doc2.file = tl2.absolute_name
+    doc2.file = tl2
 
     assert_same cm.comment_location, cm.parse(cm.comment_location)
   end
@@ -591,6 +641,39 @@ class TestRDocClassModule < XrefTestCase
     assert_equal %w[D], parent.classes_hash.keys
   end
 
+  def test_search_record
+    @c2_c3.add_comment 'This is a comment.', @xref_data
+
+    expected = [
+      'C3',
+      'C2::C3',
+      'C2::C3',
+      '',
+      'C2/C3.html',
+      '',
+      "<p>This is a comment.\n"
+    ]
+
+    assert_equal expected, @c2_c3.search_record
+  end
+
+  def test_search_record_merged
+    @c2_c3.add_comment 'comment A', RDoc::TopLevel.new('a.rb')
+    @c2_c3.add_comment 'comment B', RDoc::TopLevel.new('b.rb')
+
+    expected = [
+      'C3',
+      'C2::C3',
+      'C2::C3',
+      '',
+      'C2/C3.html',
+      '',
+      "<p>comment A\n<p>comment B\n"
+    ]
+
+    assert_equal expected, @c2_c3.search_record
+  end
+
   def test_superclass
     assert_equal @c3_h1, @c3_h2.superclass
   end

data/test/test_rdoc_code_object.rb

@@ -1,9 +1,6 @@
 # coding: US-ASCII
 
-require 'rubygems'
-require 'minitest/autorun'
 require File.expand_path '../xref_test_case', __FILE__
-require 'rdoc/code_object'
 
 class TestRDocCodeObject < XrefTestCase
 
@@ -32,6 +29,16 @@ class TestRDocCodeObject < XrefTestCase
     assert_equal 'I am a comment', @co.comment
   end
 
+  def test_comment_equals_comment
+    @co.comment = comment ''
+
+    assert_equal '', @co.comment.text
+
+    @co.comment = comment 'I am a comment'
+
+    assert_equal 'I am a comment', @co.comment.text
+  end
+
   def test_comment_equals_document
     doc = RDoc::Markup::Document.new
     @co.comment = doc

data/test/test_rdoc_comment.rb

@@ -0,0 +1,504 @@
+# coding: us-ascii
+
+require 'rdoc/test_case'
+
+class TestRDocComment < RDoc::TestCase
+
+  def setup
+    super
+
+    @top_level = RDoc::TopLevel.new 'file.rb'
+    @comment = RDoc::Comment.new
+    @comment.location = @top_level
+    @comment.text = 'this is a comment'
+  end
+
+  def test_empty_eh
+    refute_empty @comment
+
+    @comment = ''
+
+    assert_empty @comment
+  end
+
+  def test_equals2
+    assert_equal @comment, @comment.dup
+
+    c2 = @comment.dup
+    c2.text = nil
+
+    refute_equal @comment, c2
+
+    c3 = @comment.dup
+    c3.location = nil
+
+    refute_equal @comment, c3
+  end
+
+  def test_extract_call_seq
+    m = RDoc::AnyMethod.new nil, 'm'
+
+    comment = RDoc::Comment.new <<-COMMENT, @top_level
+call-seq:
+  bla => true or false
+
+moar comment
+    COMMENT
+
+    comment.extract_call_seq m
+
+    assert_equal "bla => true or false\n", m.call_seq
+  end
+
+  def test_extract_call_seq_blank
+    m = RDoc::AnyMethod.new nil, 'm'
+
+    comment = RDoc::Comment.new <<-COMMENT, @top_level
+call-seq:
+  bla => true or false
+
+    COMMENT
+
+    comment.extract_call_seq m
+
+    assert_equal "bla => true or false\n", m.call_seq
+  end
+
+  def test_extract_call_seq_commented
+    m = RDoc::AnyMethod.new nil, 'm'
+
+    comment = RDoc::Comment.new <<-COMMENT, @top_level
+# call-seq:
+#   bla => true or false
+# 
+# moar comment
+    COMMENT
+
+    comment.extract_call_seq m
+
+    assert_equal nil, m.call_seq
+  end
+
+  def test_extract_call_seq_no_blank
+    m = RDoc::AnyMethod.new nil, 'm'
+
+    comment = RDoc::Comment.new <<-COMMENT, @top_level
+call-seq:
+  bla => true or false
+    COMMENT
+
+    comment.extract_call_seq m
+
+    assert_equal "bla => true or false\n", m.call_seq
+  end
+
+  def test_extract_call_seq_undent
+    m = RDoc::AnyMethod.new nil, 'm'
+
+    comment = RDoc::Comment.new <<-COMMENT, @top_level
+call-seq:
+  bla => true or false
+moar comment
+    COMMENT
+
+    comment.extract_call_seq m
+
+    assert_equal "bla => true or false\nmoar comment\n", m.call_seq
+  end
+
+  def test_extract_call_seq_c
+    comment = RDoc::Comment.new <<-COMMENT
+call-seq:
+  commercial() -> Date <br />
+  commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
+  commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
+
+If no arguments are given:
+* ruby 1.8: returns a +Date+ for 1582-10-15 (the Day of Calendar Reform in
+  Italy)
+* ruby 1.9: returns a +Date+ for julian day 0
+
+Otherwise, returns a +Date+ for the commercial week year, commercial week,
+and commercial week day given. Ignores the 4th argument.
+    COMMENT
+
+    method_obj = RDoc::AnyMethod.new nil, 'blah'
+
+    comment.extract_call_seq method_obj
+
+    expected = <<-CALL_SEQ.chomp
+commercial() -> Date <br />
+commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
+commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
+
+    CALL_SEQ
+
+    assert_equal expected, method_obj.call_seq
+  end
+
+  def test_extract_call_seq_c_no_blank
+    comment = RDoc::Comment.new <<-COMMENT
+call-seq:
+  commercial() -> Date <br />
+  commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
+  commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
+    COMMENT
+
+    method_obj = RDoc::AnyMethod.new nil, 'blah'
+
+    comment.extract_call_seq method_obj
+
+    expected = <<-CALL_SEQ.chomp
+commercial() -> Date <br />
+commercial(cwyear, cweek=41, cwday=5, sg=nil) -> Date [ruby 1.8] <br />
+commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
+
+    CALL_SEQ
+
+    assert_equal expected, method_obj.call_seq
+  end
+
+  def test_extract_call_seq_c_separator
+    comment = RDoc::Comment.new <<-'COMMENT'
+call-seq:
+   ARGF.readlines(sep=$/)     -> array
+   ARGF.readlines(limit)      -> array
+   ARGF.readlines(sep, limit) -> array
+
+   ARGF.to_a(sep=$/)     -> array
+   ARGF.to_a(limit)      -> array
+   ARGF.to_a(sep, limit) -> array
+
+Reads +ARGF+'s current file in its entirety, returning an +Array+ of its
+lines, one line per element. Lines are assumed to be separated by _sep_.
+
+   lines = ARGF.readlines
+   lines[0]                #=> "This is line one\n"
+
+    COMMENT
+
+    method_obj = RDoc::AnyMethod.new nil, 'blah'
+
+    comment.extract_call_seq method_obj
+
+    expected = <<-CALL_SEQ
+ARGF.readlines(sep=$/)     -> array
+ARGF.readlines(limit)      -> array
+ARGF.readlines(sep, limit) -> array
+ARGF.to_a(sep=$/)     -> array
+ARGF.to_a(limit)      -> array
+ARGF.to_a(sep, limit) -> array
+    CALL_SEQ
+
+    assert_equal expected, method_obj.call_seq
+
+    expected = <<-'COMMENT'
+
+Reads +ARGF+'s current file in its entirety, returning an +Array+ of its
+lines, one line per element. Lines are assumed to be separated by _sep_.
+
+   lines = ARGF.readlines
+   lines[0]                #=> "This is line one\n"
+
+    COMMENT
+
+    assert_equal expected, comment.text
+  end
+
+  def test_force_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    @comment.force_encoding Encoding::UTF_8
+
+    assert_equal Encoding::UTF_8, @comment.text.encoding
+  end
+
+  def test_format
+    assert_equal 'rdoc', @comment.format
+  end
+
+  def test_format_equals
+    c = comment 'content'
+    document = c.parse
+
+    c.format = RDoc::RD
+
+    assert_equal RDoc::RD, c.format
+    refute_same document, c.parse
+  end
+
+  def test_initialize_copy
+    copy = @comment.dup
+
+    refute_same @comment.text, copy.text
+    assert_same @comment.location, copy.location
+  end
+
+  def test_location
+    assert_equal @top_level, @comment.location
+  end
+
+  def test_normalize
+    @comment.text = <<-TEXT
+  # comment
+    TEXT
+
+    assert_same @comment, @comment.normalize
+
+    assert_equal 'comment', @comment.text
+  end
+
+  def test_normalize_twice
+    @comment.text = <<-TEXT
+  # comment
+    TEXT
+
+    @comment.normalize
+
+    text = @comment.text
+
+    @comment.normalize
+
+    assert_same text, @comment.text, 'normalize not cached'
+  end
+
+  def test_normalize_document
+    @comment.text = nil
+    @comment.document = @RM::Document.new
+
+    assert_same @comment, @comment.normalize
+
+    assert_nil @comment.text
+  end
+
+  def test_normalize_eh
+    refute @comment.normalized?
+
+    @comment.normalize
+
+    assert @comment.normalized?
+  end
+
+  def test_text
+    assert_equal 'this is a comment', @comment.text
+  end
+
+  def test_text_equals
+    @comment.text = 'other'
+
+    assert_equal 'other', @comment.text
+    refute @comment.normalized?
+  end
+
+  def test_text_equals_no_text
+    c = RDoc::Comment.new nil, @top_level
+    c.document = @RM::Document.new
+
+    e = assert_raises RDoc::Error do
+      c.text = 'other'
+    end
+
+    assert_equal 'replacing document-only comment is not allowed', e.message
+  end
+
+  def test_text_equals_parsed
+    document = @comment.parse
+
+    @comment.text = 'other'
+
+    refute_equal document, @comment.parse
+  end
+
+  def test_tomdoc_eh
+    refute @comment.tomdoc?
+
+    @comment.format = 'tomdoc'
+
+    assert @comment.tomdoc?
+  end
+
+  def test_parse
+    parsed = @comment.parse
+
+    expected = @RM::Document.new(
+      @RM::Paragraph.new('this is a comment'))
+
+    expected.file = @top_level
+
+    assert_equal expected, parsed
+    assert_same  parsed, @comment.parse
+  end
+
+  def test_parse_rd
+    c = comment 'it ((*works*))'
+    c.format = 'rd'
+
+    expected =
+      @RM::Document.new(
+        @RM::Paragraph.new('it <em>works</em>'))
+    expected.file = @top_level
+
+    assert_equal expected, c.parse
+  end
+
+  def test_remove_private_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    comment = RDoc::Comment.new <<-EOS, @top_level
+# This is text
+#--
+# this is private
+    EOS
+
+    comment.force_encoding Encoding::IBM437
+
+    comment.remove_private
+
+    assert_equal Encoding::IBM437, comment.text.encoding
+  end
+
+  def test_remove_private_hash
+    @comment.text = <<-TEXT
+#--
+# private
+#++
+# public
+    TEXT
+
+    @comment.remove_private
+
+    assert_equal "# public\n", @comment.text
+  end
+
+  def test_remove_private_hash_trail
+    comment = RDoc::Comment.new <<-EOS, @top_level
+# This is text
+#--
+# this is private
+    EOS
+
+    expected = RDoc::Comment.new <<-EOS, @top_level
+# This is text
+    EOS
+
+    comment.remove_private
+
+    assert_equal expected, comment
+  end
+
+  def test_remove_private_long
+    comment = RDoc::Comment.new <<-EOS, @top_level
+#-----
+#++
+# this is text
+#-----
+    EOS
+
+    expected = RDoc::Comment.new <<-EOS, @top_level
+# this is text
+    EOS
+
+    comment.remove_private
+
+    assert_equal expected, comment
+  end
+
+  def test_remove_private_rule
+    comment = RDoc::Comment.new <<-EOS, @top_level
+# This is text with a rule:
+# ---
+# this is also text
+    EOS
+
+    expected = comment.dup
+
+    comment.remove_private
+
+    assert_equal expected, comment
+  end
+
+  def test_remove_private_star
+    @comment.text = <<-TEXT
+/*
+ *--
+ * private
+ *++
+ * public
+ */
+    TEXT
+
+    @comment.remove_private
+
+    assert_equal "/*\n * public\n */\n", @comment.text
+  end
+
+  def test_remove_private_star2
+    @comment.text = <<-TEXT
+/*--
+ * private
+ *++
+ * public
+ */
+    TEXT
+
+    @comment.remove_private
+
+    assert_equal "/*--\n * private\n *++\n * public\n */\n", @comment.text
+  end
+
+  def test_remove_private_toggle
+    comment = RDoc::Comment.new <<-EOS, @top_level
+# This is text
+#--
+# this is private
+#++
+# This is text again.
+    EOS
+
+    expected = RDoc::Comment.new <<-EOS, @top_level
+# This is text
+# This is text again.
+    EOS
+
+    comment.remove_private
+
+    assert_equal expected, comment
+  end
+
+  def test_remove_private_toggle_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    comment = RDoc::Comment.new <<-EOS, @top_level
+# This is text
+#--
+# this is private
+#++
+# This is text again.
+    EOS
+
+    comment.force_encoding Encoding::IBM437
+
+    comment.remove_private
+
+    assert_equal Encoding::IBM437, comment.text.encoding
+  end
+
+  def test_remove_private_toggle_encoding_ruby_bug?
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    comment = RDoc::Comment.new <<-EOS, @top_level
+#--
+# this is private
+#++
+# This is text again.
+    EOS
+
+    comment.force_encoding Encoding::IBM437
+
+    comment.remove_private
+
+    assert_equal Encoding::IBM437, comment.text.encoding
+  end
+
+end
+