query_helper 0.2.9 → 0.2.14

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad62903d54b1df9280b687c57da64e7a8a94e0919c156a1176f517248c69065e
-  data.tar.gz: d6c25ed277261ea00685c57bee58432bbc208d76f6e4b42d9ce3401173e3f35a
+  metadata.gz: 1aceb412b2d8c65cbe7a8ca001c0d3609b926546a3928e996b9a8f68f3c59491
+  data.tar.gz: 28027fdaec7281917bf52578c2dcf36d390e4dbdecc71286f35453f30831fd2f
 SHA512:
-  metadata.gz: abeb83f9d294ee0a0d0dcc7ed1c702b9f8d2858ce8da6c82b5cd8fc12c45634865cb68cdfc994851362fc4180d38d31b992bda0f35e0ec1b21c0462a29b61999
-  data.tar.gz: cddfa33a462fb4391bb736a39405309fbb980ab14e72040e4924fa898c0d95aac69bf4635b6f312df694480827969a715d4f77452aa6303c9f90236f2e0688f7
+  metadata.gz: 8a402b1afb054e8470ee020d354e581564940b27091f5d24cb7a0cd277e7fd20c26cc2e6e15211967bf993ea96346223e60fba4a07f39eda34720d23351eb58a
+  data.tar.gz: cae4fbd2f45abbd36df6393883897cf77d7451c8a86211085f48185ba0ad3d6dab68f3d196a757b49261afa4976137f4291acd825d63bebc2a81d9eff2893030

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    query_helper (0.2.9)
+    query_helper (0.2.14)
       activerecord (> 5)
       activesupport (> 5)
 

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
+  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
@@ -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/query_helper_concern.rb

@@ -17,6 +17,10 @@ class QueryHelper
         @query_helper = QueryHelper.new(**query_helper_params, api_payload: true)
       end
 
+      def create_query_helper_with_no_pagination
+        @query_helper = query_helper_with_no_pagination()
+      end
+
       def reload_query_params(query_helper=@query_helper)
         query_helper.update(**query_helper_params)
       end 

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.9"
+  VERSION = "0.2.14"
 end

metadata

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