Changeset 5694

Timestamp:

12/06/06 22:27:08 (2 years ago)

Author:

bitsweat

Message:

respond_to recognizes JSON. render :json => @person.to_json automatically sets the content type and takes a :callback option to specify a client-side function to call using the rendered JSON as an argument. References #4185.

Files:

• trunk/actionpack/CHANGELOG (modified) (1 diff)
• trunk/actionpack/lib/action_controller/base.rb (modified) (3 diffs)
• trunk/actionpack/lib/action_controller/mime_types.rb (modified) (1 diff)
• trunk/actionpack/lib/action_controller/request.rb (modified) (1 diff)
• trunk/actionpack/test/controller/mime_responds_test.rb (modified) (2 diffs)
• trunk/actionpack/test/controller/render_test.rb (modified) (2 diffs)

trunk/actionpack/CHANGELOG

@@ -1 +1 @@
-*SVN*
+
+* respond_to recognizes JSON. render :json => @person.to_json automatically sets the content type and takes a :callback option to specify a client-side function to call using the rendered JSON as an argument.  #4185 [Scott Raymond, eventualbuddha]
+    # text/x-json response with body 'Element.show({:name: "David"})'
+    respond_to do |format|
+      format.json { render :json => { :name => "David" }.to_json, :callback => 'Element.show' }
+    end
-
-* Makes :discard_year work without breaking multi-attribute parsing in AR.  #1260, #3800 [sean@ardismg.com, jmartin@desertflood.com, stephen@touset.org, Bob Silva]

trunk/actionpack/lib/action_controller/base.rb

@@ -651 +651 @@
-      # _Deprecation_ _notice_: This used to have the signature <tt>render_text("text", status = 200)</tt>
-      #
+      # === 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.
+      #
+      #   # Renders '{name: "David"}'
+      #   render :json => {:name => "David"}.to_json
+      #
+      # 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.
+      #
+      #   # Renders 'show({name: "David"})'
+      #   render :json => {:name => "David"}.to_json, :callback => 'show'
+      #
-      # === Rendering an inline template
-      #
@@ -734 +748 @@
-          elsif xml = options[:xml]
-            render_xml(xml, options[:status])
+          
+          elsif json = options[:json]
+            render_json(json, options[:callback], options[:status])
+          
+          elsif yaml = options[:yaml]
+            render_yaml(yaml, options[:status])
-
-          elsif partial = options[:partial]
@@ -813 +833 @@
-        response.content_type = Mime::XML
-        render_text(xml, status)
+      end
+      
+      def render_json(json, callback = nil, status = nil) #:nodoc:
+        json = "#{callback}(#{json})" unless callback.blank?
+        
+        response.content_type = Mime::JSON
+        render_text(json, status)
+      end
+      
+      def render_yaml(yaml, status = nil) #:nodoc:
+        response.content_type = Mime::YAML
+        render_text(yaml, status)
-      end
-

trunk/actionpack/lib/action_controller/mime_types.rb

@@ -3 +3 @@
-Mime::Type.register "text/html", :html, %w( application/xhtml+xml ), %w( xhtml )
-Mime::Type.register "text/javascript", :js, %w( application/javascript application/x-javascript )
+Mime::Type.register "text/x-json", :json, %w( application/x-json )
-Mime::Type.register "text/calendar", :ics
-Mime::Type.register "text/csv", :csv

trunk/actionpack/lib/action_controller/request.rb

@@ -67 +67 @@
-            when 'xml'
-              content_type = 'application/xml'
+            when 'json'
+              content_type = 'application/x-json'
-            end
-          end

trunk/actionpack/test/controller/mime_responds_test.rb

@@ -18 +18 @@
-      type.js   { render :text => "JS"      }
-      type.all  { render :text => "Nothing" }
+    end
+  end
+  
+  def json_or_yaml
+    respond_to do |type|
+      type.json { render :text => "JSON" }
+      type.yaml { render :yaml => "YAML" }
-    end
-  end
@@ -163 +170 @@
-    get :just_xml
-    assert_response 406
+  end
+  
+  def test_json_or_yaml
+    get :json_or_yaml
+    assert_equal 'JSON', @response.body
+    
+    @request.env["HTTP_ACCEPT"] = "text/yaml"
+    get :json_or_yaml
+    assert_equal 'YAML', @response.body
+    
+    @request.env["HTTP_ACCEPT"] = "text/x-json"
+    get :json_or_yaml
+    assert_equal 'JSON', @response.body
-  end
-

trunk/actionpack/test/controller/render_test.rb

@@ -38 +38 @@
-  def render_text_hello_world
-    render_text "hello world"
+  end
+  
+  def render_json_hello_world
+    render_json({:hello => 'world'}.to_json)
+  end
+  
+  def render_json_hello_world_with_callback
+    render_json({:hello => 'world'}.to_json, 'alert')
-  end
-
@@ -164 +172 @@
-    assert_equal "hello world", @response.body
-  end
+  
+  def test_do_with_render_json
+    get :render_json_hello_world
+    assert_equal '{hello: "world"}', @response.body
+  end
+  
+  def test_do_with_render_json_with_callback
+    get :render_json_hello_world_with_callback
+    assert_equal 'alert({hello: "world"})', @response.body
+  end
-
-  def test_do_with_render_custom_code