query_helper 0.2.11 → 0.2.16

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c0ce7906e41c5c383352f7c5cab44a96a1cfac4101f70a29baf72275151d91b4
-  data.tar.gz: 8add1223d5c3da00ceb82af7125f01175e3072057ae7d29368d1cc5f12ba1854
+  metadata.gz: ec3e2ffc3d82e55e6e2898c06071e3dc08111df35b70c0b51f430d6f0b85c8b4
+  data.tar.gz: 13e9d510e2c5cee31a8ac64b089d9822402742d2a31f3e34bf51dd2db0db1ae7
 SHA512:
-  metadata.gz: a81a407516f330e80191f1d2d41be5c091aede40b3950503ff05eeda26a2e09fefb6be3dd03a3280765b53f0b6da9c3c64c963bc84a0788be6d9af9d3aa088be
-  data.tar.gz: 91ba599cff34800fb1c0e7cb39d0a07e51b4320ff5e7d8248f9c2abf97794532db6a6fbc29f397dca620e363d75cbe883ae72ca983010510a17c4105ecfb5f42
+  metadata.gz: 121e0ec7dfab835a7aa77d368d82bfc373d8b13c8a7483c4950a9f9995c676d25c51bfd29eb9a48b0781f1ab12fabe10334612d766188fd568581f209b509df7
+  data.tar.gz: 6f03e2fa58fc313e657f8d0ff868e9c6bfe668713202e227451369f2b47b99e4d3b0015113ca1f7cd4add40d20bc6fccc9833fd60204784d89d1c22c2c9a01c5

data/Gemfile.lock

@@ -1,56 +1,56 @@
 PATH
   remote: .
   specs:
-    query_helper (0.2.11)
+    query_helper (0.2.16)
       activerecord (> 5)
       activesupport (> 5)
 
 GEM
   remote: https://rubygems.org/
   specs:
-    actionpack (6.0.2.2)
-      actionview (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionpack (6.0.3.2)
+      actionview (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       rack (~> 2.0, >= 2.0.8)
       rack-test (>= 0.6.3)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.0, >= 1.2.0)
-    actionview (6.0.2.2)
-      activesupport (= 6.0.2.2)
+    actionview (6.0.3.2)
+      activesupport (= 6.0.3.2)
       builder (~> 3.1)
       erubi (~> 1.4)
       rails-dom-testing (~> 2.0)
       rails-html-sanitizer (~> 1.1, >= 1.2.0)
-    activemodel (6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activerecord (6.0.2.2)
-      activemodel (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
-    activesupport (6.0.2.2)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.2)
+      zeitwerk (~> 2.2, >= 2.2.2)
     builder (3.2.4)
-    byebug (11.1.1)
+    byebug (11.1.3)
     concurrent-ruby (1.1.6)
     crass (1.0.6)
-    diff-lcs (1.3)
+    diff-lcs (1.4.4)
     erubi (1.9.0)
     faker (1.9.6)
       i18n (>= 0.7)
-    i18n (1.8.2)
+    i18n (1.8.5)
       concurrent-ruby (~> 1.0)
-    loofah (2.4.0)
+    loofah (2.6.0)
       crass (~> 1.0.2)
       nokogiri (>= 1.5.9)
     method_source (1.0.0)
     mini_portile2 (2.4.0)
-    minitest (5.14.0)
-    nokogiri (1.10.9)
+    minitest (5.14.1)
+    nokogiri (1.10.10)
       mini_portile2 (~> 2.4.0)
-    rack (2.2.2)
+    rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rails-dom-testing (2.0.3)
@@ -58,9 +58,9 @@ GEM
       nokogiri (>= 1.6)
     rails-html-sanitizer (1.3.0)
       loofah (~> 2.3)
-    railties (6.0.2.2)
-      actionpack (= 6.0.2.2)
-      activesupport (= 6.0.2.2)
+    railties (6.0.3.2)
+      actionpack (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
       method_source
       rake (>= 0.8.7)
       thor (>= 0.20.3, < 2.0)
@@ -69,15 +69,15 @@ GEM
       rspec-core (~> 3.9.0)
       rspec-expectations (~> 3.9.0)
       rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.1)
-      rspec-support (~> 3.9.1)
-    rspec-expectations (3.9.1)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
     rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.9.0)
-    rspec-rails (4.0.0)
+    rspec-rails (4.0.1)
       actionpack (>= 4.2)
       activesupport (>= 4.2)
       railties (>= 4.2)
@@ -85,13 +85,13 @@ GEM
       rspec-expectations (~> 3.9)
       rspec-mocks (~> 3.9)
       rspec-support (~> 3.9)
-    rspec-support (3.9.2)
+    rspec-support (3.9.3)
     sqlite3 (1.3.13)
     thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.6)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.3.0)
+    zeitwerk (2.4.0)
 
 PLATFORMS
   ruby

data/lib/query_helper.rb

@@ -13,7 +13,7 @@ require "query_helper/invalid_query_error"
 
 class QueryHelper
 
-  attr_accessor :model, :bind_variables, :sql_filter, :sql_sort, :page, :per_page, :single_record, :associations, :as_json_options, :executed_query, :api_payload, :preload, :search_field, :search_string
+  attr_accessor :model, :bind_variables, :sql_filter, :sql_sort, :page, :per_page, :single_record, :associations, :as_json_options, :executed_query, :api_payload, :preload, :search_field, :search_string, :metadata
   attr_reader :query
 
   def initialize(
@@ -31,7 +31,8 @@ class QueryHelper
     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
     search_fields: [],
-    search_string: nil
+    search_string: nil,
+    metadata: {}
   )
     @query = query.class < ActiveRecord::Relation ? query.to_sql : query
     @model = query.class < ActiveRecord::Relation ? query.base_class : model
@@ -49,6 +50,7 @@ class QueryHelper
     @preload = preload
     @search_fields = search_fields
     @search_string = search_string
+    @metadata = metadata
   end
 
   def update(
@@ -66,7 +68,8 @@ class QueryHelper
     sql_sort: nil,
     page: nil,
     per_page: nil,
-    search_string: nil
+    search_string: nil,
+    metadata: nil
   )
     @query = query.class < ActiveRecord::Relation ? query.to_sql : query if query
     @model = query.class < ActiveRecord::Relation ? query.base_class : model if model || query
@@ -83,6 +86,7 @@ class QueryHelper
     @search_string = search_string if search_string 
     @page = determine_page(page: page, per_page: per_page) if page
     @per_page = determine_per_page(page: page, per_page: per_page) if per_page
+    @metadata = metadata if metadata 
     set_limit_and_offset()
     return self
   end
@@ -140,7 +144,7 @@ class QueryHelper
   end
 
   def to_json(args)
-    JSON.generate(results)
+    results.to_json
   end
 
   def to_sql
@@ -175,6 +179,29 @@ class QueryHelper
     return @results
   end
 
+  def pagination_results(count=@count)
+    # Set pagination params if they aren't provided
+    results_per_page = @per_page || count 
+    results_page = @page || 1 
+
+    total_pages = (count/(results_per_page.nonzero? || 1).to_f).ceil
+    next_page = results_page + 1 if results_page.between?(1, total_pages - 1)
+    previous_page = results_page - 1 if results_page.between?(2, total_pages)
+    first_page = results_page == 1
+    last_page = results_page == total_pages
+    out_of_range = !results_page.between?(1,total_pages)
+
+    { count: count,
+      current_page: results_page,
+      next_page: next_page,
+      previous_page: previous_page,
+      total_pages: total_pages,
+      per_page: results_per_page,
+      first_page: first_page,
+      last_page: last_page,
+      out_of_range: out_of_range }
+  end
+
   private
 
     def determine_page(page:, per_page:)
@@ -203,7 +230,8 @@ class QueryHelper
 
     def paginated_results
       { pagination: pagination_results(),
-        data: @results }
+        data: @results,
+        metadata: @metadata }
     end
 
     def determine_count
@@ -234,29 +262,6 @@ class QueryHelper
       @results.map!{ |r| r.except("_query_full_count") } if @page && @per_page && !@single_record
     end
 
-    def pagination_results
-      # Set pagination params if they aren't provided
-      results_per_page = @per_page || @count 
-      results_page = @page || 1 
-
-      total_pages = (@count/(results_per_page.nonzero? || 1).to_f).ceil
-      next_page = results_page + 1 if results_page.between?(1, total_pages - 1)
-      previous_page = results_page - 1 if results_page.between?(2, total_pages)
-      first_page = results_page == 1
-      last_page = results_page == total_pages
-      out_of_range = !results_page.between?(1,total_pages)
-
-      { count: @count,
-        current_page: results_page,
-        next_page: next_page,
-        previous_page: previous_page,
-        total_pages: total_pages,
-        per_page: results_per_page,
-        first_page: first_page,
-        last_page: last_page,
-        out_of_range: out_of_range }
-    end
-
     def create_column_maps
       ColumnMap.create_column_mappings(
         query: @query,

data/lib/query_helper/sql_manipulator.rb

@@ -55,7 +55,7 @@ class QueryHelper
 
     def insert_order_by_and_limit_clause
       @sql.slice!(@parser.limit_clause) if @parser.limit_included? # remove existing limit clause
-      @sql.slice!(@parser.order_by_clause) if @parser.order_by_included? # remove existing order by clause
+      @sql.slice!(@parser.order_by_clause) if @parser.order_by_included? && @order_by_clauses.length > 0 # remove existing order by clause
       @sql += " order by #{@order_by_clauses.join(", ")} " if @order_by_clauses.length > 0
       @sql += " limit :limit offset :offset " if @include_limit_clause
     end

data/lib/query_helper/version.rb

@@ -1,3 +1,3 @@
 class QueryHelper
-  VERSION = "0.2.11"
+  VERSION = "0.2.16"
 end

metadata

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