From fe234a1538dd96c6e0d3ca44b651fcc7abc4663e Mon Sep 17 00:00:00 2001
From: Michael Koziarski <michael@koziarski.com>
Date: Mon, 15 Oct 2007 07:04:10 +0000
Subject: [PATCH] Fix Json related documentation for render and the AR
 serializer. Closes #9814. Closes #9833. [chuyeow]

git-svn-id: http://svn-commit.rubyonrails.org/rails/trunk@7905 5ecf4fe2-1ee6-0310-87b1-e25e094e27de
---
 actionpack/lib/action_controller/base.rb      | 16 ++++--
 actionpack/lib/action_controller/mime_type.rb |  2 +-
 .../serializers/json_serializer.rb            | 53 +++++++++++++++++++
 3 files changed, 65 insertions(+), 6 deletions(-)

diff --git a/actionpack/lib/action_controller/base.rb b/actionpack/lib/action_controller/base.rb
index 0f5604c707..b1fdea4635 100755
--- a/actionpack/lib/action_controller/base.rb
+++ b/actionpack/lib/action_controller/base.rb
@@ -748,16 +748,22 @@ def view_paths
       #
       # === Rendering JSON
       #
-      # Rendering JSON sets the content type to text/x-json and optionally wraps the JSON in a callback. It is expected
-      # that the response will be eval'd for use as a data structure.
+      # Rendering JSON sets the content type to application/json and optionally wraps the JSON in a callback. It is expected
+      # that the response will be parsed (or eval'd) for use as a data structure.
       #
-      #   # Renders '{name: "David"}'
+      #   # Renders '{"name": "David"}'
       #   render :json => {:name => "David"}.to_json
       #
+      # It's not necessary to call <tt>to_json</tt> on the object you want to render, since <tt>render</tt> will
+      # automatically do that for you:
+      #
+      #   # Also renders '{"name": "David"}'
+      #   render :json => {:name => "David"}
+      #
       # Sometimes the result isn't handled directly by a script (such as when the request comes from a SCRIPT tag),
-      # so the callback option is provided for these cases.
+      # so the <tt>:callback</tt> option is provided for these cases.
       #
-      #   # Renders 'show({name: "David"})'
+      #   # Renders 'show({"name": "David"})'
       #   render :json => {:name => "David"}.to_json, :callback => 'show'
       #
       # === Rendering an inline template
diff --git a/actionpack/lib/action_controller/mime_type.rb b/actionpack/lib/action_controller/mime_type.rb
index ef5fee0864..a0e2e70deb 100644
--- a/actionpack/lib/action_controller/mime_type.rb
+++ b/actionpack/lib/action_controller/mime_type.rb
@@ -52,7 +52,7 @@ def lookup_by_extension(extension)
         EXTENSION_LOOKUP[extension]
       end
 
-      # Registers an alias that's not usd on mime type lookup, but can be referenced directly. Especially useful for
+      # Registers an alias that's not used on mime type lookup, but can be referenced directly. Especially useful for
       # rendering different HTML versions depending on the user agent, like an iPhone.
       def register_alias(string, symbol, extension_synonyms = [])
         register(string, symbol, [], extension_synonyms, true)
diff --git a/activerecord/lib/active_record/serializers/json_serializer.rb b/activerecord/lib/active_record/serializers/json_serializer.rb
index 8b1b8299f8..cf44309de7 100644
--- a/activerecord/lib/active_record/serializers/json_serializer.rb
+++ b/activerecord/lib/active_record/serializers/json_serializer.rb
@@ -1,5 +1,58 @@
 module ActiveRecord #:nodoc:
   module Serialization
+    # Returns a JSON string representing the model. Some configuration is
+    # available through +options+.
+    #
+    # Without any +options+, the returned JSON string will include all
+    # the model's attributes. For example:
+    #
+    #   konata = User.find(1)
+    #   konata.to_json
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true}
+    #
+    # The :only and :except options can be used to limit the attributes
+    # included, and work similar to the #attributes method. For example:
+    #
+    #   konata.to_json(:only => [ :id, :name ])
+    #
+    #   {"id": 1, "name": "Konata Izumi"}
+    #
+    #   konata.to_json(:except => [ :id, :created_at, :age ])
+    #
+    #   {"name": "Konata Izumi", "awesome": true}
+    #
+    # To include any methods on the model, use :methods.
+    #
+    #   konata.to_json(:methods => :permalink)
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true,
+    #    "permalink": "1-konata-izumi"}
+    #
+    # To include associations, use :include.
+    #
+    #   konata.to_json(:include => :posts)
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true,
+    #    "posts": [{"id": 1, "author_id": 1, "title": "Welcome to the weblog"},
+    #              {"id": 2, author_id: 1, "title": "So I was thinking"}]}
+    #
+    # 2nd level and higher order associations work as well:
+    #
+    #   konata.to_json(:include => { :posts => {
+    #                                  :include => { :comments => {
+    #                                                :only => :body } },
+    #                                  :only => :title } })
+    #
+    #   {"id": 1, "name": "Konata Izumi", "age": 16,
+    #    "created_at": "2006/08/01", "awesome": true,
+    #    "posts": [{"comments": [{"body": "1st post!"}, {"body": "Second!"}],
+    #               "title": "Welcome to the weblog"},
+    #              {"comments": [{"body": "Don't think too hard"}],
+    #               "title": "So I was thinking"}]}
     def to_json(options = {})
       JsonSerializer.new(self, options).to_s
     end
-- 
GitLab