123456789_123456789_123456789_123456789_123456789_

Class: RDoc::Generator::POT::MessageExtractor

Relationships & Source Files
Inherits: Object
Defined in: lib/rdoc/generator/pot/message_extractor.rb

Overview

Extracts message from ::RDoc::Store

Class Method Summary

Instance Method Summary

Constructor Details

.new(store) ⇒ MessageExtractor

Creates a message extractor for store.

[ GitHub ]

  
# File 'lib/rdoc/generator/pot/message_extractor.rb', line 10

def initialize store
  @store = store
  @po = RDoc::Generator::POT::PO.new
end

Instance Method Details

#entry(msgid, options) (private)

[ GitHub ]

  
# File 'lib/rdoc/generator/pot/message_extractor.rb', line 64

def entry msgid, options
  RDoc::Generator::POT::POEntry.new(msgid, options)
end

#extract

Extracts messages from store, stores them into PO and returns it.

[ GitHub ]

  
# File 'lib/rdoc/generator/pot/message_extractor.rb', line 19

def extract
  @store.all_classes_and_modules.each do |klass|
    extract_from_klass(klass)
  end
  @po
end

#extract_from_klass(klass) (private)

[ GitHub ]

  
# File 'lib/rdoc/generator/pot/message_extractor.rb', line 28

def extract_from_klass klass
  extract_text(klass.comment_location, klass.full_name)

  klass.each_section do |section, constants, attributes|
    extract_text(section.title, "#{klass.full_name}: section title")
    section.comments.each do |comment|
      extract_text(comment, "#{klass.full_name}: #{section.title}")
    end
  end

  klass.each_constant do |constant|
    extract_text(constant.comment, constant.full_name)
  end

  klass.each_attribute do |attribute|
    extract_text(attribute.comment, attribute.full_name)
  end

  klass.each_method do |method|
    extract_text(method.comment, method.full_name)
  end
end

#extract_text(text, comment, location = nil) (private)

[ GitHub ]

  
# File 'lib/rdoc/generator/pot/message_extractor.rb', line 51

def extract_text text, comment, location = nil
  return if text.nil?

  options = {
    :extracted_comment => comment,
    :references => [location].compact,
  }
  i18n_text = RDoc::I18n::Text.new(text)
  i18n_text.extract_messages do |part|
    @po.add(entry(part[:paragraph], options))
  end
end