/Ruby on Rails 6.0

module ActionView::Helpers::TranslationHelper

Included modules:

Public Instance Methods

Alias for: localize
localize(*args) Show source
# File actionview/lib/action_view/helpers/translation_helper.rb, line 119
def localize(*args)

Delegates to I18n.localize with no additional functionality.

See www.rubydoc.info/github/svenfuchs/i18n/master/I18n/Backend/Base:localize for more information.

Also aliased as: l
t(key, options = {})
Alias for: translate
translate(key, options = {}) Show source
# File actionview/lib/action_view/helpers/translation_helper.rb, line 60
def translate(key, options = {})
  options = options.dup
  if options.has_key?(:default)
    remaining_defaults = Array.wrap(options.delete(:default)).compact
    options[:default] = remaining_defaults unless remaining_defaults.first.kind_of?(Symbol)

  # If the user has explicitly decided to NOT raise errors, pass that option to I18n.
  # Otherwise, tell I18n to raise an exception, which we rescue further in this method.
  # Note: `raise_error` refers to us re-raising the error in this method. I18n is forced to raise by default.
  if options[:raise] == false
    raise_error = false
    i18n_raise = false
    raise_error = options[:raise] || ActionView::Base.raise_on_missing_translations
    i18n_raise = true

  if html_safe_translation_key?(key)
    html_safe_options = options.dup
    options.except(*I18n::RESERVED_KEYS).each do |name, value|
      unless name == :count && value.is_a?(Numeric)
        html_safe_options[name] = ERB::Util.html_escape(value.to_s)
    translation = I18n.translate(scope_key_by_partial(key), html_safe_options.merge(raise: i18n_raise))
    if translation.respond_to?(:map)
      translation.map { |element| element.respond_to?(:html_safe) ? element.html_safe : element }
      translation.respond_to?(:html_safe) ? translation.html_safe : translation
    I18n.translate(scope_key_by_partial(key), options.merge(raise: i18n_raise))
rescue I18n::MissingTranslationData => e
  if remaining_defaults.present?
    translate remaining_defaults.shift, options.merge(default: remaining_defaults)
    raise e if raise_error

    keys = I18n.normalize_keys(e.locale, e.key, e.options[:scope])
    title = +"translation missing: #{keys.join('.')}"

    interpolations = options.except(:default, :scope)
    if interpolations.any?
      title << ", " << interpolations.map { |k, v| "#{k}: #{ERB::Util.html_escape(v)}" }.join(", ")

    return title unless ActionView::Base.debug_missing_translation

    content_tag("span", keys.last.to_s.titleize, class: "translation_missing", title: title)

Delegates to I18n#translate but also performs three additional functions.

First, it will ensure that any thrown MissingTranslation messages will be rendered as inline spans that:

  • Have a translation-missing class applied

  • Contain the missing key as the value of the title attribute

  • Have a titleized version of the last key segment as text

For example, the value returned for the missing translation key "blog.post.title" will be:

  title="translation missing: en.blog.post.title">Title</span>

This allows for views to display rather reasonable strings while still giving developers a way to find missing translations.

If you would prefer missing translations to raise an error, you can opt out of span-wrapping behavior globally by setting ActionView::Base.raise_on_missing_translations = true or individually by passing raise: true as an option to translate.

Second, if the key starts with a period translate will scope the key by the current partial. Calling translate(".foo") from the people/index.html.erb template is equivalent to calling translate("people.index.foo"). This makes it less repetitive to translate many keys within the same partial and provides a convention to scope keys consistently.

Third, the translation will be marked as html_safe if the key has the suffix “_html” or the last element of the key is “html”. Calling translate("footer_html") or translate("footer.html") will return an HTML safe string that won't be escaped by other HTML helper methods. This naming convention helps to identify translations that include HTML tags so that you know what kind of output to expect when you call translate in a template and translators know which keys they can provide HTML values for.

Also aliased as: t

© 2004–2019 David Heinemeier Hansson
Licensed under the MIT License.