query_helper 0.2.8 → 0.2.13

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2c63157141a68e8dafa45c307f5be2c90cc88fdea8b4c4777c4f81f89a58e797
-  data.tar.gz: 720e0093ccddebf935977aa8180127c99b2bbcd232f343ba75684c32c38d7686
+  metadata.gz: b0971fc10b2b990185b05e538e41dcb898033baa6e9f3f59c22a5c024fead8bb
+  data.tar.gz: 55e383eadc934c0ff9f1cb44236033b5c93b6d7b302210fc10eaff1c8e4d614f
 SHA512:
-  metadata.gz: 2d49fc27361319b65c9b03d07b387561baf0341f3783166b41f51b30166b6a381d8ef2ccdc7dab141fd7db58bf16f68850a6ed6692ad9f055eff6304fce52acb
-  data.tar.gz: 87f9578aad0578a016aa573493adf486aeb9793506522685e1d6c388c028e85483d97a29d420f9257d81a4c3fd33577ffb6b76e331c626eaf1f7b22b717a6c99
+  metadata.gz: 8f5c67987554c03af1a0cf2d6a72bc3e225463c33fc5e8b53fbc5689fe05888bcb364f702d771b47f23c1cf356b8c0a01d0c1c39e56afd9931e55c50cdc0d6a7
+  data.tar.gz: 8a65504c1ba6e8f7f5088e6dcdbeb132b438781c63efec29eb79f527d0fb18919af1f4570f10be3e0453bea014892c3dd8372388c2f6e8b8a9b536197c3f683a

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    query_helper (0.2.8)
+    query_helper (0.2.13)
       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
@@ -40,6 +41,7 @@ class QueryHelper
     @sql_sort = sql_sort
     @page = determine_page(page: page, per_page: per_page)
     @per_page = determine_per_page(page: page, per_page: per_page)
+    set_limit_and_offset()
     @single_record = single_record
     @associations = associations
     @as_json_options = as_json_options
@@ -48,15 +50,7 @@ class QueryHelper
     @preload = preload
     @search_fields = search_fields
     @search_string = search_string
-
-    if @page && @per_page
-      # Determine limit and offset
-      limit = @per_page
-      offset = (@page - 1) * @per_page
-
-      # Merge limit/offset variables into bind_variables
-      @bind_variables.merge!({limit: limit, offset: offset})
-    end
+    @metadata = metadata
   end
 
   def update(
@@ -69,7 +63,13 @@ class QueryHelper
     single_record: nil,
     custom_mappings: nil,
     preload: [],
-    search_fields: nil
+    search_fields: nil,
+    sql_filter: nil,
+    sql_sort: nil,
+    page: nil,
+    per_page: 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
@@ -81,6 +81,13 @@ class QueryHelper
     @custom_mappings = custom_mappings if custom_mappings
     @preload = preload if preload
     @search_fields = search_fields if search_fields 
+    @sql_filter = sql_filter if sql_filter 
+    @sql_sort = sql_sort if sql_sort 
+    @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
 
@@ -110,7 +117,7 @@ class QueryHelper
 
     having_clauses = @sql_filter.having_clauses
     where_clauses = @sql_filter.where_clauses 
-
+    
     if @search_string
       search_filter = search_filter(column_maps)
       if search_filter[:placement] == :where
@@ -123,7 +130,7 @@ class QueryHelper
 
     # merge the filter bind variables into the query bind variables
     @bind_variables.merge!(@sql_filter.bind_variables)
-
+    
     # Execute Sql Query
     manipulator = SqlManipulator.new(
       sql: @query,
@@ -186,9 +193,22 @@ class QueryHelper
       return nil
     end 
 
+    def set_limit_and_offset
+      if @page && @per_page
+        # Determine limit and offset
+        limit = @per_page
+        offset = (@page - 1) * @per_page
+
+        # Merge limit/offset variables into bind_variables
+        @bind_variables[:limit] = limit
+        @bind_variables[:offset] = offset
+      end
+    end 
+
     def paginated_results
       { pagination: pagination_results(),
-        data: @results }
+        data: @results,
+        metadata: @metadata }
     end
 
     def determine_count
@@ -221,22 +241,22 @@ class QueryHelper
 
     def pagination_results
       # Set pagination params if they aren't provided
-      @per_page = @count unless @per_page
-      @page = 1 unless @page
+      results_per_page = @per_page || @count 
+      results_page = @page || 1 
 
-      total_pages = (@count/(@per_page.nonzero? || 1).to_f).ceil
-      next_page = @page + 1 if @page.between?(1, total_pages - 1)
-      previous_page = @page - 1 if @page.between?(2, total_pages)
-      first_page = @page == 1
-      last_page = @page == total_pages
-      out_of_range = !@page.between?(1,total_pages)
+      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: @page,
+        current_page: results_page,
         next_page: next_page,
         previous_page: previous_page,
         total_pages: total_pages,
-        per_page: @per_page,
+        per_page: results_per_page,
         first_page: first_page,
         last_page: last_page,
         out_of_range: out_of_range }

data/lib/query_helper/query_helper_concern.rb

@@ -9,10 +9,22 @@ class QueryHelper
         @query_helper
       end
 
+      def query_helper_with_no_pagination
+        QueryHelper.new(**query_helper_params_no_pagination)
+      end
+
       def create_query_helper
         @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 
+
       def create_query_helper_filter
         filter_values = params[:filter].permit!.to_h
         QueryHelper::SqlFilter.new(filter_values: filter_values)
@@ -27,9 +39,14 @@ class QueryHelper
       end
 
       def query_helper_params
-        helpers = {}
+        helpers = query_helper_params_no_pagination
         helpers[:page] = params[:page] if params[:page]
         helpers[:per_page] = params[:per_page] if params[:per_page]
+        helpers
+      end
+
+      def query_helper_params_no_pagination
+        helpers = {}
         helpers[:sql_filter] = create_query_helper_filter() if params[:filter]
         helpers[:sql_sort] = create_query_helper_sort() if params[:sort]
         helpers[:associations] = create_query_helper_associations() if params[:include]

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.8"
+  VERSION = "0.2.13"
 end

metadata

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