ActiveModel::Translation

Active Model Translation

Provides integration between your object and the Rails internationalization (i18n) framework.

A minimal implementation could be:

class TranslatedPerson
  extend ActiveModel::Translation
end

TranslatedPerson.human_attribute_name('my_attribute')
# => "My attribute"

This also provides the required class methods for hooking into the Rails internationalization API, including being able to define a class based i18n_scope and lookup_ancestors to find translations in parent classes.

Included Modules

ActiveModel::Naming

Instance Public methods

human_attribute_name(attribute, options = {})

Transforms attribute names into a more human format, such as “First name” instead of “first_name”.

Person.human_attribute_name("first_name") # => "First name"

Specify options with additional translating options.

📝 Source code

# File activemodel/lib/active_model/translation.rb, line 44
    def human_attribute_name(attribute, options = {})
      options   = { count: 1 }.merge!(options)
      parts     = attribute.to_s.split(".")
      attribute = parts.pop
      namespace = parts.join("/") unless parts.empty?
      attributes_scope = "#{i18n_scope}.attributes"

      if namespace
        defaults = lookup_ancestors.map do |klass|
          :"#{attributes_scope}.#{klass.model_name.i18n_key}/#{namespace}.#{attribute}"
        end
        defaults << :"#{attributes_scope}.#{namespace}.#{attribute}"
      else
        defaults = lookup_ancestors.map do |klass|
          :"#{attributes_scope}.#{klass.model_name.i18n_key}.#{attribute}"
        end
      end

      defaults << :"attributes.#{attribute}"
      defaults << options.delete(:default) if options[:default]
      defaults << attribute.humanize

      options[:default] = defaults
      I18n.translate(defaults.shift, **options)
    end

🔎 See on GitHub

i18n_scope()

Returns the i18n_scope for the class. Overwrite if you want custom lookup.

📝 Source code

# File activemodel/lib/active_model/translation.rb, line 26
    def i18n_scope
      :activemodel
    end

🔎 See on GitHub

lookup_ancestors()

When localizing a string, it goes through the lookup returned by this method, which is used in ActiveModel::Name#human, ActiveModel::Errors#full_messages and ActiveModel::Translation#human_attribute_name.

📝 Source code

# File activemodel/lib/active_model/translation.rb, line 34
    def lookup_ancestors
      ancestors.select { |x| x.respond_to?(:model_name) }
    end

🔎 See on GitHub