Module: I18n::Base

Included in:
I18n
Defined in:
lib/i18n.rb

Instance Method Summary collapse

Instance Method Details

#available_locales_initialized?Boolean

Returns:

  • (Boolean)

299
300
301
# File 'lib/i18n.rb', line 299

def available_locales_initialized?
  config.available_locales_initialized?
end

#configObject

Gets I18n configuration object.


25
26
27
# File 'lib/i18n.rb', line 25

def config
  Thread.current[:i18n_config] ||= I18n::Config.new
end

#config=(value) ⇒ Object

Sets I18n configuration object.


30
31
32
# File 'lib/i18n.rb', line 30

def config=(value)
  Thread.current[:i18n_config] = value
end

#enforce_available_locales!(locale) ⇒ Object

Raises an InvalidLocale exception when the passed locale is not available.


293
294
295
296
297
# File 'lib/i18n.rb', line 293

def enforce_available_locales!(locale)
  if config.enforce_available_locales
    raise I18n::InvalidLocale.new(locale) if !locale_available?(locale)
  end
end

#exists?(key, locale = config.locale) ⇒ Boolean

Returns true if a translation exists for a given key, otherwise returns false.

Returns:

  • (Boolean)

Raises:


184
185
186
187
# File 'lib/i18n.rb', line 184

def exists?(key, locale = config.locale)
  raise I18n::ArgumentError if key.is_a?(String) && key.empty?
  config.backend.exists?(locale, key)
end

#locale_available?(locale) ⇒ Boolean

Returns true when the passed locale, which can be either a String or a Symbol, is in the list of available locales. Returns false otherwise.

Returns:

  • (Boolean)

288
289
290
# File 'lib/i18n.rb', line 288

def locale_available?(locale)
  I18n.config.available_locales_set.include?(locale)
end

#localize(object, options = nil) ⇒ Object Also known as: l

Localizes certain objects, such as dates and numbers to local formatting.


253
254
255
256
257
258
259
# File 'lib/i18n.rb', line 253

def localize(object, options = nil)
  options = options ? options.dup : {}
  locale = options.delete(:locale) || config.locale
  format = options.delete(:format) || :default
  enforce_available_locales!(locale)
  config.backend.localize(locale, object, format, options)
end

#normalize_keys(locale, key, scope, separator = nil) ⇒ Object

Merges the given locale, key and scope into a single array of keys. Splits keys that contain dots into multiple keys. Makes sure all keys are Symbols.


276
277
278
279
280
281
282
283
284
# File 'lib/i18n.rb', line 276

def normalize_keys(locale, key, scope, separator = nil)
  separator ||= I18n.default_separator

  keys = []
  keys.concat normalize_key(locale, separator)
  keys.concat normalize_key(scope, separator)
  keys.concat normalize_key(key, separator)
  keys
end

#reload!Object

Tells the backend to reload translations. Used in situations like the Rails development environment. Backends can implement whatever strategy is useful.


51
52
53
54
# File 'lib/i18n.rb', line 51

def reload!
  config.clear_available_locales_set
  config.backend.reload!
end

#translate(*args) ⇒ Object Also known as: t

Translates, pluralizes and interpolates a given key using a given locale, scope, and default, as well as interpolation values.

LOOKUP

Translation data is organized as a nested hash using the upper-level keys as namespaces. E.g., ActionView ships with the translation: :date => {:formats => {:short => "%b %d"}}.

Translations can be looked up at any level of this hash using the key argument and the scope option. E.g., in this example I18n.t :date returns the whole translations hash {:formats => {:short => "%b %d"}}.

Key can be either a single key or a dot-separated key (both Strings and Symbols work). E.g., the short format can be looked up using both:

I18n.t 'date.formats.short'
I18n.t :'date.formats.short'

Scope can be either a single key, a dot-separated key or an array of keys or dot-separated keys. Keys and scopes can be combined freely. So these examples will all look up the same short date format:

I18n.t 'date.formats.short'
I18n.t 'formats.short', :scope => 'date'
I18n.t 'short', :scope => 'date.formats'
I18n.t 'short', :scope => %w(date formats)

INTERPOLATION

Translations can contain interpolation variables which will be replaced by values passed to #translate as part of the options hash, with the keys matching the interpolation variable names.

E.g., with a translation :foo => "foo %{bar}" the option value for the key bar will be interpolated into the translation:

I18n.t :foo, :bar => 'baz' # => 'foo baz'

PLURALIZATION

Translation data can contain pluralized translations. Pluralized translations are arrays of singluar/plural versions of translations like ['Foo', 'Foos'].

Note that I18n::Backend::Simple only supports an algorithm for English pluralization rules. Other algorithms can be supported by custom backends.

This returns the singular version of a pluralized translation:

I18n.t :foo, :count => 1 # => 'Foo'

These both return the plural version of a pluralized translation:

I18n.t :foo, :count => 0 # => 'Foos'
I18n.t :foo, :count => 2 # => 'Foos'

The :count option can be used both for pluralization and interpolation. E.g., with the translation :foo => ['%{count} foo', '%{count} foos'], count will be interpolated to the pluralized translation:

I18n.t :foo, :count => 1 # => '1 foo'

DEFAULTS

This returns the translation for :foo or default if no translation was found:

I18n.t :foo, :default => 'default'

This returns the translation for :foo or the translation for :bar if no translation for :foo was found:

I18n.t :foo, :default => :bar

Returns the translation for :foo or the translation for :bar or default if no translations for :foo and :bar were found.

I18n.t :foo, :default => [:bar, 'default']

*BULK LOOKUP*

This returns an array with the translations for :foo and :bar.

I18n.t [:foo, :bar]

Can be used with dot-separated nested keys:

I18n.t [:'baz.foo', :'baz.bar']

Which is the same as using a scope option:

I18n.t [:foo, :bar], :scope => :baz

LAMBDAS

Both translations and defaults can be given as Ruby lambdas. Lambdas will be called and passed the key and options.

E.g. assuming the key :salutation resolves to:

lambda { |key, options| options[:gender] == 'm' ? "Mr. #{options[:name]}" : "Mrs. #{options[:name]}" }

Then <tt>I18n.t(:salutation, :gender => 'w', :name => 'Smith') will result in “Mrs. Smith”.

Note that the string returned by lambda will go through string interpolation too, so the following lambda would give the same result:

lambda { |key, options| options[:gender] == 'm' ? "Mr. %{name}" : "Mrs. %{name}" }

It is recommended to use/implement lambdas in an “idempotent” way. E.g. when a cache layer is put in front of I18n.translate it will generate a cache key from the argument values passed to #translate. Therefor your lambdas should always return the same translations/values per unique combination of argument values.


156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
# File 'lib/i18n.rb', line 156

def translate(*args)
  options  = args.last.is_a?(Hash) ? args.pop.dup : {}
  key      = args.shift
  backend  = config.backend
  locale   = options.delete(:locale) || config.locale
  handling = options.delete(:throw) && :throw || options.delete(:raise) && :raise # TODO deprecate :raise

  enforce_available_locales!(locale)

  result = catch(:exception) do
    if key.is_a?(Array)
      key.map { |k| backend.translate(locale, k, options) }
    else
      backend.translate(locale, key, options)
    end
  end
  result.is_a?(MissingTranslation) ? handle_exception(handling, result, locale, key, options) : result
end

#translate!(key, options = {}) ⇒ Object Also known as: t!

Wrapper for translate that adds :raise => true. With this option, if no translation is found, it will raise I18n::MissingTranslationData


178
179
180
# File 'lib/i18n.rb', line 178

def translate!(key, options={})
  translate(key, options.merge(:raise => true))
end

#transliterate(*args) ⇒ Object

Transliterates UTF-8 characters to ASCII. By default this method will transliterate only Latin strings to an ASCII approximation:

I18n.transliterate("Ærøskøbing")
# => "AEroskobing"

I18n.transliterate("日本語")
# => "???"

It's also possible to add support for per-locale transliterations. I18n expects transliteration rules to be stored at i18n.transliterate.rule.

Transliteration rules can either be a Hash or a Proc. Procs must accept a single string argument. Hash rules inherit the default transliteration rules, while Procs do not.

Examples

Setting a Hash in <locale>.yml:

i18n:
  transliterate:
    rule:
      ü: "ue"
      ö: "oe"

Setting a Hash using Ruby:

store_translations(:de, :i18n => {
  :transliterate => {
    :rule => {
      "ü" => "ue",
      "ö" => "oe"
    }
  }
)

Setting a Proc:

translit = lambda {|string| MyTransliterator.transliterate(string) }
store_translations(:xx, :i18n => {:transliterate => {:rule => translit})

Transliterating strings:

I18n.locale = :en
I18n.transliterate("Jürgen") # => "Jurgen"
I18n.locale = :de
I18n.transliterate("Jürgen") # => "Juergen"
I18n.transliterate("Jürgen", :locale => :en) # => "Jurgen"
I18n.transliterate("Jürgen", :locale => :de) # => "Juergen"

240
241
242
243
244
245
246
247
248
249
250
# File 'lib/i18n.rb', line 240

def transliterate(*args)
  options      = args.pop.dup if args.last.is_a?(Hash)
  key          = args.shift
  locale       = options && options.delete(:locale) || config.locale
  handling     = options && (options.delete(:throw) && :throw || options.delete(:raise) && :raise)
  replacement  = options && options.delete(:replacement)
  enforce_available_locales!(locale)
  config.backend.transliterate(locale, key, replacement)
rescue I18n::ArgumentError => exception
  handle_exception(handling, exception, locale, key, options || {})
end

#with_locale(tmp_locale = nil) ⇒ Object

Executes block with given I18n.locale set.


263
264
265
266
267
268
269
270
271
# File 'lib/i18n.rb', line 263

def with_locale(tmp_locale = nil)
  if tmp_locale
    current_locale = self.locale
    self.locale    = tmp_locale
  end
  yield
ensure
  self.locale = current_locale if tmp_locale
end