pattern_query_helper 0.2.5 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 7ba28c50b8182b282a395344c179d5a6329d5fcf
-  data.tar.gz: 6e49fce6551458c99ff19865155f26c9791cc5d4
+SHA256:
+  metadata.gz: f9478c942fdda25782ac53d2adc8aeea980719414857098383a5c5b6cfbecf6a
+  data.tar.gz: d5cf42e0b74a810e5111bb42e78595c7fca64ecd87657b7af6a23baa7765cc53
 SHA512:
-  metadata.gz: 524be27175d2e7184876227ebc9e0e2066c5913e79deca6227e61057fb4036bef66549f337652d6187013c64e54d30e66134624cf83185882a9625598b5310f4
-  data.tar.gz: fd6db4e9904794269808cbc9de802b49f49987a72f8ee3cfa83542ae78e9eaeffdf71febaf9b2c4af1448ff3399e9bc139e672d6e62d59e92e6dff28120f9fed
+  metadata.gz: 59ea5d4b72d30ab2761f1f72fc43546ac20c2f48cb3e5924c95e81522a535a526be3f074226e6fc911b36b7dd1f902c5a897e2fa0c1166748635e30424f3ec74
+  data.tar.gz: b90f41129c7aea623290ffe882e981327b6604a821fc1536ff3eac67350ac05ece354c1a82605df0886612b4ff6795b4ee7752d3550ca4442ae2b804ad21ae7b

data/README.md

@@ -26,22 +26,24 @@ Or install it yourself as:
 
 To run an active record query execute
 ```ruby
-PatternQueryHelper.run_sql_query(active_record_call, query_helpers, single_record)
+PatternQueryHelper.run_active_record_query(active_record_call, query_helpers, valid_columns, single_record)
 ```
 active_record_call: Valid active record syntax (i.e. ```Object.where(state: 'Active')```)
 query_helpers: See docs below
+valid_columns: Default is [].  Pass in an array of columns you want to allow sorting and filtering on.
 single_record: Default is false.  Pass in true to format payload as a single object instead of a list of objects
 
 ### Custom SQL Queries
 
 To run a custom sql query execute
 ```ruby
-PatternQueryHelper.run_sql_query(model, query, query_params, query_helpers, single_record)
+PatternQueryHelper.run_sql_query(model, query, query_params, query_helpers, valid_columns, single_record)
 ```
 model: A valid ActiveRecord model
 query: A string containing your custom SQL query
 query_params: a symbolized hash of binds to be included in your SQL query
 query_helpers: See docs below
+valid_columns: Default is [].  Pass in an array of columns you want to allow sorting and filtering on.
 single_record: Default is false.  Pass in true to format payload as a single object instead of a list of objects
 
 ## Query Helpers
@@ -86,6 +88,12 @@ Filtering is controlled by the `filter` object in the query_helpers hash
     },
     "column_2" => {
       "eql" => "my_string"
+    },
+    "column_3" => {
+      "like" => "my_string%"
+    },
+    "column_4" => {
+      "in" => "item1,item2,item3"
     }
 }
 ```
@@ -99,6 +107,7 @@ The following operator codes are valid
 “lt”: <
 “eql”: =
 “noteql”: !=
+"like": like
 “in”: in
 “notin” not in
 “null”: “is null” or “is not null” (pass in true or false as the value)

data/lib/pattern_query_helper/associations.rb

@@ -2,11 +2,7 @@ module PatternQueryHelper
   class Associations
     def self.process_association_params(associations)
       associations ||= []
-      if associations.class == String
-        [associations.to_sym]
-      else
-        associations
-      end
+      associations.class == String ? [associations.to_sym] : associations
     end
 
     def self.load_associations(payload, associations, as_json_options)

data/lib/pattern_query_helper/filtering.rb

@@ -1,16 +1,13 @@
 module PatternQueryHelper
   class Filtering
-    def self.create_filters(filters, column_map=nil, symbol_prefix="")
+    def self.create_filters(filters, valid_columns=nil, symbol_prefix="")
       filters ||= {}
       filter_string = "true = true"
       filter_params = {}
       filter_array = []
       filters.each do |filter_attribute, criteria|
-        if column_map
-          raise ArgumentError.new("Invalid filter '#{filter_attribute}'") unless column_map[filter_attribute]
-          filter_column = column_map[filter_attribute]
-        else
-          filter_column = filter_attribute
+        if valid_columns
+          raise ArgumentError.new("Invalid filter '#{filter_attribute}'") unless valid_columns.include? filter_attribute
         end
         criteria.each do |operator_code, criterion|
           filter_symbol = "#{symbol_prefix}#{filter_attribute}_#{operator_code}"
@@ -27,29 +24,25 @@ module PatternQueryHelper
               operator = "="
             when "noteql"
               operator = "!="
+            when "like"
+              operator = "like"
             when "in"
-              values = criterion.split(",").map { |s| s.to_i }
-              values = values.to_s.gsub("[","(").gsub("]",")")
-              operator = "in #{values}"
-              filter_symbol = ""
+              operator = "in (:#{filter_symbol})"
+              criterion = criterion.split(",")
+              filter_symbol_already_embedded = true
             when "notin"
-              values = criterion.split(",").map { |s| s.to_i }
-              values = values.to_s.gsub("[","(").gsub("]",")")
-              operator = "not in #{values}"
-              filter_symbol = ""
+              operator = "not in (:#{filter_symbol})"
+              criterion = criterion.split(",")
+              filter_symbol_already_embedded = true
             when "null"
-              if criterion = true || "true"
-                operator = "is null"
-              elsif criterion = false || "false"
-                operator = "is not null"
-              end
+              operator = criterion.to_s == "true" ? "is null" : "is not null"
               filter_symbol = ""
             else
               raise ArgumentError.new("Invalid operator code '#{operator_code}' on '#{filter_attribute}' filter")
           end
-          filter_symbol_embed = ":#{filter_symbol}" unless filter_symbol.blank?
-          filter_string = "#{filter_string} and #{filter_column} #{operator} #{filter_symbol_embed}"
-          filter_params["#{filter_symbol}"] = criterion
+          filter_string = "#{filter_string} and #{filter_attribute} #{operator}"
+          filter_string << " :#{filter_symbol}" unless filter_symbol_already_embedded or filter_symbol.blank?
+          filter_params["#{filter_symbol}"] = criterion unless filter_symbol.blank?
           filter_array << {
             column: filter_attribute,
             operator: operator,

data/lib/pattern_query_helper/pagination.rb

@@ -4,16 +4,8 @@ require 'kaminari'
 module PatternQueryHelper
   class Pagination
     def self.parse_pagination_params(page, per_page)
-      if page
-        page = page.to_i
-      else
-        page = 1
-      end
-      if per_page
-        per_page = per_page.to_i
-      else
-        per_page = 20
-      end
+      page = page ? page.to_i : 1
+      per_page = per_page ? per_page.to_i : 20
       raise RangeError.new("page must be greater than 0") unless page > 0
       raise RangeError.new("per_page must be greater than 0") unless per_page > 0
 

data/lib/pattern_query_helper/version.rb

@@ -1,3 +1,3 @@
 module PatternQueryHelper
-  VERSION = "0.2.5"
+  VERSION = "0.2.6"
 end

data/lib/pattern_query_helper.rb

@@ -89,11 +89,7 @@ module PatternQueryHelper
   end
 
   def self.parse_helpers(query_helpers, valid_columns)
-    valid_columns_map = {}
-    valid_columns.each do |c|
-      valid_columns_map["#{c}"] = c
-    end
-    filtering = PatternQueryHelper::Filtering.create_filters(query_helpers[:filter], valid_columns_map)
+    filtering = PatternQueryHelper::Filtering.create_filters(query_helpers[:filter], valid_columns)
     sorting = PatternQueryHelper::Sorting.parse_sorting_params(query_helpers[:sort], valid_columns)
     associations = PatternQueryHelper::Associations.process_association_params(query_helpers[:include])
     pagination = PatternQueryHelper::Pagination.parse_pagination_params(query_helpers[:page], query_helpers[:per_page])

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: pattern_query_helper
 version: !ruby/object:Gem::Version
-  version: 0.2.5
+  version: 0.2.6
 platform: ruby
 authors:
 - Evan McDaniel
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-18 00:00:00.000000000 Z
+date: 2019-05-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -169,7 +169,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.6.14
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby Gem to help with pagination and data formatting at Pattern, Inc.