Class: Annotations::Extractor

Inherits:
Object
  • Object
show all
Defined in:
lib/annotations/extractor.rb

Overview

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.

Defined Under Namespace

Classes: Annotation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tag, options) ⇒ Extractor

Returns a new instance of Extractor.



45
46
47
48
 
# File 'lib/annotations/extractor.rb', line 45

def initialize(tag, options)
  @tag = tag
  @extensions = options[:extensions]
end

Instance Attribute Details

#tag ⇒ Object (readonly)

Returns the value of attribute tag.



43
44
45
 
# File 'lib/annotations/extractor.rb', line 43

def tag
  @tag
end

Class Method Details

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

Prints all annotations with tag tag under the root directories app, lib, and test (recursively). Only filenames with extension .builder, .rb, .rxml, .rhtml, or .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.



38
39
40
41
 
# File 'lib/annotations/extractor.rb', line 38

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



104
105
106
107
108
109
110
111
112
 
# File 'lib/annotations/extractor.rb', line 104

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) ⇒ 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.



92
93
94
95
96
97
98
99
100
 
# File 'lib/annotations/extractor.rb', line 92

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(.))) ⇒ Object

Returns a hash that maps filenames under dirs (recursively) to arrays with their annotations. Only files with annotations are included, and only those with extension .builder, .rb, .rxml, .rhtml, and .erb are taken into account. TODO: Make dirs configurable



55
56
57
 
# File 'lib/annotations/extractor.rb', line 55

def find(dirs=%w(.))
  dirs.inject({}) { |h, dir| h.update(find_in(dir)) }
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 those with extension .builder, .rb, .rxml, .rhtml, and .erb are taken into account.



63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
 
# File 'lib/annotations/extractor.rb', line 63

def find_in(dir)
  results = {}

  pattern = "#{dir}/**/*"
  pattern += ".{#{@extensions}}" if @extensions

  Dir.glob(pattern) do |item|
    next if File.basename(item)[0] == ?. or File.directory?(item)

    if item =~ /\.(ru|builder|coffee|(r(?:b|xml|js)))$/
      results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
    # Other Ruby source files (Rake, Bundler)
    elsif item =~ /(Rakefile|Gemfile|Guardfile)$/
      results.update(extract_annotations_from(item, /#\s*(#{tag}):?\s*(.*)$/))
    # ERb templates
    elsif item =~ /\.(rhtml|erb)$/
      results.update(extract_annotations_from(item, /<%\s*#\s*(#{tag}):?\s*(.*?)\s*%>/))
    # Sass, JavaScript, PHP, other source with double-slash comments
    elsif item =~ /\.(s(?:a|c)ss|js|php)$/
      results.update(extract_annotations_from(item, /\/\/\s*(#{tag}):?\s*(.*)$/))
    end
  end

  results
end