rails/actionpack/lib/abstract_controller/translation.rb
Hartley McGuire b3c6a9adf0
Remove explicit "aliased as" documentation
Most of these are redundant because rdoc handles these itself, but
`titlecase` on `ActiveSupport::Inflector` does not exist so that one is
just incorrect.
2023-05-18 11:04:04 -04:00

39 lines
1.3 KiB
Ruby

# frozen_string_literal: true
require "active_support/html_safe_translation"
module AbstractController
module Translation
mattr_accessor :raise_on_missing_translations, default: false
# Delegates to <tt>I18n.translate</tt>.
#
# When the given key starts with a period, it will be scoped by the current
# controller and action. So if you call <tt>translate(".foo")</tt> from
# <tt>PeopleController#index</tt>, it will convert the call to
# <tt>I18n.translate("people.index.foo")</tt>. This makes it less repetitive
# to translate many keys within the same controller / action and gives you a
# simple framework for scoping them consistently.
def translate(key, **options)
if key&.start_with?(".")
path = controller_path.tr("/", ".")
defaults = [:"#{path}#{key}"]
defaults << options[:default] if options[:default]
options[:default] = defaults.flatten
key = "#{path}.#{action_name}#{key}"
end
i18n_raise = options.fetch(:raise, self.raise_on_missing_translations)
ActiveSupport::HtmlSafeTranslation.translate(key, **options, raise: i18n_raise)
end
alias :t :translate
# Delegates to <tt>I18n.localize</tt>.
def localize(object, **options)
I18n.localize(object, **options)
end
alias :l :localize
end
end