module ActionView::Helpers::TranslationHelper
Public Instance Methods
# File actionview/lib/action_view/helpers/translation_helper.rb, line 117 def localize(*args) I18n.localize(*args) end
Delegates to I18n.localize
with no additional functionality.
See rubydoc.info/github/svenfuchs/i18n/master/I18n/Backend/Base:localize for more information.
# File actionview/lib/action_view/helpers/translation_helper.rb, line 59 def translate(key, options = {}) options = options.dup has_default = options.has_key?(:default) remaining_defaults = Array(options.delete(:default)).compact if has_default && !remaining_defaults.first.kind_of?(Symbol) options[:default] = remaining_defaults end # 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 else raise_error = options[:raise] || ActionView::Base.raise_on_missing_translations i18n_raise = true end 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) end end translation = I18n.translate(scope_key_by_partial(key), html_safe_options.merge(raise: i18n_raise)) translation.respond_to?(:html_safe) ? translation.html_safe : translation else I18n.translate(scope_key_by_partial(key), options.merge(raise: i18n_raise)) end rescue I18n::MissingTranslationData => e if remaining_defaults.present? translate remaining_defaults.shift, options.merge(default: remaining_defaults) else 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(', ') end return title unless ActionView::Base.debug_missing_translation content_tag('span', keys.last.to_s.titleize, class: 'translation_missing', title: title) end end
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:
<span class="translation_missing" 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.
© 2004–2018 David Heinemeier Hansson
Licensed under the MIT License.