restful_json 4.0.0 → 4.1.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjYzYjM4ODY4NjIyNWM4ZDdjMGQxODY0M2QyMGM5Y2MzMTVlMjFjZg==
+    YjBiNTMxMDFhMDg0NDIwMTMzNzg1ZDVhYmQxYTlkNzM0OThiZTg2ZQ==
   data.tar.gz: !binary |-
-    MjA0NzNiYzc0OTJiMjU0OGE3ZjQ4ZWU5YmUyZTJhMTliYjdlZDg0ZA==
+    NjhjODQ3Yzc2Nzk4MTI0ZTkxYjI3MmMwYTBlNTZlY2U1ZTkwOTM1Ng==
 !binary "U0hBNTEy":
   metadata.gz: !binary |-
-    YjIxMjNjYTFhZmM5M2E4Yjg3Mzc4MmMzZDA3MTIyMTgxMzYyZjBjZTRmODJi
-    YjgyOWI3M2EzMGIzNGI4ZmI5YzI3ODRmZDBiMDc1NGMxY2IzNTBmYTFmMmEy
-    ZjAzZmRlMjAzMWIyYWRmODVlYmFlNzhiODg0YTBmMWQ1Y2JiNTI=
+    YzhkZGIwMzA4YzAzNjYyYWRjMmMzOTgwYTJiZDk1OGEwNjQ5MGQ1N2EzNGMx
+    NGM3MmQ4NDU2N2U4YmQzYWVlYmQzMTBiMTcxOTI4ZGY5Y2JkMDdjMzUyNTgx
+    NzYxYzk1YWZiY2I1NzUxYTQ5NTA0MzJmMGU2YWRlODQzOGI1MzM=
   data.tar.gz: !binary |-
-    NDJlYjExZThhNzU0OWJmYmJiOTQ3YTI3ZmQ0NDZhNDU4YmQxODYzYTk2ODBi
-    NzgzNGZlOGJkMzZlMGJmODU3NDdkN2JhOTkxZDljZjc2NWE5ODliZTk4YjEy
-    NzM0NzFiODEzZDNhNWM1ZDdiNjdjNGEwOTBmZjNjYzY4NGUzNjk=
+    MGY3NTJiOWNiOGE5MDZjMTBjMTllYTNiYmIzZjg1MDgyZDQ1OTc3MzZiZGMx
+    ZWZhMjliZTAwNTExNmFlZTcwZjM2MDZiZTQ0MTUyMDQ5YjRiMjcyYWIzMDMx
+    ZTI3MGU5OTM5NDQ0YjZkMWY0ZTAzZDQ0ZGEwMmMyZWIzZjcyODE=

data/README.md

@@ -9,7 +9,7 @@ Why do you need this if Rails controllers already make it easy to provide RESTfu
 
 The goal of the project is to reduce service controller code in an intuitive way, not to be a be-everything DSL or limit what you can do in a controller. Choose what features to expose, and you can still define/redefine actions etc. at will.
 
-We test with travis-ci with with Rails 3.1, 3.2, and Rails 4. Feel free to submit issues and/or do a pull requests if you run into anything.
+We test with travis-ci with with Rails 3.1, 3.2, and Rails 4. Feel free to submit issues and/or do a pull request if you run into anything.
 
 You can use any of these for the JSON response (the view):
 * [ActiveModel::Serializers][active_model_serializers]
@@ -614,6 +614,8 @@ query_for :index, is: ->(t,q) {
 }
 ```
 
+To avoid n+1 queries, use `.includes(...)` in your query to eager load any associations that you will need in the JSON view.
+
 ##### Define Custom Actions with Custom Queries
 
 You are still working with regular controllers here, so add or override methods if you want more!
@@ -702,6 +704,32 @@ And by default restful_json allows action specific `(action)_(model)_params` met
 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:
+
+```ruby
+class PostsController < ApplicationController
+   include RestfulJson::DefaultController
+
+   # eager loads all the posts and the associated category and comments for each post (note: have to define .includes(...) in query_for query)
+   including :category, :comments
+end
+```
+
+or
+
+```ruby
+class PostsController < ApplicationController
+   include RestfulJson::DefaultController
+
+   # eager load all of the associated posts, the associated posts’ tags and comments, and every comment’s guest association
+   including posts: [{comments: :guest}, :tags]
+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).
+
 ### With Rails-api
 
 If you want to try out [rails-api][rails-api]:
@@ -727,13 +755,12 @@ module MyServiceController
 
     # use Permitters and AMS
     include RestfulJson::DefaultController
-    # or comment that last line and uncomment whatever you want to use
-    #include ::ActionController::Serialization # AMS
-    #include ::ActionController::StrongParameters
-    #include ::TwinTurbo::Controller # Permitters which uses CanCan and Strong Parameters
-    #include ::RestfulJson::Controller
 
-    # If you want any additional inline class stuff, it goes here...
+    # or comment that last line and uncomment whatever you want to use
+    #include ActionController::Serialization # AMS
+    #include ActionController::StrongParameters
+    #include ActionController::Permittance # Permitters
+    #include RestfulJson::Controller
   end      
 end
 
@@ -772,10 +799,10 @@ Don't do this:
 
 ```ruby
 class ServiceController < ApplicationController
-  include ::ActionController::Serialization
-  include ::ActionController::StrongParameters
-  include ::TwinTurbo::Controller
-  include ::RestfulJson::Controller
+  include ActionController::Serialization
+  include ActionController::StrongParameters
+  include ActionController::Permittance
+  include RestfulJson::Controller
 end
 
 class FoobarsController < ServiceController

data/lib/restful_json/controller.rb

@@ -36,6 +36,7 @@ module RestfulJson
       class_attribute :param_to_through, instance_writer: true
       class_attribute :action_to_serializer, instance_writer: true
       class_attribute :action_to_serializer_for, instance_writer: true
+      class_attribute :query_includes, instance_writer: true
 
       # use values from config
       RestfulJson::CONTROLLER_OPTIONS.each do |key|
@@ -103,6 +104,10 @@ module RestfulJson
         args.extract_options! # remove hash from array- we're not using it yet
         self.supported_functions += args
       end
+
+      def including(*args)
+        self.query_includes = args
+      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.
       #
@@ -270,6 +275,9 @@ module RestfulJson
       if @model_class.primary_key.is_a? Array
         c = @model_class
         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
@@ -437,6 +445,10 @@ 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.0.0'
+  VERSION = '4.1.0'
 end

metadata

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