rdoc 3.5.3 → 3.6

data/test/test_rdoc_markup_parser.rb

@@ -625,6 +625,25 @@ for all good men
     assert_equal expected, @RMP.parse(str).parts
   end
 
+  def test_parse_rule
+    str = <<-STR
+now is the time
+
+---
+
+for all good men
+    STR
+
+    expected = [
+      @RM::Paragraph.new('now is the time'),
+      @RM::BlankLine.new,
+      @RM::Rule.new(1),
+      @RM::BlankLine.new,
+      @RM::Paragraph.new('for all good men')]
+
+    assert_equal expected, @RMP.parse(str).parts
+  end
+
   def test_parse_ualpha
     str = <<-STR
 A. l1

data/test/test_rdoc_options.rb

@@ -17,26 +17,16 @@ class TestRDocOptions < MiniTest::Unit::TestCase
   end
 
   def test_check_files
+    skip "assumes UNIX permission model" if /mswin|mingw/ =~ RUBY_PLATFORM
     out, err = capture_io do
       Dir.mktmpdir do |dir|
-        begin
-          unreadable = nil # variable for windows
-
-          Dir.chdir dir do
-            if RUBY_PLATFORM =~ /mswin|mingw/ then
-              unreadable = open 'unreadable'
-              File.delete 'unreadable'
-            else
-              FileUtils.touch 'unreadable'
-              FileUtils.chmod 0, 'unreadable'
-            end
-
-            @options.files = %w[nonexistent unreadable]
-
-            @options.check_files
-          end
-        ensure
-          unreadable.close if unreadable
+        Dir.chdir dir do
+          FileUtils.touch 'unreadable'
+          FileUtils.chmod 0, 'unreadable'
+
+          @options.files = %w[nonexistent unreadable]
+
+          @options.check_files
         end
       end
     end

data/test/test_rdoc_parser_c.rb

@@ -680,7 +680,7 @@ Init_Foo(void) {
 
     baz = methods.last
     assert_equal 'Foo#baz', baz.full_name
-    assert_equal "a comment for bar", bar.comment
+    assert_equal "a comment for bar", baz.comment
   end
 
   def test_find_modifiers_call_seq
@@ -911,6 +911,37 @@ rb_io_s_read(argc, argv, io)
 {
 }
 
+void
+Init_IO(void) {
+    /*
+     * a comment for class Foo on rb_define_class
+     */
+    VALUE rb_cIO = rb_define_class("IO", rb_cObject);
+    rb_define_singleton_method(rb_cIO, "read", rb_io_s_read, -1);
+}
+    EOF
+
+    klass = util_get_class content, 'rb_cIO'
+    read_method = klass.method_list.first
+    assert_equal "read", read_method.name
+    assert_equal "Method Comment!   ", read_method.comment
+    assert_equal "rb_io_s_read", read_method.c_function
+    assert read_method.singleton
+  end
+
+  def test_define_method_with_prototype
+    content = <<-EOF
+static VALUE rb_io_s_read(int, VALUE*, VALUE);
+
+/* Method Comment! */
+static VALUE
+rb_io_s_read(argc, argv, io)
+    int argc;
+    VALUE *argv;
+    VALUE io;
+{
+}
+
 void
 Init_IO(void) {
     /*

data/test/test_rdoc_parser_ruby.rb

@@ -1799,6 +1799,56 @@ EOF
     assert_equal :private, foo.visibility
   end
 
+  def test_parse_statements_identifier_public_class_method
+    content = <<-CONTENT
+class Date
+  def self.now; end
+  private_class_method :now
+end
+
+class DateTime < Date
+  public_class_method :now
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.parse_statements @top_level
+
+    date, date_time = @top_level.classes
+
+    date_now      = date.method_list.first
+    date_time_now = date_time.method_list.first
+
+    assert_equal :private, date_now.visibility
+    assert_equal :public,  date_time_now.visibility
+  end
+
+  def test_parse_statements_identifier_private_class_method
+    content = <<-CONTENT
+class Date
+  def self.now; end
+  public_class_method :now
+end
+
+class DateTime < Date
+  private_class_method :now
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.parse_statements @top_level
+
+    date, date_time = @top_level.classes
+
+    date_now      = date.method_list.first
+    date_time_now = date_time.method_list.first
+
+    assert_equal :public,  date_now.visibility,      date_now.full_name
+    assert_equal :private, date_time_now.visibility, date_time_now.full_name
+  end
+
   def test_parse_statements_identifier_require
     content = "require 'bar'"
 
@@ -1978,6 +2028,53 @@ end
     assert_equal 'm comment', m.comment
   end
 
+  def test_scan_block_comment_notflush
+  ##
+  #
+  # The previous test assumes that between the =begin/=end blocs that there is
+  # only one line, or minima formatting directives. This test tests for those
+  # who use the =begin bloc with longer / more advanced formatting within.
+  #
+  ##
+    content = <<-CONTENT
+=begin rdoc
+
+= DESCRIPTION
+
+This is a simple test class
+
+= RUMPUS
+
+Is a silly word
+
+=end
+class StevenSimpleClass
+  # A band on my iPhone as I wrote this test
+  FRUIT_BATS="Make nice music"
+
+=begin rdoc
+A nice girl
+=end
+
+  def lauren
+    puts "Summoning Lauren!"
+  end
+end
+    CONTENT
+    util_parser content
+
+    @parser.scan
+
+    foo = @top_level.classes.first
+
+    assert_equal "= DESCRIPTION\n\nThis is a simple test class\n\n= RUMPUS\n\nIs a silly word", 
+      foo.comment
+
+    m = foo.method_list.first
+
+    assert_equal 'A nice girl', m.comment
+  end
+
   def test_scan_meta_method_block
     content = <<-CONTENT
 class C

data/test/test_rdoc_ri_driver.rb

@@ -3,6 +3,7 @@ require 'rubygems'
 require 'minitest/autorun'
 require 'tmpdir'
 require 'fileutils'
+require 'stringio'
 require 'rdoc/ri/driver'
 
 class TestRDocRIDriver < MiniTest::Unit::TestCase
@@ -249,12 +250,14 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
 
     @driver.stores = [store]
 
-    assert_equal %w[Foo Foo::Bar], @driver.complete('F')
+    assert_equal %w[Foo         ], @driver.complete('F')
     assert_equal %w[    Foo::Bar], @driver.complete('Foo::B')
 
-    assert_equal %w[Foo#Bar],           @driver.complete('Foo#'),  'Foo#'
-    assert_equal %w[Foo#Bar  Foo::bar], @driver.complete('Foo.'),  'Foo.'
-    assert_equal %w[Foo::Bar Foo::bar], @driver.complete('Foo::'), 'Foo::'
+    assert_equal %w[Foo#Bar],           @driver.complete('Foo#'),   'Foo#'
+    assert_equal %w[Foo#Bar  Foo::bar], @driver.complete('Foo.'),   'Foo.'
+    assert_equal %w[Foo::Bar Foo::bar], @driver.complete('Foo::'),  'Foo::'
+
+    assert_equal %w[         Foo::bar], @driver.complete('Foo::b'), 'Foo::b'
   end
 
   def test_complete_ancestor
@@ -269,7 +272,7 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
   def test_complete_classes
     util_store
 
-    assert_equal %w[Foo   Foo::Bar Foo::Baz], @driver.complete('F')
+    assert_equal %w[Foo                    ], @driver.complete('F')
     assert_equal %w[Foo:: Foo::Bar Foo::Baz], @driver.complete('Foo::')
     assert_equal %w[      Foo::Bar Foo::Baz], @driver.complete('Foo::B')
   end
@@ -278,7 +281,8 @@ class TestRDocRIDriver < MiniTest::Unit::TestCase
     util_multi_store
 
     assert_equal %w[Bar], @driver.complete('B')
-    assert_equal %w[Foo Foo::Bar Foo::Baz], @driver.complete('F')
+    assert_equal %w[Foo], @driver.complete('F')
+    assert_equal %w[Foo::Bar Foo::Baz], @driver.complete('Foo::B')
   end
 
   def test_display
@@ -572,11 +576,18 @@ Foo::Bar#bother
   def test_name_regexp
     assert_equal %r%^RDoc::AnyMethod#new$%,
                  @driver.name_regexp('RDoc::AnyMethod#new')
+
     assert_equal %r%^RDoc::AnyMethod::new$%,
                  @driver.name_regexp('RDoc::AnyMethod::new')
 
     assert_equal %r%^RDoc::AnyMethod(#|::)new$%,
                  @driver.name_regexp('RDoc::AnyMethod.new')
+
+    assert_equal %r%^Hash(#|::)\[\]$%,
+                 @driver.name_regexp('Hash.[]')
+
+    assert_equal %r%^Hash::\[\]$%,
+                 @driver.name_regexp('Hash::[]')
   end
 
   def test_list_known_classes
@@ -589,6 +600,16 @@ Foo::Bar#bother
     assert_equal "Ambiguous\nFoo\nFoo::Bar\nFoo::Baz\nInc\n", out
   end
 
+  def test_list_known_classes_name
+    util_store
+
+    out, = capture_io do
+      @driver.list_known_classes %w[F I]
+    end
+
+    assert_equal "Foo\nFoo::Bar\nFoo::Baz\nInc\n", out
+  end
+
   def test_list_methods_matching
     util_store
 
@@ -596,6 +617,24 @@ Foo::Bar#bother
                  @driver.list_methods_matching('Foo::Bar.')
   end
 
+  def test_list_methods_matching_regexp
+    util_store
+
+    index = RDoc::AnyMethod.new nil, '[]'
+    @cFoo.add_method index
+    @store.save_method @cFoo, index
+
+    c_index = RDoc::AnyMethod.new nil, '[]'
+    c_index.singleton = true
+    @cFoo.add_method c_index
+    @store.save_method @cFoo, c_index
+
+    @store.save_cache
+
+    assert_equal %w[Foo#[]], @driver.list_methods_matching('Foo#[]')
+    assert_equal %w[Foo::[]], @driver.list_methods_matching('Foo::[]')
+  end
+
   def test_load_method
     util_store
 

data/test/test_rdoc_top_level.rb

@@ -12,7 +12,10 @@ class TestRDocTopLevel < XrefTestCase
 
   def test_class_all_classes_and_modules
     expected = %w[
-      C1 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4 C5 C5::C1 M1 M1::M2
+      C1 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4 C5 C5::C1
+      Child
+      M1 M1::M2
+      Parent
     ]
 
     assert_equal expected,
@@ -22,6 +25,7 @@ class TestRDocTopLevel < XrefTestCase
   def test_class_classes
     expected = %w[
       C1 C2 C2::C3 C2::C3::H1 C3 C3::H1 C3::H2 C4 C4::C4 C5 C5::C1
+      Child Parent
     ]
 
     assert_equal expected, RDoc::TopLevel.classes.map { |m| m.full_name }.sort

data/test/xref_data.rb

@@ -63,5 +63,14 @@ end
 
 module M1::M2
 end
+
+class Parent
+  def m() end
+  def self.m() end
+end
+
+class Child < Parent
+end
+
 XREF_DATA
 

data/test/xref_test_case.rb

@@ -38,7 +38,6 @@ class XrefTestCase < MiniTest::Unit::TestCase
     @c1_m  = @c1.method_list.last  # C1#m
     @c1__m = @c1.method_list.first # C1::m
 
-
     @c2    = @xref_data.find_module_named 'C2'
     @c2_a  = @c2.method_list.last
     @c2_b  = @c2.method_list.first
@@ -55,6 +54,12 @@ class XrefTestCase < MiniTest::Unit::TestCase
     @m1_m  = @m1.method_list.first
 
     @m1_m2 = @xref_data.find_module_named 'M1::M2'
+
+    @parent = @xref_data.find_module_named 'Parent'
+    @child  = @xref_data.find_module_named 'Child'
+
+    @parent_m  = @parent.method_list.first # Parent#m
+    @parent__m = @parent.method_list.last  # Parent::m
   end
 
 end

metadata

@@ -1,13 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 21
+  hash: 11
   prerelease: 
   segments: 
   - 3
-  - 5
-  - 3
-  version: 3.5.3
+  - 6
+  version: "3.6"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -39,8 +38,7 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-02-06 00:00:00 -08:00
-default_executable: 
+date: 2011-05-14 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: minitest
@@ -108,12 +106,12 @@ dependencies:
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 43
+        hash: 35
         segments: 
         - 2
         - 9
-        - 0
-        version: 2.9.0
+        - 4
+        version: 2.9.4
   type: :development
   version_requirements: *id005
 description: |-
@@ -306,33 +304,10 @@ files:
 - test/xref_data.rb
 - test/xref_test_case.rb
 - .gemtest
-has_rdoc: true
-homepage: http://rdoc.rubyforge.org
+homepage: http://docs.seattlerb.org/rdoc
 licenses: []
 
-post_install_message: |
-  NOTE: If you are running Ruby 1.9.2 you can ignore this message.
-  
-  RDoc 2.5+ has a new ri data format for Ruby 1.8.7 and 1.9.1.  (1.9.2 contains
-  RDoc 2.5 so there is nothing to do!)
-  
-  To install new ri data for core and stdlib you'll need to:
-  
-    gem install rdoc-data
-  
-  then run:
-  
-    rdoc-data --install
-  
-  To have ri data for you gems you'll also need to run:
-  
-    gem rdoc --all --overwrite
-  
-  If you don't want to rebuild the rdoc for `gem server`, add --no-rdoc.
-  
-  NOTE:  RDoc 2.5 did not save method parameters, so you should upgrade your
-  rdoc-data gem to a version >= 2.5.3 if you installed an older version.
-
+post_install_message: 
 rdoc_options: 
 - --main
 - README.txt
@@ -362,7 +337,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rdoc
-rubygems_version: 1.5.0
+rubygems_version: 1.8.2
 signing_key: 
 specification_version: 3
 summary: RDoc produces HTML and command-line documentation for Ruby projects