rdoc 2.3.0 → 2.4.0

data/test/test_rdoc_require.rb

@@ -0,0 +1,25 @@
+require 'test/xref_test_case'
+
+class TestRDocRequire < XrefTestCase
+
+  def setup
+    super
+
+    @req = RDoc::Require.new 'foo', 'comment'
+  end
+
+  def test_initialize
+    assert_equal 'foo', @req.name
+
+    req = RDoc::Require.new '"foo"', ''
+    assert_equal 'foo', @req.name
+
+    req = RDoc::Require.new '\'foo\'', ''
+    assert_equal 'foo', @req.name
+
+    req = RDoc::Require.new '|foo|', ''
+    assert_equal 'foo', @req.name, 'for fortran?'
+  end
+
+end
+

data/test/test_rdoc_ri_default_display.rb

@@ -267,7 +267,8 @@ some_method(start, length)
     expected = <<-EOF
 ---------------------------------------------------- Known classes and modules
 
-     SomeClass, SomeModule
+     SomeClass
+     SomeModule
     EOF
 
     assert_equal expected, @output.string

data/test/test_rdoc_ri_html_formatter.rb

@@ -0,0 +1,141 @@
+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
+

data/test/test_rdoc_top_level.rb

@@ -0,0 +1,85 @@
+require 'rubygems'
+require 'minitest/unit'
+require 'test/xref_test_case'
+
+class TestRDocTopLevel < XrefTestCase
+
+  def setup
+    super
+
+    @top_level = RDoc::TopLevel.new 'path/top_level.rb'
+  end
+
+  def test_class_all_classes_and_modules
+    assert_equal %w[C1 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4 M1],
+                 RDoc::TopLevel.all_classes_and_modules.map { |m| m.full_name }.sort
+  end
+
+  def test_class_classes
+    assert_equal %w[C1 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4],
+                 RDoc::TopLevel.classes.map { |m| m.full_name }.sort
+  end
+
+  def test_class_files
+    assert_equal %w[path/top_level.rb xref_data.rb],
+                 RDoc::TopLevel.files.map { |m| m.full_name }.sort
+  end
+
+  def test_class_find_class_named
+    assert_equal @c1, RDoc::TopLevel.find_class_named('C1')
+  end
+
+  def test_class_find_file_named
+    assert_equal @xref_data, RDoc::TopLevel.find_file_named(@file_name)
+  end
+
+  def test_class_find_module_named
+    assert_equal @m1, RDoc::TopLevel.find_module_named('M1')
+  end
+
+  def test_class_modules
+    assert_equal %w[M1],
+                 RDoc::TopLevel.modules.map { |m| m.full_name }.sort
+  end
+
+  def test_class_reset
+    RDoc::TopLevel.reset
+
+    assert_empty RDoc::TopLevel.classes
+    assert_empty RDoc::TopLevel.modules
+    assert_empty RDoc::TopLevel.files
+  end
+
+  def test_base_name
+    assert_equal 'top_level.rb', @top_level.base_name
+  end
+
+  def test_find_class_or_module_named
+    assert_equal @c1, @xref_data.find_class_or_module_named('C1')
+    assert_equal @c4, @xref_data.find_class_or_module_named('C4')
+  end
+
+  def test_full_name
+    assert_equal 'path/top_level.rb', @top_level.full_name
+  end
+
+  def test_http_url
+    assert_equal 'prefix/path/top_level_rb.html', @top_level.http_url('prefix')
+  end
+
+  def test_last_modified
+    assert_equal 'Unknown', @top_level.last_modified
+
+    stat = Object.new
+    def stat.mtime() 0 end
+    @top_level.file_stat = stat
+
+    assert_equal '0', @top_level.last_modified
+  end
+
+  def test_name
+    assert_equal 'top_level.rb', @top_level.name
+  end
+
+end
+

data/test/xref_data.rb

@@ -0,0 +1,46 @@
+XREF_DATA = <<-XREF_DATA
+class C1
+
+  attr :attr
+  attr_reader :attr_reader
+  attr_writer :attr_writer
+  attr_accessor :attr_accessor
+
+  CONST = :const
+
+  def self.m
+  end
+
+  def m
+  end
+end
+
+class C2
+  class C3
+    def m
+    end
+
+    class H1
+      def m?
+      end
+    end
+  end
+end
+
+class C3
+  class H1
+  end
+
+  class H2
+  end
+end
+
+class C4
+  class C4
+  end
+end
+
+module M1
+end
+XREF_DATA
+

data/test/xref_test_case.rb

@@ -0,0 +1,48 @@
+require 'rubygems'
+require 'minitest/unit'
+require 'rdoc/stats'
+require 'rdoc/options'
+require 'rdoc/code_objects'
+require 'rdoc/parser/ruby'
+require 'test/xref_data'
+
+class XrefTestCase < MiniTest::Unit::TestCase
+
+  def setup
+    RDoc::TopLevel.reset
+    RDoc::AnyMethod.reset
+
+    @file_name = 'xref_data.rb'
+    @xref_data = RDoc::TopLevel.new @file_name
+
+    @options = RDoc::Options.new
+    @options.quiet = true
+
+    stats = RDoc::Stats.new 0
+
+    parser = RDoc::Parser::Ruby.new @xref_data, @file_name, XREF_DATA, @options,
+                                    stats
+    @top_levels = []
+    @top_levels.push parser.scan
+
+    generator = Object.new
+    def generator.class_dir() nil end
+    def generator.file_dir() nil end
+    rdoc = RDoc::RDoc.new
+    RDoc::RDoc.current = rdoc
+    rdoc.generator = generator
+
+    @c1    = @xref_data.find_module_named 'C1'
+    @c2    = @xref_data.find_module_named 'C2'
+    @c2_c3 = @xref_data.find_module_named 'C2::C3'
+    @c3    = @xref_data.find_module_named 'C3'
+    @c4    = @xref_data.find_module_named 'C4'
+    @c4_c4 = @xref_data.find_module_named 'C4::C4'
+
+    @m1    = @xref_data.find_module_named 'M1'
+  end
+
+end
+
+MiniTest::Unit.autorun
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  version: 2.3.0
+  version: 2.4.0
 platform: ruby
 authors: 
 - Eric Hodel
@@ -33,7 +33,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2009-01-28 00:00:00 -08:00
+date: 2009-02-24 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -54,7 +54,7 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 1.8.2
+        version: 1.8.3
     version: 
 description: RDoc is an application that produces documentation for one or more Ruby source files.  RDoc includes the +rdoc+ and +ri+ tools for generating and displaying online documentation.  At this point in time, RDoc 2.x is a work in progress and may incur further API changes beyond what has been made to RDoc 1.0.1.  Command-line tools are largely unaffected, but internal APIs may shift rapidly.  See RDoc for a description of RDoc's markup and basic use.
 email: 
@@ -74,6 +74,7 @@ extra_rdoc_files:
 - RI.txt
 - test/test.ja.txt
 files: 
+- .autotest
 - .document
 - History.txt
 - Manifest.txt
@@ -83,16 +84,21 @@ files:
 - bin/rdoc
 - bin/ri
 - lib/rdoc.rb
+- lib/rdoc/alias.rb
+- lib/rdoc/anon_class.rb
+- lib/rdoc/any_method.rb
+- lib/rdoc/attr.rb
 - lib/rdoc/cache.rb
+- lib/rdoc/class_module.rb
+- lib/rdoc/code_object.rb
 - lib/rdoc/code_objects.rb
+- lib/rdoc/constant.rb
+- lib/rdoc/context.rb
 - lib/rdoc/diagram.rb
 - lib/rdoc/dot.rb
 - lib/rdoc/generator.rb
 - lib/rdoc/generator/darkfish.rb
-- lib/rdoc/generator/html.rb
-- lib/rdoc/generator/html/common.rb
-- lib/rdoc/generator/html/html.rb
-- lib/rdoc/generator/html/one_page_html.rb
+- lib/rdoc/generator/markup.rb
 - lib/rdoc/generator/ri.rb
 - lib/rdoc/generator/template/darkfish/.document
 - lib/rdoc/generator/template/darkfish/classpage.rhtml
@@ -123,9 +129,8 @@ files:
 - lib/rdoc/generator/template/darkfish/js/quicksearch.js
 - lib/rdoc/generator/template/darkfish/js/thickbox-compressed.js
 - lib/rdoc/generator/template/darkfish/rdoc.css
-- lib/rdoc/generator/xml.rb
-- lib/rdoc/generator/xml/rdf.rb
-- lib/rdoc/generator/xml/xml.rb
+- lib/rdoc/ghost_method.rb
+- lib/rdoc/include.rb
 - lib/rdoc/known_classes.rb
 - lib/rdoc/markup.rb
 - lib/rdoc/markup/attribute_manager.rb
@@ -140,14 +145,17 @@ files:
 - lib/rdoc/markup/to_latex.rb
 - lib/rdoc/markup/to_test.rb
 - lib/rdoc/markup/to_texinfo.rb
+- lib/rdoc/meta_method.rb
+- lib/rdoc/normal_class.rb
+- lib/rdoc/normal_module.rb
 - lib/rdoc/options.rb
 - lib/rdoc/parser.rb
 - lib/rdoc/parser/c.rb
-- lib/rdoc/parser/f95.rb
 - lib/rdoc/parser/perl.rb
 - lib/rdoc/parser/ruby.rb
 - lib/rdoc/parser/simple.rb
 - lib/rdoc/rdoc.rb
+- lib/rdoc/require.rb
 - lib/rdoc/ri.rb
 - lib/rdoc/ri/cache.rb
 - lib/rdoc/ri/descriptions.rb
@@ -158,26 +166,38 @@ files:
 - lib/rdoc/ri/reader.rb
 - lib/rdoc/ri/util.rb
 - lib/rdoc/ri/writer.rb
+- lib/rdoc/single_class.rb
 - lib/rdoc/stats.rb
-- lib/rdoc/template.rb
 - lib/rdoc/tokenstream.rb
+- lib/rdoc/top_level.rb
 - test/binary.dat
 - test/test.ja.rdoc
 - test/test.ja.txt
 - test/test_attribute_manager.rb
+- test/test_rdoc_any_method.rb
+- test/test_rdoc_code_object.rb
+- test/test_rdoc_constant.rb
+- test/test_rdoc_context.rb
+- test/test_rdoc_include.rb
 - test/test_rdoc_markup.rb
 - test/test_rdoc_markup_attribute_manager.rb
 - test/test_rdoc_markup_to_html.rb
 - test/test_rdoc_markup_to_html_crossref.rb
+- test/test_rdoc_normal_module.rb
 - test/test_rdoc_parser.rb
 - test/test_rdoc_parser_c.rb
 - test/test_rdoc_parser_perl.rb
 - test/test_rdoc_parser_ruby.rb
+- test/test_rdoc_require.rb
 - test/test_rdoc_ri_attribute_formatter.rb
 - test/test_rdoc_ri_default_display.rb
 - test/test_rdoc_ri_driver.rb
 - test/test_rdoc_ri_formatter.rb
+- test/test_rdoc_ri_html_formatter.rb
 - test/test_rdoc_ri_overstrike_formatter.rb
+- test/test_rdoc_top_level.rb
+- test/xref_data.rb
+- test/xref_test_case.rb
 has_rdoc: true
 homepage: "Project Page: http://rubyforge.org/projects/rdoc/"
 post_install_message: 
@@ -201,22 +221,31 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rdoc
-rubygems_version: 1.3.1.1939
+rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
 summary: RDoc is an application that produces documentation for one or more Ruby source files
 test_files: 
 - test/test_attribute_manager.rb
+- test/test_rdoc_any_method.rb
+- test/test_rdoc_code_object.rb
+- test/test_rdoc_constant.rb
+- test/test_rdoc_context.rb
+- test/test_rdoc_include.rb
 - test/test_rdoc_markup.rb
 - test/test_rdoc_markup_attribute_manager.rb
 - test/test_rdoc_markup_to_html.rb
 - test/test_rdoc_markup_to_html_crossref.rb
+- test/test_rdoc_normal_module.rb
 - test/test_rdoc_parser.rb
 - test/test_rdoc_parser_c.rb
 - test/test_rdoc_parser_perl.rb
 - test/test_rdoc_parser_ruby.rb
+- test/test_rdoc_require.rb
 - test/test_rdoc_ri_attribute_formatter.rb
 - test/test_rdoc_ri_default_display.rb
 - test/test_rdoc_ri_driver.rb
 - test/test_rdoc_ri_formatter.rb
+- test/test_rdoc_ri_html_formatter.rb
 - test/test_rdoc_ri_overstrike_formatter.rb
+- test/test_rdoc_top_level.rb