Permalink
Browse files

Adding documentation for ActiveModel::Translation

  • Loading branch information...
1 parent 71328a9 commit 91c38403be88a2a9a3485ddd58237445fa176a77 @mikel mikel committed Jan 18, 2010
Showing with 26 additions and 2 deletions.
  1. +9 −0 activemodel/README
  2. +17 −2 activemodel/lib/active_model/translation.rb
View
@@ -167,3 +167,12 @@ functionality from the following modules:
{Learn more}[link:classes/ActiveModel/StateMachine.html]
+* Integrating with Rail's internationalization (i18n) handling through
+ ActiveModel::Translations...
+
+ class Person
+ extend ActiveModel::Translation
+ end
+
+ {Learn more}[link:classes/ActiveModel/Translation.html]
+
@@ -1,6 +1,23 @@
require 'active_support/core_ext/hash/reverse_merge'
module ActiveModel
+
+ # ActiveModel::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_attribue')
+ # #=> "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.
module Translation
include ActiveModel::Naming
@@ -18,8 +35,6 @@ def lookup_ancestors
# Transforms attributes names into a more human format, such as "First name" instead of "first_name".
#
- # Example:
- #
# Person.human_attribute_name("first_name") # => "First name"
#
# Specify +options+ with additional translating options.

0 comments on commit 91c3840

Please sign in to comment.