query_helper 0.2.7 → 0.2.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34196dda5d9ed84de34c317c6f9096a87e9b403ca37868f5f087ef565886fe8d
-  data.tar.gz: e036203e497d95e1d37ceddd53ec72a3cb794ac3c6675842dfae642e0d9db9ac
+  metadata.gz: d785c033c2c9b9f1eaa01641b8e92b8690a1a54eceb1507e58efb4a4437655ab
+  data.tar.gz: de0529d9069f0c612b39873c69160eff8eeb52b35bcc05401026cc161b9914c9
 SHA512:
-  metadata.gz: 71590ca9d1f926b868d44f6170390d6a795dcab47f17dae1fbc7aed8e010d85d095e7322c5e1fbfe491ef614a2d9abf2863ce67baf57ab013f8d4faac7db823f
-  data.tar.gz: 3efc246697287100945bd1c247df76ca0db2c5d04df4c44fb711560de9245c5daabe5d73f8a3c9dc4d6c0edf748f8e29b065ad3d30816ddccde0205dcee9c6c2
+  metadata.gz: 39e7d8268cde0434747bfb2cc52e0f85c6d294ba18af86b5a415f5c92da2f1dfbe7822dbdc685c55f99520b15e205e2a75867db6e628b5d594730a1b472990ca
+  data.tar.gz: efcb54e2da3b21a3c454ff490b2c892336913dde41602aa07b31edf658f4644ebcc4f1a234bff8b72706ebd8fcfc7366de24c1a88891d1a3176d72686cdceb7e

data/Gemfile.lock

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

data/README.md

@@ -111,6 +111,33 @@ null | is null *or* is not null
 
 Note: For the null operator code, toggle *is null* operator with true and *is not null* operator with false
 
+#### Search
+
+QueryHelper supports searching across multiple fields.  To implement pass an array of column aliases into the `search_fields` argument when creating or updating a `QueryHelper` object.
+
+```ruby
+@query_helper.update(search_fields: ["column1", "column2"])
+render json: @query_helper.results()
+```
+
+You can then take advantage of the `search_for` url param to do text matching in any of the columns included
+
+Request: `http://www.example.com/resources?search_for=foo`
+
+Results: 
+```json
+[
+  {
+    "column1": "foobar",
+    "column2": "bar"
+  },
+  {
+    "column1": "bar",
+    "column2": "barfoo"
+  }
+]
+```
+
 #### Associations
 
 Include ActiveRecord associations in the payload.  The association must be defined in the model.

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(
@@ -29,7 +29,10 @@ class QueryHelper
     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
-    preload: [] # preload activerecord associations - used instead of `associations` when you don't want them included in the payload
+    preload: [], # preload activerecord associations - used instead of `associations` when you don't want them included in the payload
+    search_fields: [],
+    search_string: nil,
+    metadata: {}
   )
     @query = query.class < ActiveRecord::Relation ? query.to_sql : query
     @model = query.class < ActiveRecord::Relation ? query.base_class : model
@@ -38,21 +41,16 @@ 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
     @custom_mappings = custom_mappings
     @api_payload = api_payload
     @preload = preload
-
-    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
+    @search_fields = search_fields
+    @search_string = search_string
+    @metadata = metadata
   end
 
   def update(
@@ -64,7 +62,14 @@ class QueryHelper
     as_json_options: nil,
     single_record: nil,
     custom_mappings: nil,
-    preload: []
+    preload: [],
+    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
@@ -75,6 +80,14 @@ class QueryHelper
     @as_json_options = as_json_options if as_json_options
     @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
 
@@ -102,14 +115,27 @@ class QueryHelper
     # create the filters from the column maps
     @sql_filter.create_filters()
 
+    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
+        where_clauses << search_filter[:filter]
+      else 
+        having_clauses << search_filter[:filter]
+      end
+    end 
+
+
     # 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,
-      where_clauses: @sql_filter.where_clauses,
-      having_clauses:  @sql_filter.having_clauses,
+      where_clauses: where_clauses,
+      having_clauses: having_clauses,
       order_by_clauses: @sql_sort.parse_sort_string,
       include_limit_clause: @page && @per_page ? true : false,
       additional_select_clauses:  @sql_sort.select_strings
@@ -167,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
@@ -202,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 }
@@ -230,4 +269,20 @@ class QueryHelper
         model: @model
       )
     end
+
+    def search_filter(column_maps)
+      raise ArgumentError.new("search_fields not defined") unless @search_fields.length > 0
+      placement = :where
+      maps = column_maps.select do |cm| 
+        placement = :having if cm.aggregate
+        @search_fields.include? cm.alias_name
+      end 
+      bind_variable = ('a'..'z').to_a.shuffle[0,20].join.to_sym
+      @bind_variables[bind_variable] = "%#{@search_string}%"
+      filter = "#{maps.map{|m| "#{m.sql_expression}::varchar"}.join(" || ")} ilike :#{bind_variable}"
+      return {
+        filter: filter,
+        placement: placement
+      }
+    end 
 end

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,12 +39,18 @@ 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]
+        helpers[:search_string] = params[:search_for] if params[:search_for]
         helpers
       end
     end

data/lib/query_helper/version.rb

@@ -1,3 +1,3 @@
 class QueryHelper
-  VERSION = "0.2.7"
+  VERSION = "0.2.12"
 end

metadata

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