query_helper 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 871736bd5aa9e012fb55ce1738a150782de390cefa9275c2d61e5d5bd89cdf84
-  data.tar.gz: 7c11403e23c7b6247a540c475dae7aa083ffb79cf4f1f0ec944a583f86f8eccd
+  metadata.gz: 1988f3c68a54af6511be4ef536fa27df2080fdfa5495b8f5532ad729fdf0f029
+  data.tar.gz: c7783fc5b7a275e4a78b9c5ca37be49c85b3e6113c9f657e72ce16101a12f364
 SHA512:
-  metadata.gz: 2105e8fee2c52885ef26b333eebe43cf017e030a6ee9420fc573f044c2d619586a9bdcf8569856861ce4599a24607284d1d80823d664c47f8465378b86bceffb
-  data.tar.gz: 0e2a4dc0b3a310f81e1713a78d61707d8d02a82b6300d7676ee6ec442f8d89302e74cf3bb81a1e13857cdf65d6d5246a19fbc13d16308ca35c4e47aa13dfb771
+  metadata.gz: f247dc18f26acd1937c1d963beb6a6e10bb9a96b4bdec974a9831279cacb65e3d12cc3f42cb01ab97135fc164d0e263349793ccfb51784ab72700a3b6d890abf
+  data.tar.gz: 4573625d4a526036fae518209836ad7be1aec3b49914cfad3e457182aeab810597903b260e74422b8563f2ed04a4623a9c11907aa791014abb5ffefe5dc41037

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    query_helper (0.1.1)
+    query_helper (0.1.2)
       activerecord (~> 5.0)
       activesupport (~> 5.0)
 

data/lib/query_helper.rb

@@ -13,7 +13,7 @@ require "query_helper/invalid_query_error"
 
 class QueryHelper
 
-  attr_accessor :model, :query, :bind_variables, :sql_filter, :sql_sort, :page, :per_page, :single_record, :associations, :as_json_options, :executed_query, :api_payload
+  attr_accessor :model, :query, :bind_variables, :sql_filter, :sql_sort, :page, :per_page, :single_record, :associations, :as_json_options, :executed_query, :api_payload, :preload
 
   def initialize(
     model: nil, # the model to run the query against
@@ -27,7 +27,8 @@ class QueryHelper
     associations: [], # a list of activerecord associations you'd like included in the payload
     as_json_options: nil, # a list of as_json options you'd like run before returning the payload
     custom_mappings: {}, # custom keyword => sql_expression mappings
-    api_payload: false # Return the paginated payload or simply return the result array
+    api_payload: false, # Return the paginated payload or simply return the result array
+    preload: [] # preload activerecord associations - used instead of `associations` when you don't want them included in the payload
   )
     @model = model
     @query = query
@@ -41,6 +42,7 @@ class QueryHelper
     @as_json_options = as_json_options
     @custom_mappings = custom_mappings
     @api_payload = api_payload
+    @preload = preload
 
     if @page && @per_page
       # Determine limit and offset
@@ -60,7 +62,8 @@ class QueryHelper
     associations: [],
     as_json_options: nil,
     single_record: nil,
-    custom_mappings: nil
+    custom_mappings: nil,
+    preload: []
   )
     @model = model if model
     @query = query if query
@@ -70,6 +73,7 @@ class QueryHelper
     @single_record = single_record if single_record
     @as_json_options = as_json_options if as_json_options
     @custom_mappings = custom_mappings if custom_mappings
+    @preload = preload if preload
   end
 
   def add_filter(operator_code:, criterion:, comparate:)
@@ -106,6 +110,7 @@ class QueryHelper
     @results = @results.first if @single_record # Return a single result if requested
 
     determine_count()
+    preload_associations()
     load_associations()
     clean_results()
   end
@@ -116,8 +121,6 @@ class QueryHelper
     return @results
   end
 
-
-
   private
 
     def paginated_results
@@ -151,6 +154,13 @@ class QueryHelper
       )
     end
 
+    def preload_associations
+      Associations.preload_associations(
+        payload: @results,
+        preload: @preload
+      )
+    end
+
     def clean_results
       @results.map!{ |r| r.except("_query_full_count") } if @page && @per_page
     end
@@ -185,5 +195,4 @@ class QueryHelper
         model: @model
       )
     end
-
 end

data/lib/query_helper/associations.rb

@@ -12,6 +12,10 @@ class QueryHelper
       payload.as_json(as_json_options)
     end
 
+    def self.preload_associations(payload:, preload: [])
+      ActiveRecord::Associations::Preloader.new.preload(payload, preload)
+    end
+
     def self.json_associations(associations)
       associations ||= []
       associations = associations.is_a?(Array) ? associations : [associations]

data/lib/query_helper/version.rb

@@ -1,3 +1,3 @@
 class QueryHelper
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: query_helper
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Evan McDaniel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-08-05 00:00:00.000000000 Z
+date: 2019-08-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler