rdoc 3.2 → 3.3

data/lib/rdoc/text.rb

@@ -146,7 +146,7 @@ http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse
   # Strips leading and trailing \n characters from +text+
 
   def strip_newlines text
-    text.gsub(/\A\n*(.*?)\n*\z/m, '\1')
+    text.gsub(/\A\n*(.*?)\n*\z/m) do $1 end # block preserves String encoding
   end
 
   ##

data/test/test_rdoc_any_method.rb

@@ -97,6 +97,48 @@ method(a, b) { |c, d| ... }
     assert_nil m.name
   end
 
+  def test_param_list_block_params
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    m.block_params = 'c, d'
+
+    assert_equal %w[c d], m.param_list
+  end
+
+  def test_param_list_call_seq
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    call_seq = <<-SEQ
+method(a) { |c| ... }
+method(a, b) { |c, d| ... }
+    SEQ
+
+    m.call_seq = call_seq
+
+    assert_equal %w[a b c d], m.param_list
+  end
+
+  def test_param_list_params
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    m.params = '(a, b)'
+
+    assert_equal %w[a b], m.param_list
+  end
+
+  def test_param_list_params_block_params
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    m.params = '(a, b)'
+    m.block_params = 'c, d'
+
+    assert_equal %w[a b c d], m.param_list
+  end
+
   def test_param_seq
     m = RDoc::AnyMethod.new nil, 'method'
     m.parent = @c1
@@ -117,6 +159,21 @@ method(a, b) { |c, d| ... }
     assert_equal '(a, b) { |c, d| ... }', m.param_seq
   end
 
+  def test_param_seq_call_seq
+    m = RDoc::AnyMethod.new nil, 'method'
+    m.parent = @c1
+
+    call_seq = <<-SEQ
+method(a) { |c| ... }
+method(a, b) { |c, d| ... }
+    SEQ
+
+    m.call_seq = call_seq
+
+    assert_equal '(a, b) { |c, d| }', m.param_seq
+
+  end
+
   def test_parent_name
     assert_equal 'C1', @c1.method_list.first.parent_name
     assert_equal 'C1', @c1.method_list.last.parent_name

data/test/test_rdoc_code_object.rb

@@ -30,6 +30,30 @@ class TestRDocCodeObject < XrefTestCase
     assert_equal 'I am a comment', @co.comment
   end
 
+  def test_comment_equals_encoding
+    refute_equal Encoding::UTF_8, ''.encoding, 'Encoding sanity check'
+
+    input = 'text'
+    input.force_encoding Encoding::UTF_8
+
+    @co.comment = input
+
+    assert_equal 'text', @co.comment
+    assert_equal Encoding::UTF_8, @co.comment.encoding
+  end
+
+  def test_comment_equals_encoding_blank
+    refute_equal Encoding::UTF_8, ''.encoding, 'Encoding sanity check'
+
+    input = ''
+    input.force_encoding Encoding::UTF_8
+
+    @co.comment = input
+
+    assert_equal '', @co.comment
+    assert_equal Encoding::UTF_8, @co.comment.encoding
+  end
+
   def test_document_children_equals
     @co.document_children = false
     refute @co.document_children

data/test/test_rdoc_markup_to_tt_only.rb

@@ -0,0 +1,225 @@
+require 'rubygems'
+require 'rdoc/markup/formatter_test_case'
+require 'rdoc/markup/to_tt_only'
+require 'minitest/autorun'
+
+class TestRDocMarkupToTtOnly < RDoc::Markup::FormatterTestCase
+
+  add_visitor_tests
+
+  def setup
+    super
+
+    @to = RDoc::Markup::ToTtOnly.new
+  end
+
+  def accept_blank_line
+    assert_empty @to.end_accepting
+  end
+
+  def accept_heading
+    assert_empty @to.end_accepting
+  end
+
+  def accept_list_end_bullet
+    assert_empty @to.res
+  end
+
+  def accept_list_end_label
+    assert_empty @to.res
+  end
+
+  def accept_list_end_lalpha
+    assert_empty @to.res
+  end
+
+  def accept_list_end_note
+    assert_empty @to.res
+  end
+
+  def accept_list_end_number
+    assert_empty @to.res
+  end
+
+  def accept_list_end_ualpha
+    assert_empty @to.res
+  end
+
+  def accept_list_item_end_bullet
+    assert_empty @to.res
+  end
+
+  def accept_list_item_end_label
+    assert_empty @to.res
+  end
+
+  def accept_list_item_end_lalpha
+    assert_empty @to.res
+  end
+
+  def accept_list_item_end_note
+    assert_empty @to.res
+  end
+
+  def accept_list_item_end_number
+    assert_empty @to.res
+  end
+
+  def accept_list_item_end_ualpha
+    assert_empty @to.res
+  end
+
+  def accept_list_item_start_bullet
+    assert_empty @to.res
+  end
+
+  def accept_list_item_start_label
+    assert_empty @to.res
+  end
+
+  def accept_list_item_start_lalpha
+    assert_empty @to.res
+  end
+
+  def accept_list_item_start_note
+    assert_empty @to.res
+  end
+
+  def accept_list_item_start_number
+    assert_empty @to.res
+  end
+
+  def accept_list_item_start_ualpha
+    assert_empty @to.res
+  end
+
+  def accept_list_start_bullet
+    assert_empty @to.res
+  end
+
+  def accept_list_start_label
+    assert_empty @to.res
+  end
+
+  def accept_list_start_lalpha
+    assert_empty @to.res
+  end
+
+  def accept_list_start_note
+    assert_empty @to.res
+  end
+
+  def accept_list_start_number
+    assert_empty @to.res
+  end
+
+  def accept_list_start_ualpha
+    assert_empty @to.res
+  end
+
+  def accept_paragraph
+    assert_empty @to.end_accepting
+  end
+
+  def accept_raw
+    assert_empty @to.end_accepting
+  end
+
+  def accept_rule
+    assert_empty @to.end_accepting
+  end
+
+  def accept_verbatim
+    assert_empty @to.end_accepting
+  end
+
+  def end_accepting
+    assert_equal %w[hi], @to.end_accepting
+  end
+
+  def start_accepting
+    assert_empty @to.end_accepting
+  end
+
+  def accept_heading_1
+    assert_empty @to.end_accepting
+  end
+
+  def accept_heading_2
+    assert_empty @to.end_accepting
+  end
+
+  def accept_heading_3
+    assert_empty @to.end_accepting
+  end
+
+  def accept_heading_4
+    assert_empty @to.end_accepting
+  end
+
+  def accept_heading_indent
+    assert_empty @to.end_accepting
+  end
+
+  def accept_heading_b
+    assert_empty @to.end_accepting
+  end
+
+  def accept_heading_suppressed_crossref
+    assert_empty @to.end_accepting
+  end
+
+  def accept_list_item_start_note_2
+    assert_equal [nil, 'teletype', nil], @to.res
+  end
+
+  def accept_paragraph_b
+    assert_empty @to.end_accepting
+  end
+
+  def accept_paragraph_i
+    assert_empty @to.end_accepting
+  end
+
+  def accept_paragraph_indent
+    assert_empty @to.end_accepting
+  end
+
+  def accept_paragraph_plus
+    assert_equal %w[teletype], @to.end_accepting
+  end
+
+  def accept_paragraph_star
+    assert_empty @to.end_accepting
+  end
+
+  def accept_paragraph_underscore
+    assert_empty @to.end_accepting
+  end
+
+  def accept_paragraph_wrap
+    assert_empty @to.end_accepting
+  end
+
+  def accept_rule_indent
+    assert_empty @to.end_accepting
+  end
+
+  def accept_verbatim_indent
+    assert_empty @to.end_accepting
+  end
+
+  def accept_verbatim_big_indent
+    assert_empty @to.end_accepting
+  end
+
+  def list_nested
+    assert_empty @to.end_accepting
+  end
+
+  def list_verbatim
+    assert_empty @to.end_accepting
+  end
+
+end
+

data/test/test_rdoc_normal_class.rb

@@ -13,5 +13,11 @@ class TestRDocNormalClass < XrefTestCase
     assert_equal [incl.name, klass], sub_klass.ancestors
   end
 
+  def test_definition
+    c = RDoc::NormalClass.new 'C'
+
+    assert_equal 'class C', c.definition
+  end
+
 end
 

data/test/test_rdoc_normal_module.rb

@@ -23,6 +23,12 @@ class TestRDocNormalModule < XrefTestCase
     assert_equal [mod2, incl.name], mod.ancestors
   end
 
+  def test_definition
+    m = RDoc::NormalModule.new 'M'
+
+    assert_equal 'module M', m.definition
+  end
+
   def test_module_eh
     assert @mod.module?
   end

data/test/test_rdoc_options.rb

@@ -66,6 +66,25 @@ file 'unreadable' not readable
     assert_equal expected, @options.generator_descriptions
   end
 
+  def test_parse_coverage
+    @options.parse %w[--dcov]
+
+    assert @options.coverage_report
+    assert @options.force_update
+  end
+
+  def test_parse_coverage_no
+    @options.parse %w[--no-dcov]
+
+    refute @options.coverage_report
+  end
+
+  def test_parse_coverage_level_1
+    @options.parse %w[--dcov=1]
+
+    assert_equal 1, @options.coverage_report
+  end
+
   def test_parse_dash_p
     out, err = capture_io do
       @options.parse %w[-p]

data/test/test_rdoc_parser_c.rb

@@ -101,6 +101,7 @@ void Init_Blah(void) {
     assert_equal 'accessor',            accessor.name
     assert_equal 'RW',                  accessor.rw
     assert_equal 'This is an accessor', accessor.comment
+    assert_equal @top_level,            accessor.file
 
     reader = attrs.shift
     assert_equal 'reader',           reader.name
@@ -134,6 +135,7 @@ void Init_Blah(void) {
     assert_equal 'accessor',            accessor.name
     assert_equal 'RW',                  accessor.rw
     assert_equal 'This is an accessor', accessor.comment
+    assert_equal @top_level,            accessor.file
   end
 
   def test_do_aliases
@@ -159,6 +161,9 @@ void Init_Blah(void) {
     assert_equal 2,      methods.length
     assert_equal 'bleh', methods.last.name
     assert_equal 'blah', methods.last.is_alias_for.name
+
+    assert_equal @top_level, methods.last.is_alias_for.file
+    assert_equal @top_level, methods.last.file
   end
 
   def test_do_aliases_singleton
@@ -339,6 +344,8 @@ void Init_foo(){
     constants = klass.constants
     assert !klass.constants.empty?
 
+    assert_equal @top_level, constants.first.file
+
     constants = constants.map { |c| [c.name, c.value, c.comment] }
 
     assert_equal ['PERFECT', '300', 'The highest possible score in bowling   '],
@@ -743,9 +750,21 @@ commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
   end
 
   def test_handle_method
+    parser = util_parser "Document-method: Object#m\n blah */"
+
+    parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', 2
+
+    m = @top_level.find_module_named('Object').method_list.first
+
+    assert_equal 'm', m.name
+    assert_equal '(p1, p2)', m.params
+    assert_equal @top_level, m.file
+  end
+
+  def test_handle_method_args
     parser = util_parser "Document-method: BasicObject#==\n blah */"
 
-    parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', 1
+    parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', 2
 
     bo = @top_level.find_module_named 'BasicObject'
 
@@ -753,7 +772,7 @@ commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
 
     equals2 = bo.method_list.first
 
-    assert_equal '==', equals2.name
+    assert_equal '(p1, p2)', equals2.params
   end
 
   def test_handle_method_initialize
@@ -772,6 +791,16 @@ commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
     assert_equal :public, new.visibility
   end
 
+  def test_handle_method_star_args
+    parser = util_parser "Document-method: Object#m\n blah */"
+
+    parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', -1
+
+    m = @top_level.find_module_named('Object').method_list.first
+
+    assert_equal '(*args)', m.params
+  end
+
   def test_look_for_directives_in
     parser = util_parser ''