Methods
Class Public methods
directories()
📝 Source code
# File railties/lib/rails/source_annotation_extractor.rb, line 72
def self.directories
@@directories ||= %w(app config db lib test)
end
🔎 See on GitHub
extensions()
📝 Source code
# File railties/lib/rails/source_annotation_extractor.rb, line 92
def self.extensions
@@extensions ||= {}
end
🔎 See on GitHub
register_directories(*dirs)
Registers additional directories to be included
Rails::SourceAnnotationExtractor::Annotation.register_directories("spec", "another")
📝 Source code
# File railties/lib/rails/source_annotation_extractor.rb, line 78
def self.register_directories(*dirs)
directories.push(*dirs)
end
🔎 See on GitHub
register_extensions(*exts, &block)
Registers new Annotations File
Extensions
Rails::SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
📝 Source code
# File railties/lib/rails/source_annotation_extractor.rb, line 98
def self.register_extensions(*exts, &block)
extensions[/\.(#{exts.join("|")})$/] = block
end
🔎 See on GitHub
register_tags(*additional_tags)
Registers additional tags
Rails::SourceAnnotationExtractor::Annotation.register_tags("TESTME", "DEPRECATEME")
📝 Source code
# File railties/lib/rails/source_annotation_extractor.rb, line 88
def self.register_tags(*additional_tags)
tags.push(*additional_tags)
end
🔎 See on GitHub
tags()
📝 Source code
# File railties/lib/rails/source_annotation_extractor.rb, line 82
def self.tags
@@tags ||= %w(OPTIMIZE FIXME TODO)
end
🔎 See on GitHub
Instance Public methods
to_s(options = {})
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.
📝 Source code
# File railties/lib/rails/source_annotation_extractor.rb, line 124
def to_s(options = {})
s = +"[#{line.to_s.rjust(options[:indent])}] "
s << "[#{tag}] " if options[:tag]
s << text
end
🔎 See on GitHub