query_helper 0.1.8 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ee722b53cba3c6bbb0657b9102e0f5a46bf15d8f8d4c661b2acd7ff1374e8b9f
-  data.tar.gz: c8749dbd254d793f8c864cd7fc85cbf6d38d8738ad8493fc54970c3e169e5915
+  metadata.gz: cd74e8f24a4e6841f6bc0049c4cc729366114be762ccd79e065153dd356149ff
+  data.tar.gz: 7cd75d322863e367a0e623a1bc6f2fdc25ce397bd77352a32b4332e294f5711e
 SHA512:
-  metadata.gz: 25116ab59d1f2f3f95a6741f5f17f9864436da4690f89e6ef12d770c16ecf0195eaae20c24b10cdb028e94fbac4bd1ed0317eac8985abba69cf575e02ed975ff
-  data.tar.gz: 0e734d5bbbcadfbbb734f9b8986d97eb85e81273901aeae90780523eb08a6aa8b9edbb10b930fb3623ee12d653b8185e4e034e89d458c33ce632ae1dc144609f
+  metadata.gz: c5ded16d1e131486949a1e5fb50622da80c1f0706fb4e1c466de98a0f631f2a7942baa90b44f6f666196c4aa711b317e86781edb79150c65a27c7fb6b83ac469
+  data.tar.gz: e481b684c397d872c9d0f1e383078f2f127f3eb0dc7a9c34f3eef3aac341849890322f5bff0a7f3d31a42dcec6d9c5cf2ba5988655e6a01de5da07712d10a0d3

data/README.md

@@ -35,7 +35,7 @@ Adding this code creates a `QueryHelper` object preloaded with pagination, filte
 
 ### Step 2: Use QueryHelper to run active record and sql queries within your controller
 
-#### Active Record Example
+#### Raw SQL Example
 
 ```ruby
 class ResourceController < ApplicationController
@@ -53,26 +53,20 @@ class ResourceController < ApplicationController
 end
 ```
 
-#### Raw SQL Example
+#### ActiveRecord Example
 
 ```ruby
 class ResourceController < ApplicationController
 
   def index
-    @query_helper.query = Resource.all
+    @query_helper.update(query: Resource.all)
     render json: @query_helper.results()
   end
 
 end
 ```
 
-You can also use the `@query_helper.update()` method to update the QueryHelper with an ActiveRecord object
-
-```ruby
-@query_helper.update(
-  query: Resource.all
-)
-```
+*NOTE: Previous documentation stated you could simply run `@query_helper.query = Resource.all`.  While this method still works, it will evaluate the ActiveRecord query causing it to hit the database twice.  It is recommended that you always use the update method to avoid this inefficiency*
 
 ### Step 3: Paginate, Sort, Filter, and Include Associations using URL params
 

data/lib/query_helper.rb

@@ -32,7 +32,7 @@ class QueryHelper
     preload: [] # preload activerecord associations - used instead of `associations` when you don't want them included in the payload
   )
     @query = query.class < ActiveRecord::Relation ? query.to_sql : query
-    @model = query.class < ActiveRecord::Relation ? query.model : model
+    @model = query.class < ActiveRecord::Relation ? query.base_class : model
     @bind_variables = bind_variables
     @sql_filter = sql_filter
     @sql_sort = sql_sort
@@ -67,7 +67,7 @@ class QueryHelper
     preload: []
   )
     @query = query.class < ActiveRecord::Relation ? query.to_sql : query if query
-    @model = query.class < ActiveRecord::Relation ? query.model : model if model || query
+    @model = query.class < ActiveRecord::Relation ? query.base_class : model if model || query
     @bind_variables.merge!(bind_variables)
     filters.each{ |f| add_filter(**f) }
     @associations = @associations | associations
@@ -85,7 +85,7 @@ class QueryHelper
   def query=(value)
     if value.class < ActiveRecord::Relation
       @query = value.to_sql
-      @model = value.model
+      @model = value.base_class
     else
       @query = value
     end

data/lib/query_helper/version.rb

@@ -1,3 +1,3 @@
 class QueryHelper
-  VERSION = "0.1.8"
+  VERSION = "0.2.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.8
+  version: 0.2.0
 platform: ruby
 authors:
 - Evan McDaniel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-12 00:00:00.000000000 Z
+date: 2019-12-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler