diff options
author | David Heinemeier Hansson <david@loudthinking.com> | 2007-02-25 19:40:37 +0000 |
---|---|---|
committer | David Heinemeier Hansson <david@loudthinking.com> | 2007-02-25 19:40:37 +0000 |
commit | ee2b5dda803d4da31b187eb592569692b4972417 (patch) | |
tree | f7c6795834a67e6290f182c9a04d8daeb3f833de /railties/lib/tasks | |
parent | 23e24c5996c90e072b66a616ee0cbe066dd5c1a2 (diff) | |
download | rails-ee2b5dda803d4da31b187eb592569692b4972417.tar.gz rails-ee2b5dda803d4da31b187eb592569692b4972417.tar.bz2 rails-ee2b5dda803d4da31b187eb592569692b4972417.zip |
Added source-annotations extractor tasks to rake [Jamis Buck]
git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@6229 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
Diffstat (limited to 'railties/lib/tasks')
-rw-r--r-- | railties/lib/tasks/annotations.rake | 84 |
1 files changed, 84 insertions, 0 deletions
diff --git a/railties/lib/tasks/annotations.rake b/railties/lib/tasks/annotations.rake new file mode 100644 index 0000000000..20ccad6d7b --- /dev/null +++ b/railties/lib/tasks/annotations.rake @@ -0,0 +1,84 @@ +class SourceAnnotationExtractor + class Annotation < Struct.new(:line, :tag, :text) + def to_s(options={}) + s = "[%3d] " % line + s << "[#{tag}] " if options[:tag] + s << text + end + end + + def self.enumerate(tag, options={}) + extractor = new(tag) + extractor.display(extractor.find, options) + end + + attr_reader :tag + + def initialize(tag) + @tag = tag + end + + def find(dirs=%w(app lib test)) + dirs.inject({}) { |h, dir| h.update(find_in(dir)) } + end + + def find_in(dir) + results = {} + + Dir.glob("#{dir}/*") do |item| + next if File.basename(item)[0] == ?. + + if File.directory?(item) + results.update(find_in(item)) + elsif item =~ /\.r(?:b|xml|js)$/ + results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/)) + elsif item =~ /\.rhtml$/ + results.update(extract_annotations_from(item, /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/)) + end + end + + results + end + + def extract_annotations_from(file, pattern) + lineno = 0 + result = File.readlines(file).inject([]) do |list, line| + lineno += 1 + next list unless line =~ pattern + list << Annotation.new(lineno, $1, $2) + end + result.empty? ? {} : { file => result } + end + + def display(results, options={}) + results.keys.sort.each do |file| + puts "#{file}:" + results[file].each do |note| + puts " * #{note.to_s(options)}" + end + puts + end + end +end + +desc "Enumerate all annotations" +task :notes do + SourceAnnotationExtractor.enumerate "OPTIMIZE|FIXME|TODO", :tag => true +end + +namespace :notes do + desc "Enumerate all OPTIMIZE annotations" + task :optimize do + SourceAnnotationExtractor.enumerate "OPTIMIZE" + end + + desc "Enumerate all FIXME annotations" + task :fixme do + SourceAnnotationExtractor.enumerate "FIXME" + end + + desc "Enumerate all TODO annotations" + task :todo do + SourceAnnotationExtractor.enumerate "TODO" + end +end
\ No newline at end of file |