123456789_123456789_123456789_123456789_123456789_

Module: ActiveModel::Translation

Relationships & Source Files
Super Chains via Extension / Inclusion / Inheritance
Instance Chain:
self, Naming
Defined in: activemodel/lib/active_model/translation.rb

Overview

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.

Constant Summary

Instance Attribute Summary

Instance Method Summary

Naming - Included

#model_name

Returns an Name object for module.
#inherited

Instance Attribute Details

#raise_on_missing_translations (rw)

[ GitHub ] 

  


# File 'activemodel/lib/active_model/translation.rb', line 25



singleton_class.attr_accessor :raise_on_missing_translations


  







Instance Method Details



  

    #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.


  



  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/translation.rb', line 48



def human_attribute_name(attribute, options = {})
  attribute = attribute.to_s

  if attribute.include?(".")
    namespace, _, attribute = attribute.rpartition(".")
    namespace.tr!(".", "/")

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

  raise_on_missing = options.fetch(:raise, Translation.raise_on_missing_translations)

  defaults << :"attributes.#{attribute}"
  defaults << options[:default] if options[:default]
  defaults << MISSING_TRANSLATION unless raise_on_missing

  translation = I18n.translate(defaults.shift, count: 1, raise: raise_on_missing, **options, default: defaults)
  translation = attribute.humanize if translation == MISSING_TRANSLATION
  translation
end


  








  

    #i18n_scope  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/translation.rb', line 28



def i18n_scope
  :activemodel
end


  








  

    #lookup_ancestors  
  



  

    

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


  



  [ GitHub ]


  

  


# File 'activemodel/lib/active_model/translation.rb', line 36



def lookup_ancestors
  ancestors.select { |x| x.respond_to?(:model_name) }
end