Add line information to code objects created by RDoc::Parser::Ruby (offset is broken)

Author: drbrain

lib/rdoc/parser/ruby.rb

@@ -174,6 +174,8 @@ def initialize(top_level, file_name, content, options, stats)
     @scanner.exception_on_syntax_error = false
     @prev_seek = nil
 
+    @encoding = @options.encoding if Object.const_defined? :Encoding
+
     reset
   end
 
@@ -449,6 +451,9 @@ def make_message message
   # +comment+.
 
   def parse_attr(context, single, tk, comment)
+    column  = tk.char_no
+    line_no = tk.line_no
+
     args = parse_symbol_arg 1
     if args.size > 0 then
       name = args[0]
@@ -464,6 +469,8 @@ def parse_attr(context, single, tk, comment)
 
       att = RDoc::Attr.new get_tkread, name, rw, comment, single == SINGLE
       att.record_location @top_level
+      att.offset = column
+      att.line   = line_no
 
       read_documentation_modifiers att, RDoc::ATTR_MODIFIERS
 
@@ -480,6 +487,9 @@ def parse_attr(context, single, tk, comment)
   # comment for each to +comment+.
 
   def parse_attr_accessor(context, single, tk, comment)
+    column  = tk.char_no
+    line_no = tk.line_no
+
     args = parse_symbol_arg
     rw = "?"
 
@@ -498,6 +508,8 @@ def parse_attr_accessor(context, single, tk, comment)
     for name in args
       att = RDoc::Attr.new get_tkread, name, rw, comment, single == SINGLE
       att.record_location @top_level
+      att.offset = column
+      att.line   = line_no
 
       context.add_attribute att
       @stats.add_attribute att
@@ -508,6 +520,9 @@ def parse_attr_accessor(context, single, tk, comment)
   # Parses an +alias+ in +context+ with +comment+
 
   def parse_alias(context, single, tk, comment)
+    column  = tk.char_no
+    line_no = tk.line_no
+
     skip_tkspace
 
     if TkLPAREN === peek_tk then
@@ -534,6 +549,8 @@ def parse_alias(context, single, tk, comment)
     al = RDoc::Alias.new(get_tkread, old_name, new_name, comment,
                          single == SINGLE)
     al.record_location @top_level
+    al.offset = column
+    al.line   = line_no
 
     read_documentation_modifiers al, RDoc::ATTR_MODIFIERS
     context.add_alias al if al.document_self
@@ -586,6 +603,9 @@ def parse_call_parameters(tk)
   # Parses a class in +context+ with +comment+
 
   def parse_class(container, single, tk, comment)
+    column  = tk.char_no
+    line_no = tk.line_no
+
     declaration_context = container
     container, name_t, given_name = get_class_or_module container
 
@@ -606,6 +626,9 @@ def parse_class(container, single, tk, comment)
 
       read_documentation_modifiers cls, RDoc::CLASS_MODIFIERS
       cls.record_location @top_level
+      cls.offset = column
+      cls.line   = line_no
+
       cls.comment = comment if cls.document_self
 
       @top_level.add_to_classes_or_modules cls
@@ -622,6 +645,9 @@ def parse_class(container, single, tk, comment)
         unless other then
           other = container.add_module RDoc::NormalModule, name
           other.record_location @top_level
+          other.offset  = column
+          other.line    = line_no
+
           other.comment = comment
         end
 
@@ -639,7 +665,6 @@ def parse_class(container, single, tk, comment)
         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 +674,9 @@ def parse_class(container, single, tk, comment)
   # Parses a constant in +context+ with +comment+
 
   def parse_constant(container, tk, comment)
+    column  = tk.char_no
+    line_no = tk.line_no
+
     name = tk.name
     skip_tkspace false
 
@@ -721,6 +749,8 @@ def parse_constant(container, tk, comment)
 
     con = RDoc::Constant.new name, res, comment
     con.record_location @top_level
+    con.offset = column
+    con.line   = line_no
     read_documentation_modifiers con, RDoc::CONSTANT_MODIFIERS
 
     @stats.add_constant con
@@ -745,6 +775,8 @@ def parse_comment(container, tk, comment)
       meth = RDoc::GhostMethod.new get_tkread, name
       meth.record_location @top_level
       meth.singleton = singleton
+      meth.offset    = column
+      meth.line      = line_no
 
       meth.start_collecting_tokens
       indent = TkSPACE.new nil, 1, 1
@@ -777,6 +809,8 @@ def parse_comment(container, tk, comment)
       # TODO authorize 'singleton-attr...'?
       att = RDoc::Attr.new get_tkread, name, rw, comment
       att.record_location @top_level
+      att.offset    = column
+      att.line      = line_no
 
       container.add_attribute att
 
@@ -904,6 +938,8 @@ def parse_meta_method(container, single, tk, comment)
 
     meth = RDoc::MetaMethod.new get_tkread, name
     meth.record_location @top_level
+    meth.offset = column
+    meth.line   = line_no
     meth.singleton = singleton
 
     remove_token_listener self
@@ -1049,6 +1085,8 @@ def parse_method(container, single, tk, comment)
     end
 
     meth.record_location @top_level
+    meth.offset = column
+    meth.line   = line_no
 
     meth.start_collecting_tokens
     indent = TkSPACE.new nil, 1, 1

test/test_rdoc_parser_ruby.rb

@@ -310,6 +310,8 @@ def test_parse_alias
     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 +363,8 @@ def test_parse_attr
     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 +386,8 @@ def test_parse_attr_accessor
     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 +546,9 @@ def test_parse_class
     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 +714,10 @@ def foo; 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 2, b.offset # HACK should be 10
+    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 +856,8 @@ def test_parse_comment_attr
     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 +887,8 @@ def test_parse_comment_method
     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 +916,25 @@ def test_parse_comment_method
     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 +995,8 @@ def test_parse_meta_method
     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 +1156,8 @@ def test_parse_method
     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