ri > Rails::SourceAnnotationExtractor

📦 Rails::SourceAnnotationExtractor < Object

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.

🚀 Quick Reference

📋 Class Methods

• enumerate — returns list of annotation sources
• new — creates a new extractor instance

🔧 Instance Methods

• display — outputs annotations to console
• extract_annotations_from — extracts annotations from a given file
• find — finds annotations in the project
• find_in — finds annotations in a specific directory
• tag — returns the tag used for annotation extraction

🏷️ Attributes

• attr_reader tag — the tag string used to filter annotations