Make scaffold_controller generator generate code for JSON response instead of XML

It seems like a lot of people are using JSON in their API more than XML nowadays, so Rails should follow that convention by providing the JSON format block in scaffold_controller by default.

This patch has been requested by DHH

2 files changed, 16 insertions, 14 deletions

diff --git a/railties/CHANGELOG b/railties/CHANGELOG
index f159247308..7f1be02cd2 100644
--- a/railties/CHANGELOG
+++ b/railties/CHANGELOG
@@ -1,5 +1,7 @@
 *Rails 3.1.0 (unreleased)*
 
+* Changed scaffold_controller generator to create format block for JSON instead of XML [Prem Sichanugrist]
+
 * Add using Turn with natural language test case names for test_help.rb when running with minitest (Ruby 1.9.2+) [DHH]
 
 * Direct logging of Active Record to STDOUT so it's shown inline with the results in the console [DHH]
diff --git a/railties/lib/rails/generators/rails/scaffold_controller/templates/controller.rb b/railties/lib/rails/generators/rails/scaffold_controller/templates/controller.rb
index b5317a055b..5fb8895654 100644
--- a/railties/lib/rails/generators/rails/scaffold_controller/templates/controller.rb
+++ b/railties/lib/rails/generators/rails/scaffold_controller/templates/controller.rb
@@ -1,35 +1,35 @@
 <% module_namespacing do -%>
 class <%= controller_class_name %>Controller < ApplicationController
   # GET <%= route_url %>
-  # GET <%= route_url %>.xml
+  # GET <%= route_url %>.json
   def index
     @<%= plural_table_name %> = <%= orm_class.all(class_name) %>
 
     respond_to do |format|
       format.html # index.html.erb
-      format.xml  { render :xml => @<%= plural_table_name %> }
+      format.json { render :json => @<%= plural_table_name %> }
     end
   end
 
   # GET <%= route_url %>/1
-  # GET <%= route_url %>/1.xml
+  # GET <%= route_url %>/1.json
   def show
     @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
 
     respond_to do |format|
       format.html # show.html.erb
-      format.xml  { render :xml => @<%= singular_table_name %> }
+      format.json { render :json => @<%= singular_table_name %> }
     end
   end
 
   # GET <%= route_url %>/new
-  # GET <%= route_url %>/new.xml
+  # GET <%= route_url %>/new.json
   def new
     @<%= singular_table_name %> = <%= orm_class.build(class_name) %>
 
     respond_to do |format|
       format.html # new.html.erb
-      format.xml  { render :xml => @<%= singular_table_name %> }
+      format.json { render :json => @<%= singular_table_name %> }
     end
   end
 
@@ -39,46 +39,46 @@ class <%= controller_class_name %>Controller < ApplicationController
   end
 
   # POST <%= route_url %>
-  # POST <%= route_url %>.xml
+  # POST <%= route_url %>.json
   def create
     @<%= singular_table_name %> = <%= orm_class.build(class_name, "params[:#{singular_table_name}]") %>
 
     respond_to do |format|
       if @<%= orm_instance.save %>
         format.html { redirect_to(@<%= singular_table_name %>, :notice => '<%= human_name %> was successfully created.') }
-        format.xml  { render :xml => @<%= singular_table_name %>, :status => :created, :location => @<%= singular_table_name %> }
+        format.json { render :json => @<%= singular_table_name %>, :status => :created, :location => @<%= singular_table_name %> }
       else
         format.html { render :action => "new" }
-        format.xml  { render :xml => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+        format.json { render :json => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
       end
     end
   end
 
   # PUT <%= route_url %>/1
-  # PUT <%= route_url %>/1.xml
+  # PUT <%= route_url %>/1.json
   def update
     @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
 
     respond_to do |format|
       if @<%= orm_instance.update_attributes("params[:#{singular_table_name}]") %>
         format.html { redirect_to(@<%= singular_table_name %>, :notice => '<%= human_name %> was successfully updated.') }
-        format.xml  { head :ok }
+        format.json { render :json => {}, :status => :ok }
       else
         format.html { render :action => "edit" }
-        format.xml  { render :xml => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
+        format.json { render :json => @<%= orm_instance.errors %>, :status => :unprocessable_entity }
       end
     end
   end
 
   # DELETE <%= route_url %>/1
-  # DELETE <%= route_url %>/1.xml
+  # DELETE <%= route_url %>/1.json
   def destroy
     @<%= singular_table_name %> = <%= orm_class.find(class_name, "params[:id]") %>
     @<%= orm_instance.destroy %>
 
     respond_to do |format|
       format.html { redirect_to(<%= index_helper %>_url) }
-      format.xml  { head :ok }
+      format.json { render :json => {}, :status => :ok }
     end
   end
 end