2008-07-06 13:00:55 -04:00
|
|
|
require 'action_view/helpers/tag_helper'
|
2010-11-14 12:46:40 -05:00
|
|
|
require 'i18n/exceptions'
|
|
|
|
|
|
|
|
module I18n
|
|
|
|
class ExceptionHandler
|
|
|
|
include Module.new {
|
|
|
|
def call(exception, locale, key, options)
|
2011-04-24 11:37:57 -04:00
|
|
|
exception.is_a?(MissingTranslation) ? super.html_safe : super
|
2010-11-14 12:46:40 -05:00
|
|
|
end
|
|
|
|
}
|
|
|
|
end
|
|
|
|
end
|
2008-07-06 13:00:55 -04:00
|
|
|
|
|
|
|
module ActionView
|
2010-06-16 14:24:53 -04:00
|
|
|
# = Action View Translation Helpers
|
2008-07-06 13:00:55 -04:00
|
|
|
module Helpers
|
|
|
|
module TranslationHelper
|
2011-05-10 18:34:59 -04:00
|
|
|
# Delegates to <tt>I18n#translate</tt> but also performs three additional functions.
|
2010-11-14 12:46:40 -05:00
|
|
|
#
|
2011-05-10 18:34:59 -04:00
|
|
|
# First, it'll pass the <tt>:rescue_format => :html</tt> option to I18n so that any
|
|
|
|
# thrown +MissingTranslation+ messages will be turned into inline spans that
|
2010-11-14 12:46:40 -05:00
|
|
|
#
|
|
|
|
# * 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: blog.post.title">Title</span>.
|
2011-03-04 00:09:26 -05:00
|
|
|
# This way your views will display rather reasonable strings but it will still
|
2010-11-14 12:46:40 -05:00
|
|
|
# be easy to spot missing translations.
|
2009-02-10 06:57:12 -05:00
|
|
|
#
|
2010-08-14 01:13:00 -04:00
|
|
|
# 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
|
2010-06-16 14:24:53 -04:00
|
|
|
# <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
|
2010-08-14 01:13:00 -04:00
|
|
|
# for scoping them consistently. If you don't prepend the key with a period,
|
2010-06-16 14:24:53 -04:00
|
|
|
# nothing is converted.
|
2010-04-09 21:01:32 -04:00
|
|
|
#
|
2010-08-14 01:13:00 -04:00
|
|
|
# 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
|
2010-06-16 14:24:53 -04:00
|
|
|
# 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
|
2010-04-09 21:01:32 -04:00
|
|
|
# you know what kind of output to expect when you call translate in a template.
|
2010-05-24 16:21:18 -04:00
|
|
|
def translate(key, options = {})
|
2010-12-04 17:07:54 -05:00
|
|
|
options.merge!(:rescue_format => :html) unless options.key?(:rescue_format)
|
2010-11-14 12:46:40 -05:00
|
|
|
translation = I18n.translate(scope_key_by_partial(key), options)
|
2010-05-24 23:16:50 -04:00
|
|
|
if html_safe_translation_key?(key) && translation.respond_to?(:html_safe)
|
|
|
|
translation.html_safe
|
|
|
|
else
|
|
|
|
translation
|
|
|
|
end
|
2008-07-06 13:00:55 -04:00
|
|
|
end
|
2008-08-25 05:06:18 -04:00
|
|
|
alias :t :translate
|
2008-07-08 06:37:49 -04:00
|
|
|
|
2011-05-10 18:34:59 -04:00
|
|
|
# Delegates to <tt>I18n.localize</tt> with no additional functionality.
|
2008-07-08 06:37:49 -04:00
|
|
|
def localize(*args)
|
2009-10-29 14:39:59 -04:00
|
|
|
I18n.localize(*args)
|
2008-07-08 06:37:49 -04:00
|
|
|
end
|
2008-08-25 05:06:18 -04:00
|
|
|
alias :l :localize
|
2009-02-10 06:57:12 -05:00
|
|
|
|
|
|
|
private
|
2010-05-24 16:21:18 -04:00
|
|
|
def scope_key_by_partial(key)
|
2010-05-24 16:49:21 -04:00
|
|
|
if key.to_s.first == "."
|
2011-05-01 05:14:38 -04:00
|
|
|
if @virtual_path
|
|
|
|
@virtual_path.gsub(%r{/_?}, ".") + key.to_s
|
2010-01-26 14:43:35 -05:00
|
|
|
else
|
2010-05-24 16:21:18 -04:00
|
|
|
raise "Cannot use t(#{key.inspect}) shortcut because path is not available"
|
2010-01-26 14:43:35 -05:00
|
|
|
end
|
2010-05-24 16:21:18 -04:00
|
|
|
else
|
|
|
|
key
|
2009-02-10 06:57:12 -05:00
|
|
|
end
|
|
|
|
end
|
2010-04-09 21:01:32 -04:00
|
|
|
|
2010-05-24 16:21:18 -04:00
|
|
|
def html_safe_translation_key?(key)
|
2010-05-24 16:49:21 -04:00
|
|
|
key.to_s =~ /(\b|_|\.)html$/
|
2010-04-09 21:01:32 -04:00
|
|
|
end
|
2008-07-06 13:00:55 -04:00
|
|
|
end
|
|
|
|
end
|
2010-02-18 19:33:24 -05:00
|
|
|
end
|