query_helper 0.1.3 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 78d3243fbf7e2565a4729636a43bce07ce12e891e4c7c154e3d086c6cbb3ff28
-  data.tar.gz: 54db35985205d12098c3f97c57c3cc25baeea13588fd82cb4c55ff8b040155a0
+  metadata.gz: 7b9afd63373b33bf0c2f1dce1bccf08842db0aa811b72cc6390ba235f3232bbd
+  data.tar.gz: efe1ea85137f17bb102a4779f5ae669530778df077fcb4f9393ecffe467f1f19
 SHA512:
-  metadata.gz: 045e30a87e6bcbdd513f9fe25911897ef94db45fd8931201491c184d36f7f2582aaf465ed0b1ded8f8abc2a00697e7c0fed1bf62f2c019fb427a50dfa8e95a29
-  data.tar.gz: c66c347806fd79685a4232f9922cd2dba8cb31ae5d0af76e88d5f547bfe5fa51a15d618f8aacefa673f39b6eb0dccd298cf64134860866dd8d937aff439b1309
+  metadata.gz: 3d1744f4a0550cf55b1bc31012d492be9ddc4b3c281b75925afba35888dea7b6e5a9db2e94498ba99a30d269f8172567cce3e6e5a67765b8ed7ce7fc65722c1f
+  data.tar.gz: 8559aed42b400167060874c43b9cfafc772ffcebb8adc7003d0f4eb63028ef08c337925380cc3fe4b92527dfe732f5d2f3da0bd37de510851bd65a8de4e01096

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    query_helper (0.1.2)
+    query_helper (0.1.5)
       activerecord (~> 5.0)
       activesupport (~> 5.0)
 
@@ -35,21 +35,21 @@ GEM
     arel (9.0.0)
     builder (3.2.3)
     byebug (11.0.1)
-    concurrent-ruby (1.1.4)
+    concurrent-ruby (1.1.5)
     crass (1.0.4)
     diff-lcs (1.3)
-    erubi (1.8.0)
-    faker (1.9.3)
+    erubi (1.9.0)
+    faker (1.9.6)
       i18n (>= 0.7)
     i18n (1.6.0)
       concurrent-ruby (~> 1.0)
-    loofah (2.2.3)
+    loofah (2.3.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (0.9.2)
     mini_portile2 (2.4.0)
-    minitest (5.11.3)
-    nokogiri (1.10.3)
+    minitest (5.12.2)
+    nokogiri (1.10.4)
       mini_portile2 (~> 2.4.0)
     rack (2.0.7)
     rack-test (1.1.0)
@@ -57,7 +57,7 @@ GEM
     rails-dom-testing (2.0.3)
       activesupport (>= 4.2.0)
       nokogiri (>= 1.6)
-    rails-html-sanitizer (1.0.4)
+    rails-html-sanitizer (1.2.0)
       loofah (~> 2.2, >= 2.2.2)
     railties (5.2.3)
       actionpack (= 5.2.3)
@@ -70,12 +70,12 @@ GEM
       rspec-core (~> 3.8.0)
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
+    rspec-core (3.8.2)
       rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+    rspec-expectations (3.8.4)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+    rspec-mocks (3.8.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.8.0)
     rspec-rails (3.8.2)
@@ -86,7 +86,7 @@ GEM
       rspec-expectations (~> 3.8.0)
       rspec-mocks (~> 3.8.0)
       rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
+    rspec-support (3.8.2)
     sqlite3 (1.3.13)
     thor (0.20.3)
     thread_safe (0.3.6)

data/README.md

@@ -170,6 +170,44 @@ The QueryHelper gem will return the following payload
 }
 ```
 
+## Using in Models or Services
+
+If your complex queries are defined in a model or service, you can still use QueryHelper to automatically paginate, filter, and sort api calls that reference the given model/service.  
+
+### Example
+
+#### Model
+
+```ruby
+class MyModel < ApplicationRecord
+
+  def complex_sql_function(query_helper=QueryHelper.new)
+    query = "select * from resource"
+    query_helper.update(
+      model: Resource,
+      query: query,
+    )
+  end
+end
+```
+
+When calling this model from outside a controller, you will get the full result set without the api wrapping. (i.e. `MyModel.first.complex_sql_function` will return an array.
+
+#### Controller
+
+```ruby
+class MyModelsController < ApplicationController
+
+  def get_complex_query
+    @object = MyModel.find(params[:id])
+    response = @object.complex_sql_function(@query_helper)
+    render json: response
+  end
+end
+```
+
+When you pass in the `@query_helper` object from the controller, QueryHelper will paginate, sort, and filter as expected.
+
 ## Advanced Options
 
 ### Associations
@@ -192,6 +230,44 @@ You can pass in additional as_json options to be included in the payload.
 )
 ```
 
+### Preload
+
+This is handy if you are loading other associations or methods with the as_json config and need to preload associations to avoid n+1 queries.
+
+```ruby
+@query_helper.update(
+  preload: [:association1, :association2]
+)
+```
+or
+```ruby
+@query_helper.update(
+  preload: [association: [:child_association]]
+)
+```
+
+### Custom Sort and Filter mappings
+
+QueryHelper will automatically determine which sql aliases to run filtering and sorting on.  In cases where this doesn't work, you can provide your own custom mappings so QueryHelper knows how to correctly sort and filter.  One common example of this is when you run a `select * from resource1` but pass `resource2` in as the model.  
+
+```ruby
+@query_helper.update(
+  custom_mappings: {
+    "alias" => "complex_sql_function"
+  }
+)
+```
+
+To indicate that a custom mapping refers to an aggregate function use the following:
+
+```ruby
+@query_helper.update(
+  custom_mappings: {
+    "alias" => { sql_expression: "MAX(resouce.age)", aggregate: true }
+  }
+)
+```
+
 ### Single Record Queries
 If you only want to return a single result, but still want to be able to use some of the other functionality of QueryHelper, you can set `single_record` to true in the QueryHelper object.
 

data/lib/query_helper/version.rb

@@ -1,3 +1,3 @@
 class QueryHelper
-  VERSION = "0.1.3"
+  VERSION = "0.1.5"
 end

data/lib/query_helper.rb

@@ -74,13 +74,14 @@ class QueryHelper
     @as_json_options = as_json_options if as_json_options
     @custom_mappings = custom_mappings if custom_mappings
     @preload = preload if preload
+    return self
   end
 
   def add_filter(operator_code:, criterion:, comparate:)
     @sql_filter.filter_values["comparate"] = { operator_code => criterion }
   end
 
-  def execute_query
+  def build_query
     # Correctly set the query and model based on query type
     determine_query_type()
 
@@ -105,8 +106,17 @@ class QueryHelper
       include_limit_clause: @page && @per_page ? true : false,
       additional_select_clauses:  @sql_sort.select_strings
     )
-    @executed_query = manipulator.build()
-    @results = @model.find_by_sql([@executed_query, @bind_variables]) # Execute Sql Query
+    manipulator.build()
+  end
+
+  def view_query
+    query = build_query()
+    @model.sanitize_sql_array([query, @bind_variables])
+  end
+
+  def execute_query
+    query = build_query()
+    @results = @model.find_by_sql([query, @bind_variables]) # Execute Sql Query
     @results = @results.first if @single_record # Return a single result if requested
 
     determine_count()
@@ -143,7 +153,11 @@ class QueryHelper
 
     def determine_count
       # Determine total result count (unpaginated)
-      @count = @page && @per_page && @results.length > 0 ? @results.first["_query_full_count"] : @results.length
+      if @single_record
+        @count = 1
+      else
+        @count = @page && @per_page && @results.length > 0 ? @results.first["_query_full_count"] : @results.length
+      end
     end
 
     def load_associations

metadata

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