Class: Rails::SourceAnnotationExtractor::Annotation
Relationships & Source Files | |
Inherits: |
Struct
|
Defined in: | railties/lib/rails/source_annotation_extractor.rb |
Class Method Summary
- .directories
- .extensions
-
.register_directories(*dirs)
Registers additional directories to be included.
-
.register_extensions(*exts, &block)
Registers new Annotations File Extensions.
-
.register_tags(*additional_tags)
Registers additional tags.
- .tags
Instance Attribute Summary
Instance Method Summary
-
#to_s(options = {})
Returns a representation of the annotation that looks like this:
Class Method Details
.directories
[ GitHub ]# File 'railties/lib/rails/source_annotation_extractor.rb', line 55
def self.directories @@directories ||= %w(app config db lib test) end
.extensions
[ GitHub ]# File 'railties/lib/rails/source_annotation_extractor.rb', line 75
def self.extensions @@extensions ||= {} end
.register_directories(*dirs)
Registers additional directories to be included
Rails::SourceAnnotationExtractor::Annotation.register_directories("spec", "another")
# File 'railties/lib/rails/source_annotation_extractor.rb', line 61
def self.register_directories(*dirs) directories.push(*dirs) end
.register_extensions(*exts, &block)
Registers new Annotations File Extensions
Rails::SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }
# File 'railties/lib/rails/source_annotation_extractor.rb', line 81
def self.register_extensions(*exts, &block) extensions[/\.(#{exts.join("|")})$/] = block end
.register_tags(*additional_tags)
Registers additional tags
Rails::SourceAnnotationExtractor::Annotation. ("TESTME", "DEPRECATEME")
# File 'railties/lib/rails/source_annotation_extractor.rb', line 71
def self. (* ) .push(* ) end
.tags
[ GitHub ]# File 'railties/lib/rails/source_annotation_extractor.rb', line 65
def self. @@tags ||= %w(OPTIMIZE FIXME TODO) end
Instance Attribute Details
#line (rw)
[ GitHub ]#tag (rw)
[ GitHub ]#text (rw)
[ GitHub ]Instance Method Details
#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.