lib/view_component/translatable.rb
# frozen_string_literal: true require "erb" require "set" require "i18n" require "active_support/concern" module ViewComponent module Translatable extend ActiveSupport::Concern HTML_SAFE_TRANSLATION_KEY = /(?:_|\b)html\z/ included do class_attribute :i18n_backend, instance_writer: false, instance_predicate: false end class_methods do def i18n_scope @i18n_scope ||= virtual_path.sub(%r{^/}, "").gsub(%r{/_?}, ".") end def build_i18n_backend return if CompileCache.compiled? self self.i18n_backend = if (translation_files = _sidecar_files(%w[yml yaml])).any? # Returning nil cleans up if translations file has been removed since the last compilation I18nBackend.new( i18n_scope: i18n_scope, load_paths: translation_files ) end end end class I18nBackend < ::I18n::Backend::Simple EMPTY_HASH = {}.freeze def initialize(i18n_scope:, load_paths:) @i18n_scope = i18n_scope.split(".").map(&:to_sym) @load_paths = load_paths end # Ensure the Simple backend won't load paths from ::I18n.load_path def load_translations super(@load_paths) end def scope_data(data) @i18n_scope.reverse_each do |part| data = {part => data} end data end def store_translations(locale, data, options = EMPTY_HASH) super(locale, scope_data(data), options) end end def translate(key = nil, **options) return super unless i18n_backend return key.map { |k| translate(k, **options) } if key.is_a?(Array) locale = options.delete(:locale) || ::I18n.locale scope = options.delete(:scope) scope = scope.join(".") if scope.is_a? Array key = key&.to_s unless key.is_a?(String) key = "#{scope}.#{key}" if scope key = "#{i18n_scope}#{key}" if key.start_with?(".") if HTML_SAFE_TRANSLATION_KEY.match?(key) html_escape_translation_options!(options) end if key.start_with?(i18n_scope + ".") translated = catch(:exception) do i18n_backend.translate(locale, key, options) end # Fallback to the global translations if translated.is_a? ::I18n::MissingTranslation return super(key, locale: locale, **options) end if HTML_SAFE_TRANSLATION_KEY.match?(key) translated = html_safe_translation(translated) end translated else super(key, locale: locale, **options) end end alias_method :t, :translate # Exposes .i18n_scope as an instance method def i18n_scope self.class.i18n_scope end def html_safe_translation(translation) if translation.respond_to?(:map) translation.map { |element| html_safe_translation(element) } else # It's assumed here that objects loaded by the i18n backend will respond to `#html_safe?`. # It's reasonable that if we're in Rails, `active_support/core_ext/string/output_safety.rb` # will provide this to `Object`. translation.html_safe end end private def html_escape_translation_options!(options) options.each do |name, value| unless i18n_option?(name) || (name == :count && value.is_a?(Numeric)) options[name] = ERB::Util.html_escape(value.to_s) end end end def i18n_option?(name) (@i18n_option_names ||= I18n::RESERVED_KEYS.to_set).include?(name) end end end