Class: YARD::I18n::Locale
- Inherits:
-
Object
- Object
- YARD::I18n::Locale
- Defined in:
- lib/yard/i18n/locale.rb
Overview
Locale is a unit of translation. It has #name and a set of messages.
Class Attribute Summary (collapse)
-
+ (String?) default
The default locale name.
Instance Attribute Summary (collapse)
-
- (String) name
readonly
The name of the locale.
Instance Method Summary (collapse)
-
- (Locale) initialize(name)
constructor
Creates a locale for name locale.
-
- (Boolean) load(locale_directory)
Loads translation messages from locale_directory/#name.po.
-
- (String) translate(message)
Translated message.
Constructor Details
- (Locale) initialize(name)
Creates a locale for name locale.
33 34 35 36 |
# File 'lib/yard/i18n/locale.rb', line 33 def initialize(name) @name = name @messages = {} end |
Class Attribute Details
+ (String?) default
Returns the default locale name.
11 12 13 |
# File 'lib/yard/i18n/locale.rb', line 11 def default @default end |
Instance Attribute Details
Instance Method Details
- (Boolean) load(locale_directory)
Loads translation messages from locale_directory/#name.po.
43 44 45 46 47 48 49 50 51 52 53 54 55 56 |
# File 'lib/yard/i18n/locale.rb', line 43 def load(locale_directory) return false if @name.nil? po_file = File.join(locale_directory, "#{@name}.po") return false unless File.exist?(po_file) require "yard/i18n/po_parser" return false unless POParser.available? po_parser = POParser.new @messages.merge!(po_parser.parse(po_file)) true end |
- (String) translate(message)
Returns translated message. If tarnslation isn’t registered, the message is returned.
61 62 63 |
# File 'lib/yard/i18n/locale.rb', line 61 def translate() @messages[] || end |