query_helper 0.2.7 → 0.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 34196dda5d9ed84de34c317c6f9096a87e9b403ca37868f5f087ef565886fe8d
-  data.tar.gz: e036203e497d95e1d37ceddd53ec72a3cb794ac3c6675842dfae642e0d9db9ac
+  metadata.gz: 2c63157141a68e8dafa45c307f5be2c90cc88fdea8b4c4777c4f81f89a58e797
+  data.tar.gz: 720e0093ccddebf935977aa8180127c99b2bbcd232f343ba75684c32c38d7686
 SHA512:
-  metadata.gz: 71590ca9d1f926b868d44f6170390d6a795dcab47f17dae1fbc7aed8e010d85d095e7322c5e1fbfe491ef614a2d9abf2863ce67baf57ab013f8d4faac7db823f
-  data.tar.gz: 3efc246697287100945bd1c247df76ca0db2c5d04df4c44fb711560de9245c5daabe5d73f8a3c9dc4d6c0edf748f8e29b065ad3d30816ddccde0205dcee9c6c2
+  metadata.gz: 2d49fc27361319b65c9b03d07b387561baf0341f3783166b41f51b30166b6a381d8ef2ccdc7dab141fd7db58bf16f68850a6ed6692ad9f055eff6304fce52acb
+  data.tar.gz: 87f9578aad0578a016aa573493adf486aeb9793506522685e1d6c388c028e85483d97a29d420f9257d81a4c3fd33577ffb6b76e331c626eaf1f7b22b717a6c99

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    query_helper (0.2.7)
+    query_helper (0.2.8)
       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

@@ -29,7 +29,9 @@ 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
   )
     @query = query.class < ActiveRecord::Relation ? query.to_sql : query
     @model = query.class < ActiveRecord::Relation ? query.base_class : model
@@ -44,6 +46,8 @@ class QueryHelper
     @custom_mappings = custom_mappings
     @api_payload = api_payload
     @preload = preload
+    @search_fields = search_fields
+    @search_string = search_string
 
     if @page && @per_page
       # Determine limit and offset
@@ -64,7 +68,8 @@ class QueryHelper
     as_json_options: nil,
     single_record: nil,
     custom_mappings: nil,
-    preload: []
+    preload: [],
+    search_fields: 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,7 @@ 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 
     return self
   end
 
@@ -102,14 +108,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
@@ -230,4 +249,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

@@ -33,6 +33,7 @@ class QueryHelper
         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.8"
 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.8
 platform: ruby
 authors:
 - Evan McDaniel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-03-31 00:00:00.000000000 Z
+date: 2020-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler