rokaki 0.8.3 → 0.8.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53402d2c7b2fca689234d8bed13602eef1bac7a161b09fe15da517da8939e5ac
-  data.tar.gz: 2a903781f7d5f2e4b90c419def1dc5a2b8289798a708a66e6be91604de02de86
+  metadata.gz: 8f2a62792073dd9728a44158d6f30dc4f0f8119316bda3a3846c16fc2abc57f7
+  data.tar.gz: 80e9bfc7b677b7e291996c5bda1fc6652ddfbb592b31083446ef992755f00404
 SHA512:
-  metadata.gz: 7cd1957fe50f484e465a7c592a6e770e6a0e46975479ea4863deab66434031936d477b852ae8b72095943bc0db47d1379cd089b280485f5d4a7aa90d50cc6a12
-  data.tar.gz: 9b966c7cafd777655fcb6f20b70b3c331d2f8175c8bf22c49ef4295188f25ae15a7b8581738f4fbac5eb5e605b129088936c8588097015d366080b8866687891
+  metadata.gz: 6570c3b380c66092b3a583b1c94a51f8364f06d936522cc72676e23c3aa1717b4b89cc65c0d3ed6e6d67291b3c7e1c3c83d8254acd7df8f9971700b314a71aa0
+  data.tar.gz: 913e7bf304da343a4dce4d061dbcdaa37c2f26d7a396e590e393a224a4ac7c30c439f8d085de1a865828c9931f1bcf99dc66b32c8494e8481dcc6c5539d03ea6

data/.gitignore

@@ -11,3 +11,4 @@
 .rspec_status
 tags
 *.gem
+TODO.md

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    rokaki (0.8.3)
+    rokaki (0.8.3.1)
       activesupport
 
 GEM
@@ -21,6 +21,10 @@ GEM
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.6)
+    database_cleaner (1.8.5)
+    database_cleaner-active_record (1.8.0)
+      activerecord
+      database_cleaner (~> 1.8.0)
     diff-lcs (1.3)
     factory_bot (6.0.2)
       activesupport (>= 5.0.0)
@@ -90,6 +94,7 @@ PLATFORMS
 DEPENDENCIES
   activerecord
   bundler (~> 2.0)
+  database_cleaner-active_record
   factory_bot
   guard
   guard-rspec

data/README.md

@@ -1,4 +1,6 @@
 # Rokaki
+## You know, for air.
+
 [![Gem Version](https://badge.fury.io/rb/rokaki.svg)](https://badge.fury.io/rb/rokaki)
 
 This gem was born out of a desire to dry up filtering services in Rails apps or any Ruby app that uses the concept of "filters" or "facets".
@@ -46,7 +48,8 @@ class FilterArticles
 
   def filter_results
     @articles = @articles.where(date: date) if date
-    @articles = @articles.joins(:author).where(author: { first_name: author_first_name }) if author_first_name
+    @articles = @articles.joins(:author).where(authors: { first_name: author_first_name }) if author_first_name
+    @articles = @articles.joins(:author).where(authors: { last_name: author_last_name }) if author_last_name
   end
 end
 
@@ -98,6 +101,7 @@ advanced_filterable.advanced__filter_key_4__deep_leaf_array == [1,2,3,4]
 advanced_filterable.advanced__filter_key_1__filter_key_3__deep_node == 'NODE'
 ```
 ### `#define_filter_map`
+The define_filter_map method is more suited to classic "search", where you might want to search multiple fields on a model or across a graph. See the section on [filter_map](https://github.com/tevio/rokaki#2-the-filter_map-command-syntax) with OR for more on this kind of application.
 
 This method takes a single field in the passed in filters hash and maps it to fields named in the second param, this is useful if you want to search for a single value across many different fields or associated tables simultaneously.
 
@@ -115,7 +119,7 @@ class FilterMap
   define_filter_map :query, :mapped_a, association: :field
 end
 
-filter_map = FilterMap.new(fytlerz: { query: 'H2O' })
+filter_map = FilterMap.new(fylterz: { query: 'H2O' })
 
 filter_map.mapped_a == 'H2O'
 filter_map.association_field = 'H2O'
@@ -257,6 +261,58 @@ filters = { query: "Lao" }
 filtered_authors = AuthorFilter.new(filters: filters).results
 ```
 
+## CAVEATS
+Active record OR over a join may require you to add something like the following in an initializer in order for it to function properly:-
+
+### #structurally_incompatible_values_for_or
+
+``` ruby
+module ActiveRecord
+  module QueryMethods
+    def structurally_incompatible_values_for_or(other)
+      Relation::SINGLE_VALUE_METHODS.reject { |m| send("#{m}_value") == other.send("#{m}_value") } +
+        (Relation::MULTI_VALUE_METHODS - [:joins, :eager_load, :references, :extending]).reject { |m| send("#{m}_values") == other.send("#{m}_values") } +
+        (Relation::CLAUSE_METHODS - [:having, :where]).reject { |m| send("#{m}_clause") == other.send("#{m}_clause") }
+    end
+  end
+end
+```
+
+### A has one relation to a model called Or
+If you happen to have a model/table named 'Or' then you can override the `or:` key syntax by specifying a special `or_key`:-
+
+```ruby
+class AuthorFilter
+  include Rokaki::FilterModel
+
+  or_key :my_or
+  filter_map :author, :query,
+    like: {
+      articles: {
+        title: :circumfix,
+        my_or: { # the or is aware of the join and will generate a compound join aware or query
+          or: { # The Or model has a title field
+            title: :circumfix
+          }
+        }
+      },
+    }
+
+  attr_accessor :filters, :model
+
+  def initialize(filters:)
+    @filters = filters
+  end
+end
+
+filters = { query: "Syntaxes" }
+filtered_authors = AuthorFilter.new(filters: filters).results
+```
+
+
+See [this issue](https://github.com/rails/rails/issues/24055) for details.
+
+
 #### 3. The porcelain command syntax
 
 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`

data/lib/rokaki.rb

@@ -11,7 +11,4 @@ require 'rokaki/filter_model/nested_like_filters'
 
 module Rokaki
   class Error < StandardError; end
-
-  # include this module for filters dsl in an object
-  #
 end

data/lib/rokaki/filter_model.rb

@@ -8,7 +8,7 @@ module Rokaki
     end
 
     def prepare_terms(param, mode)
-      if param.is_a? Array
+      if Array === param
         return param.map { |term| "%#{term}%" } if mode == :circumfix
         return param.map { |term| "%#{term}" } if mode == :prefix
         return param.map { |term| "#{term}%" } if mode == :suffix
@@ -79,7 +79,8 @@ module Rokaki
           prefix: filter_key_prefix,
           infix: filter_key_infix,
           db: @_filter_db,
-          type: term_type
+          type: term_type,
+          or_key: or_key
         )
         nested_like_filter.call
 

data/lib/rokaki/filter_model/join_map.rb

@@ -25,7 +25,7 @@ module Rokaki
           current_key_path = []
           previous_key = nil
 
-          if key_path.is_a?(Symbol)
+          if Symbol === key_path
             if key_paths.length == 1
               @result = key_paths
             else
@@ -33,7 +33,7 @@ module Rokaki
             end
           end
 
-          if key_path.is_a?(Array)
+          if Array === key_path
             key_path.each do |key|
               current_path_length = current_key_path.length
 
@@ -42,9 +42,9 @@ module Rokaki
                 if current_path_length == 1
                   parent_result = result[previous_key]
 
-                  if parent_result.is_a?(Symbol) && parent_result != key
+                  if Symbol === parent_result && parent_result != key
                     result[previous_key] = [parent_result, key]
-                  elsif parent_result.is_a?(Array)
+                  elsif Array === parent_result
 
                     parent_result.each_with_index do |array_item, index|
                       if array_item == key
@@ -63,13 +63,14 @@ module Rokaki
 
                   if previous_path_length == 1
                     res = result.dig(*previous_key_path)
-                    if res.is_a? Symbol
+
+                    if Symbol === res
                       result[previous_key_path.first] = { previous_key => key }
-                    elsif res.is_a?(Hash)
                     end
                   elsif previous_path_length > 1
                     res = result.dig(*previous_key_path)
-                    if res.is_a? Symbol
+
+                    if Symbol === res
                       base = previous_key_path.pop
                       result.dig(*previous_key_path)[base] = { previous_key => key }
                     end

data/lib/rokaki/filter_model/nested_filter.rb

@@ -66,7 +66,7 @@ module Rokaki
       end
 
       def _build_deep_chain(keys)
-        name    = '' # prefix.to_s
+        name    = ''
         count   = keys.size - 1
 
         joins_before = []

data/lib/rokaki/filter_model/nested_like_filters.rb

@@ -81,7 +81,7 @@ module Rokaki
             base_modes = modes[index]
             key_path_item.each_with_index do |key_path, kp_index|
 
-              build_filter(keys: key_path.dup, join_map: join_map.result, mode: base_modes[kp_index], filter_name: item_filter_names[kp_index], search_mode: item_search_modes[kp_index])
+              build_query(keys: key_path.dup, join_map: join_map.result, mode: base_modes[kp_index], filter_name: item_filter_names[kp_index], search_mode: item_search_modes[kp_index])
             end
 
             item_filter_queries = filter_queries[index]
@@ -102,7 +102,7 @@ module Rokaki
 
             method_name = ([prefix, :filter, base_name]).compact.join(infix.to_s)
 
-            build_filter(keys: key_path_item.dup, join_map: join_map.result, filter_name: filter_name, search_mode: search_modes[index])
+            build_query(keys: key_path_item.dup, join_map: join_map.result, filter_name: filter_name, search_mode: search_modes[index])
 
             @filter_methods << "def #{method_name}; #{filter_queries[index]}; end;"
             @templates << "@model = #{method_name} if #{filter_name};"
@@ -190,7 +190,7 @@ module Rokaki
       end
 
       # DOUBLE SPLAT HASHES TO MAKE ARG LISTS!
-      def build_filter(keys: , join_map:, mode: :and, filter_name:, search_mode:)
+      def build_query(keys: , join_map:, mode: :and, filter_name:, search_mode:)
         leaf = nil
         leaf = keys.pop
 
@@ -212,7 +212,7 @@ module Rokaki
           filter_query = "@model.joins(**#{join_map}).#{query}"
         end
 
-        if mode == :or
+        if mode == or_key
           @filter_queries << [@filter_queries.pop, filter_query].flatten
         else
           @filter_queries << filter_query

data/lib/rokaki/filterable.rb

@@ -1,4 +1,8 @@
+# frozen_string_literal: true
+
 module Rokaki
+  # include this module for rokaki's filtering dsl in any object
+  #
   module Filterable
     def self.included(base)
       base.extend(ClassMethods)
@@ -11,15 +15,15 @@ module Rokaki
 
       def define_filter_keys(*filter_keys)
         filter_keys.each do |filter_key|
-          _build_filter([filter_key]) unless filter_key.is_a? Hash
-          _nested_key filter_key if filter_key.is_a? Hash
+          _build_filter([filter_key]) unless Hash === filter_key
+          _nested_key filter_key if Hash === filter_key
         end
       end
 
       def define_filter_map(query_field, *filter_keys)
         filter_keys.each do |filter_key|
-          _map_filters(query_field, [filter_key]) unless filter_key.is_a? Hash
-          _nested_map query_field, filter_key if filter_key.is_a? Hash
+          _map_filters(query_field, [filter_key]) unless Hash === filter_key
+          _nested_map query_field, filter_key if Hash === filter_key
         end
       end
 

data/lib/rokaki/version.rb

@@ -1,3 +1,3 @@
 module Rokaki
-  VERSION = "0.8.3"
+  VERSION = "0.8.3.1"
 end

data/rokaki.gemspec

@@ -34,13 +34,17 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'activerecord'
   spec.add_development_dependency 'bundler', '~> 2.0'
-  spec.add_development_dependency 'factory_bot'
-  spec.add_development_dependency 'guard'
-  spec.add_development_dependency 'guard-rspec'
-  spec.add_development_dependency 'pg'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
   spec.add_development_dependency 'rake', '~> 13.0'
+
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
   spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'factory_bot'
+
+  spec.add_development_dependency 'pg'
   spec.add_development_dependency 'sqlite3'
+  spec.add_development_dependency 'database_cleaner-active_record'
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rokaki
 version: !ruby/object:Gem::Version
-  version: 0.8.3
+  version: 0.8.3.1
 platform: ruby
 authors:
 - Steve Martin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-06-26 00:00:00.000000000 Z
+date: 2020-06-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -53,7 +53,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '2.0'
 - !ruby/object:Gem::Dependency
-  name: factory_bot
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,21 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
-  name: pg
+  name: guard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -109,7 +109,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -123,7 +123,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry-byebug
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: factory_bot
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -137,35 +151,35 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: pg
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '13.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: sqlite3
+  name: database_cleaner-active_record
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="