Class: Rails::SourceAnnotationExtractor
Relationships & Source Files | |
Namespace Children | |
Classes:
| |
Inherits: | Object |
Defined in: | railties/lib/rails/source_annotation_extractor.rb |
Overview
Implements the logic behind Command::NotesCommand
. See rails notes --help
for usage information.
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.
Class Method Summary
-
.enumerate(tag = nil, options = {})
Prints all annotations with tag #tag under the root directories
app
,config
,db
,lib
, andtest
(recursively). - .new(tag) ⇒ SourceAnnotationExtractor constructor
Instance Attribute Summary
- #tag readonly
Instance Method Summary
-
#display(results, options = {})
Prints the mapping from filenames to annotations in
results
ordered by filename. -
#find(dirs)
Returns a hash that maps filenames under
dirs
(recursively) to arrays with their annotations. -
#find_in(dir)
Returns a hash that maps filenames under
dir
(recursively) to arrays with their annotations.
Constructor Details
.new(tag) ⇒ SourceAnnotationExtractor
Class Method Details
.enumerate(tag = nil, options = {})
Prints all annotations with tag #tag under the root directories app
, config
, db
, lib
, and test
(recursively).
If #tag is nil
, annotations with either default or registered tags are printed.
Specific directories can be explicitly set using the :dirs
key in options
.
Rails::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 rails notes
command.
# File 'railties/lib/rails/source_annotation_extractor.rb', line 128
def self.enumerate(tag = nil, = {}) tag ||= Annotation. .join("|") extractor = new(tag) dirs = .delete(:dirs) || Annotation.directories extractor.display(extractor.find(dirs), ) end
Instance Attribute Details
#tag (readonly)
[ GitHub ]# File 'railties/lib/rails/source_annotation_extractor.rb', line 135
attr_reader :tag
Instance Method Details
#display(results, options = {})
Prints the mapping from filenames to annotations in results
ordered by filename. The options
hash is passed to each annotation’s to_s
.
# File 'railties/lib/rails/source_annotation_extractor.rb', line 186
def display(results, = {}) [:indent] = results.flat_map { |f, a| a.map(&:line) }.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
#find(dirs)
Returns a hash that maps filenames under dirs
(recursively) to arrays with their annotations.
# File 'railties/lib/rails/source_annotation_extractor.rb', line 143
def find(dirs) dirs.inject({}) { |h, dir| h.update(find_in(dir)) } end
#find_in(dir)
Returns a hash that maps filenames under dir
(recursively) to arrays with their annotations. Files with extensions registered in Annotation.extensions are taken into account. Only files with annotations are included.
# File 'railties/lib/rails/source_annotation_extractor.rb', line 151
def find_in(dir) results = {} Dir.glob("#{dir}/*") do |item| next if File.basename(item).start_with?(".") if File.directory?(item) results.update(find_in(item)) else extension = Annotation.extensions.detect do |regexp, _block| regexp.match(item) end if extension pattern = extension.last.call(tag) # In case a user-defined pattern returns nothing for the given set # of tags, we exit early. next unless pattern # If a user-defined pattern returns a regular expression, we will # wrap it in a PatternExtractor to keep the same API. pattern = PatternExtractor.new(pattern) if pattern.is_a?(Regexp) annotations = pattern.annotations(item) results.update(item => annotations) if annotations.any? end end end results end