SourceAnnotationExtractor

Implements the logic behind the rake tasks for annotations like

rails notes
rails notes:optimize

and friends. See rails -T notes and railties/lib/rails/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.

Methods
D
E
F
N
Constants
Annotation = Struct.new(:line, :tag, :text) do def self.directories @@directories ||= %w(app config db lib test) + (ENV["SOURCE_ANNOTATION_DIRECTORIES"] || "").split(",") end # Registers additional directories to be included # SourceAnnotationExtractor::Annotation.register_directories("spec","another") def self.register_directories(*dirs) directories.push(*dirs) end def self.extensions @@extensions ||= {} end # Registers new Annotations File Extensions # SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ } def self.register_extensions(*exts, &block) extensions[/\.(#{exts.join("|")})$/] = block end register_extensions("builder", "rb", "rake", "yml", "yaml", "ruby") { |tag| /#\s*(#{tag}):?\s*(.*)$/ } register_extensions("css", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ } register_extensions("erb") { |tag| /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/ } # Returns a representation of the annotation that looks like this: # # [126] [TODO] This algorithm is simple and clearly correct, make it faster. # # If +options+ has a flag <tt>:tag</tt> the tag is shown as in the example above. # Otherwise the string contains just line and text. def to_s(options = {}) s = "[#{line.to_s.rjust(options[:indent])}] " s << "[#{tag}] " if options[:tag] s << text end end
 
Attributes
[R] tag
Class Public methods
enumerate(tag, options = {})

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.

Source: show | on GitHub 

# File railties/lib/rails/source_annotation_extractor.rb, line 69
def self.enumerate(tag, options = {})
  extractor = new(tag)
  dirs = options.delete(:dirs) || Annotation.directories
  extractor.display(extractor.find(dirs), options)
end
new(tag)

Source: show | on GitHub 

# File railties/lib/rails/source_annotation_extractor.rb, line 77
def initialize(tag)
  @tag = tag
end
Instance Public methods
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.

Source: show | on GitHub 

# File railties/lib/rails/source_annotation_extractor.rb, line 129
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
extract_annotations_from(file, pattern)

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.

Source: show | on GitHub 

# File railties/lib/rails/source_annotation_extractor.rb, line 117
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
find(dirs)

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

Source: show | on GitHub 

# File railties/lib/rails/source_annotation_extractor.rb, line 83
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. Only files with annotations are included. Files with extension .builder, .rb, .rake, .yml, .yaml, .ruby, .css, .js and .erb are taken into account.

Source: show | on GitHub 

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