rdoc 3.4 → 3.5

data/lib/rdoc/parser/ruby.rb

@@ -174,6 +174,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
     @scanner.exception_on_syntax_error = false
     @prev_seek = nil
 
+    @encoding = nil
+    @encoding = @options.encoding if Object.const_defined? :Encoding
+
     reset
   end
 
@@ -183,6 +186,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
   def collect_first_comment
     skip_tkspace
     comment = ''
+    comment.force_encoding @encoding if @encoding
     first_line = true
 
     tk = get_tk
@@ -449,6 +453,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # +comment+.
 
   def parse_attr(context, single, tk, comment)
+    offset  = tk.seek
+    line_no = tk.line_no
+
     args = parse_symbol_arg 1
     if args.size > 0 then
       name = args[0]
@@ -464,6 +471,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
       att = RDoc::Attr.new get_tkread, name, rw, comment, single == SINGLE
       att.record_location @top_level
+      att.offset = offset
+      att.line   = line_no
 
       read_documentation_modifiers att, RDoc::ATTR_MODIFIERS
 
@@ -480,6 +489,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # comment for each to +comment+.
 
   def parse_attr_accessor(context, single, tk, comment)
+    offset  = tk.seek
+    line_no = tk.line_no
+
     args = parse_symbol_arg
     rw = "?"
 
@@ -498,6 +510,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
     for name in args
       att = RDoc::Attr.new get_tkread, name, rw, comment, single == SINGLE
       att.record_location @top_level
+      att.offset = offset
+      att.line   = line_no
 
       context.add_attribute att
       @stats.add_attribute att
@@ -508,6 +522,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # Parses an +alias+ in +context+ with +comment+
 
   def parse_alias(context, single, tk, comment)
+    offset  = tk.seek
+    line_no = tk.line_no
+
     skip_tkspace
 
     if TkLPAREN === peek_tk then
@@ -534,6 +551,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
     al = RDoc::Alias.new(get_tkread, old_name, new_name, comment,
                          single == SINGLE)
     al.record_location @top_level
+    al.offset = offset
+    al.line   = line_no
 
     read_documentation_modifiers al, RDoc::ATTR_MODIFIERS
     context.add_alias al if al.document_self
@@ -586,6 +605,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # Parses a class in +context+ with +comment+
 
   def parse_class(container, single, tk, comment)
+    offset  = tk.seek
+    line_no = tk.line_no
+
     declaration_context = container
     container, name_t, given_name = get_class_or_module container
 
@@ -606,6 +628,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
       read_documentation_modifiers cls, RDoc::CLASS_MODIFIERS
       cls.record_location @top_level
+      cls.offset = offset
+      cls.line   = line_no
+
       cls.comment = comment if cls.document_self
 
       @top_level.add_to_classes_or_modules cls
@@ -622,6 +647,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
         unless other then
           other = container.add_module RDoc::NormalModule, name
           other.record_location @top_level
+          other.offset  = offset
+          other.line    = line_no
+
           other.comment = comment
         end
 
@@ -639,7 +667,6 @@ class RDoc::Parser::Ruby < RDoc::Parser
         read_documentation_modifiers other, RDoc::CLASS_MODIFIERS
         parse_statements(other, SINGLE)
       end
-
     else
       warn("Expected class name or '<<'. Got #{name_t.class}: #{name_t.text.inspect}")
     end
@@ -649,6 +676,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # Parses a constant in +context+ with +comment+
 
   def parse_constant(container, tk, comment)
+    offset  = tk.seek
+    line_no = tk.line_no
+
     name = tk.name
     skip_tkspace false
 
@@ -698,7 +728,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
                   container.find_module_named rhs_name
                 end
 
-          container.add_module_alias mod, name if mod
+          container.add_module_alias mod, name, @top_level if mod
           get_tk # TkNL
           break
         end
@@ -721,6 +751,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
     con = RDoc::Constant.new name, res, comment
     con.record_location @top_level
+    con.offset = offset
+    con.line   = line_no
     read_documentation_modifiers con, RDoc::CONSTANT_MODIFIERS
 
     @stats.add_constant con
@@ -733,8 +765,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # :method: or :attr: directives in +comment+.
 
   def parse_comment(container, tk, comment)
-    line_no = tk.line_no
     column  = tk.char_no
+    offset  = tk.seek
+    line_no = tk.line_no
 
     singleton = !!comment.sub!(/(^# +:?)(singleton-)(method:)/, '\1\3')
 
@@ -745,6 +778,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
       meth = RDoc::GhostMethod.new get_tkread, name
       meth.record_location @top_level
       meth.singleton = singleton
+      meth.offset    = offset
+      meth.line      = line_no
 
       meth.start_collecting_tokens
       indent = TkSPACE.new nil, 1, 1
@@ -777,6 +812,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
       # TODO authorize 'singleton-attr...'?
       att = RDoc::Attr.new get_tkread, name, rw, comment
       att.record_location @top_level
+      att.offset    = offset
+      att.line      = line_no
 
       container.add_attribute att
 
@@ -871,8 +908,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # Parses a meta-programmed method
 
   def parse_meta_method(container, single, tk, comment)
-    line_no = tk.line_no
     column  = tk.char_no
+    offset  = tk.seek
+    line_no = tk.line_no
 
     start_collecting_tokens
     add_token tk
@@ -904,6 +942,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
     meth = RDoc::MetaMethod.new get_tkread, name
     meth.record_location @top_level
+    meth.offset = offset
+    meth.line   = line_no
     meth.singleton = singleton
 
     remove_token_listener self
@@ -956,8 +996,9 @@ class RDoc::Parser::Ruby < RDoc::Parser
     added_container = nil
     meth = nil
     name = nil
-    line_no = tk.line_no
     column  = tk.char_no
+    offset  = tk.seek
+    line_no = tk.line_no
 
     start_collecting_tokens
     add_token tk
@@ -1049,6 +1090,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
     end
 
     meth.record_location @top_level
+    meth.offset = offset
+    meth.line   = line_no
 
     meth.start_collecting_tokens
     indent = TkSPACE.new nil, 1, 1
@@ -1221,6 +1264,8 @@ class RDoc::Parser::Ruby < RDoc::Parser
 
   def parse_statements(container, single = NORMAL, current_method = nil,
                        comment = '')
+    comment.force_encoding @encoding if @encoding
+
     nest = 1
     save_visibility = container.visibility
 
@@ -1244,6 +1289,7 @@ class RDoc::Parser::Ruby < RDoc::Parser
               comment.empty?
 
             comment = ''
+            comment.force_encoding @encoding if @encoding
           end
 
           while TkCOMMENT === tk do
@@ -1383,7 +1429,10 @@ class RDoc::Parser::Ruby < RDoc::Parser
         keep_comment = false
       end
 
-      comment = '' unless keep_comment
+      unless keep_comment then
+        comment = ''
+        comment.force_encoding @encoding if @encoding
+      end
 
       begin
         get_tkread
@@ -1596,8 +1645,11 @@ class RDoc::Parser::Ruby < RDoc::Parser
   # Removes private comments from +comment+
 
   def remove_private_comments(comment)
-    comment.gsub!(/^#--\n.*?^#\+\+\n?/m, '')
-    comment.sub!(/^#--\n.*\n?/m, '')
+    empty = ''
+    empty.force_encoding comment.encoding if Object.const_defined? :Encoding
+
+    comment.gsub!(/^#--.*?^#\+\+\n?/m, empty)
+    comment.sub!(/^#--.*/m, '')
   end
 
   ##

data/lib/rdoc/text.rb

@@ -97,7 +97,8 @@ module RDoc::Text
     text = strip_hashes text
     text = expand_tabs text
     text = flush_left text
-    strip_newlines text
+    text = strip_newlines text
+    text
   end
 
   ##
@@ -139,7 +140,11 @@ http://rubyforge.org/tracker/?atid=2472&group_id=627&func=browse
 
   def strip_hashes text
     return text if text =~ /^(?>\s*)[^\#]/
-    text.gsub(/^\s*(#+)/) { $1.tr '#',' ' }.gsub(/^\s+$/, '')
+
+    empty = ''
+    empty.force_encoding text.encoding if Object.const_defined? :Encoding
+
+    text.gsub(/^\s*(#+)/) { $1.tr '#', ' ' }.gsub(/^\s+$/, empty)
   end
 
   ##

data/test/test_rdoc_any_method.rb

@@ -34,6 +34,12 @@ method(a, b) { |c, d| ... }
     assert_equal call_seq, m.arglists
   end
 
+  def test_c_function
+    @c1_m.c_function = 'my_c1_m'
+
+    assert_equal 'my_c1_m', @c1_m.c_function
+  end
+
   def test_full_name
     assert_equal 'C1::m', @c1.method_list.first.full_name
   end

data/test/test_rdoc_class_module.rb

@@ -114,7 +114,7 @@ class TestRDocClassModule < XrefTestCase
     n1 = @xref_data.add_module RDoc::NormalClass, 'N1'
     n1_k2 = n1.add_module RDoc::NormalClass, 'N2'
 
-    n1.add_module_alias n1_k2, 'A1'
+    n1.add_module_alias n1_k2, 'A1', @xref_data
 
     n1_a1_c = n1.constants.find { |c| c.name == 'A1' }
     refute_nil n1_a1_c
@@ -138,7 +138,7 @@ class TestRDocClassModule < XrefTestCase
     n1 = @xref_data.add_module RDoc::NormalModule, 'N1'
     n1_n2 = n1.add_module RDoc::NormalModule, 'N2'
 
-    n1.add_module_alias n1_n2, 'A1'
+    n1.add_module_alias n1_n2, 'A1', @xref_data
 
     n1_a1_c = n1.constants.find { |c| c.name == 'A1' }
     refute_nil n1_a1_c
@@ -163,7 +163,7 @@ class TestRDocClassModule < XrefTestCase
     l1_l2 = l1.add_module RDoc::NormalModule, 'L2'
     o1 = @xref_data.add_module RDoc::NormalModule, 'O1'
 
-    o1.add_module_alias l1_l2, 'A1'
+    o1.add_module_alias l1_l2, 'A1', @xref_data
 
     o1_a1_c = o1.constants.find { |c| c.name == 'A1' }
     refute_nil o1_a1_c

data/test/test_rdoc_code_object.rb

@@ -129,6 +129,12 @@ class TestRDocCodeObject < XrefTestCase
     assert_nil @co.instance_variable_get(:@full_name)
   end
 
+  def test_line
+    @c1_m.line = 5
+
+    assert_equal 5, @c1_m.line
+  end
+
   def test_metadata
     assert_empty @co.metadata
 
@@ -141,6 +147,12 @@ class TestRDocCodeObject < XrefTestCase
     assert_equal 'not_rdoc', @co.metadata['markup']
   end
 
+  def test_offset
+    @c1_m.offset = 5
+
+    assert_equal 5, @c1_m.offset
+  end
+
   def test_parent_file_name
     assert_equal '(unknown)', @co.parent_file_name
     assert_equal 'xref_data.rb', @c1.parent_file_name

data/test/test_rdoc_context.rb

@@ -174,9 +174,16 @@ class TestRDocContext < XrefTestCase
   end
 
   def test_add_module_alias
-    c3_c4 = @c2.add_module_alias @c2_c3, 'C4'
+    tl = RDoc::TopLevel.new 'file.rb'
 
-    assert_equal @c2.find_module_named('C4'), c3_c4
+    c3_c4 = @c2.add_module_alias @c2_c3, 'C4', tl
+
+    c4 = @c2.find_module_named('C4')
+
+    alias_constant = @c2.constants.first
+
+    assert_equal c4, c3_c4
+    assert_equal tl, alias_constant.file
   end
 
   def test_add_module_class

data/test/test_rdoc_options.rb

@@ -17,6 +17,7 @@ class TestRDocOptions < MiniTest::Unit::TestCase
   end
 
   def test_check_files
+    skip "assumes UNIX permition model" if /mswin|mingw/ =~ RUBY_PLATFORM
     out, err = capture_io do
       Dir.mktmpdir do |dir|
         Dir.chdir dir do

data/test/test_rdoc_parser_c.rb

@@ -536,7 +536,7 @@ Init_Foo(void) {
 
     code = other_function.token_stream.first.text
 
-    assert_equal "VALUE\nother_function() ", code
+    assert_equal "VALUE\nother_function() {\n}", code
   end
 
   def test_find_body_2
@@ -581,6 +581,41 @@ init_gi_repository (void)
 
   def test_find_body_define
     content = <<-EOF
+#define something something_else
+
+#define other_function rb_other_function
+
+/*
+ * a comment for rb_other_function
+ */
+VALUE
+rb_other_function() {
+}
+
+void
+Init_Foo(void) {
+    VALUE foo = rb_define_class("Foo", rb_cObject);
+
+    rb_define_method(foo, "my_method", other_function, 0);
+}
+    EOF
+
+    klass = util_get_class content, 'foo'
+    other_function = klass.method_list.first
+
+    assert_equal 'my_method', other_function.name
+    assert_equal 'a comment for rb_other_function', other_function.comment
+    assert_equal '()', other_function.params
+    assert_equal 118, other_function.offset
+    assert_equal 8, other_function.line
+
+    code = other_function.token_stream.first.text
+
+    assert_equal "VALUE\nrb_other_function() {\n}", code
+  end
+
+  def test_find_body_define_comment
+    content = <<-EOF
 /*
  * a comment for other_function
  */
@@ -603,9 +638,10 @@ Init_Foo(void) {
     other_function = klass.method_list.first
 
     assert_equal 'my_method', other_function.name
-    assert_equal "a comment for other_function",
-                 other_function.comment
+    assert_equal 'a comment for other_function', other_function.comment
     assert_equal '()', other_function.params
+    assert_equal 39, other_function.offset
+    assert_equal 4, other_function.line
 
     code = other_function.token_stream.first.text
 
@@ -749,19 +785,65 @@ commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
     assert_equal expected, comment
   end
 
-  def test_handle_method
+  def test_handle_method_args_minus_1
     parser = util_parser "Document-method: Object#m\n blah */"
 
-    parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', 2
+    parser.content = <<-BODY
+VALUE
+rb_other(VALUE obj) {
+  rb_funcall(obj, rb_intern("other"), 0);
+  return rb_str_new2("blah, blah, blah");
+}
+
+VALUE
+rb_m(int argc, VALUE *argv, VALUE obj) {
+  VALUE o1, o2;
+  rb_scan_args(argc, argv, "1", &o1, &o2);
+}
+    BODY
+
+    parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', -1
 
     m = @top_level.find_module_named('Object').method_list.first
 
     assert_equal 'm', m.name
-    assert_equal '(p1, p2)', m.params
     assert_equal @top_level, m.file
+    assert_equal 115, m.offset
+    assert_equal 7, m.line
+
+    assert_equal '(p1)', m.params
   end
 
-  def test_handle_method_args
+
+  def test_handle_method_args_0
+    parser = util_parser "Document-method: BasicObject#==\n blah */"
+
+    parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', 0
+
+    bo = @top_level.find_module_named 'BasicObject'
+
+    assert_equal 1, bo.method_list.length
+
+    equals2 = bo.method_list.first
+
+    assert_equal '()', equals2.params
+  end
+
+  def test_handle_method_args_1
+    parser = util_parser "Document-method: BasicObject#==\n blah */"
+
+    parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', 1
+
+    bo = @top_level.find_module_named 'BasicObject'
+
+    assert_equal 1, bo.method_list.length
+
+    equals2 = bo.method_list.first
+
+    assert_equal '(p1)', equals2.params
+  end
+
+  def test_handle_method_args_2
     parser = util_parser "Document-method: BasicObject#==\n blah */"
 
     parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', 2
@@ -775,6 +857,22 @@ commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
     assert_equal '(p1, p2)', equals2.params
   end
 
+  # test_handle_args_minus_1 handled by test_handle_method
+
+  def test_handle_method_args_minus_2
+    parser = util_parser "Document-method: BasicObject#==\n blah */"
+
+    parser.handle_method 'method', 'rb_cBasicObject', '==', 'rb_obj_equal', -2
+
+    bo = @top_level.find_module_named 'BasicObject'
+
+    assert_equal 1, bo.method_list.length
+
+    equals2 = bo.method_list.first
+
+    assert_equal '(*args)', equals2.params
+  end
+
   def test_handle_method_initialize
     parser = util_parser "Document-method: BasicObject::new\n blah */"
 
@@ -791,16 +889,6 @@ commercial(cwyear, cweek=1, cwday=1, sg=nil) -> Date [ruby 1.9]
     assert_equal :public, new.visibility
   end
 
-  def test_handle_method_star_args
-    parser = util_parser "Document-method: Object#m\n blah */"
-
-    parser.handle_method 'method', 'rb_cObject', 'm', 'rb_m', -1
-
-    m = @top_level.find_module_named('Object').method_list.first
-
-    assert_equal '(*args)', m.params
-  end
-
   def test_look_for_directives_in
     parser = util_parser ''
 
@@ -837,6 +925,7 @@ Init_IO(void) {
     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
 
@@ -927,6 +1016,65 @@ Init_IO(void) {
     assert read_method.singleton
   end
 
+  def test_rb_scan_args
+    parser = util_parser ''
+
+    assert_equal '(p1)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "1",)')
+    assert_equal '(p1, p2)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "2",)')
+
+    assert_equal '(p1 = v1)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "01",)')
+    assert_equal '(p1 = v1, p2 = v2)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "02",)')
+
+    assert_equal '(p1, p2 = v2)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "11",)')
+
+    assert_equal '(p1, *args)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "1*",)')
+    assert_equal '(p1, p2 = {})',
+                 parser.rb_scan_args('rb_scan_args(a, b, "1:",)')
+    assert_equal '(p1, &block)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "1&",)')
+
+    assert_equal '(p1, p2)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "101",)')
+
+    assert_equal '(p1, p2 = v2, p3)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "111",)')
+
+    assert_equal '(p1, *args, p3)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "1*1",)')
+
+    assert_equal '(p1, p2 = v2, *args)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "11*",)')
+    assert_equal '(p1, p2 = v2, p3 = {})',
+                 parser.rb_scan_args('rb_scan_args(a, b, "11:",)')
+    assert_equal '(p1, p2 = v2, &block)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "11&",)')
+
+    assert_equal '(p1, p2 = v2, *args, p4, p5 = {}, &block)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "11*1:&",)')
+
+    # The following aren't valid according to spec but are according to the
+    # implementation.
+    assert_equal '(*args)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "*",)')
+    assert_equal '(p1 = {})',
+                 parser.rb_scan_args('rb_scan_args(a, b, ":",)')
+    assert_equal '(&block)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "&",)')
+
+    assert_equal '(*args, p2 = {})',
+                 parser.rb_scan_args('rb_scan_args(a, b, "*:",)')
+    assert_equal '(p1 = {}, &block)',
+                 parser.rb_scan_args('rb_scan_args(a, b, ":&",)')
+    assert_equal '(*args, p2 = {}, &block)',
+                 parser.rb_scan_args('rb_scan_args(a, b, "*:&",)')
+  end
+
   def util_get_class(content, name)
     @parser = util_parser content
     @parser.scan