Class: SourceAnnotationExtractor::Annotation

Inherits:
Struct show all
Defined in:
railties/lib/rails/source_annotation_extractor.rb

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods inherited from Struct

#as_json

Instance Attribute Details

#lineObject

Returns the value of attribute line


16
17
18
# File 'railties/lib/rails/source_annotation_extractor.rb', line 16

def line
  @line
end

#tagObject

Returns the value of attribute tag


16
17
18
# File 'railties/lib/rails/source_annotation_extractor.rb', line 16

def tag
  @tag
end

#textObject

Returns the value of attribute text


16
17
18
# File 'railties/lib/rails/source_annotation_extractor.rb', line 16

def text
  @text
end

Instance Method Details

#to_s(options = {}) ⇒ Object

Returns a representation of the annotation that looks like this:

[126] [TODO] This algorithm is simple and clearly correct, make it faster.

If options has a flag :tag the tag is shown as in the example above. Otherwise the string contains just line and text.


24
25
26
27
28
# File 'railties/lib/rails/source_annotation_extractor.rb', line 24

def to_s(options={})
  s = "[%3d] " % line
  s << "[#{tag}] " if options[:tag]
  s << text
end