rdoc 3.1 → 6.3.3

data/test/test_rdoc_markup_to_html_crossref.rb

@@ -1,169 +0,0 @@
-require 'rubygems'
-require 'minitest/autorun'
-require 'rdoc/rdoc'
-require 'rdoc/code_objects'
-require 'rdoc/markup/to_html_crossref'
-require File.expand_path '../xref_test_case', __FILE__
-
-class TestRDocMarkupToHtmlCrossref < XrefTestCase
-
-  def setup
-    super
-
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'index.html', @c1, true
-  end
-
-  def assert_ref(path, ref)
-    assert_equal "\n<p><a href=\"#{path}\">#{ref}</a></p>\n", @xref.convert(ref)
-  end
-
-  def refute_ref(body, ref)
-    assert_equal "\n<p>#{body}</p>\n", @xref.convert(ref)
-  end
-
-  def test_handle_special_CROSSREF_C2
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C2.html', @c2, true
-
-    refute_ref '#m', '#m'
-
-    assert_ref '../C1.html#method-c-m', 'C1::m'
-    assert_ref '../C2/C3.html', 'C2::C3'
-    assert_ref '../C2/C3.html#method-i-m', 'C2::C3#m'
-    assert_ref '../C2/C3/H1.html', 'C3::H1'
-    assert_ref '../C4.html', 'C4'
-
-    assert_ref '../C3/H2.html', 'C3::H2'
-    refute_ref 'H1', 'H1'
-  end
-
-  def test_handle_special_CROSSREF_C2_C3
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C2/C3.html', @c2_c3, true
-
-    assert_ref '../../C2/C3.html#method-i-m', '#m'
-
-    assert_ref '../../C2/C3.html', 'C3'
-    assert_ref '../../C2/C3.html#method-i-m', 'C3#m'
-
-    assert_ref '../../C2/C3/H1.html', 'H1'
-    assert_ref '../../C2/C3/H1.html', 'C3::H1'
-
-    assert_ref '../../C4.html', 'C4'
-
-    assert_ref '../../C3/H2.html', 'C3::H2'
-  end
-
-  def test_handle_special_CROSSREF_C3
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C3.html', @c3, true
-
-    assert_ref '../C3.html', 'C3'
-
-    refute_ref '#m',   '#m'
-    refute_ref 'C3#m', 'C3#m'
-
-    assert_ref '../C3/H1.html', 'H1'
-
-    assert_ref '../C3/H1.html', 'C3::H1'
-    assert_ref '../C3/H2.html', 'C3::H2'
-
-    assert_ref '../C4.html', 'C4'
-  end
-
-  def test_handle_special_CROSSREF_C4
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C4.html', @c4, true
-
-    # C4 ref inside a C4 containing a C4 should resolve to the contained class
-    assert_ref '../C4/C4.html', 'C4'
-  end
-
-  def test_handle_special_CROSSREF_C4_C4
-    @xref = RDoc::Markup::ToHtmlCrossref.new 'classes/C4/C4.html', @c4_c4, true
-
-    # A C4 reference inside a C4 class contained within a C4 class should
-    # resolve to the inner C4 class.
-    assert_ref '../../C4/C4.html', 'C4'
-  end
-
-  def test_handle_special_CROSSREF_class
-    assert_ref 'C1.html', 'C1'
-    refute_ref 'H1', 'H1'
-
-    assert_ref 'C2.html',       'C2'
-    assert_ref 'C2/C3.html',    'C2::C3'
-    assert_ref 'C2/C3/H1.html', 'C2::C3::H1'
-
-    assert_ref 'C3.html',    '::C3'
-    assert_ref 'C3/H1.html', '::C3::H1'
-
-    assert_ref 'C4/C4.html', 'C4::C4'
-  end
-
-  def test_handle_special_CROSSREF_file
-    assert_ref 'xref_data_rb.html', 'xref_data.rb'
-  end
-
-  def test_handle_special_CROSSREF_method
-    refute_ref 'm', 'm'
-    assert_ref 'C1.html#method-i-m', '#m'
-    assert_ref 'C1.html#method-c-m', '::m'
-
-    assert_ref 'C1.html#method-i-m', 'C1#m'
-    assert_ref 'C1.html#method-c-m', 'C1.m'
-    assert_ref 'C1.html#method-c-m', 'C1::m'
-
-    assert_ref 'C1.html#method-i-m', 'C1#m'
-    assert_ref 'C1.html#method-i-m', 'C1#m()'
-    assert_ref 'C1.html#method-i-m', 'C1#m(*)'
-
-    assert_ref 'C1.html#method-c-m', 'C1.m'
-    assert_ref 'C1.html#method-c-m', 'C1.m()'
-    assert_ref 'C1.html#method-c-m', 'C1.m(*)'
-
-    assert_ref 'C1.html#method-c-m', 'C1::m'
-    assert_ref 'C1.html#method-c-m', 'C1::m()'
-    assert_ref 'C1.html#method-c-m', 'C1::m(*)'
-
-    assert_ref 'C2/C3.html#method-i-m', 'C2::C3#m'
-
-    assert_ref 'C2/C3.html#method-i-m', 'C2::C3.m'
-
-    # TODO stop escaping - HTML5 allows anything but space
-    assert_ref 'C2/C3/H1.html#method-i-m-3F', 'C2::C3::H1#m?'
-
-    assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m'
-    assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m()'
-    assert_ref 'C2/C3.html#method-i-m', '::C2::C3#m(*)'
-  end
-
-  def test_handle_special_CROSSREF_no_ref
-    assert_equal '', @xref.convert('')
-
-    refute_ref 'bogus', 'bogus'
-    refute_ref 'bogus', '\bogus'
-    refute_ref '\bogus', '\\\bogus'
-
-    refute_ref '#n',    '\#n'
-    refute_ref '#n()',  '\#n()'
-    refute_ref '#n(*)', '\#n(*)'
-
-    refute_ref 'C1',   '\C1'
-    refute_ref '::C3', '\::C3'
-
-    refute_ref '::C3::H1#n',    '::C3::H1#n'
-    refute_ref '::C3::H1#n(*)', '::C3::H1#n(*)'
-    refute_ref '::C3::H1#n',    '\::C3::H1#n'
-  end
-
-  def test_handle_special_CROSSREF_show_hash_false
-    @xref.show_hash = false
-
-    assert_equal "\n<p><a href=\"C1.html#method-i-m\">m</a></p>\n",
-                 @xref.convert('#m')
-  end
-
-  def test_handle_special_CROSSREF_special
-    assert_equal "\n<p><a href=\"C2/C3.html\">C2::C3</a>;method(*)</p>\n",
-                 @xref.convert('C2::C3;method(*)')
-  end
-
-end
-

data/test/test_rdoc_markup_to_rdoc.rb

@@ -1,327 +0,0 @@
-require 'rubygems'
-require 'rdoc/markup/text_formatter_test_case'
-require 'rdoc/markup/to_rdoc'
-require 'minitest/autorun'
-
-class TestRDocMarkupToRDoc < RDoc::Markup::TextFormatterTestCase
-
-  add_visitor_tests
-  add_text_tests
-
-  def setup
-    super
-
-    @to = RDoc::Markup::ToRdoc.new
-  end
-
-  def accept_blank_line
-    assert_equal "\n", @to.res.join
-  end
-
-  def accept_heading
-    assert_equal "===== Hello\n", @to.res.join
-  end
-
-  def accept_list_end_bullet
-    assert_empty @to.list_index
-    assert_empty @to.list_type
-    assert_empty @to.list_width
-  end
-
-  def accept_list_end_label
-    assert_empty @to.list_index
-    assert_empty @to.list_type
-    assert_empty @to.list_width
-  end
-
-  def accept_list_end_lalpha
-    assert_empty @to.list_index
-    assert_empty @to.list_type
-    assert_empty @to.list_width
-  end
-
-  def accept_list_end_note
-    assert_empty @to.list_index
-    assert_empty @to.list_type
-    assert_empty @to.list_width
-  end
-
-  def accept_list_end_number
-    assert_empty @to.list_index
-    assert_empty @to.list_type
-    assert_empty @to.list_width
-  end
-
-  def accept_list_end_ualpha
-    assert_empty @to.list_index
-    assert_empty @to.list_type
-    assert_empty @to.list_width
-  end
-
-  def accept_list_item_end_bullet
-    assert_equal 0, @to.indent, 'indent'
-  end
-
-  def accept_list_item_end_label
-    assert_equal "\n", @to.res.join
-    assert_equal 0, @to.indent, 'indent'
-  end
-
-  def accept_list_item_end_lalpha
-    assert_equal 0, @to.indent, 'indent'
-    assert_equal 'b', @to.list_index.last
-  end
-
-  def accept_list_item_end_note
-    assert_equal "\n", @to.res.join
-    assert_equal 0, @to.indent, 'indent'
-  end
-
-  def accept_list_item_end_number
-    assert_equal 0, @to.indent, 'indent'
-    assert_equal 2, @to.list_index.last
-  end
-
-  def accept_list_item_end_ualpha
-    assert_equal 0, @to.indent, 'indent'
-    assert_equal 'B', @to.list_index.last
-  end
-
-  def accept_list_item_start_bullet
-    assert_equal [""], @to.res
-    assert_equal '* ', @to.prefix
-  end
-
-  def accept_list_item_start_label
-    assert_equal [""], @to.res
-    assert_equal "cat:\n  ", @to.prefix
-
-    assert_equal 2, @to.indent
-  end
-
-  def accept_list_item_start_lalpha
-    assert_equal [""], @to.res
-    assert_equal 'a. ', @to.prefix
-
-    assert_equal 'a', @to.list_index.last
-    assert_equal 3, @to.indent
-  end
-
-  def accept_list_item_start_note
-    assert_equal [""], @to.res
-    assert_equal "cat:\n  ", @to.prefix
-
-    assert_equal 2, @to.indent
-  end
-
-  def accept_list_item_start_number
-    assert_equal [""], @to.res
-    assert_equal '1. ', @to.prefix
-
-    assert_equal 1, @to.list_index.last
-    assert_equal 3, @to.indent
-  end
-
-  def accept_list_item_start_ualpha
-    assert_equal [""], @to.res
-    assert_equal 'A. ', @to.prefix
-
-    assert_equal 'A', @to.list_index.last
-    assert_equal 3, @to.indent
-  end
-
-  def accept_list_start_bullet
-    assert_equal "",   @to.res.join
-    assert_equal [nil],     @to.list_index
-    assert_equal [:BULLET], @to.list_type
-    assert_equal [1],       @to.list_width
-  end
-
-  def accept_list_start_label
-    assert_equal "",  @to.res.join
-    assert_equal [nil],    @to.list_index
-    assert_equal [:LABEL], @to.list_type
-    assert_equal [2],      @to.list_width
-  end
-
-  def accept_list_start_lalpha
-    assert_equal "",   @to.res.join
-    assert_equal ['a'],     @to.list_index
-    assert_equal [:LALPHA], @to.list_type
-    assert_equal [1],       @to.list_width
-  end
-
-  def accept_list_start_note
-    assert_equal "", @to.res.join
-    assert_equal [nil],   @to.list_index
-    assert_equal [:NOTE], @to.list_type
-    assert_equal [2],     @to.list_width
-  end
-
-  def accept_list_start_number
-    assert_equal "",   @to.res.join
-    assert_equal [1],       @to.list_index
-    assert_equal [:NUMBER], @to.list_type
-    assert_equal [1],       @to.list_width
-  end
-
-  def accept_list_start_ualpha
-    assert_equal "",   @to.res.join
-    assert_equal ['A'],     @to.list_index
-    assert_equal [:UALPHA], @to.list_type
-    assert_equal [1],       @to.list_width
-  end
-
-  def accept_paragraph
-    assert_equal "hi\n", @to.res.join
-  end
-
-  def accept_raw
-    raw = <<-RAW.rstrip
-<table>
-<tr><th>Name<th>Count
-<tr><td>a<td>1
-<tr><td>b<td>2
-</table>
-    RAW
-
-    assert_equal raw, @to.res.join
-  end
-
-  def accept_rule
-    assert_equal "#{'-' * 78}\n", @to.res.join
-  end
-
-  def accept_verbatim
-    assert_equal "  hi\n    world\n\n", @to.res.join
-  end
-
-  def end_accepting
-    assert_equal "hi", @to.end_accepting
-  end
-
-  def start_accepting
-    assert_equal 0, @to.indent
-    assert_equal [""], @to.res
-    assert_empty @to.list_index
-    assert_empty @to.list_type
-    assert_empty @to.list_width
-  end
-
-  def accept_heading_1
-    assert_equal "= Hello\n", @to.end_accepting
-  end
-
-  def accept_heading_2
-    assert_equal "== Hello\n", @to.end_accepting
-  end
-
-  def accept_heading_3
-    assert_equal "=== Hello\n", @to.end_accepting
-  end
-
-  def accept_heading_4
-    assert_equal "==== Hello\n", @to.end_accepting
-  end
-
-  def accept_heading_indent
-    assert_equal "   = Hello\n", @to.end_accepting
-  end
-
-  def accept_heading_b
-    assert_equal "= <b>Hello</b>\n", @to.end_accepting
-  end
-
-  def accept_heading_suppressed_crossref
-    assert_equal "= Hello\n", @to.end_accepting
-  end
-
-  def accept_list_item_start_note_2
-    assert_equal "<tt>teletype</tt>:\n  teletype description\n\n", @to.res.join
-  end
-
-  def accept_paragraph_b
-    assert_equal "reg <b>bold words</b> reg\n", @to.end_accepting
-  end
-
-  def accept_paragraph_i
-    assert_equal "reg <em>italic words</em> reg\n", @to.end_accepting
-  end
-
-  def accept_paragraph_indent
-    expected = <<-EXPECTED
-   words words words words words words words words words words words words
-   words words words words words words words words words words words words
-   words words words words words words
-    EXPECTED
-
-    assert_equal expected, @to.end_accepting
-  end
-
-  def accept_paragraph_plus
-    assert_equal "reg <tt>teletype</tt> reg\n", @to.end_accepting
-  end
-
-  def accept_paragraph_star
-    assert_equal "reg <b>bold</b> reg\n", @to.end_accepting
-  end
-
-  def accept_paragraph_underscore
-    assert_equal "reg <em>italic</em> reg\n", @to.end_accepting
-  end
-
-  def accept_paragraph_wrap
-    expected = <<-EXPECTED
-words words words words words words words words words words words words words
-words words words words words words words words words words words words words
-words words words words
-    EXPECTED
-
-    assert_equal expected, @to.end_accepting
-  end
-
-  def accept_rule_indent
-    assert_equal "   #{'-' * 75}\n", @to.end_accepting
-  end
-
-  def accept_verbatim_indent
-    assert_equal "    hi\n     world\n\n", @to.end_accepting
-  end
-
-  def accept_verbatim_big_indent
-    assert_equal "    hi\n    world\n\n", @to.end_accepting
-  end
-
-  def list_nested
-    expected = <<-EXPECTED
-* l1
-  * l1.1
-* l2
-    EXPECTED
-
-    assert_equal expected, @to.end_accepting
-  end
-
-  def list_verbatim
-    expected = <<-EXPECTED # HACK overblown
-* list stuff
-
-    * list
-      with
-
-      second
-
-      1. indented
-      2. numbered
-
-      third
-
-    * second
-
-    EXPECTED
-
-    assert_equal expected, @to.end_accepting
-  end
-
-end
-

data/test/test_rdoc_method_attr.rb

@@ -1,122 +0,0 @@
-require File.expand_path '../xref_test_case', __FILE__
-
-class TestRDocMethodAttr < XrefTestCase
-
-  def test_block_params_equal
-
-    m = RDoc::MethodAttr.new(nil, 'foo')
-
-    m.block_params = ''
-    assert_equal '', m.block_params
-
-    m.block_params = 'a_var'
-    assert_equal 'a_var', m.block_params
-
-    m.block_params = '()'
-    assert_equal '', m.block_params
-
-    m.block_params = '(a_var, b_var)'
-    assert_equal 'a_var, b_var', m.block_params
-
-    m.block_params = '.to_s + "</#{element.upcase}>"'
-    assert_equal '', m.block_params
-
-    m.block_params = 'i.name'
-    assert_equal 'name', m.block_params
-
-    m.block_params = 'attr.expanded_name, attr.value'
-    assert_equal 'expanded_name, value', m.block_params
-
-    m.block_params = 'expanded_name, attr.value'
-    assert_equal 'expanded_name, value', m.block_params
-
-    m.block_params = 'attr.expanded_name, value'
-    assert_equal 'expanded_name, value', m.block_params
-
-    m.block_params = '(@base_notifier)'
-    assert_equal 'base_notifier', m.block_params
-
-    m.block_params = 'if @signal_status == :IN_LOAD'
-    assert_equal '', m.block_params
-
-    m.block_params = 'e if e.kind_of? Element'
-    assert_equal 'e', m.block_params
-
-    m.block_params = '(e, f) if e.kind_of? Element'
-    assert_equal 'e, f', m.block_params
-
-    m.block_params = 'back_path, back_name'
-    assert_equal 'back_path, back_name', m.block_params
-
-    m.block_params = '(*a[1..-1])'
-    assert_equal '*a', m.block_params
-
-    m.block_params = '@@context[:node] if defined? @@context[:node].namespace'
-    assert_equal 'context', m.block_params
-
-    m.block_params = '(result, klass.const_get(constant_name))'
-    assert_equal 'result, const', m.block_params
-
-    m.block_params = 'name.to_s if (bitmap & bit) != 0'
-    assert_equal 'name', m.block_params
-
-    m.block_params = 'line unless line.deleted'
-    assert_equal 'line', m.block_params
-
-    m.block_params = 'str + rs'
-    assert_equal 'str', m.block_params
-
-    m.block_params = 'f+rs'
-    assert_equal 'f', m.block_params
-
-    m.block_params = '[user, realm, hash[user]]'
-    assert_equal 'user, realm, hash', m.block_params
-
-    m.block_params = 'proc{|rc| rc == "rc" ? irbrc : irbrc+rc| ... }'
-    assert_equal 'proc', m.block_params
-
-    m.block_params = 'lambda { |x| x.to_i }'
-    assert_equal 'lambda', m.block_params
-
-    m.block_params = '$&'
-    assert_equal 'str', m.block_params
-
-    m.block_params = 'Inflections.instance'
-    assert_equal 'instance', m.block_params
-
-    m.block_params = 'self.class::STARTED'
-    assert_equal 'STARTED', m.block_params
-
-    m.block_params = 'Test::Unit::TestCase::STARTED'
-    assert_equal 'STARTED', m.block_params
-
-    m.block_params = 'ActiveSupport::OptionMerger.new(self, options)'
-    assert_equal 'option_merger', m.block_params
-
-    m.block_params = ', msg'
-    assert_equal '', m.block_params
-
-    m.block_params = '[size.to_s(16), term, chunk, term].join'
-    assert_equal '[size, term, chunk, term].join', m.block_params
-
-    m.block_params = 'YPath.new( path )'
-    assert_equal 'y_path', m.block_params
-
-  end
-
-  def test_find_method_or_attribute_recursive
-    inc = RDoc::Include.new 'M1', nil
-    @m1.add_include inc # M1 now includes itself
-
-    assert_nil @m1_m.find_method_or_attribute 'm'
-  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
-    assert_equal 'RDoc::AnyMethod: C1::m', @c1__m.to_s
-  end
-
-
-end
-

data/test/test_rdoc_normal_class.rb

@@ -1,17 +0,0 @@
-require File.expand_path '../xref_test_case', __FILE__
-
-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.name, klass], sub_klass.ancestors
-  end
-
-end
-

data/test/test_rdoc_normal_module.rb

@@ -1,31 +0,0 @@
-require File.expand_path '../xref_test_case', __FILE__
-
-class TestRDocNormalModule < XrefTestCase
-
-  def setup
-    super
-
-    @mod = RDoc::NormalModule.new 'Mod'
-  end
-
-  def test_ancestors_module
-    top_level = RDoc::TopLevel.new 'file.rb'
-    mod = top_level.add_module RDoc::NormalModule, 'Mod'
-    incl = RDoc::Include.new 'Incl', ''
-
-    mod.add_include incl
-
-    assert_equal [incl.name], mod.ancestors
-
-    mod2 = top_level.add_module RDoc::NormalModule, 'Inc2'
-    inc2 = RDoc::Include.new 'Inc2', ''
-    mod.add_include inc2
-    assert_equal [mod2, incl.name], mod.ancestors
-  end
-
-  def test_module_eh
-    assert @mod.module?
-  end
-
-end
-