class Rails::SourceAnnotationExtractor::Annotation

Открытые методы класса

# File railties/lib/rails/source_annotation_extractor.rb, line 72
def self.directories
  @@directories ||= %w(app config db lib test)
end

extensions () Показать исходный код

# File railties/lib/rails/source_annotation_extractor.rb, line 92
def self.extensions
  @@extensions ||= {}
end

register_directories (*dirs) Показать исходный код

# File railties/lib/rails/source_annotation_extractor.rb, line 78
def self.register_directories(*dirs)
  directories.push(*dirs)
end

Регистрирует дополнительные каталоги для включения

Rails::SourceAnnotationExtractor::Annotation.register_directories("spec", "another")

register_extensions (*exts, &block) Показать исходный код

# File railties/lib/rails/source_annotation_extractor.rb, line 98
def self.register_extensions(*exts, &block)
  extensions[/\.(#{exts.join("|")})$/] = block
end

Регистрирует новые расширения File аннотаций

Rails::SourceAnnotationExtractor::Annotation.register_extensions("css", "scss", "sass", "less", "js") { |tag| /\/\/\s*(#{tag}):?\s*(.*)$/ }

register_tags (*additional_tags) Показать исходный код

# File railties/lib/rails/source_annotation_extractor.rb, line 88
def self.register_tags(*additional_tags)
  tags.push(*additional_tags)
end

Регистрирует дополнительные теги

Rails::SourceAnnotationExtractor::Annotation.register_tags("TESTME", "DEPRECATEME")

tags () Показать исходный код

# File railties/lib/rails/source_annotation_extractor.rb, line 82
def self.tags
  @@tags ||= %w(OPTIMIZE FIXME TODO)
end

Открытые методы экземпляра

to_s (options = {}) Показать исходный код

# File railties/lib/rails/source_annotation_extractor.rb, line 128
def to_s(options = {})
  s = +"[#{line.to_s.rjust(options[:indent])}] "
  s << "[#{tag}] " if options[:tag]
  s << text
end

Возвращает представление аннотации следующего вида:

[126] [TODO] This algorithm is simple and clearly correct, make it faster.

Если у options есть флаг :tag, тег отображается, как в примере выше. В противном случае строка содержит только номер строки и текст.