rokaki 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7da479ed93b1e8e6aa8e91e080356e71b39061a647960175c49ef0f5a1b90855
-  data.tar.gz: 021aaa044351b96fec1566c1e900f816908cc9a7dcd53d7d8b2a547e7d120872
+  metadata.gz: a46db4e821b0a8fb7f661ed539c18c6509b0a644b3bc0f790c0619ab72ff4108
+  data.tar.gz: f6ae9809a6a82c9a1de24ecf7d79b9f0cc6cab530579751df919832c0fa3593e
 SHA512:
-  metadata.gz: 6f4b5be13f85b953aced1c4269539d5abe5c2611a22bbc3fdda2c19c8254e872116b51ec235e856015e0574f8439d761d3eb433c6f94499683590084814b560d
-  data.tar.gz: fb29f358eca0b1186afd6cb1417538bac16731a8a2c1faf06c9526afd7e00bc93bcbdfd642b1a8912b02fbe39318842e8730a738586e64ed5df5d7915e94a6b2
+  metadata.gz: 55b11eee1380defcbd8b56e584b4d4ea145571718da3fa82e5445b2233d779bf169c173d19f5afbf5e7eb6dc69a070a8a08ff64fa3dc41fc4d29690ab2de0556
+  data.tar.gz: 88869cad8ba114234d2581661277963d3eb2effd4aecded8be6d2b7140dcb8331b68d529b4e388518c8ca503deff5f5b8ede87d33bb98152c8e29f676eb268ba

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rokaki (0.5.1)
+    rokaki (0.6.0)
       activesupport
 
 GEM
@@ -51,6 +51,7 @@ GEM
     notiffany (0.1.3)
       nenv (~> 0.1)
       shellany (~> 0.0)
+    pg (1.1.4)
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
@@ -91,6 +92,7 @@ DEPENDENCIES
   bundler (~> 2.0)
   guard
   guard-rspec
+  pg
   pry
   pry-byebug
   rake (~> 10.0)

data/README.md

@@ -161,6 +161,62 @@ Would produce a query with a LIKE which circumfixes '%' around the filter term,
 @model = @model.where('title LIKE :query', query: "%#{title}%")
 ```
 
+### Deep nesting
+You can filter joins both with basic matching and partial matching
+```ruby
+class ArticleFilter
+  include FilterModel
+
+  filter :author,
+    like: {
+      articles: {
+        reviews: {
+          title: :circumfix
+        }
+      },
+    }
+
+  attr_accessor :filters
+
+  def initialize(filters:)
+    @filters = filters
+  end
+end
+```
+
+### Array params
+You can pass array params (and partially match them), to filters (search multiple matches) in databases that support it (postgres) by passing the `db` param to the filter keyword, and passing an array of search terms at runtine
+
+```ruby
+class ArticleFilter
+  filter :article,
+    like: {
+      author: {
+        first_name: :circumfix,
+        last_name: :circumfix
+      }
+    },
+    match: %i[title created_at],
+    db: :postgres
+
+  attr_accessor :filters
+
+  def initialize(filters:)
+    @filters = filters
+  end
+end
+
+filterable = ArticleFilter.new(filters:
+               {
+                 author: {
+                   first_name: ['Match One', 'Match Two']
+                 }
+               }
+             )
+
+filterable.results
+```
+
 
 ## Development
 

data/lib/rokaki/filter_model/basic_filter.rb

@@ -3,14 +3,15 @@
 module Rokaki
   module FilterModel
     class BasicFilter
-      def initialize(keys:, prefix:, infix:, like_semantics:, i_like_semantics:)
+      def initialize(keys:, prefix:, infix:, like_semantics:, i_like_semantics:, db:)
         @keys = keys
         @prefix = prefix
         @infix = infix
         @like_semantics = like_semantics
         @i_like_semantics = i_like_semantics
+        @db = db
       end
-      attr_reader :keys, :prefix, :infix, :like_semantics, :i_like_semantics
+      attr_reader :keys, :prefix, :infix, :like_semantics, :i_like_semantics, :db
       attr_accessor :filter_method, :filter_template
 
       def call
@@ -59,10 +60,16 @@ module Rokaki
       end
 
       def build_like_query(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
+        if db == :postgres
+          query = "@model.where(\"#{key} #{type} ANY (ARRAY[?])\", "
+          query += "prepare_terms(#{filter}, :#{mode}))"
+        else
+          query = "@model.where(\"#{key} #{type} :query\", "
+          query += "query: \"%\#{#{filter}}%\")" if mode == :circumfix
+          query += "query: \"%\#{#{filter}}\")" if mode == :prefix
+          query += "query: \"\#{#{filter}}%\")" if mode == :suffix
+        end
+
         query
       end
     end

data/lib/rokaki/filter_model/nested_filter.rb

@@ -4,7 +4,7 @@ require 'active_support/inflector'
 module Rokaki
   module FilterModel
     class NestedFilter
-      def initialize(filter_key_object:, prefix:, infix:, like_semantics:, i_like_semantics:)
+      def initialize(filter_key_object:, prefix:, infix:, like_semantics:, i_like_semantics:, db:)
         @filter_key_object = filter_key_object
         @prefix = prefix
         @infix = infix
@@ -12,8 +12,9 @@ module Rokaki
         @i_like_semantics = i_like_semantics
         @filter_methods = []
         @filter_templates = []
+        @db = db
       end
-      attr_reader :filter_key_object, :prefix, :infix, :like_semantics, :i_like_semantics
+      attr_reader :filter_key_object, :prefix, :infix, :like_semantics, :i_like_semantics, :db
       attr_accessor :filter_methods, :filter_templates
 
       def call # _chain_nested_filter
@@ -135,10 +136,16 @@ module Rokaki
       end
 
       def build_like_query(type:, query:, filter:, mode:, key:, leaf:)
-        query = "where(\"#{key}.#{leaf} #{type} :query\", "
-        query += "query: \"%\#{#{filter}}%\")" if mode == :circumfix
-        query += "query: \"%\#{#{filter}}\")" if mode == :prefix
-        query += "query: \"\#{#{filter}}%\")" if mode == :suffix
+        if db == :postgres
+          query = "where(\"#{key}.#{leaf} #{type} ANY (ARRAY[?])\", "
+          query += "prepare_terms(#{filter}, :#{mode}))"
+        else
+          query = "where(\"#{key}.#{leaf} #{type} :query\", "
+          query += "query: \"%\#{#{filter}}%\")" if mode == :circumfix
+          query += "query: \"%\#{#{filter}}\")" if mode == :prefix
+          query += "query: \"\#{#{filter}}%\")" if mode == :suffix
+        end
+
         query
       end
 

data/lib/rokaki/filter_model.rb

@@ -7,6 +7,19 @@ module Rokaki
       base.extend(ClassMethods)
     end
 
+    def prepare_terms(param, mode)
+      if param.is_a? Array
+        return param.map { |term| "%#{term}%" } if mode == :circumfix
+        return param.map { |term| "%#{term}" } if mode == :prefix
+        return param.map { |term| "#{term}%" } if mode == :suffix
+      else
+        return ["%#{param}%"] if mode == :circumfix
+        return ["%#{param}"] if mode == :prefix
+        return ["#{param}%"] if mode == :suffix
+      end
+    end
+
+
     module ClassMethods
       include Filterable::ClassMethods
 
@@ -15,6 +28,7 @@ module Rokaki
       def filter(model, options)
         filter_model(model)
 
+        @_filter_db = options[:db] || :postgres
         like(options[:like]) if options[:like]
         ilike(options[:ilike]) if options[:ilike]
         filters(*options[:match]) if options[:match]
@@ -42,7 +56,8 @@ module Rokaki
           prefix: filter_key_prefix,
           infix: filter_key_infix,
           like_semantics: @_like_semantics,
-          i_like_semantics: @i_like_semantics
+          i_like_semantics: @i_like_semantics,
+          db: @_filter_db
         )
         basic_filter.call
 
@@ -51,21 +66,14 @@ module Rokaki
         @_chain_filters << basic_filter.filter_template
       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 _chain_nested_filter(filters_object)
         nested_filter = NestedFilter.new(
           filter_key_object: filters_object,
           prefix: filter_key_prefix,
           infix: filter_key_infix,
           like_semantics: @_like_semantics,
-          i_like_semantics: @i_like_semantics
+          i_like_semantics: @i_like_semantics,
+          db: @_filter_db
         )
         nested_filter.call
 
@@ -82,9 +90,9 @@ module Rokaki
         @model.reflect_on_association(association).klass.table_name
       end
 
-      def filter_model(model)
-        @model = (model.is_a?(Class) ? model : Object.const_get(model.capitalize))
-        class_eval "def model; @model ||= #{@model}; end;"
+      def filter_model(model_class)
+        @model = (model_class.is_a?(Class) ? model_class : Object.const_get(model_class.capitalize))
+        class_eval "def set_model; @model ||= #{@model}; end;"
       end
 
       def like(args)
@@ -132,7 +140,7 @@ module Rokaki
       # filter_model method
       #
       def define_results
-        results_def = 'def results; model;'
+        results_def = 'def results; @model || set_model;'
         @_chain_filters.each do |item|
           results_def += item
         end

data/lib/rokaki/version.rb

@@ -1,3 +1,3 @@
 module Rokaki
-  VERSION = "0.6.0"
+  VERSION = "0.7.0"
 end

data/rokaki.gemspec

@@ -41,4 +41,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'pg'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rokaki
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Steve Martin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-11-07 00:00:00.000000000 Z
+date: 2019-11-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -150,6 +150,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: pg
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: A dsl for filtering data in web requests
 email:
 - steve@martian.media