rdoc 2.4.3 → 2.5

data/test/test_rdoc_parser_ruby.rb

@@ -1,3 +1,5 @@
+# coding: utf-8
+
 require 'stringio'
 require 'tempfile'
 require 'rubygems'
@@ -158,6 +160,35 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     assert_equal 'hi', @options.title
   end
 
+  def test_parse_alias
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    util_parser "alias :next= :bar"
+
+    tk = @parser.get_tk
+
+    alas = @parser.parse_alias klass, RDoc::Parser::Ruby::NORMAL, tk, 'comment'
+
+    assert_equal 'bar',     alas.old_name
+    assert_equal 'next=',   alas.new_name
+    assert_equal klass,     alas.parent
+    assert_equal 'comment', alas.comment
+  end
+
+  def test_parse_alias_meta
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    util_parser "alias m.chop m"
+
+    tk = @parser.get_tk
+
+    alas = @parser.parse_alias klass, RDoc::Parser::Ruby::NORMAL, tk, 'comment'
+
+    assert_nil alas
+  end
+
   def test_parse_attr
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
@@ -174,7 +205,7 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
 
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
-    assert_equal "##\n# my attr\n", foo.comment
+    assert_equal 'my attr', foo.comment
   end
 
   def test_parse_attr_accessor
@@ -194,12 +225,12 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'RW', foo.rw
-    assert_equal "##\n# my attr\n", foo.comment
+    assert_equal 'my attr', foo.comment
 
     bar = klass.attributes.last
     assert_equal 'bar', bar.name
     assert_equal 'RW', bar.rw
-    assert_equal "##\n# my attr\n", bar.comment
+    assert_equal 'my attr', bar.comment
   end
 
   def test_parse_attr_accessor_writer
@@ -219,12 +250,12 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'W', foo.rw
-    assert_equal "##\n# my attr\n", foo.comment
+    assert_equal "my attr", foo.comment
 
     bar = klass.attributes.last
     assert_equal 'bar', bar.name
     assert_equal 'W', bar.rw
-    assert_equal "##\n# my attr\n", bar.comment
+    assert_equal "my attr", bar.comment
   end
 
   def test_parse_meta_attr
@@ -239,10 +270,11 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
 
     @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment
 
+    assert_equal 2, klass.attributes.length
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'RW', foo.rw
-    assert_equal "##\n# my method\n", foo.comment
+    assert_equal "my method", foo.comment
   end
 
   def test_parse_meta_attr_accessor
@@ -257,10 +289,30 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
 
     @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment
 
+    assert_equal 2, klass.attributes.length
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'RW', foo.rw
-    assert_equal "##\n# my method\n", foo.comment
+    assert_equal 'my method', foo.comment
+  end
+
+  def test_parse_meta_attr_named
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# :attr: foo\n# my method\n"
+
+    util_parser "add_my_method :foo, :bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_meta_attr klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    assert_equal 1, klass.attributes.length
+    foo = klass.attributes.first
+    assert_equal 'foo', foo.name
+    assert_equal 'RW', foo.rw
+    assert_equal 'my method', foo.comment
   end
 
   def test_parse_meta_attr_reader
@@ -278,7 +330,7 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'R', foo.rw
-    assert_equal "##\n# my method\n", foo.comment
+    assert_equal 'my method', foo.comment
   end
 
   def test_parse_meta_attr_writer
@@ -296,7 +348,7 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
     foo = klass.attributes.first
     assert_equal 'foo', foo.name
     assert_equal 'W', foo.rw
-    assert_equal "##\n# my method\n", foo.comment
+    assert_equal "my method", foo.comment
   end
 
   def test_parse_class
@@ -310,7 +362,27 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
 
     foo = @top_level.classes.first
     assert_equal 'Foo', foo.full_name
-    assert_equal comment, foo.comment
+    assert_equal 'my method', foo.comment
+  end
+
+  def test_parse_class_ghost_method
+    util_parser <<-CLASS
+class Foo
+  ##
+  # :method: blah
+  # my method
+end
+    CLASS
+
+    tk = @parser.get_tk
+
+    @parser.parse_class @top_level, RDoc::Parser::Ruby::NORMAL, tk, ''
+
+    foo = @top_level.classes.first
+    assert_equal 'Foo', foo.full_name
+
+    blah = foo.method_list.first
+    assert_equal 'Foo#blah', blah.full_name
   end
 
   def test_parse_class_nested_superclass
@@ -338,7 +410,38 @@ class TestRDocParserRuby < MiniTest::Unit::TestCase
 
     foo = @top_level.modules.first
     assert_equal 'Foo', foo.full_name
-    assert_equal comment, foo.comment
+    assert_equal 'my module', foo.comment
+  end
+
+  def test_parse_class_colon3
+    code = <<-CODE
+class A
+  class ::B
+  end
+end
+    CODE
+
+    util_parser code
+
+    @parser.parse_class @top_level, false, @parser.get_tk, ''
+
+    assert_equal %w[A B],    RDoc::TopLevel.classes.map { |c| c.full_name }
+  end
+
+  def test_parse_class_single
+    code = <<-CODE
+class A
+  class << B
+  end
+end
+    CODE
+
+    util_parser code
+
+    @parser.parse_class @top_level, false, @parser.get_tk, ''
+
+    assert_equal %w[A],    RDoc::TopLevel.classes.map { |c| c.full_name }
+    assert_equal %w[A::B], RDoc::TopLevel.modules.map { |c| c.full_name }
   end
 
   def test_parse_class_mistaken_for_module
@@ -422,7 +525,7 @@ EOF
 
     foo = @top_level.modules.first
     assert_equal 'Foo', foo.full_name
-    assert_equal comment, foo.comment
+    assert_equal 'Weirdly named module', foo.comment
 
     helper = foo.classes.first
     assert_equal 'Foo::Helper', helper.full_name
@@ -443,7 +546,7 @@ EOF
     foo = klass.attributes.first
     assert_equal 'foo',     foo.name
     assert_equal 'RW',      foo.rw
-    assert_equal comment,   foo.comment
+    assert_equal 'my attr',   foo.comment
 
     assert_equal nil,       foo.viewer
     assert_equal true,      foo.document_children
@@ -470,7 +573,7 @@ EOF
 
     foo = klass.method_list.first
     assert_equal 'foo',     foo.name
-    assert_equal comment,   foo.comment
+    assert_equal 'my method',   foo.comment
 
     assert_equal [],        foo.aliases
     assert_equal nil,       foo.block_params
@@ -492,12 +595,42 @@ EOF
     stream = [
       tk(:COMMENT, 1, 1, nil, "# File #{@top_level.absolute_name}, line 1"),
       RDoc::Parser::Ruby::NEWLINE_TOKEN,
-      tk(:SPACE,      1, 1,  nil,   ''),
+      tk(:SPACE,   1, 1, nil, ''),
     ]
 
     assert_equal stream, foo.token_stream
   end
 
+  def test_parse_constant_alias
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+    cB = klass.add_class RDoc::NormalClass, 'B'
+
+    util_parser "A = B"
+
+    tk = @parser.get_tk
+
+    @parser.parse_constant klass, tk, ''
+
+    assert_equal cB, klass.find_module_named('A')
+  end
+
+  def test_parse_constant_alias_same_name
+    foo = @top_level.add_class RDoc::NormalClass, 'Foo'
+    top_bar = @top_level.add_class RDoc::NormalClass, 'Bar'
+    bar = foo.add_class RDoc::NormalClass, 'Bar'
+
+    assert RDoc::TopLevel.find_class_or_module('::Bar')
+
+    util_parser "A = ::Bar"
+
+    tk = @parser.get_tk
+
+    @parser.parse_constant foo, tk, ''
+
+    assert_equal top_bar, bar.find_module_named('A')
+  end
+
   def test_parse_meta_method
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
@@ -512,7 +645,7 @@ EOF
 
     foo = klass.method_list.first
     assert_equal 'foo', foo.name
-    assert_equal comment, foo.comment
+    assert_equal 'my method', foo.comment
 
     assert_equal [],      foo.aliases
     assert_equal nil,     foo.block_params
@@ -532,7 +665,7 @@ EOF
     assert_equal klass.current_section, foo.section
 
     stream = [
-      tk(:COMMENT, 1, 1, nil, "# File #{@top_level.absolute_name}, line 1"),
+      tk(:COMMENT,    1, 1,  nil, "# File #{@top_level.absolute_name}, line 1"),
       RDoc::Parser::Ruby::NEWLINE_TOKEN,
       tk(:SPACE,      1, 1,  nil, ''),
       tk(:IDENTIFIER, 1, 0,  'add_my_method', 'add_my_method'),
@@ -561,7 +694,7 @@ EOF
 
     foo = klass.method_list.first
     assert_equal 'woo_hoo!', foo.name
-    assert_equal "##\n# my method\n", foo.comment
+    assert_equal 'my method', foo.comment
   end
 
   def test_parse_meta_method_singleton
@@ -579,7 +712,7 @@ EOF
     foo = klass.method_list.first
     assert_equal 'foo', foo.name
     assert_equal true, foo.singleton, 'singleton method'
-    assert_equal "##\n# my method\n", foo.comment
+    assert_equal 'my method', foo.comment
   end
 
   def test_parse_meta_method_singleton_name
@@ -597,7 +730,7 @@ EOF
     foo = klass.method_list.first
     assert_equal 'woo_hoo!', foo.name
     assert_equal true, foo.singleton, 'singleton method'
-    assert_equal "##\n# my method\n", foo.comment
+    assert_equal 'my method', foo.comment
   end
 
   def test_parse_meta_method_string_name
@@ -612,7 +745,7 @@ EOF
 
     foo = klass.method_list.first
     assert_equal 'foo', foo.name
-    assert_equal comment, foo.comment
+    assert_equal 'my method', foo.comment
   end
 
   def test_parse_meta_method_unknown
@@ -627,7 +760,7 @@ EOF
 
     foo = klass.method_list.first
     assert_equal 'unknown', foo.name
-    assert_equal comment, foo.comment
+    assert_equal 'my method', foo.comment
   end
 
   def test_parse_method
@@ -644,7 +777,7 @@ EOF
 
     foo = klass.method_list.first
     assert_equal 'foo',     foo.name
-    assert_equal comment,   foo.comment
+    assert_equal 'my method',   foo.comment
 
     assert_equal [],        foo.aliases
     assert_equal nil,       foo.block_params
@@ -664,7 +797,7 @@ EOF
     assert_equal klass.current_section, foo.section
 
     stream = [
-      tk(:COMMENT, 1, 1, nil, "# File #{@top_level.absolute_name}, line 1"),
+      tk(:COMMENT,    1, 1,  nil, "# File #{@top_level.absolute_name}, line 1"),
       RDoc::Parser::Ruby::NEWLINE_TOKEN,
       tk(:SPACE,      1, 1,  nil,   ''),
       tk(:DEF,        1, 0,  'def', 'def'),
@@ -682,6 +815,39 @@ EOF
     assert_equal stream, foo.token_stream
   end
 
+  def test_parse_method_alias
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    util_parser "def m() alias a b; end"
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+
+    assert klass.aliases.empty?
+  end
+
+  def test_parse_method_utf8
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    comment = "##\n# my method\n"
+
+    method = "def ω() end"
+
+    assert_equal Encoding::UTF_8, method.encoding if defined? ::Encoding
+
+    util_parser method
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, comment
+
+    omega = klass.method_list.first
+    assert_equal "def \317\211", omega.text
+  end
+
   def test_parse_method_funky
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
@@ -697,6 +863,32 @@ EOF
     assert klass.method_list.empty?
   end
 
+  def test_parse_method_internal_ivar
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    util_parser "def foo() def @blah.bar() end end"
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+
+    assert_equal 1, klass.method_list.length
+  end
+
+  def test_parse_method_internal_lvar
+    klass = RDoc::NormalClass.new 'Foo'
+    klass.parent = @top_level
+
+    util_parser "def foo() def blah.bar() end end"
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+
+    assert_equal 1, klass.method_list.length
+  end
+
   def test_parse_method_no_parens
     klass = RDoc::NormalClass.new 'Foo'
     klass.parent = @top_level
@@ -762,6 +954,21 @@ EOF
     assert_equal 'Object#foo', foo.full_name
   end
 
+  def test_parse_method_toplevel_class
+    klass = @top_level
+
+    util_parser "def Object.foo arg1, arg2\nend"
+
+    tk = @parser.get_tk
+
+    @parser.parse_method klass, RDoc::Parser::Ruby::NORMAL, tk, ''
+
+    object = RDoc::TopLevel.find_class_named 'Object'
+
+    foo = object.method_list.first
+    assert_equal 'Object::foo', foo.full_name
+  end
+
   def test_parse_statements_class_if
     comment = "##\n# my method\n"
 
@@ -798,7 +1005,7 @@ end
 
     bar = foo.classes.first
     assert_equal 'Foo::Bar', bar.full_name, 'class Foo::Bar'
-    assert_equal comment, bar.comment
+    assert_equal 'my method', bar.comment
   end
 
   def test_parse_statements_identifier_meta_method
@@ -1003,14 +1210,70 @@ EOF
     assert_equal 1, @top_level.requires.length
   end
 
+  def test_parse_top_level_statements_alias_method
+    content = <<-CONTENT
+class A
+  alias_method :a, :[] unless c
+end
+
+B = A
+
+class C
+end
+    CONTENT
+
+    util_parser content
+
+    @parser.parse_statements @top_level
+  end
+
+  def test_sanity_integer
+    util_parser '1'
+    assert_equal '1', @parser.get_tk.text
+
+    util_parser '1.0'
+    assert_equal '1.0', @parser.get_tk.text
+  end
+
+  def test_sanity_interpolation
+    last_tk = nil
+    util_parser 'class A; B = "#{c}"; end'
+
+    while tk = @parser.get_tk do last_tk = tk end
+    
+    assert_equal "\n", last_tk.text
+  end
+
+  # If you're writing code like this you're doing it wrong
+
+  def x_test_sanity_interpolation_crazy
+    last_tk = nil
+    util_parser '"#{"#{"a")}" if b}"'
+
+    assert_equal RDoc::RubyToken::TkDSTRING, tk.class
+    assert_equal RDoc::RubyToken::TkNL, @parser.get_tk.class
+  end
+
+  def test_sanity_interpolation_format
+    util_parser '"#{stftime("%m-%d")}"'
+
+    while tk = @parser.get_tk do end
+  end
+
+  def test_sanity_symbol_interpolation
+    util_parser ':"#{bar}="'
+
+    while tk = @parser.get_tk do end
+  end
+
   def tk(klass, line, char, name, text)
     klass = RDoc::RubyToken.const_get "Tk#{klass.to_s.upcase}"
 
-    token = if klass.instance_method(:initialize).arity == 2 then
+    token = if klass.instance_method(:initialize).arity == 3 then
               raise ArgumentError, "name not used for #{klass}" unless name.nil?
-              klass.new line, char
+              klass.new nil, line, char
             else
-              klass.new line, char, name
+              klass.new nil, line, char, name
             end
 
     token.set_text text