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
This commit is contained in:
parent
23e24c5996
commit
ee2b5dda80
@ -1,5 +1,7 @@
|
||||
*SVN*
|
||||
|
||||
* Added source-annotations extractor tasks to rake [Jamis Buck]. This allows you to add FIXME, OPTIMIZE, and TODO comments to your source code that can then be extracted in concert with rake notes (shows all), rake notes:fixme, rake notes:optimize and rake notes:todo.
|
||||
|
||||
* Added fixtures :all to test_helper.rb to assume that most people just want all their fixtures loaded all the time [DHH]
|
||||
|
||||
* Added config/initializers where all ruby files within it are automatically loaded after the Rails configuration is done, so you don't have to litter the environment.rb file with a ton of mixed stuff [DHH]
|
||||
|
84
railties/lib/tasks/annotations.rake
Normal file
84
railties/lib/tasks/annotations.rake
Normal file
@ -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
|
Loading…
Reference in New Issue
Block a user