enumerate

enumerate(tag, options={}) Class Public methods 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'

new

new(tag) Class Public methods

display

display(results, options={}) Instance Public methods Prints the mapping from filenames to annotations in results ordered by filename. The options hash is passed to each annotation's to_s.

extract_annotations_from

extract_annotations_from(file, pattern) Instance Public methods 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.

find

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

find_in

find_in(dir) Instance Public methods 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, .erb, .haml, .slim, .css, .scss, .js, .coffee, .rake, .sass and .less are taken into account.

__method_for_multibyte_testing

__method_for_multibyte_testing() Instance Public methods

__method_for_multibyte_testing!

__method_for_multibyte_testing!() Instance Public methods

__method_for_multibyte_testing_that_returns_nil!

__method_for_multibyte_testing_that_returns_nil!() Instance Public methods

__method_for_multibyte_testing_with_integer_result

__method_for_multibyte_testing_with_integer_result() Instance Public methods