Class: SourceAnnotationExtractor::Annotation

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

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Methods inherited from Struct

#as_json, #to_h

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

Class Method Details

.directoriesObject



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

def self.directories
  @@directories ||= %w(app config db lib test) + (ENV['SOURCE_ANNOTATION_DIRECTORIES'] || '').split(',')
end

.extensionsObject



21
22
23
# File 'railties/lib/rails/source_annotation_extractor.rb', line 21

def self.extensions
  @@extensions ||= {}
end

.register_extensions(*exts, &block) ⇒ Object

Registers new Annotations File Extensions

SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }


27
28
29
# File 'railties/lib/rails/source_annotation_extractor.rb', line 27

def self.register_extensions(*exts, &block)
  extensions[/\.(#{exts.join("|")})$/] = block
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.



41
42
43
44
45
# File 'railties/lib/rails/source_annotation_extractor.rb', line 41

def to_s(options={})
  s = "[#{line.to_s.rjust(options[:indent])}] "
  s << "[#{tag}] " if options[:tag]
  s << text
end