rokaki 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5d32983f1791295aadabcc64fafca2e7cda63e679b0e37fcf38fc41085679e5
-  data.tar.gz: f1125b9db501745d1d3cad0da31b378f90fd1e5b44b2cdf0e8a2429eea91dea2
+  metadata.gz: ebc3f6bb8aab2597c36dd7876792e22395a56a8d099b18cb0d48157e178e81bf
+  data.tar.gz: df20e88198f10346531fa5e5ffde6c8627ef5d19192119b07362865175e7357a
 SHA512:
-  metadata.gz: fcac7ca5e906933335255fb59c63b2e8114a864cd8a6c9f2868c9e64a25566c6c00d9439c01dc372b123443e953cd45930ceb93bc80cd43dc3f6da48ad029f83
-  data.tar.gz: c9f3742c1ec502b04453ab373eff82646c67b8d134981b67838666f185d5b6d36fefc0371ee386d60fda6a17f6e2e90d52a17e6de5963bb501d365a8e4eb4c24
+  metadata.gz: 9f419fea3a5e3e292d8f44c6006df9ee799d49b4a1aa14820441c2e76c21cb514b668079ea9b727bc64cfb65d107efb162d49a1176bfadc5037b588db2323352
+  data.tar.gz: c683abe335a7d84718da478711c10704830470771e92420cd3ad3540a1062dbb065865e58fdcea4e0d5478cf4ab43293413ed7e0c6337e6f8d8a19e760a67555

data/README.md

@@ -23,7 +23,7 @@ To use the basic DSL include the `Rokaki::Filterable` module
 
 A simple example might be:-
 
-```
+```ruby
   class FilterArticles
     include Rokaki::Filterable
 
@@ -55,7 +55,7 @@ You can specify a `filter_key_prefix` and a `filter_key_infix` to change the str
 ## ActiveRecord
 Include `Rokaki::FilterModel` in any ActiveRecord model (only AR >= 6.0.0 tested so far) you can generate the filter keys and the actual filter lookup code using the `filters` keyword on a model like so:-
 
-```
+```ruby
 # Given the models
 class Author < ActiveRecord::Base
   has_many :articles, inverse_of: :author
@@ -86,17 +86,17 @@ filtered_results = filter.results
 ```
 
 ### Partial matching
-You can use `like` to perform a partial match on a specific key, there are 3 options:- `:prefix`, `:circumfix` and `:suffix`. There are two syntaxes you can use for this:-
+You can use `like` (or, if you use postgres, the case insensitive `ilike`) to perform a partial match on a specific key, there are 3 options:- `:prefix`, `:circumfix` and `:suffix`. There are two syntaxes you can use for this:-
 
 #### 1. The `filter` command syntax
 
 
-```
+```ruby
 class ArticleFilter
   include FilterModel
 
   filter :article,
-    like: {
+    like: { # you can use ilike here instead if you use postgres and want case insensitive results
       author: {
         first_name: :circumfix,
         last_name: :circumfix
@@ -117,12 +117,13 @@ Or
 In this syntax you will need to provide three keywords:- `filters`, `like` and `filter_model` if you are not passing in the model type and assigning it to `@model`
 
 
-```
+```ruby
 class ArticleFilter
   include FilterModel
 
   filters :date, :title, author: [:first_name, :last_name]
   like title: :circumfix
+  # ilike title: :circumfix # case insensitive postgres mode
 
   attr_accessor :filters
 
@@ -135,7 +136,7 @@ end
 
 Or without the model in the initializer
 
-```
+```ruby
 class ArticleFilter
   include FilterModel
 
@@ -153,7 +154,7 @@ end
 
 Would produce a query with a LIKE which circumfixes '%' around the filter term, like:-
 
-```
+```ruby
 @model = @model.where('title LIKE :query', query: "%#{title}%")
 ```
 

data/lib/rokaki/filter_model/like_keys.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Rokaki
+  module FilterModel
+    class LikeKeys
+      def initialize(args)
+        @args = args
+        @like_keys = []
+      end
+
+      attr_reader :args, :like_keys
+
+      def call
+        args.keys.each do |key|
+          like_keys << map_keys(args[key], key)
+        end
+        like_keys
+      end
+
+      private
+
+      def map_keys(value, key)
+        key_result = {}
+
+        if value.is_a? Hash
+        value.keys.each do |sub_key|
+          sub_value = value[sub_key]
+
+          if sub_value.is_a? Symbol
+            if key_result[key].is_a? Array
+              key_result[key] << sub_key
+            else
+              key_result[key] = [ sub_key ]
+            end
+
+          elsif sub_value.is_a? Hash
+            key_result[key] = map_keys(sub_value, sub_key)
+          end
+        end
+        else
+          key_result = key
+        end
+
+        key_result
+      end
+    end
+  end
+end

data/lib/rokaki/filter_model.rb

@@ -16,6 +16,7 @@ module Rokaki
         filter_model(model)
 
         like(options[:like]) if options[:like]
+        ilike(options[:ilike]) if options[:ilike]
         filters(*options[:match]) if options[:match]
       end
 
@@ -54,10 +55,9 @@ module Rokaki
 
         query = ''
         if @_like_semantics && mode = @_like_semantics[key]
-          query = "@model.where(\"#{key} LIKE :query\", "
-          query += "query: \"%\#{#{filter}}%\")" if mode == :circumfix
-          query += "query: \"%\#{#{filter}}\")" if mode == :prefix
-          query += "query: \"\#{#{filter}}%\")" if mode == :suffix
+          query = like_semantics(type: 'LIKE', query: query, filter: filter, mode: mode, key: key)
+        elsif @i_like_semantics && mode = @i_like_semantics[key]
+          query = like_semantics(type: 'ILIKE', query: query, filter: filter, mode: mode, key: key)
         else
           query = "@model.where(#{filter}: #{key})"
         end
@@ -65,6 +65,14 @@ module Rokaki
         query
       end
 
+      def like_semantics(type:, query:, filter:, mode:, key:)
+        query = "@model.where(\"#{key} #{type} :query\", "
+        query += "query: \"%\#{#{filter}}%\")" if mode == :circumfix
+        query += "query: \"%\#{#{filter}}\")" if mode == :prefix
+        query += "query: \"\#{#{filter}}%\")" if mode == :suffix
+        query
+      end
+
       def _build_deep_chain(keys)
         name    = filter_key_prefix.to_s
         count   = keys.size - 1
@@ -120,6 +128,15 @@ module Rokaki
         filters(*key_builder.call)
       end
 
+      def ilike(args)
+        raise ArgumentError, 'argument mush be a hash' unless args.is_a? Hash
+        @i_like_semantics = (@i_like_semantics || {}).merge(args)
+
+        key_builder = LikeKeys.new(args)
+
+        filters(*key_builder.call)
+      end
+
       def deep_chain(keys, value)
         if value.is_a? Hash
           value.keys.map do |key|

data/lib/rokaki/version.rb

@@ -1,3 +1,3 @@
 module Rokaki
-  VERSION = "0.4.1"
+  VERSION = "0.5.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rokaki
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Steve Martin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-16 00:00:00.000000000 Z
+date: 2019-10-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -143,7 +143,7 @@ files:
 - bin/setup
 - lib/rokaki.rb
 - lib/rokaki/filter_model.rb
-- lib/rokaki/filter_model/like.rb
+- lib/rokaki/filter_model/like_keys.rb
 - lib/rokaki/filterable.rb
 - lib/rokaki/version.rb
 - rokaki.gemspec