SourceAnnotationExtractor
Implements the logic behind the rake tasks for annotations like
rake notes rake notes:optimize
and friends. See rake -T notes and railties/lib/tasks/annotations.rake.
Annotation objects are triplets :line, :tag, :text that represent the line where the annotation lives, its tag, and its text. Note the filename is not stored.
Annotations are looked for in comments and modulus whitespace they have to start with the tag optionally followed by a colon. Everything up to the end of the line (or closing ERB comment tag) is considered to be their text.
Attributes
| [R] | tag |
Files
- railties/lib/rails/source_annotation_extractor.rb
Nested classes and modules
2Notes
Custom annotation types
For group work you may need something more than FIXME, OPTIMIZE and TODO. Just create new rake file and place it to lib/tasks:
require 'source_annotation_extractor'
task :notes do
SourceAnnotationExtractor.enumerate "WTF|OMG", :tag => true
end
namespace :notes do
desc "Enumerate all WTF annotations"
task :wtf do
SourceAnnotationExtractor.enumerate "WTF"
end
desc "Enumerate all OMG annotations"
task :omg do
SourceAnnotationExtractor.enumerate "OMG"
end
end
or create an array of new types and generate tasks dynamicaly.
Add Rspec files to the annotations
By default the annotations search the 'test' folder, but not the 'spec' folder if you are using Rspec. To get those specs involved do this:
require 'source_annotation_extractor'
class SourceAnnotationExtractor
def find(dirs=%w(app lib spec))
dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
end
end
If you have other folders you want to check, just add them to the dirs list.