W3cubDocs

class Rails::SourceAnnotationExtractor

Parent:: Object

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.

Attributes

tag[R]

Public Class Methods

enumerate(tag = nil, options = {}) Show source

# File railties/lib/rails/source_annotation_extractor.rb, line 76
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

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.

new(tag) Show source

# File railties/lib/rails/source_annotation_extractor.rb, line 85
def initialize(tag)
  @tag = tag
end

Public Instance Methods

display(results, options = {}) Show source

# File railties/lib/rails/source_annotation_extractor.rb, line 137
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

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

extract_annotations_from(file, pattern) Show source

# File railties/lib/rails/source_annotation_extractor.rb, line 125
def extract_annotations_from(file, pattern)
  lineno = 0
  result = File.readlines(file, encoding: Encoding::BINARY).inject([]) do |list, line|
    lineno += 1
    next list unless line =~ pattern
    list << Annotation.new(lineno, $1, $2)
  end
  result.empty? ? {} : { file => result }
end

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.

find(dirs) Show source

# File railties/lib/rails/source_annotation_extractor.rb, line 91
def find(dirs)
  dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
end

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

find_in(dir) Show source

# File railties/lib/rails/source_annotation_extractor.rb, line 99
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)
        results.update(extract_annotations_from(item, pattern)) if pattern
      end
    end
  end

  results
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.