Permalink
Browse files

ActiveModel::Conversion documentation

  • Loading branch information...
1 parent 582228e commit 23e434f08fa756e9a8c472a8212c6f72ac92b32b @mikel mikel committed Jan 14, 2010
Showing with 21 additions and 2 deletions.
  1. +9 −1 activemodel/README
  2. +12 −1 activemodel/lib/active_model/conversion.rb
View
@@ -13,7 +13,7 @@ to then present a common interface to the Action Pack helpers.
You can include functionality from the following modules:
-* Callbacks
+* Adding callbacks to your class
class MyClass
extend ActiveModel::Callbacks
@@ -31,3 +31,11 @@ You can include functionality from the following modules:
{Learn more}[link:classes/ActiveModel/CallBacks.html]
+* For classes that already look like an Active Record object
+
+ class MyClass
+ include ActiveModel::Conversion
+ end
+
+ ...returns the class itself when sent :to_model
+
@@ -1,5 +1,16 @@
module ActiveModel
- # Include ActiveModel::Conversion if your object "acts like an ActiveModel model".
+ # If your object is already designed to implement all of the Active Model featurs
+ # include this module in your Class.
+ #
+ # class MyClass
+ # include ActiveModel::Conversion
+ # end
+ #
+ # Returns self to the <tt>:to_model</tt> method.
+ #
+ # If your model does not act like an Active Model object, then you should define
+ # <tt>:to_model</tt> yourself returning a proxy object that wraps your object
+ # with Active Model compliant methods.
module Conversion
def to_model
self

0 comments on commit 23e434f

Please sign in to comment.