rokaki 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 732268408b0eaebe95dc53cfd1cb3788c10d198bb47eddb3f4c75d0ff796d98c
-  data.tar.gz: d698e633dd2d8b48ee086c37e35121c870bc16c40a43070f8c8a5f1db04fc8fd
+  metadata.gz: 1731cab4173cbacc31862d09d6825ee0a6158ec70845bf78dfe3c9ed5cfa1edd
+  data.tar.gz: c9ff65505f778861b286f94196791bb7a36c79933e8b8136604ea1d9f97579da
 SHA512:
-  metadata.gz: f2d9eb53031c10422b3133063792d99f534f4e47ef12fcabe61e52f244d221dae997c437665dada3b7036e017fdd6245f24f54b3507a4ee30dfa0ba976cb8c1e
-  data.tar.gz: e632c271dfc09265b2717e348b7becf7fdf401c1921e34edc6cdae67b52cfc0eeebe481815bd608695236cdfb0008c7a6c662b93c89bb605d8ca10fa8cfa2f37
+  metadata.gz: ee38b03675197b3cc8f9dca7f64e0475ea3c5265163de87e9110b0976f08ab6030a7e4b3a1540050ec8870ec64942af2982e9a688309e1100cc851eb6534aa6d
+  data.tar.gz: 9eb901aa514cd3efa3731193340033b3fc48a55e2ba76b398ecc289756a912531abda70a3604f2cf5d71d2799b5161ce11283b442267ad73e3cc94ad197df851

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rokaki (0.1.0)
+    rokaki (0.3.0)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -47,9 +47,10 @@ This maps attributes `date`, `author_first_name` and `author_last_name` to a fil
 You can specify a `filter_key_prefix` and a `filter_key_infix` to change the structure of the accessors.
 
 `filter_key_prefix :__` would result in key accessors like `__author_first_name`
+
 `filter_key_infix :__` would result in key accessors like `author__first_name`
 
-### ActiveRecord
+## 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:-
 
 ```
@@ -80,7 +81,32 @@ filter = ArticleFilter.new(filters: params[:filters])
 
 filtered_results = filter.results
 
-* note: This will currently return full text matches (I hope to add partial matching with like and ilike soon)
+```
+
+### Partial matching
+You can use `like` to perform a partial match on a specific key, there are 3 options:- `:prefix`, `:circumfix` and `:suffix`.
+
+
+```
+class ArticleFilter
+  include FilterModel
+
+  filters :date, :title, author: [:first_name, :last_name]
+  like title: :circumfix
+
+  attr_accessor :filters
+
+  def initialize(filters:, model: Article)
+    @filters = filters
+    @model = model
+  end
+end
+```
+
+Would produce a query with a LIKE which circumfixes '%' around the filter term, like:-
+
+```
+@model = @model.where('title LIKE :query', query: "%#{title}%")
 ```
 
 

data/lib/rokaki/filter_model.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Rokaki
   module FilterModel
     include Filterable
@@ -7,6 +9,7 @@ module Rokaki
 
     module ClassMethods
       include Filterable::ClassMethods
+
       private
 
       def filters(*filter_keys)
@@ -22,44 +25,62 @@ module Rokaki
       end
 
       def _chain_filter(key)
-        @_chain_filters << "@model = @model.where(#{key.to_s}: #{key.to_s}) if #{key.to_s};"
+        filter = "#{filter_key_prefix}#{key}"
+        class_eval "def #{filter_key_prefix}filter_#{key};" \
+                   "#{_chain_filter_type(key)} end;",
+                   __FILE__, __LINE__ - 2
+
+        @_chain_filters << "@model = #{filter_key_prefix}filter_#{key} if #{filter};"
+      end
+
+      def _chain_filter_type(key)
+        filter = "#{filter_key_prefix}#{key}"
+
+        query = ""
+        if @_like_semantics && mode = @_like_semantics[key]
+          query = "@model.where(\"#{key} LIKE :query\", "
+          if mode == :circumfix
+            query += "query: \"%\#{#{filter}}%\")"
+          end
+          if mode == :prefix
+            query += "query: \"%\#{#{filter}}\")"
+          end
+          if mode == :suffix
+            query += "query: \"\#{#{filter}}%\")"
+          end
+        else
+          query = "@model.where(#{filter}: #{key})"
+        end
+        "#{query};"
       end
 
       def _build_deep_chain(keys)
-        name    = @filter_key_prefix.to_s
+        name    = filter_key_prefix.to_s
         count   = keys.size - 1
 
-        joins = ""
-        where = ""
-        out   = ""
+        joins = ''
+        where = ''
+        out   = ''
 
         leaf = keys.pop
 
-        keys.each_with_index do |key, i|
-          if keys.length == 1
-            name  = "#{key}#{filter_key_infix.to_s}#{leaf}"
-            joins = ":#{key}"
+        keys.each_with_index do |key, _i|
+          next unless keys.length == 1
+          name  = "#{filter_key_prefix}#{key}#{filter_key_infix}#{leaf}"
+          joins = ":#{key}"
 
-            where = "{ #{key.to_s.pluralize}: { #{leaf}: #{name} } }"
-          end
+          where = "{ #{key.to_s.pluralize}: { #{leaf}: #{name} } }"
         end
 
-        # keys.each_with_index do |key, i|
-        #   name += key.to_s
-        #   name += filter_key_infix.to_s unless count == i
-
-        #   joins += "{ #{key.to_s}: " unless count == i
-        #   where += "{ #{key.to_s.pluralize}: " unless count == i
-        #   out += " }" unless count == i
-
-        #   joins += key.to_s if count == i
-        #   where += name if count == i
-        # end
 
         joins = joins += out
         where = where += out
 
-        @_chain_filters << "@model = @model.joins(#{joins}).where(#{where}) if #{name};"
+        class_eval "def #{filter_key_prefix.to_s}filter_#{name};"\
+                   "@model.joins(#{joins}).where(#{where}); end;",
+                   __FILE__, __LINE__ - 2
+
+        @_chain_filters << "@model = #{filter_key_prefix}filter_#{name} if #{name};"
       end
 
       def _chain_nested(filters_object)
@@ -76,8 +97,9 @@ module Rokaki
         @model = model
       end
 
-      def like(*args)
-
+      def like(args)
+        raise ArgumentError, 'argument mush be a hash' unless args.is_a? Hash
+        @_like_semantics = (@_like_semantics || {}).merge(args)
       end
 
       def deep_chain(keys, value)
@@ -102,12 +124,12 @@ module Rokaki
       end
 
       def define_results
-        results_def = "def results;"
+        results_def = 'def results;'
         @_chain_filters.each do |item|
           results_def += item
         end
         results_def += '@model;end;'
-        class_eval results_def
+        class_eval results_def, __FILE__, __LINE__
       end
     end
   end

data/lib/rokaki/filterable.rb

@@ -16,7 +16,7 @@ module Rokaki
         end
       end
 
-      def filter_key_prefix(prefix)
+      def filter_key_prefix(prefix = nil)
         @filter_key_prefix ||= prefix
       end
 

data/lib/rokaki/version.rb

@@ -1,3 +1,3 @@
 module Rokaki
-  VERSION = "0.2.0"
+  VERSION = "0.3.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rokaki
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Steve Martin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-02 00:00:00.000000000 Z
+date: 2019-09-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler