Rails::SourceAnnotationExtractor (original) (raw)

Implements the logic behind Rails::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.

Namespace

Methods

D

E

F

N

Attributes

Class Public methods

enumerate(tag = nil, options = {})Link

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 SourceAnnotationExtractor#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.

Source: show | on GitHub

def self.enumerate(tag = nil, options = {}) tag ||= Annotation.tags.join("|") extractor = new(tag) dirs = options.delete(:dirs) || Annotation.directories extractor.display(extractor.find(dirs), options) end

Instance Public methods

display(results, options = {})Link

Prints the mapping from filenames to annotations in results ordered by filename. The options hash is passed to each annotation’s to_s.

Source: show | on GitHub

def display(results, options = {}) options[: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(options)}" end puts end end

Returns a hash that maps filenames under dirs (recursively) to arrays with their annotations.

Source: show | on GitHub

def find(dirs) dirs.inject({}) { |h, dir| h.update(find_in(dir)) } end

Returns a hash that maps filenames under dir (recursively) to arrays with their annotations. Files with extensions registered in Rails::SourceAnnotationExtractor::Annotation.extensions are taken into account. Only files with annotations are included.

Source: show | on GitHub

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)
    
    
    next unless pattern
    
    
    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