Class: SourceAnnotationExtractor
- Defined in:
- railties/lib/rails/source_annotation_extractor.rb
Overview
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.
Defined Under Namespace
Classes: Annotation
Instance Attribute Summary collapse
-
#tag ⇒ Object
readonly
Returns the value of attribute tag.
Class Method Summary collapse
-
.enumerate(tag, options = {}) ⇒ Object
Prints all annotations with tag
tag
under the root directoriesapp
,config
,db
,lib
, andtest
(recursively).
Instance Method Summary collapse
-
#display(results, options = {}) ⇒ Object
Prints the mapping from filenames to annotations in
results
ordered by filename. -
#extract_annotations_from(file, pattern) ⇒ Object
If
file
is the filename of a file that contains annotations this method returns a hash with a single entry that mapsfile
to an array of its annotations. -
#find(dirs) ⇒ Object
Returns a hash that maps filenames under
dirs
(recursively) to arrays with their annotations. -
#find_in(dir) ⇒ Object
Returns a hash that maps filenames under
dir
(recursively) to arrays with their annotations. -
#initialize(tag) ⇒ SourceAnnotationExtractor
constructor
A new instance of SourceAnnotationExtractor.
Constructor Details
#initialize(tag) ⇒ SourceAnnotationExtractor
Returns a new instance of SourceAnnotationExtractor.
57 58 59 |
# File 'railties/lib/rails/source_annotation_extractor.rb', line 57 def initialize(tag) @tag = tag end |
Instance Attribute Details
#tag ⇒ Object (readonly)
Returns the value of attribute tag
55 56 57 |
# File 'railties/lib/rails/source_annotation_extractor.rb', line 55 def tag @tag end |
Class Method Details
.enumerate(tag, options = {}) ⇒ Object
Prints all annotations with tag tag
under the root directories app
, config
, db
, lib
, and test
(recursively).
Additional directories may be added using a comma-delimited list set using ENV['SOURCE_ANNOTATION_DIRECTORIES']
.
Directories may also be explicitly set using the :dirs
key in options
.
SourceAnnotationExtractor.enumerate 'TODO|FIXME', dirs: %w(app lib), tag: true
If options
has a :tag
flag, it will be passed to each annotation’s to_s
.
See #find_in
for a list of file extensions that will be taken into account.
This class method is the single entry point for the rake tasks.
49 50 51 52 53 |
# File 'railties/lib/rails/source_annotation_extractor.rb', line 49 def self.enumerate(tag, ={}) extractor = new(tag) dirs = .delete(:dirs) || Annotation.directories extractor.display(extractor.find(dirs), ) end |
Instance Method Details
#display(results, options = {}) ⇒ Object
Prints the mapping from filenames to annotations in results
ordered by filename. The options
hash is passed to each annotation’s to_s
.
117 118 119 120 121 122 123 124 125 126 |
# File 'railties/lib/rails/source_annotation_extractor.rb', line 117 def display(results, ={}) [:indent] = results.map { |f, a| a.map(&:line) }.flatten.max.to_s.size results.keys.sort.each do |file| puts "#{file}:" results[file].each do |note| puts " * #{note.to_s()}" end puts end end |
#extract_annotations_from(file, pattern) ⇒ Object
If file
is the filename of a file that contains annotations this method returns a hash with a single entry that maps file
to an array of its annotations. Otherwise it returns an empty hash.
105 106 107 108 109 110 111 112 113 |
# File 'railties/lib/rails/source_annotation_extractor.rb', line 105 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 |
#find(dirs) ⇒ Object
Returns a hash that maps filenames under dirs
(recursively) to arrays with their annotations.
63 64 65 |
# File 'railties/lib/rails/source_annotation_extractor.rb', line 63 def find(dirs) dirs.inject({}) { |h, dir| h.update(find_in(dir)) } end |
#find_in(dir) ⇒ Object
Returns a hash that maps filenames under dir
(recursively) to arrays with their annotations. Only files with annotations are included. Files with extension .builder
, .rb
, .erb
, .haml
, .slim
, .css
, .scss
, .js
, .coffee
, and .rake
are taken into account.
72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 |
# File 'railties/lib/rails/source_annotation_extractor.rb', line 72 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)) else pattern = case item when /\.(builder|rb|coffee|rake)$/ /#\s*(#{tag}):?\s*(.*)$/ when /\.(css|scss|sass|js)$/ /\/\/\s*(#{tag}):?\s*(.*)$/ when /\.erb$/ /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/ when /\.haml$/ /-\s*#\s*(#{tag}):?\s*(.*)$/ when /\.slim$/ /\/\s*\s*(#{tag}):?\s*(.*)$/ else nil end results.update(extract_annotations_from(item, pattern)) if pattern end end results end |