rdoc 3.4 → 3.5

data/test/test_rdoc_parser_ruby.rb

@@ -32,6 +32,36 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     @tempfile2.close
   end
 
+  def test_collect_first_comment
+    p = util_parser <<-CONTENT
+# first
+
+# second
+class C; end
+    CONTENT
+
+    comment = p.collect_first_comment
+
+    assert_equal "# first\n", comment
+  end
+
+  def test_collect_first_comment_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    @options.encoding = Encoding::CP852
+
+    p = util_parser <<-CONTENT
+# first
+
+# second
+class C; end
+    CONTENT
+
+    comment = p.collect_first_comment
+
+    assert_equal Encoding::CP852, comment.encoding
+  end
+
   def test_extract_call_seq
     m = RDoc::AnyMethod.new nil, 'm'
     p = util_parser ''
@@ -156,6 +186,42 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     assert_equal expected, comment
   end
 
+  def test_remove_private_comments_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    util_parser ''
+
+    comment = <<-EOS
+# This is text
+#--
+# this is private
+    EOS
+    comment.force_encoding Encoding::IBM437
+
+    @parser.remove_private_comments comment
+
+    assert_equal Encoding::IBM437, comment.encoding
+  end
+
+  def test_remove_private_comments_long
+    util_parser ''
+
+    comment = <<-EOS
+#-----
+#++
+# this is text
+#-----
+    EOS
+
+    expected = <<-EOS
+# this is text
+    EOS
+
+    @parser.remove_private_comments(comment)
+
+    assert_equal expected, comment
+  end
+
   def test_remove_private_comments_rule
     util_parser ''
 
@@ -193,6 +259,45 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     assert_equal expected, comment
   end
 
+  def test_remove_private_comments_toggle_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    util_parser ''
+
+    comment = <<-EOS
+# This is text
+#--
+# this is private
+#++
+# This is text again.
+    EOS
+
+    comment.force_encoding Encoding::IBM437
+
+    @parser.remove_private_comments comment
+
+    assert_equal Encoding::IBM437, comment.encoding
+  end
+
+  def test_remove_private_comments_toggle_encoding_ruby_bug?
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    util_parser ''
+
+    comment = <<-EOS
+#--
+# this is private
+#++
+# This is text again.
+    EOS
+
+    comment.force_encoding Encoding::IBM437
+
+    @parser.remove_private_comments comment
+
+    assert_equal Encoding::IBM437, comment.encoding
+  end
+
   def test_look_for_directives_in_commented
     util_parser ""
 
@@ -310,6 +415,8 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     assert_equal klass,      alas.parent
     assert_equal 'comment',  alas.comment
     assert_equal @top_level, alas.file
+    assert_equal 0,          alas.offset
+    assert_equal 1,          alas.line
   end
 
   def test_parse_alias_singleton
@@ -361,6 +468,8 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     assert_equal 'foo', foo.name
     assert_equal 'my attr', foo.comment
     assert_equal @top_level, foo.file
+    assert_equal 0, foo.offset
+    assert_equal 1, foo.line
   end
 
   def test_parse_attr_accessor
@@ -382,6 +491,8 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     assert_equal 'RW', foo.rw
     assert_equal 'my attr', foo.comment
     assert_equal @top_level, foo.file
+    assert_equal 0, foo.offset
+    assert_equal 1, foo.line
 
     bar = klass.attributes.last
     assert_equal 'bar', bar.name
@@ -540,6 +651,9 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     foo = @top_level.classes.first
     assert_equal 'Foo', foo.full_name
     assert_equal 'my method', foo.comment
+    assert_equal [@top_level], foo.in_files
+    assert_equal 0, foo.offset
+    assert_equal 1, foo.line
   end
 
   def test_parse_class_ghost_method
@@ -705,6 +819,10 @@ end
     assert_equal %w[A],    RDoc::TopLevel.classes.map { |c| c.full_name }
     assert_equal %w[A::B A::d], RDoc::TopLevel.modules.map { |c| c.full_name }
 
+    b = RDoc::TopLevel.modules.first
+    assert_equal 10, b.offset
+    assert_equal 2,  b.line
+
     # make sure method/alias was not added to enclosing class/module
     a = RDoc::TopLevel.all_classes_hash['A']
     assert_empty a.method_list
@@ -843,6 +961,8 @@ EOF
     assert_equal 'RW',       foo.rw
     assert_equal 'my attr',  foo.comment
     assert_equal @top_level, foo.file
+    assert_equal 0,          foo.offset
+    assert_equal 1,          foo.line
 
     assert_equal nil,        foo.viewer
     assert_equal true,       foo.document_children
@@ -872,6 +992,8 @@ EOF
     assert_equal 'foo',       foo.name
     assert_equal 'my method', foo.comment
     assert_equal @top_level,  foo.file
+    assert_equal 0,           foo.offset
+    assert_equal 1,           foo.line
 
     assert_equal [],        foo.aliases
     assert_equal nil,       foo.block_params
@@ -899,6 +1021,25 @@ EOF
     assert_equal stream, foo.token_stream
   end
 
+  def test_parse_constant
+    util_top_level
+
+    klass = @top_level.add_class RDoc::NormalClass, 'Foo'
+
+    util_parser "A = v"
+
+    tk = @parser.get_tk
+
+    @parser.parse_constant klass, tk, ''
+
+    foo = klass.constants.first
+
+    assert_equal 'A', foo.name
+    assert_equal @top_level, foo.file
+    assert_equal 0, foo.offset
+    assert_equal 1, foo.line
+  end
+
   def test_parse_constant_attrasgn
     util_top_level
 
@@ -959,6 +1100,8 @@ EOF
     assert_equal 'foo',       foo.name
     assert_equal 'my method', foo.comment
     assert_equal @top_level,  foo.file
+    assert_equal 0,           foo.offset
+    assert_equal 1,           foo.line
 
     assert_equal [],      foo.aliases
     assert_equal nil,     foo.block_params
@@ -1118,6 +1261,8 @@ end
     assert_equal 'foo',       foo.name
     assert_equal 'my method', foo.comment
     assert_equal @top_level,  foo.file
+    assert_equal 0,           foo.offset
+    assert_equal 1,           foo.line
 
     assert_equal [],        foo.aliases
     assert_equal nil,       foo.block_params
@@ -1399,6 +1544,28 @@ end
     assert_equal 'my method', bar.comment
   end
 
+  def test_parse_statements_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+    @options.encoding = Encoding::CP852
+
+    content = <<-EOF
+class Foo
+  ##
+  # this is my method
+  add_my_method :foo
+end
+    EOF
+
+    util_parser content
+
+    @parser.parse_statements @top_level
+
+    foo = @top_level.classes.first.method_list.first
+    assert_equal 'foo', foo.name
+    assert_equal 'this is my method', foo.comment
+    assert_equal Encoding::CP852, foo.comment.encoding
+  end
+
   def test_parse_statements_identifier_meta_method
     content = <<-EOF
 class Foo
@@ -1410,7 +1577,7 @@ end
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo = @top_level.classes.first.method_list.first
     assert_equal 'foo', foo.name
@@ -1426,7 +1593,7 @@ end
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo = @top_level.classes.first.method_list[0]
     assert_equal 'foo', foo.name
@@ -1459,7 +1626,7 @@ EOF
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo = @top_level.classes.first.method_list[0]
     assert_equal 'foo', foo.name
@@ -1525,7 +1692,7 @@ EOF
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     constants = @top_level.classes.first.constants
 
@@ -1572,7 +1739,7 @@ EOF
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo = @top_level.classes.first.attributes.first
     assert_equal 'foo', foo.name
@@ -1584,7 +1751,7 @@ EOF
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo = @top_level.classes.first.attributes.first
     assert_equal 'foo', foo.name
@@ -1596,7 +1763,7 @@ EOF
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo = @top_level.classes.first
     assert_equal 'Foo', foo.name
@@ -1608,7 +1775,7 @@ EOF
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo, s_foo = @top_level.modules.first.method_list
     assert_equal 'foo',    foo.name,       'instance method name'
@@ -1625,7 +1792,7 @@ EOF
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo = @top_level.classes.first.method_list.first
     assert_equal 'foo', foo.name
@@ -1637,7 +1804,7 @@ EOF
 
     util_parser content
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     assert_equal 1, @top_level.requires.length
   end
@@ -1655,7 +1822,7 @@ class A
 end
     RUBY
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     c_a = @top_level.classes.first
     assert_equal 'A', c_a.full_name
@@ -1847,7 +2014,7 @@ class C
       end
     EOS
 
-    @parser.parse_statements @top_level, RDoc::Parser::Ruby::NORMAL, nil, ''
+    @parser.parse_statements @top_level
 
     foo = @top_level.modules.first.modules.first
     assert_equal 'Foo', foo.name

data/test/test_rdoc_text.rb

@@ -134,6 +134,31 @@ The comments associated with
     assert_equal expected, strip_hashes(text)
   end
 
+  def test_strip_hashes_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    text = <<-TEXT
+##
+# we don't worry too much.
+#
+# The comments associated with
+    TEXT
+
+    text.force_encoding Encoding::CP852
+
+    expected = <<-EXPECTED
+
+  we don't worry too much.
+
+  The comments associated with
+    EXPECTED
+
+    stripped = strip_hashes text
+
+    assert_equal expected, stripped
+    assert_equal Encoding::CP852, stripped.encoding
+  end
+
   def test_strip_newlines
     assert_equal ' ',  strip_newlines("\n \n")
 
@@ -178,6 +203,30 @@ The comments associated with
     assert_equal expected, strip_stars(text)
   end
 
+  def test_strip_stars_encoding
+    skip "Encoding not implemented" unless Object.const_defined? :Encoding
+
+    text = <<-TEXT
+/*
+ * * we don't worry too much.
+ *
+ * The comments associated with
+ */
+    TEXT
+
+    text.force_encoding Encoding::CP852
+
+    expected = <<-EXPECTED
+
+   * we don't worry too much.
+
+   The comments associated with
+    EXPECTED
+
+    assert_equal expected, strip_stars(text)
+    assert_equal Encoding::CP852, text.encoding
+  end
+
   def test_to_html_apostrophe
     assert_equal '‘a', to_html("'a")
     assert_equal 'a’', to_html("a'")

data/test/test_rdoc_top_level.rb

@@ -28,7 +28,7 @@ class TestRDocTopLevel < XrefTestCase
   end
 
   def test_class_complete
-    @c2.add_module_alias @c2_c3, 'A1'
+    @c2.add_module_alias @c2_c3, 'A1', @top_level
 
     RDoc::TopLevel.complete :public
 

metadata

@@ -1,12 +1,12 @@
 --- !ruby/object:Gem::Specification 
 name: rdoc
 version: !ruby/object:Gem::Version 
-  hash: 15
-  prerelease: false
+  hash: 13
+  prerelease: 
   segments: 
   - 3
-  - 4
-  version: "3.4"
+  - 5
+  version: "3.5"
 platform: ruby
 authors: 
 - Eric Hodel
@@ -38,29 +38,13 @@ cert_chain:
   x52qPcexcYZR7w==
   -----END CERTIFICATE-----
 
-date: 2011-01-06 00:00:00 -08:00
+date: 2011-01-29 00:00:00 -08:00
 default_executable: 
 dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: rubyforge
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 2
-        - 0
-        - 4
-        version: 2.0.4
-  type: :development
-  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: minitest
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  requirement: &id001 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
@@ -72,11 +56,11 @@ dependencies:
         - 2
         version: 2.0.2
   type: :development
-  version_requirements: *id002
+  version_requirements: *id001
 - !ruby/object:Gem::Dependency 
   name: minitest
   prerelease: false
-  requirement: &id003 !ruby/object:Gem::Requirement 
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -86,11 +70,11 @@ dependencies:
         - 2
         version: "2"
   type: :development
-  version_requirements: *id003
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: isolate
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -100,11 +84,11 @@ dependencies:
         - 3
         version: "3"
   type: :development
-  version_requirements: *id004
+  version_requirements: *id003
 - !ruby/object:Gem::Dependency 
   name: ZenTest
   prerelease: false
-  requirement: &id005 !ruby/object:Gem::Requirement 
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
@@ -114,23 +98,23 @@ dependencies:
         - 4
         version: "4"
   type: :development
-  version_requirements: *id005
+  version_requirements: *id004
 - !ruby/object:Gem::Dependency 
   name: hoe
   prerelease: false
-  requirement: &id006 !ruby/object:Gem::Requirement 
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 19
+        hash: 47
         segments: 
         - 2
-        - 7
+        - 8
         - 0
-        version: 2.7.0
+        version: 2.8.0
   type: :development
-  version_requirements: *id006
+  version_requirements: *id005
 description: |-
   RDoc produces HTML and command-line documentation for Ruby projects.  RDoc
   includes the +rdoc+ and +ri+ tools for generating and displaying online
@@ -319,6 +303,7 @@ files:
 - test/test_rdoc_top_level.rb
 - test/xref_data.rb
 - test/xref_test_case.rb
+- .gemtest
 has_rdoc: true
 homepage: http://rdoc.rubyforge.org
 licenses: []
@@ -368,7 +353,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: rdoc
-rubygems_version: 1.3.7
+rubygems_version: 1.4.2
 signing_key: 
 specification_version: 3
 summary: RDoc produces HTML and command-line documentation for Ruby projects