rdoc 2.1.0 → 2.2.0

data/test/test_rdoc_parser.rb

@@ -0,0 +1,13 @@
+require 'rdoc/parser'
+
+class TestRDocParser < Test::Unit::TestCase
+  def test_can_parse
+    assert_equal(RDoc::Parser.can_parse(__FILE__), RDoc::Parser::Ruby)
+
+    readme_file_name = File.join(File.dirname(__FILE__), "..", "README.txt")
+    assert_equal(RDoc::Parser.can_parse(readme_file_name), RDoc::Parser::Simple)
+
+    binary_file_name = File.join(File.dirname(__FILE__), "binary.dat")
+    assert_equal(RDoc::Parser.can_parse(binary_file_name), nil)
+  end
+end

data/test/test_rdoc_parser_c.rb

@@ -10,7 +10,7 @@ class RDoc::Parser::C
   public :do_classes, :do_constants
 end
 
-class TestRdocParserC < Test::Unit::TestCase
+class TestRDocParserC < Test::Unit::TestCase
 
   def setup
     @tempfile = Tempfile.new self.class.name

data/test/test_rdoc_parser_ruby.rb

@@ -6,7 +6,7 @@ require 'rdoc/options'
 require 'rdoc/parser/ruby'
 require 'rdoc/stats'
 
-class TestRdocParserRuby < Test::Unit::TestCase
+class TestRDocParserRuby < Test::Unit::TestCase
 
   def setup
     @tempfile = Tempfile.new self.class.name
@@ -158,6 +158,77 @@ class TestRdocParserRuby < Test::Unit::TestCase
     assert_equal 'Super', bar.superclass
   end
 
+  def test_parse_module
+    comment = "##\n# my module\n"
+
+    util_parser 'module Foo; end'
+
+    tk = @parser.get_tk
+
+    @parser.parse_module @top_level, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    foo = @top_level.modules.first
+    assert_equal 'Foo', foo.full_name
+    assert_equal comment, foo.comment
+  end
+  
+  def test_parse_class_mistaken_for_module
+#
+# The code below is not strictly legal Ruby (Foo must have been defined
+# before Foo::Bar is encountered), but RDoc might encounter Foo::Bar before
+# Foo if they live in different files.
+#
+    code = <<-EOF
+class Foo::Bar
+end
+
+module Foo::Baz
+end
+
+class Foo
+end
+EOF
+
+    util_parser code
+
+    @parser.scan()
+
+    assert(@top_level.modules.empty?)
+    foo = @top_level.classes.first
+    assert_equal 'Foo', foo.full_name
+
+    bar = foo.classes.first
+    assert_equal 'Foo::Bar', bar.full_name
+
+    baz = foo.modules.first
+    assert_equal 'Foo::Baz', baz.full_name
+  end
+
+  def test_parse_module_relative_to_top_level_namespace
+    comment = <<-EOF
+#
+# Weirdly named module
+#
+EOF
+
+    code = comment + <<-EOF
+module ::Foo
+  class Helper
+  end
+end
+EOF
+
+    util_parser code
+    @parser.scan()
+
+    foo = @top_level.modules.first
+    assert_equal 'Foo', foo.full_name
+    assert_equal comment, foo.comment
+
+    helper = foo.classes.first
+    assert_equal 'Foo::Helper', helper.full_name
+  end
+
   def test_parse_comment
     content = <<-EOF
 class Foo

data/test/test_rdoc_ri_default_display.rb

@@ -4,7 +4,7 @@ require 'rdoc/ri/formatter'
 require 'rdoc/ri/display'
 require 'rdoc/ri/driver'
 
-class TestRdocRiDefaultDisplay < Test::Unit::TestCase
+class TestRDocRiDefaultDisplay < Test::Unit::TestCase
 
   def setup
     @output = StringIO.new
@@ -27,7 +27,6 @@ class TestRdocRiDefaultDisplay < Test::Unit::TestCase
   end
 
   def test_display_class_info
-    ri_reader = nil
     klass = h \
       'attributes' => [
         { 'name' => 'attribute', 'rw' => 'RW',
@@ -59,7 +58,7 @@ class TestRdocRiDefaultDisplay < Test::Unit::TestCase
       ],
       'superclass_string' => 'Object'
 
-    @dd.display_class_info klass, ri_reader
+    @dd.display_class_info klass
 
     expected = <<-EOF
 ---------------------------------------------------- Class: SomeClass < Object
@@ -77,6 +76,15 @@ Constants:
      CONSTANT_NOCOMMENT
 
 
+Attributes:
+-----------
+
+     attribute (RW):
+          attribute comment
+
+     attribute_no_comment (RW)
+
+
 Class methods:
 --------------
 
@@ -99,15 +107,6 @@ Instance method extensions:
 ---------------------------
 
      instance_method_extension
-
-
-Attributes:
------------
-
-     attribute (RW):
-          attribute comment
-
-     attribute_no_comment (RW)
     EOF
 
     assert_equal expected, @output.string
@@ -140,7 +139,7 @@ Attributes:
 -------------------------------------------------------- SomeClass#some_method
      some_method(arg1, arg2) {|block_param| ...}
 
-     Extension from /nonexistent
+     From /nonexistent
 ------------------------------------------------------------------------------
      some comment
 
@@ -152,7 +151,7 @@ Attributes:
   end
 
   def test_display_method_info_singleton
-    method = RDoc::RI::Driver::Hash.new.update \
+    method = RDoc::RI::Driver::OpenStructHash.new.update \
       'aliases' => [],
       'block_params' => nil,
       'comment' => nil,
@@ -167,6 +166,8 @@ Attributes:
     expected = <<-EOF
 ------------------------------------------------------- SomeClass::some_method
      SomeClass::some_method(arg1, arg2)
+
+     From 
 ------------------------------------------------------------------------------
      [no description]
     EOF
@@ -176,7 +177,7 @@ Attributes:
 
   def test_display_method_list
     methods = [
-      RDoc::RI::Driver::Hash.new.update(
+      RDoc::RI::Driver::OpenStructHash.new.update(
         "aliases" => [],
         "block_params" => nil,
         "comment" =>  nil,
@@ -186,7 +187,7 @@ Attributes:
         "params" => "()",
         "visibility" => "public"
       ),
-      RDoc::RI::Driver::Hash.new.update(
+      RDoc::RI::Driver::OpenStructHash.new.update(
         "aliases" => [],
         "block_params" => nil,
         "comment" => nil,
@@ -204,7 +205,8 @@ Attributes:
      More than one method matched your request.  You can refine your search by
      asking for information on one of:
 
-     SomeClass#some_method, SomeClass#some_other_method
+SomeClass#some_method []
+SomeClass#some_other_method []
     EOF
 
     assert_equal expected, @output.string
@@ -216,7 +218,7 @@ Attributes:
     expected = <<-EOF
      some_method(arg1, arg2) {|block_param| ...}
 
-     Extension from /nonexistent
+     From /nonexistent
     EOF
 
     assert_equal expected, @output.string
@@ -234,7 +236,7 @@ some_method(start, length)
      some_method(index)
      some_method(start, length)
 
-     Extension from /nonexistent
+     From /nonexistent
     EOF
 
     assert_equal expected, @output.string
@@ -249,7 +251,7 @@ some_method(start, length)
     expected = <<-EOF
      SomeClass::some_method(arg1, arg2) {|block_param| ...}
 
-     Extension from /nonexistent
+     From /nonexistent
     EOF
 
     assert_equal expected, @output.string
@@ -289,8 +291,7 @@ install an additional package, or ask the packager to enable ri generation.
   end
 
   def h(hash)
-    RDoc::RI::Driver::Hash.convert hash
+    RDoc::RI::Driver::OpenStructHash.convert hash
   end
 
 end
-

data/test/test_rdoc_ri_driver.rb

@@ -14,7 +14,7 @@ class TestRDocRIDriver < Test::Unit::TestCase
     FileUtils.mkdir_p @home_ri
     FileUtils.mkdir_p @cache_dir
 
-    @driver = RDoc::RI::Driver.new
+    @driver = RDoc::RI::Driver.new(RDoc::RI::Driver.process_args([]))
     @driver.homepath = @home_ri
   end
 

data/test/test_rdoc_ri_formatter.rb

@@ -245,7 +245,7 @@ class TestRDocRIFormatter < Test::Unit::TestCase
   def test_raw_print_line
     @f.raw_print_line 'a b c'
 
-    assert_equal "a b c\n", @output.string
+    assert_equal "a b c", @output.string
   end
 
   def test_strip_attributes_b

metadata

@@ -1,38 +1,18 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  version: 2.1.0
+  version: 2.2.0
 platform: ruby
 authors: 
 - Eric Hodel
 - Dave Thomas
 - Phil Hagelberg
+- Tony Strauss
 autorequire: 
 bindir: bin
-cert_chain: 
-- |
-  -----BEGIN CERTIFICATE-----
-  MIIDNjCCAh6gAwIBAgIBADANBgkqhkiG9w0BAQUFADBBMRAwDgYDVQQDDAdkcmJy
-  YWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZFgNu
-  ZXQwHhcNMDcxMjIxMDIwNDE0WhcNMDgxMjIwMDIwNDE0WjBBMRAwDgYDVQQDDAdk
-  cmJyYWluMRgwFgYKCZImiZPyLGQBGRYIc2VnbWVudDcxEzARBgoJkiaJk/IsZAEZ
-  FgNuZXQwggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQCbbgLrGLGIDE76
-  LV/cvxdEzCuYuS3oG9PrSZnuDweySUfdp/so0cDq+j8bqy6OzZSw07gdjwFMSd6J
-  U5ddZCVywn5nnAQ+Ui7jMW54CYt5/H6f2US6U0hQOjJR6cpfiymgxGdfyTiVcvTm
-  Gj/okWrQl0NjYOYBpDi+9PPmaH2RmLJu0dB/NylsDnW5j6yN1BEI8MfJRR+HRKZY
-  mUtgzBwF1V4KIZQ8EuL6I/nHVu07i6IkrpAgxpXUfdJQJi0oZAqXurAV3yTxkFwd
-  g62YrrW26mDe+pZBzR6bpLE+PmXCzz7UxUq3AE0gPHbiMXie3EFE0oxnsU3lIduh
-  sCANiQ8BAgMBAAGjOTA3MAkGA1UdEwQCMAAwCwYDVR0PBAQDAgSwMB0GA1UdDgQW
-  BBS5k4Z75VSpdM0AclG2UvzFA/VW5DANBgkqhkiG9w0BAQUFAAOCAQEAHagT4lfX
-  kP/hDaiwGct7XPuVGbrOsKRVD59FF5kETBxEc9UQ1clKWngf8JoVuEoKD774dW19
-  bU0GOVWO+J6FMmT/Cp7nuFJ79egMf/gy4gfUfQMuvfcr6DvZUPIs9P/TlK59iMYF
-  DIOQ3DxdF3rMzztNUCizN4taVscEsjCcgW6WkUJnGdqlu3OHWpQxZBJkBTjPCoc6
-  UW6on70SFPmAy/5Cq0OJNGEWBfgD9q7rrs/X8GGwUWqXb85RXnUVi/P8Up75E0ag
-  14jEc90kN+C7oI/AGCBN0j6JnEtYIEJZibjjDJTSMWlUKKkj30kq7hlUC2CepJ4v
-  x52qPcexcYZR7w==
-  -----END CERTIFICATE-----
+cert_chain: []
 
-date: 2008-07-20 00:00:00 -07:00
+date: 2008-09-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -45,11 +25,12 @@ dependencies:
       - !ruby/object:Gem::Version 
         version: 1.7.0
     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 the RDoc 1.0.1.  Command-line tools are largely unaffected, but internal APIs may shift rapidly.
+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 the 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: 
 - drbrain@segment7.net
 - ""
 - technomancy@gmail.com
+- tony.strauss@designingpatterns.com
 executables: 
 - rdoc
 - ri
@@ -59,11 +40,13 @@ extra_rdoc_files:
 - History.txt
 - Manifest.txt
 - README.txt
+- RI.txt
 files: 
 - History.txt
 - Manifest.txt
 - README.txt
 - Rakefile
+- RI.txt
 - bin/rdoc
 - bin/ri
 - lib/rdoc.rb
@@ -74,10 +57,12 @@ files:
 - lib/rdoc/generator/chm.rb
 - lib/rdoc/generator/chm/chm.rb
 - lib/rdoc/generator/html.rb
+- lib/rdoc/generator/html/common.rb
 - lib/rdoc/generator/html/frameless.rb
 - lib/rdoc/generator/html/hefss.rb
 - lib/rdoc/generator/html/html.rb
 - lib/rdoc/generator/html/kilmer.rb
+- lib/rdoc/generator/html/kilmerfactory.rb
 - lib/rdoc/generator/html/one_page_html.rb
 - lib/rdoc/generator/ri.rb
 - lib/rdoc/generator/texinfo.rb
@@ -122,10 +107,15 @@ files:
 - lib/rdoc/stats.rb
 - lib/rdoc/template.rb
 - lib/rdoc/tokenstream.rb
+- test/binary.dat
+- test/rdoc_markup_to_html_crossref_reference.rb
 - test/test_rdoc_info_formatting.rb
 - test/test_rdoc_info_sections.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_parser.rb
 - test/test_rdoc_parser_c.rb
 - test/test_rdoc_parser_ruby.rb
 - test/test_rdoc_ri_attribute_formatter.rb
@@ -134,7 +124,7 @@ files:
 - test/test_rdoc_ri_formatter.rb
 - test/test_rdoc_ri_overstrike_formatter.rb
 has_rdoc: true
-homepage: http://rubyforge.org/projects/rdoc/
+homepage: "Project Page: http://rubyforge.org/projects/rdoc/"
 post_install_message: 
 rdoc_options: 
 - --main
@@ -161,16 +151,18 @@ signing_key:
 specification_version: 2
 summary: RDoc is an application that produces documentation for one or more Ruby source files
 test_files: 
-- test/test_rdoc_info_formatting.rb
-- test/test_rdoc_info_sections.rb
-- test/test_rdoc_markup.rb
-- test/test_rdoc_markup_attribute_manager.rb
+- test/test_rdoc_parser.rb
 - test/test_rdoc_markup_to_html.rb
-- test/test_rdoc_markup_to_html_crossref.rb
-- test/test_rdoc_parser_c.rb
-- test/test_rdoc_parser_ruby.rb
-- test/test_rdoc_ri_attribute_formatter.rb
 - test/test_rdoc_ri_default_display.rb
-- test/test_rdoc_ri_driver.rb
+- test/test_rdoc_markup_to_html_crossref.rb
+- test/test_rdoc_info_sections.rb
 - test/test_rdoc_ri_formatter.rb
+- test/test_rdoc_ri_driver.rb
+- test/test_attribute_manager.rb
+- test/test_rdoc_parser_ruby.rb
 - test/test_rdoc_ri_overstrike_formatter.rb
+- test/test_rdoc_markup_attribute_manager.rb
+- test/test_rdoc_info_formatting.rb
+- test/test_rdoc_parser_c.rb
+- test/test_rdoc_ri_attribute_formatter.rb
+- test/test_rdoc_markup.rb

data.tar.gz.sig

@@ -1 +0,0 @@
-U�����5j�_Bf~M�]�h煆�_����-G}�tk��C�{�
6)��6XGÆ���|�����KE��~þ{>�va���RV����B,�0JA��
Kw|ީ7�4�}�P��