Class: Rails::SourceAnnotationExtractor

Inherits:
Object
  • Object
show all
Defined in:
railties/lib/rails/source_annotation_extractor.rb

Overview

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.

Defined Under Namespace

Classes: Annotation

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(tag) ⇒ SourceAnnotationExtractor


94
95
96
# File 'railties/lib/rails/source_annotation_extractor.rb', line 94

def initialize(tag)
  @tag = tag
end

Instance Attribute Details

#tagObject (readonly)

Returns the value of attribute tag


92
93
94
# File 'railties/lib/rails/source_annotation_extractor.rb', line 92

def tag
  @tag
end

Class Method Details

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

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.


85
86
87
88
89
90
# File 'railties/lib/rails/source_annotation_extractor.rb', line 85

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

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.


146
147
148
149
150
151
152
153
154
155
# File 'railties/lib/rails/source_annotation_extractor.rb', line 146

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


134
135
136
137
138
139
140
141
142
# File 'railties/lib/rails/source_annotation_extractor.rb', line 134

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

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


100
101
102
# File 'railties/lib/rails/source_annotation_extractor.rb', line 100

def find(dirs)
  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. Files with extensions registered in Rails::SourceAnnotationExtractor::Annotation.extensions are taken into account. Only files with annotations are included.


108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
# File 'railties/lib/rails/source_annotation_extractor.rb', line 108

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