restful_json 4.1.0 → 4.2.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    YjBiNTMxMDFhMDg0NDIwMTMzNzg1ZDVhYmQxYTlkNzM0OThiZTg2ZQ==
+    OTZiNzMzYTllNTRkNGQ1N2I1ZjYyOWM4ZDJlZjI3MWQ4ZDMzMTg4Yg==
   data.tar.gz: !binary |-
-    NjhjODQ3Yzc2Nzk4MTI0ZTkxYjI3MmMwYTBlNTZlY2U1ZTkwOTM1Ng==
+    NTRiMGMwZjRmZjllYTJhNTUxZDdhYWQ0ZTIzM2U2OTY0MmJkZTkzZA==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YzhkZGIwMzA4YzAzNjYyYWRjMmMzOTgwYTJiZDk1OGEwNjQ5MGQ1N2EzNGMx
-    NGM3MmQ4NDU2N2U4YmQzYWVlYmQzMTBiMTcxOTI4ZGY5Y2JkMDdjMzUyNTgx
-    NzYxYzk1YWZiY2I1NzUxYTQ5NTA0MzJmMGU2YWRlODQzOGI1MzM=
+    ODZmNGI1MDljOGM4YTRhZmY1OTU5MjAyYzRmZGY5ZGNhZjdmMGJkZTE3OTE0
+    M2M5M2FjMzAxYTMwNDJhMzhlMDY0YWMyNDZmMDk0N2JmNjI5MTg5NDUwMmM5
+    NDU0YWZmOTA0NjMyNTE1MmY3MWU1NGNiNzlkZTk2YjUyNWU1MDk=
   data.tar.gz: !binary |-
-    MGY3NTJiOWNiOGE5MDZjMTBjMTllYTNiYmIzZjg1MDgyZDQ1OTc3MzZiZGMx
-    ZWZhMjliZTAwNTExNmFlZTcwZjM2MDZiZTQ0MTUyMDQ5YjRiMjcyYWIzMDMx
-    ZTI3MGU5OTM5NDQ0YjZkMWY0ZTAzZDQ0ZGEwMmMyZWIzZjcyODE=
+    ZmMwNjgxMDI1ZDhhNjc0YzA3YzUyNDJlZjI0NDZiYTZhYzg0MjJhYTIwNTIx
+    YTEwZWNiYzcwOGVmNTcxYWY1ODc1ODc5NDQ3NzY5YTY0YTAxYmQ5Y2UxZjNk
+    ZjM5OWEwZjIzODk4MDc1MmExM2RjMDQ1NzdiNzZjMzNmNmRlMmY=

data/README.md

@@ -252,40 +252,40 @@ or in bulk, like:
 
 ```ruby
 RestfulJson.configure do
-
+  
   # default for :using in can_filter_by
   self.can_filter_by_default_using = [:eq]
-
+  
   # to log debug info during request handling
   self.debug = false
-
+  
   # delimiter for values in request parameter values
   self.filter_split = ','.freeze
-
+  
   # equivalent to specifying respond_to :json, :html in the controller, and can be overriden in the controller. Note that by default responders gem sets respond_to :html in application_controller.rb.
   self.formats = :json, :html
-
+  
   # default number of records to return if using the page request function
   self.number_of_records_in_a_page = 15
-
+  
   # delimiter for ARel predicate in the request parameter name
   self.predicate_prefix = '!'.freeze
-
+  
   # if true, will render resource and HTTP 201 for post/create or resource and HTTP 200 for put/update. ignored if render_enabled is false.
   self.return_resource = false
-
+  
   # if false, controller actions will just set instance variable and return it instead of calling setting instance variable and then calling render/respond_with
   self.render_enabled = true
-
+  
   # use Permitters
   self.use_permitters = true
-
+  
   # instead of using Rails default respond_with, explicitly define render in respond_with block
   self.avoid_respond_with = true
-
+  
   # use the permitter_class for create and update, if use_permitters = true
   self.action_to_permitter = {create: nil, update: nil}
-
+  
   # the methods that call authorize! action_sym, @model_class
   self.actions_that_authorize = [:create, :update]
   
@@ -294,36 +294,39 @@ RestfulJson.configure do
   
   # if not using permitters, will check respond_to?("(singular_model_name)_params".to_sym) and if true will __send__(method)
   self.actions_that_permit = [:create, :update]
-
+  
+  # will call .includes(...) for including and/or including_for_action when action was generated by query_for
+  self.apply_includes_to_custom_queries = true
+  
   # in error JSON, break out the exception info into fields for debugging
   self.return_error_data = true
-
+  
   # the class that is rescued in each action method, but if nil will always reraise and not handle
   self.rescue_class = StandardError
   
   # will define order of errors handled and what status and/or i18n message key to use
   self.rescue_handlers = []
-
+  
   # rescue_handlers are an ordered array of handlers to handle rescue of self.rescue_class or sub types.
   # can use optional i18n_key for message, but will default to e.message if i18n_key not found.
-
+  
   # support 404 error for ActiveRecord::RecordNotFound if using ActiveRecord.
   begin
     require 'active_record/errors'
     self.rescue_handlers << {exception_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze}
   rescue LoadError, NameError
   end
-
+  
   # support 403 error for CanCan::AccessDenied if using CanCan
   begin
     require 'cancan/exceptions'
     self.rescue_handlers << {exception_classes: [CanCan::AccessDenied], status: :forbidden, i18n_key: 'api.not_found'.freeze}
   rescue LoadError, NameError
   end
-
+  
   # support 500 error for everything else that is a self.rescue_class (in action)
   self.rescue_handlers << {status: :internal_server_error, i18n_key: 'api.internal_server_error'.freeze}
-
+  
 end
 ```
 
@@ -706,7 +709,7 @@ self.allow_action_specific_params_methods = true
 
 ##### Avoid n+1 Queries
 
-Unless using a custom query, if you specify `including {some hash}`, that will add `.includes({some hash})` to any automatically generated queries (in the proper place) such that eager loading can be used to avoid n+1 queries:
+Call `include(...) to eager load and avoid n+1 queries:
 
 ```ruby
 class PostsController < ApplicationController
@@ -730,6 +733,21 @@ end
 
 Be careful- Rails doesn't raise an error if it includes associations that don't exist (at least in Rails 3.1-4.0).
 
+A relevant config option is:
+
+```ruby
+self.apply_includes_to_custom_queries = true
+```
+
+If that is instead set to true as it is by default, it will also try to call `.includes` on the relation returned from your custom `query_for` query, e.g. if you called index and in the controller defined `including ...` or `including_for_action index: ...`, it will execute your custom query and then take the resuling relation and call `.includes(...)` on it. If `self.apply_includes_to_custom_queries = false`, it won't do that.
+
+If you have action-specific ActiveModel::Serializers or JBuilder views that require different includes (such as an index action that only includes abbreviated info and a show action that includes more associations), you can handle that with `including_for_action`. Some examples:
+
+```ruby
+includes_for :create, are: [:category, :comments]
+includes_for :index, :a_custom_action, are: [posts: [{comments: :guest}, :tags]]
+```
+
 ### With Rails-api
 
 If you want to try out [rails-api][rails-api]:

data/lib/restful_json/config.rb

@@ -17,7 +17,8 @@ module RestfulJson
     :avoid_respond_with,
     :return_error_data,
     :rescue_class,
-    :rescue_handlers
+    :rescue_handlers,
+    :apply_includes_to_custom_queries
   ]
   
   class << self
@@ -28,40 +29,40 @@ module RestfulJson
 end
 
 RestfulJson.configure do
-
+  
   # default for :using in can_filter_by
   self.can_filter_by_default_using = [:eq]
-
+  
   # to log debug info during request handling
   self.debug = false
-
+  
   # delimiter for values in request parameter values
   self.filter_split = ','.freeze
-
+  
   # equivalent to specifying respond_to :json, :html in the controller, and can be overriden in the controller. Note that by default responders gem sets respond_to :html in application_controller.rb.
   self.formats = :json, :html
-
+  
   # default number of records to return if using the page request function
   self.number_of_records_in_a_page = 15
-
+  
   # delimiter for ARel predicate in the request parameter name
   self.predicate_prefix = '!'.freeze
-
+  
   # if true, will render resource and HTTP 201 for post/create or resource and HTTP 200 for put/update. ignored if render_enabled is false.
   self.return_resource = false
-
+  
   # if false, controller actions will just set instance variable and return it instead of calling setting instance variable and then calling render/respond_with
   self.render_enabled = true
-
+  
   # use Permitters
   self.use_permitters = true
-
+  
   # instead of using Rails default respond_with, explicitly define render in respond_with block
   self.avoid_respond_with = true
-
+  
   # use the permitter_class for create and update, if use_permitters = true
   self.action_to_permitter = {create: nil, update: nil}
-
+  
   # the methods that call authorize! action_sym, @model_class
   self.actions_that_authorize = [:create, :update]
   
@@ -70,34 +71,37 @@ RestfulJson.configure do
   
   # if not using permitters, will check respond_to?("(singular_model_name)_params".to_sym) and if true will __send__(method)
   self.actions_that_permit = [:create, :update]
-
+  
+  # will call .includes(...) for including and/or including_for_action when action was generated by query_for
+  self.apply_includes_to_custom_queries = true
+  
   # in error JSON, break out the exception info into fields for debugging
   self.return_error_data = true
-
+  
   # the class that is rescued in each action method, but if nil will always reraise and not handle
   self.rescue_class = StandardError
   
   # will define order of errors handled and what status and/or i18n message key to use
   self.rescue_handlers = []
-
+  
   # rescue_handlers are an ordered array of handlers to handle rescue of self.rescue_class or sub types.
   # can use optional i18n_key for message, but will default to e.message if i18n_key not found.
-
+  
   # support 404 error for ActiveRecord::RecordNotFound if using ActiveRecord.
   begin
     require 'active_record/errors'
     self.rescue_handlers << {exception_classes: [ActiveRecord::RecordNotFound], status: :not_found, i18n_key: 'api.not_found'.freeze}
   rescue LoadError, NameError
   end
-
+  
   # support 403 error for CanCan::AccessDenied if using CanCan
   begin
     require 'cancan/exceptions'
     self.rescue_handlers << {exception_classes: [CanCan::AccessDenied], status: :forbidden, i18n_key: 'api.not_found'.freeze}
   rescue LoadError, NameError
   end
-
+  
   # support 500 error for everything else that is a self.rescue_class (in action)
   self.rescue_handlers << {status: :internal_server_error, i18n_key: 'api.internal_server_error'.freeze}
-
+  
 end

data/lib/restful_json/controller.rb

@@ -37,6 +37,7 @@ module RestfulJson
       class_attribute :action_to_serializer, instance_writer: true
       class_attribute :action_to_serializer_for, instance_writer: true
       class_attribute :query_includes, instance_writer: true
+      class_attribute :action_to_query_includes, instance_writer: true
 
       # use values from config
       RestfulJson::CONTROLLER_OPTIONS.each do |key|
@@ -52,6 +53,7 @@ module RestfulJson
       self.param_to_through ||= {}
       self.action_to_serializer ||= {}
       self.action_to_serializer_for ||= {}
+      self.action_to_query_includes ||= {}
     end
 
     module ClassMethods
@@ -105,9 +107,27 @@ module RestfulJson
         self.supported_functions += args
       end
 
+      # Calls .includes(...) on queries. Take a hash of action as symbol to the includes, e.g. to include(:category, :comments):
+      #   including :category, :comments
+      # or includes({posts: [{comments: :guest}, :tags]}):
+      #   including posts: [{comments: :guest}, :tags]
       def including(*args)
         self.query_includes = args
       end
+
+      # Calls .includes(...) only on specified action queries. Take a hash of action as symbol to the includes, e.g.:
+      #   includes_for :create, are: [:category, :comments]
+      #   includes_for :index, :a_custom_action, are: [posts: [{comments: :guest}, :tags]]
+      def includes_for(*args)
+        options = args.extract_options!
+        args.each do |an_action|
+          if options[:are]
+            self.action_to_query_includes.merge!({an_action.to_sym => options[:are]})
+          else
+            raise "#{self.class.name} must supply an :are option with includes_for #{an_action.inspect}"
+          end
+        end
+      end
       
       # Specify a custom query. If action specified does not have a method, it will alias_method index to create a new action method with that query.
       #
@@ -274,10 +294,8 @@ module RestfulJson
       # primary_key array support for composite_primary_keys.
       if @model_class.primary_key.is_a? Array
         c = @model_class
+        apply_includes params[:action].to_sym, value
         c.primary_key.each {|pkey|c.where(pkey.to_sym => params[pkey].to_s)}
-        if self.query_includes
-          value.includes(*(self.query_includes))
-        end
         # raise exception if not found
         @value = c.first!
       else
@@ -285,6 +303,13 @@ module RestfulJson
       end
     end
 
+    def apply_includes(action_sym, value)
+      this_includes = self.action_to_query_includes[action_sym] || self.query_includes
+      if this_includes
+        value.includes(*this_includes)
+      end
+    end
+
     def allowed_params
       action_sym = params[:action].to_sym
       singular = single_value_response?
@@ -383,14 +408,17 @@ module RestfulJson
     def index
       # could be index or another action if alias_method'd by query_for
       logger.debug "#{params[:action]} called in #{self.class}: model=#{@model_class}, request.format=#{request.format}, request.content_type=#{request.content_type}, params=#{params.inspect}" if self.debug
+      action_sym = params[:action].to_sym
       p_params = allowed_params
       t = @model_class.arel_table
       value = @model_class.scoped # returns ActiveRecord::Relation equivalent to select with no where clause
-      custom_query = self.action_to_query[params[:action].to_sym]
+      custom_query = self.action_to_query[action_sym]
       if custom_query
         value = custom_query.call(t, value)
       end
 
+      apply_includes action_sym, value
+
       self.param_to_query.each do |param_name, param_query|
         if params[param_name]
           # to_s as safety measure for vulnerabilities similar to CVE-2013-1854
@@ -445,10 +473,6 @@ module RestfulJson
         end
       end
 
-      if self.query_includes
-        value.includes(*(self.query_includes))
-      end
-
       if p_params[:page] && self.supported_functions.include?(:page)
         page = p_params[:page].to_i
         page = 1 if page < 1 # to avoid people using this as a way to get all records unpaged, as that probably isn't the intent?

data/lib/restful_json/version.rb

@@ -1,3 +1,3 @@
 module RestfulJson
-  VERSION = '4.1.0'
+  VERSION = '4.2.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restful_json
 version: !ruby/object:Gem::Version
-  version: 4.1.0
+  version: 4.2.0
 platform: ruby
 authors:
 - Gary S. Weaver
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-01 00:00:00.000000000 Z
+date: 2013-05-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport