Permalink
Browse files

update ActiveModel::Conversion documentation [ci skip]

  • Loading branch information...
1 parent 35ee8fa commit d9238d044a0ad2ef5057c31e574d8cc687bb1b77 Francesco Rodriguez committed Jun 22, 2012
Showing with 21 additions and 8 deletions.
  1. +21 −8 activemodel/lib/active_model/conversion.rb
@@ -18,40 +18,53 @@ module ActiveModel
# end
#
# cm = ContactMessage.new
- # cm.to_model == self # => true
- # cm.to_key # => nil
- # cm.to_param # => nil
- # cm.to_partial_path # => "contact_messages/contact_message"
- #
+ # cm.to_model == cm # => true
+ # cm.to_key # => nil
+ # cm.to_param # => nil
+ # cm.to_partial_path # => "contact_messages/contact_message"
module Conversion
extend ActiveSupport::Concern
# If your object is already designed to implement all of the Active Model
# you can use the default <tt>:to_model</tt> implementation, which simply
# returns self.
#
+ # class Person
+ # include ActiveModel::Conversion
+ # end
+ #
+ # person = Person.new
+ # person.to_model == person # => true
+ #
# 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 key attributes if any is set, regardless
- # if the object is persisted or not.
+ # Returns an Enumerable of all key attributes if any is set, regardless if
+ # the object is persisted or not. If there no key attributes, returns +nil+.
def to_key
key = respond_to?(:id) && id
key ? [key] : nil
end
# Returns a string representing the object's key suitable for use in URLs,
- # or nil if <tt>persisted?</tt> is false.
+ # or +nil+ if <tt>persisted?</tt> is false.
def to_param
persisted? ? to_key.join('-') : nil
end
# Returns a string identifying the path associated with the object.
# ActionPack uses this to find a suitable partial to represent the object.
+ #
+ # class Person
+ # include ActiveModel::Conversion
+ # end
+ #
+ # person = Person.new
+ # person.to_partial_path # => "people/person"
def to_partial_path
self.class._to_partial_path
end

0 comments on commit d9238d0

Please sign in to comment.