Class: NoteTracker::SourceAnnotationExtractor
- Inherits:
-
Object
- Object
- NoteTracker::SourceAnnotationExtractor
- Defined in:
- lib/note_tracker/source_annotation_extractor.rb
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.
65 66 67 |
# File 'lib/note_tracker/source_annotation_extractor.rb', line 65 def initialize(tag) @tag = tag end |
Instance Attribute Details
#tag ⇒ Object (readonly)
Returns the value of attribute tag.
63 64 65 |
# File 'lib/note_tracker/source_annotation_extractor.rb', line 63 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.
57 58 59 60 61 |
# File 'lib/note_tracker/source_annotation_extractor.rb', line 57 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
.
123 124 125 126 127 128 129 130 131 132 |
# File 'lib/note_tracker/source_annotation_extractor.rb', line 123 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 |
#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.
108 109 110 111 112 113 114 115 116 117 118 119 |
# File 'lib/note_tracker/source_annotation_extractor.rb', line 108 def extract_annotations_from(file, pattern) lineno = 0 result = File.readlines(file).inject([]) do |list, line| lineno += 1 next list unless line =~ pattern tag = $2 text = $3 story_id = $1.to_s.scan(/\d+/).first list << Annotation.new(lineno, tag, story_id, text) end result.empty? ? {} : { file => result } end |
#find(dirs) ⇒ Object
Returns a hash that maps filenames under dirs
(recursively) to arrays with their annotations.
71 72 73 |
# File 'lib/note_tracker/source_annotation_extractor.rb', line 71 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
, .rake
, .sass
and .less
are taken into account.
80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 |
# File 'lib/note_tracker/source_annotation_extractor.rb', line 80 def find_in(dir) results = {} p dir p ".. #{Dir.glob("#{dir}/*")}" Dir.glob("#{dir}/*") do |item| p item next if File.basename(item)[0] == ?. 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) results.update(extract_annotations_from(item, pattern)) if pattern end end end results end |