RubyGems - rdoc - Versions diffs - 2.4.3 → 2.5 - Mend

rdoc 2.4.3 → 2.5

Potentially problematic release.

This version of rdoc might be problematic. Click here for more details.

Files changed (139) hide show

data.tar.gz.sig +0 -0
data/.autotest +3 -1
data/History.txt +68 -0
data/LICENSE.txt +57 -0
data/Manifest.txt +37 -19
data/README.txt +2 -12
data/Rakefile +12 -12
data/bin/rdoc +4 -4
data/lib/rdoc.rb +32 -9
data/lib/rdoc/alias.rb +2 -2
data/lib/rdoc/any_method.rb +108 -16
data/lib/rdoc/attr.rb +87 -1
data/lib/rdoc/class_module.rb +131 -5
data/lib/rdoc/code_object.rb +28 -5
data/lib/rdoc/constant.rb +22 -0
data/lib/rdoc/context.rb +80 -37
data/lib/rdoc/gauntlet.rb +48 -0
data/lib/rdoc/generator/darkfish.rb +25 -23
data/lib/rdoc/generator/markup.rb +6 -29
data/lib/rdoc/generator/ri.rb +39 -189
data/lib/rdoc/generator/template/darkfish/classpage.rhtml +17 -1
data/lib/rdoc/generator/template/darkfish/filepage.rhtml +10 -0
data/lib/rdoc/generator/template/darkfish/images/brick.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/brick_link.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/bullet_black.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/bullet_toggle_minus.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/bullet_toggle_plus.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/date.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/find.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/package.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/page_green.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/page_white_text.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/page_white_width.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/plugin.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/ruby.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/tag_green.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/wrench.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/wrench_orange.png +0 -0
data/lib/rdoc/generator/template/darkfish/images/zoom.png +0 -0
data/lib/rdoc/generator/template/darkfish/index.rhtml +2 -2
data/lib/rdoc/generator/template/darkfish/rdoc.css +38 -33
data/lib/rdoc/include.rb +22 -0
data/lib/rdoc/markup.rb +10 -262
data/lib/rdoc/markup/attribute_manager.rb +57 -50
data/lib/rdoc/markup/blank_line.rb +19 -0
data/lib/rdoc/markup/document.rb +72 -0
data/lib/rdoc/markup/formatter.rb +118 -0
data/lib/rdoc/markup/formatter_test_case.rb +341 -0
data/lib/rdoc/markup/heading.rb +17 -0
data/lib/rdoc/markup/inline.rb +6 -5
data/lib/rdoc/markup/list.rb +78 -0
data/lib/rdoc/markup/list_item.rb +83 -0
data/lib/rdoc/markup/paragraph.rb +66 -0
data/lib/rdoc/markup/parser.rb +528 -0
data/lib/rdoc/markup/rule.rb +17 -0
data/lib/rdoc/markup/to_ansi.rb +72 -0
data/lib/rdoc/markup/to_bs.rb +74 -0
data/lib/rdoc/markup/to_html.rb +106 -172
data/lib/rdoc/markup/to_html_crossref.rb +10 -4
data/lib/rdoc/markup/to_rdoc.rb +243 -0
data/lib/rdoc/markup/to_test.rb +27 -16
data/lib/rdoc/markup/verbatim.rb +42 -0
data/lib/rdoc/normal_class.rb +38 -1
data/lib/rdoc/normal_module.rb +38 -8
data/lib/rdoc/options.rb +39 -151
data/lib/rdoc/parser.rb +36 -18
data/lib/rdoc/parser/c.rb +102 -109
data/lib/rdoc/parser/ruby.rb +359 -1662
data/lib/rdoc/parser/ruby_tools.rb +157 -0
data/lib/rdoc/parser/simple.rb +0 -2
data/lib/rdoc/rdoc.rb +142 -82
data/lib/rdoc/ri.rb +10 -0
data/lib/rdoc/ri/driver.rb +674 -444
data/lib/rdoc/ri/formatter.rb +2 -651
data/lib/rdoc/ri/paths.rb +70 -45
data/lib/rdoc/ri/store.rb +248 -0
data/lib/rdoc/ruby_lex.rb +1284 -0
data/lib/rdoc/ruby_token.rb +416 -0
data/lib/rdoc/single_class.rb +5 -0
data/lib/rdoc/stats.rb +152 -83
data/lib/rdoc/task.rb +27 -49
data/lib/rdoc/text.rb +130 -0
data/lib/rdoc/tokenstream.rb +28 -9
data/lib/rdoc/top_level.rb +49 -43
data/test/hidden.zip.txt +1 -0
data/test/test_attribute_manager.rb +9 -16
data/test/test_rdoc_any_method.rb +23 -0
data/test/test_rdoc_attr.rb +40 -0
data/test/test_rdoc_class_module.rb +100 -0
data/test/test_rdoc_code_object.rb +18 -2
data/test/test_rdoc_context.rb +41 -0
data/test/test_rdoc_generator_ri.rb +56 -0
data/test/test_rdoc_markup.rb +21 -610
data/test/test_rdoc_markup_attribute_manager.rb +14 -17
data/test/test_rdoc_markup_document.rb +51 -0
data/test/test_rdoc_markup_paragraph.rb +27 -0
data/test/test_rdoc_markup_parser.rb +1327 -0
data/test/test_rdoc_markup_to_ansi.rb +426 -0
data/test/test_rdoc_markup_to_bs.rb +443 -0
data/test/test_rdoc_markup_to_html.rb +183 -18
data/test/test_rdoc_markup_to_html_crossref.rb +1 -3
data/test/test_rdoc_markup_to_rdoc.rb +426 -0
data/test/test_rdoc_normal_class.rb +17 -0
data/test/test_rdoc_normal_module.rb +6 -6
data/test/test_rdoc_options.rb +41 -0
data/test/test_rdoc_parser.rb +66 -13
data/test/test_rdoc_parser_c.rb +93 -38
data/test/test_rdoc_parser_perl.rb +2 -3
data/test/test_rdoc_parser_ruby.rb +291 -28
data/test/test_rdoc_parser_simple.rb +48 -0
data/test/test_rdoc_rdoc.rb +66 -0
data/test/test_rdoc_ri_driver.rb +752 -38
data/test/test_rdoc_ri_paths.rb +39 -0
data/test/test_rdoc_ri_store.rb +309 -0
data/test/test_rdoc_text.rb +157 -0
data/test/test_rdoc_top_level.rb +35 -9
data/test/xref_data.rb +9 -1
data/test/xref_test_case.rb +8 -3
metadata +110 -38
metadata.gz.sig +0 -0
data/lib/rdoc/cache.rb +0 -41
data/lib/rdoc/diagram.rb +0 -340
data/lib/rdoc/dot.rb +0 -249
data/lib/rdoc/markup/fragments.rb +0 -377
data/lib/rdoc/markup/lines.rb +0 -156
data/lib/rdoc/markup/to_flow.rb +0 -211
data/lib/rdoc/markup/to_latex.rb +0 -328
data/lib/rdoc/markup/to_texinfo.rb +0 -73
data/lib/rdoc/ri/cache.rb +0 -187
data/lib/rdoc/ri/descriptions.rb +0 -156
data/lib/rdoc/ri/display.rb +0 -340
data/lib/rdoc/ri/reader.rb +0 -106
data/lib/rdoc/ri/util.rb +0 -79
data/lib/rdoc/ri/writer.rb +0 -68
data/test/test_rdoc_ri_attribute_formatter.rb +0 -44
data/test/test_rdoc_ri_default_display.rb +0 -302
data/test/test_rdoc_ri_formatter.rb +0 -320
data/test/test_rdoc_ri_html_formatter.rb +0 -141
data/test/test_rdoc_ri_overstrike_formatter.rb +0 -71

data/test/test_rdoc_ri_formatter.rb DELETED

@@ -1,320 +0,0 @@
-require 'stringio'
-require 'rubygems'
-require 'minitest/unit'
-require 'rdoc/ri/formatter'
-require 'rdoc/markup/to_flow'
-class TestRDocRIFormatter < MiniTest::Unit::TestCase
-  def setup
-    @output = StringIO.new
-    @width = 78
-    @indent = '  '
-    @f = RDoc::RI::Formatter.new @output, @width, @indent
-    @markup = RDoc::Markup.new
-    @flow = RDoc::Markup::ToFlow.new
-  end
-  def test_blankline
-    @f.blankline
-    assert_equal "\n", @output.string
-  end
-  def test_bold_print
-    @f.bold_print 'a b c'
-    assert_equal 'a b c', @output.string
-  end
-  def test_break_to_newline
-    @f.break_to_newline
-    assert_equal '', @output.string
-  end
-  def test_conv_html
-    assert_equal '> < " &', @f.conv_html('&gt; &lt; &quot; &amp;')
-  end
-  def test_conv_markup
-    text = '<tt>a</tt> <code>b</code> <b>c</b> <em>d</em>'
-    expected = '+a+ +b+ *c* _d_'
-    assert_equal expected, @f.conv_markup(text)
-  end
-  def test_display_flow
-    flow = [
-      RDoc::Markup::Flow::H.new(1, 'heading'),
-      RDoc::Markup::Flow::P.new('paragraph'),
-    ]
-    @f.display_flow flow
-    assert_equal "\nHEADING\n=======\n\n  paragraph\n\n", @output.string
-  end
-  def test_display_flow_item_h
-    item = RDoc::Markup::Flow::H.new 1, 'heading'
-    @f.display_flow_item item
-    assert_equal "\nHEADING\n=======\n\n", @output.string
-  end
-  def test_display_flow_item_li
-    item = RDoc::Markup::Flow::LI.new nil, 'paragraph'
-    @f.display_flow_item item
-    assert_equal "  paragraph\n\n", @output.string
-  end
-  def test_display_flow_item_list
-    item = RDoc::Markup::Flow::LIST.new :NUMBER
-    @f.display_flow_item item
-    assert_equal "", @output.string
-  end
-  def test_display_flow_item_p
-    item = RDoc::Markup::Flow::P.new 'paragraph'
-    @f.display_flow_item item
-    assert_equal "  paragraph\n\n", @output.string
-  end
-  def test_display_flow_item_rule
-    item = RDoc::Markup::Flow::RULE.new 1
-    @f.display_flow_item item
-    assert_equal "#{'-' * 78}\n", @output.string
-  end
-  def test_display_flow_item_unknown
-    e = assert_raises RDoc::Error do
-      @f.display_flow_item Object.new
-    end
-    assert_equal "Unknown flow element: Object", e.message
-  end
-  def test_display_flow_item_verb
-    item = RDoc::Markup::Flow::VERB.new 'a b c'
-    @f.display_flow_item item
-    assert_equal "  a b c\n\n", @output.string
-  end
-  def test_display_heading_1
-    @f.display_heading 'heading', 1, '  '
-    assert_equal "\nHEADING\n=======\n\n", @output.string
-  end
-  def test_display_heading_2
-    @f.display_heading 'heading', 2, '  '
-    assert_equal "\nheading\n-------\n\n", @output.string
-  end
-  def test_display_heading_3
-    @f.display_heading 'heading', 3, '  '
-    assert_equal "  heading\n\n", @output.string
-  end
-  def test_display_list
-    list = RDoc::Markup::Flow::LIST.new :NUMBER
-    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
-    list << RDoc::Markup::Flow::LI.new(nil, 'd e f')
-    @f.display_list list
-    assert_equal "  1.  a b c\n\n  2.  d e f\n\n", @output.string
-  end
-  def test_display_list_bullet
-    list = RDoc::Markup::Flow::LIST.new :BULLET
-    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
-    @f.display_list list
-    assert_equal "  *   a b c\n\n", @output.string
-  end
-  def test_display_list_labeled
-    list = RDoc::Markup::Flow::LIST.new :LABELED
-    list << RDoc::Markup::Flow::LI.new('label', 'a b c')
-    @f.display_list list
-    assert_equal "  label a b c\n\n", @output.string
-  end
-  def test_display_list_lower_alpha
-    list = RDoc::Markup::Flow::LIST.new :LOWERALPHA
-    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
-    @f.display_list list
-    assert_equal "  a.  a b c\n\n", @output.string
-  end
-  def test_display_list_note
-    list = RDoc::Markup::Flow::LIST.new :NOTE
-    list << RDoc::Markup::Flow::LI.new('note:', 'a b c')
-    @f.display_list list
-    assert_equal "  note: a b c\n\n", @output.string
-  end
-  def test_display_list_number
-    list = RDoc::Markup::Flow::LIST.new :NUMBER
-    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
-    @f.display_list list
-    assert_equal "  1.  a b c\n\n", @output.string
-  end
-  def test_display_list_unknown
-    list = RDoc::Markup::Flow::LIST.new :UNKNOWN
-    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
-    e = assert_raises ArgumentError do
-      @f.display_list list
-    end
-    assert_equal 'unknown list type UNKNOWN', e.message
-  end
-  def test_display_list_upper_alpha
-    list = RDoc::Markup::Flow::LIST.new :UPPERALPHA
-    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
-    @f.display_list list
-    assert_equal "  A.  a b c\n\n", @output.string
-  end
-  def test_display_verbatim_flow_item
-    verbatim = RDoc::Markup::Flow::VERB.new "a b c\nd e f"
-    @f.display_verbatim_flow_item verbatim
-    assert_equal "  a b c\n  d e f\n\n", @output.string
-  end
-  def test_display_verbatim_flow_item_bold
-    verbatim = RDoc::Markup::Flow::VERB.new "*a* b c"
-    @f.display_verbatim_flow_item verbatim
-    assert_equal "  *a* b c\n\n", @output.string
-  end
-  def test_draw_line
-    @f.draw_line
-    expected = '-' * @width + "\n"
-    assert_equal expected, @output.string
-  end
-  def test_draw_line_label
-    @f.draw_line 'label'
-    expected = '-' * (@width - 6) + " label\n"
-    assert_equal expected, @output.string
-  end
-  def test_draw_line_label_long
-    @f.draw_line 'a' * @width
-    expected = '-' * @width + "\n" + ('a' * @width) + "\n"
-    assert_equal expected, @output.string
-  end
-  def test_raw_print_line
-    @f.raw_print_line 'a b c'
-    assert_equal "a b c", @output.string
-  end
-  def test_strip_attributes_b
-    text = @f.strip_attributes 'hello <b>world</b>'
-    expected = 'hello world'
-    assert_equal expected, text
-  end
-  def test_strip_attributes_code
-    text = @f.strip_attributes 'hello <code>world</code>'
-    expected = 'hello world'
-    assert_equal expected, text
-  end
-  def test_strip_attributes_em
-    text = @f.strip_attributes 'hello <em>world</em>'
-    expected = 'hello world'
-    assert_equal expected, text
-  end
-  def test_strip_attributes_i
-    text = @f.strip_attributes 'hello <i>world</i>'
-    expected = 'hello world'
-    assert_equal expected, text
-  end
-  def test_strip_attributes_tt
-    text = @f.strip_attributes 'hello <tt>world</tt>'
-    expected = 'hello world'
-    assert_equal expected, text
-  end
-  def test_wrap_empty
-    @f.wrap ''
-    assert_equal '', @output.string
-  end
-  def test_wrap_long
-    @f.wrap 'a ' * (@width / 2)
-    assert_equal "  a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a a\n  a \n",
-                 @output.string
-  end
-  def test_wrap_markup
-    @f.wrap 'a <tt>b</tt> c'
-    assert_equal "  a +b+ c\n", @output.string
-  end
-  def test_wrap_nil
-    @f.wrap nil
-    assert_equal '', @output.string
-  end
-  def test_wrap_short
-    @f.wrap 'a b c'
-    assert_equal "  a b c\n", @output.string
-  end
-end
-MiniTest::Unit.autorun

data/test/test_rdoc_ri_html_formatter.rb DELETED

@@ -1,141 +0,0 @@
-require 'stringio'
-require 'rubygems'
-require 'minitest/unit'
-require 'rdoc/ri/formatter'
-require 'rdoc/markup/fragments'
-require 'rdoc/markup/to_flow'
-class TestRDocRIHtmlFormatter < MiniTest::Unit::TestCase
-  def setup
-    @output = StringIO.new
-    @width = 78
-    @indent = '  '
-    @f = RDoc::RI::HtmlFormatter.new @output, @width, @indent
-    @markup = RDoc::Markup.new
-    @flow = RDoc::Markup::ToFlow.new
-    @af = RDoc::RI::AttributeFormatter
-  end
-  def test_blankline
-    @f.blankline
-    assert_equal "<p />\n", @output.string
-  end
-  def test_bold_print
-    @f.bold_print 'text'
-    assert_equal '<b>text</b>', @output.string
-  end
-  def test_break_to_newline
-    @f.break_to_newline
-    assert_equal "<br />\n", @output.string
-  end
-  def test_display_heading
-    @f.display_heading 'text', 1, '  '
-    assert_equal "<h1>text</h1>\n", @output.string
-  end
-  def test_display_heading_level_4
-    @f.display_heading 'text', 4, '  '
-    assert_equal "<h4>text</h4>\n", @output.string
-  end
-  def test_display_heading_level_5
-    @f.display_heading 'text', 5, '  '
-    assert_equal "<h4>text</h4>\n", @output.string
-  end
-  def test_display_list_bullet
-    list = RDoc::Markup::Flow::LIST.new :BULLET
-    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
-    list << RDoc::Markup::Flow::LI.new(nil, 'd e f')
-    @f.display_list list
-    expected = <<-EOF.strip
-<ul><li>a b c<p />
-</li><li>d e f<p />
-</li></ul>
-    EOF
-    assert_equal expected, @output.string
-  end
-  def test_display_list_number
-    list = RDoc::Markup::Flow::LIST.new :NUMBER
-    list << RDoc::Markup::Flow::LI.new(nil, 'a b c')
-    list << RDoc::Markup::Flow::LI.new(nil, 'd e f')
-    @f.display_list list
-    expected = <<-EOF.strip
-<ol><li>a b c<p />
-</li><li>d e f<p />
-</li></ol>
-    EOF
-    assert_equal expected, @output.string
-  end
-  def test_display_list_labeled
-    list = RDoc::Markup::Flow::LIST.new :LABELED
-    list << RDoc::Markup::Flow::LI.new('label',   'a b c')
-    list << RDoc::Markup::Flow::LI.new('label 2', 'd e f')
-    @f.display_list list
-    expected = <<-EOF.strip
-<dl><dt><b>label</b></dt><dd>a b c<p />
-</dd><dt><b>label 2</b></dt><dd>d e f<p />
-</dd></dl>
-    EOF
-    assert_equal expected, @output.string
-  end
-  def test_display_list_note
-    list = RDoc::Markup::Flow::LIST.new :NOTE
-    list << RDoc::Markup::Flow::LI.new('note:',   'a b c')
-    list << RDoc::Markup::Flow::LI.new('note 2:', 'd e f')
-    @f.display_list list
-    expected = <<-EOF.strip
-<table><tr valign="top"><td>note:</td><td>a b c<p />
-</td></tr><tr valign="top"><td>note&nbsp;2:</td><td>d e f<p />
-</td></tr></table>
-    EOF
-    assert_equal expected, @output.string
-  end
-  def test_display_verbatim_flow_item
-    verbatim = RDoc::Markup::Flow::VERB.new '*a* > b &gt; c'
-    @f.display_verbatim_flow_item verbatim
-    assert_equal "<pre>*a* &gt; b &amp;gt; c\n</pre>\n", @output.string
-  end
-  def test_draw_line
-    @f.draw_line
-    assert_equal "<hr />\n", @output.string
-  end
-  def test_draw_line_label
-    @f.draw_line 'label'
-    assert_equal "<b>label</b><hr />\n", @output.string
-  end
-end