107 lines
4.6 KiB
Ruby
107 lines
4.6 KiB
Ruby
require 'action_view/helpers/tag_helper'
|
|
require 'active_support/core_ext/string/access'
|
|
require 'i18n/exceptions'
|
|
|
|
module ActionView
|
|
# = Action View Translation Helpers
|
|
module Helpers
|
|
module TranslationHelper
|
|
include TagHelper
|
|
# Delegates to <tt>I18n#translate</tt> but also performs three additional functions.
|
|
#
|
|
# First, it will ensure that any thrown +MissingTranslation+ messages will be turned
|
|
# into inline spans that:
|
|
#
|
|
# * have a "translation-missing" class set,
|
|
# * contain the missing key as a title attribute and
|
|
# * a titleized version of the last key segment as a text.
|
|
#
|
|
# E.g. the value returned for a missing translation key :"blog.post.title" will be
|
|
# <span class="translation_missing" title="translation missing: en.blog.post.title">Title</span>.
|
|
# This way your views will display rather reasonable strings but it will still
|
|
# be easy to spot missing translations.
|
|
#
|
|
# Second, it'll scope the key by the current partial if the key starts
|
|
# with a period. So if you call <tt>translate(".foo")</tt> from the
|
|
# <tt>people/index.html.erb</tt> template, you'll actually be calling
|
|
# <tt>I18n.translate("people.index.foo")</tt>. This makes it less repetitive
|
|
# to translate many keys within the same partials and gives you a simple framework
|
|
# for scoping them consistently. If you don't prepend the key with a period,
|
|
# nothing is converted.
|
|
#
|
|
# Third, it'll mark the translation as safe HTML if the key has the suffix
|
|
# "_html" or the last element of the key is the word "html". For example,
|
|
# calling translate("footer_html") or translate("footer.html") will return
|
|
# a safe HTML 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.
|
|
def translate(key, options = {})
|
|
options = options.dup
|
|
remaining_defaults = Array(options.delete(:default))
|
|
options[:default] = remaining_defaults.shift if remaining_defaults.first.kind_of? String
|
|
|
|
# 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 || (options.key?(:rescue_format) && options[:rescue_format].nil?)
|
|
raise_error = false
|
|
options[:raise] = false
|
|
else
|
|
raise_error = options[:raise] || options[:rescue_format] || ActionView::Base.raise_on_missing_translations
|
|
options[: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)
|
|
|
|
translation.respond_to?(:html_safe) ? translation.html_safe : translation
|
|
else
|
|
I18n.translate(scope_key_by_partial(key), options)
|
|
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])
|
|
content_tag('span', keys.last.to_s.titleize, :class => 'translation_missing', :title => "translation missing: #{keys.join('.')}")
|
|
end
|
|
end
|
|
alias :t :translate
|
|
|
|
# Delegates to <tt>I18n.localize</tt> with no additional functionality.
|
|
#
|
|
# See http://rubydoc.info/github/svenfuchs/i18n/master/I18n/Backend/Base:localize
|
|
# for more information.
|
|
def localize(*args)
|
|
I18n.localize(*args)
|
|
end
|
|
alias :l :localize
|
|
|
|
private
|
|
def scope_key_by_partial(key)
|
|
if key.to_s.first == "."
|
|
if @virtual_path
|
|
@virtual_path.gsub(%r{/_?}, ".") + key.to_s
|
|
else
|
|
raise "Cannot use t(#{key.inspect}) shortcut because path is not available"
|
|
end
|
|
else
|
|
key
|
|
end
|
|
end
|
|
|
|
def html_safe_translation_key?(key)
|
|
key.to_s =~ /(\b|_|\.)html$/
|
|
end
|
|
end
|
|
end
|
|
end
|