restful_json 3.2.0 → 3.2.1

data/README.md

@@ -271,15 +271,11 @@ You can have something as simple as:
 
 which would use the restful_json configuration and the controller's classname for the service definition.
 
-Or you could have a superclass:
+Or, you could define more bells and whistles (read on to see what these do...):
 
-    class ServiceController < ApplicationController
-      acts_as_restful_json
-    end
-
-And define more bells and whistles (read on to see what these do...):
+    class FoobarsController < ApplicationController
 
-    class FoobarsController < ServiceController
+      acts_as_restful_json
       
       query_for :index, is: ->(t,q) {q.joins(:apples, :pears).where(apples: {color: 'green'}).where(pears: {color: 'green'})}
       
@@ -308,6 +304,28 @@ And define more bells and whistles (read on to see what these do...):
       
     end
 
+##### Parent/Ancestor Class Definition Not Supported
+
+Have had issues with putting `acts_as_restful_json` in parent/ancestor class, so even though it seems like it would be a good idea at first to move it into a shared parent controller, please keep it in each individual controller, e.g.:
+
+Don't do this:
+
+    class ServiceController < ApplicationController
+      acts_as_restful_json
+    end
+    
+    class FoobarsController < ServiceController
+      acts_as_restful_json
+    end
+
+It may appear to work when using the same controller, but when you make requests to more than one controller sharing the same parent/ancestor that define `acts_as_restful_json`, it may fail in very strange ways that are hard to diagnose from the error message.
+
+Do this instead:
+
+    class FoobarsController < ApplicationController
+      acts_as_restful_json
+    end
+
 #### Default Filtering by Attribute(s)
 
 First, declare in the controller:

data/lib/restful_json/controller.rb

@@ -4,6 +4,20 @@ require 'active_model_serializers'
 require 'strong_parameters'
 require 'cancan'
 
+# The restful_json controller module. This module (RestfulJson::Controller) is included on ActionController
+# and then each individual controller should call acts_as_restful_json.
+#
+# Only use acts_as_restful_json in each individual service controller rather than a parent or
+# ancestor class of the service controller. class_attribute's are supposed to work when you subclass,
+# if you use setters (=, =+ to add to array instead of <<, etc.) but we have seen strange errors
+# about missing columns, etc. related to the model_class, etc. being wrong if you share a 
+# parent/ancestor class that acts_as_restful_json and then switch back and forth between controllers.
+# Why? The controller class overrides the shared class_attribute's when the controller class loads,
+# which other than re-loading via Rails autoload, only happens once; so you hit one controller, then the
+# the other, it starts overwriting/adding to attributes, and then when you hit the first one again, no
+# class method calling on class instantiation is being called, so it is using the wrong model. That is
+# bad, so don't do that.
+#
 module RestfulJson
   module Controller
     extend ActiveSupport::Concern
@@ -358,11 +372,12 @@ module RestfulJson
         @value.save
         instance_variable_set(@model_at_singular_name_sym, @value)
 
-        if self.render_enabled
-          custom_action_serializer = self.action_to_serializer[params[:action].to_s]
+        if self.render_enabled          
           if !@value.nil? && RestfulJson.return_resource
             respond_with(@value) do |format|
               format.json do
+                # define local variables in blocks, not outside of them, to be safe, even though would work in this case
+                custom_action_serializer = self.action_to_serializer[params[:action].to_s]
                 if @value.errors.empty?
                   render custom_action_serializer ? {json: @value, status: :created, serializer: custom_action_serializer} : {json: @value, status: :created}
                 else
@@ -371,6 +386,7 @@ module RestfulJson
               end
             end
           else
+            custom_action_serializer = self.action_to_serializer[params[:action].to_s]
             respond_with @value, custom_action_serializer ? {serializer: custom_action_serializer} : {}
           end
         else
@@ -396,10 +412,11 @@ module RestfulJson
         instance_variable_set(@model_at_singular_name_sym, @value)
         
         if self.render_enabled
-          custom_action_serializer = self.action_to_serializer[params[:action].to_s]
           if !@value.nil? && RestfulJson.return_resource
             respond_with(@value) do |format|
               format.json do
+                # define local variables in blocks, not outside of them, to be safe, even though would work in this case
+                custom_action_serializer = self.action_to_serializer[params[:action].to_s]
                 if @value.errors.empty?
                   render custom_action_serializer ? {json: @value, status: :ok, serializer: custom_action_serializer} : {json: @value, status: :ok}
                 else
@@ -408,6 +425,7 @@ module RestfulJson
               end
             end
           else
+            custom_action_serializer = self.action_to_serializer[params[:action].to_s]
             respond_with @value, custom_action_serializer ? {serializer: custom_action_serializer} : {}
           end
         else
@@ -423,6 +441,7 @@ module RestfulJson
         instance_variable_set(@model_at_singular_name_sym, @value)
 
         if self.render_enabled
+          custom_action_serializer = self.action_to_serializer[params[:action].to_s]
           respond_with @value, custom_action_serializer ? {serializer: custom_action_serializer} : {}
         else
           @value

data/lib/restful_json/version.rb

@@ -1,3 +1,3 @@
 module RestfulJson
-  VERSION = '3.2.0'
+  VERSION = '3.2.1'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_json
 version: !ruby/object:Gem::Version
-  version: 3.2.0
+  version: 3.2.1
   prerelease: 
 platform: ruby
 authors:
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-25 00:00:00.000000000 Z
+date: 2013-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: actionpack