Add docs to serializers. Update CHANGELOGs.

1 files changed, 71 insertions, 7 deletions

diff --git a/activemodel/lib/active_model/serializer.rb b/activemodel/lib/active_model/serializer.rb
index 5478da15c8..0e23df2f2b 100644
--- a/activemodel/lib/active_model/serializer.rb
+++ b/activemodel/lib/active_model/serializer.rb
@@ -5,6 +5,9 @@ require "set"
 
 module ActiveModel
   # Active Model Array Serializer
+  #
+  # It serializes an array checking if each element that implements
+  # the +active_model_serializer+ method passing down the current scope.
   class ArraySerializer
     attr_reader :object, :scope
 
@@ -28,15 +31,46 @@ module ActiveModel
   end
 
   # Active Model Serializer
+  #
+  # Provides a basic serializer implementation that allows you to easily
+  # control how a given object is going to be serialized. On initialization,
+  # it expects to object as arguments, a resource and a scope. For example,
+  # one may do in a controller:
+  #
+  #     PostSerializer.new(@post, current_user).to_json
+  #
+  # The object to be serialized is the +@post+ and the scope is +current_user+.
+  #
+  # We use the scope to check if a given attribute should be serialized or not.
+  # For example, some attributes maybe only be returned if +current_user+ is the
+  # author of the post:
+  #
+  #     class PostSerializer < ActiveModel::Serializer
+  #       attributes :title, :body
+  #       has_many :comments
+  #     
+  #       private
+  #
+  #       def attributes
+  #         hash = super
+  #         hash.merge!(:email => post.email) if author?
+  #         hash
+  #       end
+  #     
+  #       def author?
+  #         post.author == scope
+  #       end
+  #     end
+  #
   class Serializer
-    module Associations
-      class Config < Struct.new(:name, :options)
+    module Associations #:nodoc:
+      class Config < Struct.new(:name, :options) #:nodoc:
         def serializer
           options[:serializer]
         end
       end
 
-      class HasMany < Config
+      class HasMany < Config #:nodoc:
         def serialize(collection, scope)
           collection.map do |item|
             serializer.new(item, scope).serializable_hash
@@ -45,7 +79,7 @@ module ActiveModel
 
         def serialize_ids(collection, scope)
           # use named scopes if they are present
-          #return collection.ids if collection.respond_to?(:ids)
+          # return collection.ids if collection.respond_to?(:ids)
 
           collection.map do |item|
             item.read_attribute_for_serialization(:id)
@@ -53,7 +87,7 @@ module ActiveModel
         end
       end
 
-      class HasOne < Config
+      class HasOne < Config #:nodoc:
         def serialize(object, scope)
           object && serializer.new(object, scope).serializable_hash
         end
@@ -76,11 +110,12 @@ module ActiveModel
     class_attribute :_root_embed
 
     class << self
+      # Define attributes to be used in the serialization.
       def attributes(*attrs)
         self._attributes += attrs
       end
 
-      def associate(klass, attrs)
+      def associate(klass, attrs) #:nodoc:
         options = attrs.extract_options!
         self._associations += attrs.map do |attr|
           unless method_defined?(attr)
@@ -92,24 +127,43 @@ module ActiveModel
         end
       end
 
+      # Defines an association in the object should be rendered.
+      #
+      # The serializer object should implement the association name
+      # as a method which should return an array when invoked. If a method
+      # with the association name does not exist, the association name is
+      # dispatched to the serialized object.
       def has_many(*attrs)
         associate(Associations::HasMany, attrs)
       end
 
+      # Defines an association in the object should be rendered.
+      #
+      # The serializer object should implement the association name
+      # as a method which should return an object when invoked. If a method
+      # with the association name does not exist, the association name is
+      # dispatched to the serialized object.
       def has_one(*attrs)
         associate(Associations::HasOne, attrs)
       end
 
+      # Define how associations should be embedded.
+      #
+      #   embed :objects               # Embed associations as full objects
+      #   embed :ids                   # Embed only the association ids
+      #   embed :ids, :include => true # Embed the association ids and include objects in the root
+      #
       def embed(type, options={})
         self._embed = type
         self._root_embed = true if options[:include]
       end
 
+      # Defines the root used on serialization. If false, disables the root.
       def root(name)
         self._root = name
       end
 
-      def inherited(klass)
+      def inherited(klass) #:nodoc:
         return if klass.anonymous?
 
         name = klass.name.demodulize.underscore.sub(/_serializer$/, '')
@@ -127,6 +181,8 @@ module ActiveModel
       @object, @scope = object, scope
     end
 
+    # Returns a json representation of the serializable
+    # object including the root.
     def as_json(*)
       if _root
         hash = { _root => serializable_hash }
@@ -137,6 +193,8 @@ module ActiveModel
       end
     end
 
+    # Returns a hash representation of the serializable
+    # object without the root.
     def serializable_hash
       if _embed == :ids
         attributes.merge(association_ids)
@@ -147,6 +205,8 @@ module ActiveModel
       end
     end
 
+    # Returns a hash representation of the serializable
+    # object associations.
     def associations
       hash = {}
 
@@ -158,6 +218,8 @@ module ActiveModel
       hash
     end
 
+    # Returns a hash representation of the serializable
+    # object associations ids.
     def association_ids
       hash = {}
 
@@ -169,6 +231,8 @@ module ActiveModel
       hash
     end
 
+    # Returns a hash representation of the serializable
+    # object attributes.
     def attributes
       hash = {}