Module: ActiveModel::Translation
Relationships & Source Files | |
Extension / Inclusion / Inheritance Descendants | |
Extended In:
| |
Included In:
| |
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.
Instance Method Summary
-
#human_attribute_name(attribute, options = {})
Transforms attribute names into a more human format, such as “First name” instead of “first_name”.
-
#i18n_scope
Returns the #i18n_scope for the class.
-
#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.
Naming
- Included
#model_name | Returns an |
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.
# File 'activemodel/lib/active_model/translation.rb', line 46
def human_attribute_name(attribute, = {}) 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 defaults << :"attributes.#{attribute}" defaults << [:default] if [:default] defaults << MISSING_TRANSLATION translation = I18n.translate(defaults.shift, count: 1, **, 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.
# File 'activemodel/lib/active_model/translation.rb', line 26
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.
# File 'activemodel/lib/active_model/translation.rb', line 34
def lookup_ancestors ancestors.select { |x| x.respond_to?(:model_name) } end