Class: Rake::Notes::SourceAnnotationExtractor

Inherits:
Object
  • Object
show all
Defined in:
lib/rake/notes/source_annotation_extractor.rb

Overview

From: github.com/rails/rails/blob/master/railties/lib/rails/source_annotation_extractor.rb

Implements the logic behind the rake tasks for annotations like

rake notes
rake notes:optimize

and friends. See rake -T notes.

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.

Defined Under Namespace

Classes: Annotation

Constant Summary collapse

RUBYFILES = 
%w( Vagrantfile Rakefile Puppetfile Gemfile )

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tag) ⇒ SourceAnnotationExtractor

Returns a new instance of SourceAnnotationExtractor.



59
60
61
 
# File 'lib/rake/notes/source_annotation_extractor.rb', line 59

def initialize(tag)
  @tag = tag
end

Instance Attribute Details

#tag ⇒ Object (readonly)

Returns the value of attribute tag.



57
58
59
 
# File 'lib/rake/notes/source_annotation_extractor.rb', line 57

def tag
  @tag
end

Class Method Details

.enumerate(tag, options = {}) ⇒ Object

Prints all annotations with tag tag under the current directory. Only known file types 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.



52
53
54
55
 
# File 'lib/rake/notes/source_annotation_extractor.rb', line 52

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



110
111
112
113
114
115
116
117
118
119
120
 
# File 'lib/rake/notes/source_annotation_extractor.rb', line 110

def display(results, options={})
  options[:indent] = results.map { |f, a| a.map(&:line) }.flatten.max.to_s.size
  out = options.delete(:out) || $stdout
  results.keys.sort.each do |file|
    out.puts "#{file[2..-1]}:"
    results[file].each do |note|
      out.puts "  * #{note.to_s(options)}"
    end
    out.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.



98
99
100
101
102
103
104
105
106
 
# File 'lib/rake/notes/source_annotation_extractor.rb', line 98

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 ⇒ Object

Returns a hash that maps filenames to arrays with their annotations.



64
65
66
 
# File 'lib/rake/notes/source_annotation_extractor.rb', line 64

def find
  find_in('.')
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, and only known file types are taken into account.



71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
 
# File 'lib/rake/notes/source_annotation_extractor.rb', line 71

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|rake|pp|ya?ml|gemspec|feature)$/ || RUBYFILES.include?(File.basename(item))
      results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
    elsif item =~ /\.(css|scss|js)$/
      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