class

SourceAnnotationExtractor

v2.0.3 - Show latest stable - Superclass: Object

No documentation available for this class.

Attributes

[R]tag

Files

  • railties/lib/source_annotation_extractor.rb

Nested classes and modules

2Notes

Custom annotation types

noxyu3m · Jul 23, 20085 thanks

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

pallan · Jan 27, 20091 thank

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.