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.
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 lib/active_model/translation.rb, line 45 45: def human_attribute_name(attribute, options = {}) 46: defaults = lookup_ancestors.map do |klass| 47: :"#{self.i18n_scope}.attributes.#{klass.model_name.underscore}.#{attribute}" 48: end 49: 50: defaults << :"attributes.#{attribute}" 51: defaults << options.delete(:default) if options[:default] 52: defaults << attribute.to_s.humanize 53: 54: options.reverse_merge! :count => 1, :default => defaults 55: I18n.translate(defaults.shift, options) 56: end
Model.human_name is deprecated. Use Model.model_name.human instead.
# File lib/active_model/translation.rb, line 59 59: def human_name(*args) 60: ActiveSupport::Deprecation.warn("human_name has been deprecated, please use model_name.human instead", caller[0,5]) 61: model_name.human(*args) 62: end
Returns the i18n_scope for the class. Overwrite if you want custom lookup.
# File lib/active_model/translation.rb, line 27 27: def i18n_scope 28: :activemodel 29: end
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.
# File lib/active_model/translation.rb, line 35 35: def lookup_ancestors 36: self.ancestors.select { |x| x.respond_to?(:model_name) } 37: end
Disabled; run with --debug to generate this.
Generated with the Darkfish Rdoc Generator 1.1.6.