Implements the logic behind the rake tasks for annotations like

rake notes
rake notes:optimize

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

Namespace
Methods
D
E
F
N
Attributes
[R] tag
Class Public methods
enumerate(tag, options={})

Prints all annotations with tag tag under the root directories app, config, lib, script, and test (recursively). Only filenames with extension .builder, .rb, and .erb are taken into account. The options hash is passed to each annotation’s to_s.

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 37
def self.enumerate(tag, options={})
  extractor = new(tag)
  extractor.display(extractor.find, options)
end
new(tag)

Source: show | on GitHub 

# File railties/lib/rails/source_annotation_extractor.rb, line 44
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 95
def display(results, options={})
  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 83
def extract_annotations_from(file, pattern)
  lineno = 0
  result = File.readlines(file).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=%w(app config lib script test))

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 50
def find(dirs=%w(app config lib script test))
  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, and only those with extension .builder, .rb, .erb, .haml, .slim and .coffee are taken into account.

Source: show | on GitHub 

# File railties/lib/rails/source_annotation_extractor.rb, line 58
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))
    elsif item =~ /\.(builder|rb|coffee)$/
      results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
    elsif item =~ /\.erb$/
      results.update(extract_annotations_from(item, /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/))
    elsif item =~ /\.haml$/
      results.update(extract_annotations_from(item, /-\s*#\s*(#{tag}):?\s*(.*)$/))
    elsif item =~ /\.slim$/
      results.update(extract_annotations_from(item, /\/\s*\s*(#{tag}):?\s*(.*)$/))
    end
  end

  results
end