Add to_key and to_param methods to ActiveModel::Conversion.

1 files changed, 35 insertions, 10 deletions

diff --git a/activemodel/lib/active_model/conversion.rb b/activemodel/lib/active_model/conversion.rb
index c14a07c7dc..78dc34197b 100644
--- a/activemodel/lib/active_model/conversion.rb
+++ b/activemodel/lib/active_model/conversion.rb
@@ -1,19 +1,44 @@
 module ActiveModel
-  # If your object is already designed to implement all of the Active Model featurs
-  # include this module in your Class.
-  # 
-  #   class MyClass
+  # Handle default conversions: to_model, to_key and to_param.
+  #
+  # == Example
+  #
+  # Let's take for example this non persisted object.
+  #
+  #   class ContactMessage
   #     include ActiveModel::Conversion
+  #
+  #     # Always a new record, since it's not persisted in the DB.
+  #     def new_record?
+  #       true
+  #     end
   #   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.
+  #
+  #   cm = ContactMessage.new
+  #   cm.to_model == self #=> true
+  #   cm.to_key           #=> nil
+  #   cm.to_param         #=> nil
+  #
   module Conversion
+    # If your object is already designed to implement all of the Active Model you can use
+    # the default to_model implementation, which simply returns self.
+    # 
+    # 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.
     def to_model
       self
     end
+
+    # Returns an Enumerable of all (primary) key attributes or nil if new_record? is true
+    def to_key
+      new_record? ? nil : [id]
+    end
+
+    # Returns a string representing the object's key suitable for use in URLs,
+    # or nil if new_record? is true
+    def to_param
+      to_key ? to_key.join('-') : nil
+    end
   end
 end