Changeset 5699

Timestamp:

12/06/06 23:26:18 (2 years ago)

Author:

bitsweat

Message:

Merge [5694]-[5698] from trunk: respond_to json and render :json => ...

Files:

• branches/1-2-pre-release/actionpack/CHANGELOG (modified) (1 diff)
• branches/1-2-pre-release/actionpack/lib/action_controller/base.rb (modified) (3 diffs)
• branches/1-2-pre-release/actionpack/lib/action_controller/mime_type.rb (modified) (3 diffs)
• branches/1-2-pre-release/actionpack/test/controller/mime_responds_test.rb (modified) (2 diffs)
• branches/1-2-pre-release/actionpack/test/controller/render_test.rb (modified) (2 diffs)

branches/1-2-pre-release/actionpack/CHANGELOG

@@ -1 +1 @@
-*1.13.0 RC2*
+
+* 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]
+    # application/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]

branches/1-2-pre-release/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
-      #
@@ -735 +749 @@
-            render_xml(xml, options[:status])
-
+          elsif json = options[:json]
+            render_json(json, options[:callback], options[:status])
+
-          elsif partial = options[:partial]
-            partial = default_template_name if partial == true
@@ -813 +830 @@
-        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
-

branches/1-2-pre-release/actionpack/lib/action_controller/mime_type.rb

@@ -141 +141 @@
-  ATOM  = Type.new "application/atom+xml", :atom
-  YAML  = Type.new "application/x-yaml", :yaml, %w( text/yaml )
-
-
+
+
+
-
-  LOOKUP = Hash.new { |h, k| h[k] = Type.new(k) unless k == "" }
@@ -171 +172 @@
-  LOOKUP["application/atom+xml"]     = ATOM
-
-
+
+
+
+
-  EXTENSION_LOOKUP = Hash.new { |h, k| h[k] = Type.new(k) unless k == "" }
-
@@ -192 +196 @@
-  EXTENSION_LOOKUP["rss"]   = RSS
-  EXTENSION_LOOKUP["atom"]  = ATOM
+
+  EXTENSION_LOOKUP["json"]  = JSON
-end

branches/1-2-pre-release/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 :text => "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
+
+    get :json_or_yaml, :format => 'json'
+    assert_equal 'JSON', @response.body
+
+    get :json_or_yaml, :format => 'yaml'
+    assert_equal 'YAML', @response.body
+
+    { 'YAML' => %w(text/yaml),
+      'JSON' => %w(application/json text/x-json)
+    }.each do |body, content_types|
+      content_types.each do |content_type|
+        @request.env['HTTP_ACCEPT'] = content_type
+        get :json_or_yaml
+        assert_equal body, @response.body
+      end
+    end
-  end
-

branches/1-2-pre-release/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
-
@@ -165 +173 @@
-  end
-
+  def test_do_with_render_json
+    get :render_json_hello_world
+    assert_equal '{hello: "world"}', @response.body
+    assert_equal 'application/json', @response.content_type
+  end
+
+  def test_do_with_render_json_with_callback
+    get :render_json_hello_world_with_callback
+    assert_equal 'alert({hello: "world"})', @response.body
+    assert_equal 'application/json', @response.content_type
+  end
+
-  def test_do_with_render_custom_code
-    get :render_custom_code