Activates a locale for translations.

This method allows to set the locale used to produce translated contents. Note that once activated, the current locale will remain active until it's explicly changed again. #with_locale should be used instead of #activate for cases where it is important to ensure that the previous active locale is restored.

An I18n::Errors::InvalidLocale exception will be raised by this method if the passed locale is not available in the main catalog of translations (ie. if no translations were defined for the considered locale).

Returns the available locales.

If no translations have been loaded yet, an array with the default locale in it will be returned.

Returns the main configuration object.

This methods return the main I18n::Config object used by the I18n module to persist configuration options.

Allows to replace the main configuration object.

This method will replace the main configuration object used by the I18n module but will not change the main catalog of translation. Calling #init once the new I18n::Config object has been assigned might be necessary in order to ensure that the main catalog of translations used by the I18n module is reinitialized.

Initializes the I18n module.

Calling this method at application startup is necessary in order to ensure that the configuration options that were set through the use of the I18n::Config object (returned by the #config method) are read in order to initialize the main catalog of translations. Calling this will ensure that the translations files that were defined using I18n::Config#loaders are read and processed in order to allow further translations lookups.

Alias for #localize.

Alias for #localize.

Returns the currently active locale.

The returned value will default to the default locale unless another locale is explicitly activated.

Alias for #activate.

Localizes a number.

This method allows to localize a Number object (such as an integer or a float). By default, the :default format is used, but custom formats can be used as well:

I18n.localize(123_456.789)          # => 123,456.789
I18n.localize(123_456.789, :custom) # => 123,456.79

Localizes a datetime or a date.

This method allows to localize a Time object or a Tuple(Int32, Int32, Int32) object (which correspond to a date obtained through the use of Time#date). Both time or "date" objects can be localized using a predefined format such as :default, :short or :long, but custom formats can be used as well:

I18n.localize(Time.local)                 # => Sun, 13 Dec 2020 21:11:08 -0500
I18n.localize(Time.local, :short)         # => 13 Dec 21:11
I18n.localize(Time.local.date)            # => 2020-12-13
I18n.localize(Time.local.date, :long)     # => December 13, 2020
I18n.localize(Time.local, "%a, %d %b %Y") # => Sun, 13 Dec 2020

Alias for #translate.

Alias for #translate!.

Performs a translation lookup.

This method performs a translation lookup for a given key. If no translation can be found for the given key, a default string stating that the translation is missing will be returned.

I18n.translate("simple.translation")               # => "Simple translation"
I18n.translate("hello.user", name: "John")         # => "Hello John!"
I18n.translate(:blank, scope: "error.username")    # => "Username cannot be blank"
I18n.translate(:blank, scope: [:error, :username]) # => "Username cannot be blank"

Performs a translation lookup.

This method performs a translation lookup for a given key. If no translation can be found for the given key, an I18n::Errors::MissingTranslation exception will be raised.

I18n.translate!("simple.translation")               # => "Simple translation"
I18n.translate!("hello.user", name: "John")         # => "Hello John!"
I18n.translate!(:blank, scope: "error.username")    # => "Username cannot be blank"
I18n.translate!(:blank, scope: [:error, :username]) # => "Username cannot be blank"

Allows to activate a specific locale for a specific block.

This method allows to activate a specific locale for a specific block, ensuring that the change of locale does not leak outside of the block. When the block execution completes, the locale that was previously activated prior to the block execution will be automatically activated again:

I18n.config.default_locale # outputs "en"
I18n.with_locale(:es) do
  I18n.translate!("test.translation") # outputs a spanish translation
end
I18n.translate!("test.translation") # outputs an english translation

An I18n::Errors::InvalidLocale exception will be raised by this method if the passed locale is not available in (ie. if no translations were defined for this locale).