rokaki 0.8.0.pre.pre → 0.8.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd7982d23aa428243393be242a44e66655f3805cd23e2cb75e9f9ac1d9f6e8a3
-  data.tar.gz: 07d183020e8234b19d253cbde9172a3d802a705be0e535d982c6be06087ab3a5
+  metadata.gz: b5484d6a4935bbc4f908e9081c82fcfd757f2e49770b7cbde2c055ec9ab169b0
+  data.tar.gz: 44a41e6c4ba814bc98934ddb2029a222841fd18425847c73ab3a9a3d86acc66a
 SHA512:
-  metadata.gz: 8a22d6928e09c881f021e16b92bffa57f43f8a872528ab49f1b25f5ffc0c0a5918898944ea41439ed58d5e1fa1a40fbc16cbc6fa628f7380680cc2cc1bc3abe2
-  data.tar.gz: 8e9ac460a085d3bc32b72cb9b9d1c6198da65bae3e6d76a03a916708faa2e5862c3102d66407b795c23c93e4b527ea5fbda190d93ae876a583253d8b18d08ce7
+  metadata.gz: e8c29246d64a0fc0c5ca63173c419cee77cf07cd06d99a1fc14bcc53285222d980e8ace9e624bb75d4566814bfc8ce38613305676d2152591da83f8ea04002b1
+  data.tar.gz: 82ac3f4b16473b8adf6aeeb93907a0e71ab811c439d5071e95b063238042828c39818f33763a953fa0898c40c0d0f912cc6b3781b9ff1bb75d6c3227c8efd282

data/.gitignore

@@ -10,3 +10,4 @@
 # rspec failure tracking
 .rspec_status
 tags
+*.gem

data/Gemfile.lock

@@ -1,32 +1,32 @@
 PATH
   remote: .
   specs:
-    rokaki (0.7.0)
+    rokaki (0.8.2)
       activesupport
 
 GEM
   remote: https://rubygems.org/
   specs:
-    activemodel (6.0.0)
-      activesupport (= 6.0.0)
-    activerecord (6.0.0)
-      activemodel (= 6.0.0)
-      activesupport (= 6.0.0)
-    activesupport (6.0.0)
+    activemodel (6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activerecord (6.0.3.2)
+      activemodel (= 6.0.3.2)
+      activesupport (= 6.0.3.2)
+    activesupport (6.0.3.2)
       concurrent-ruby (~> 1.0, >= 1.0.2)
       i18n (>= 0.7, < 2)
       minitest (~> 5.1)
       tzinfo (~> 1.1)
-      zeitwerk (~> 2.1, >= 2.1.8)
-    byebug (11.0.1)
-    coderay (1.1.2)
-    concurrent-ruby (1.1.5)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
     diff-lcs (1.3)
-    factory_bot (5.1.1)
-      activesupport (>= 4.2.0)
-    ffi (1.11.1)
+    factory_bot (6.0.2)
+      activesupport (>= 5.0.0)
+    ffi (1.13.1)
     formatador (0.2.5)
-    guard (2.15.0)
+    guard (2.16.2)
       formatador (>= 0.2.4)
       listen (>= 2.7, < 4.0)
       lumberjack (>= 1.0.12, < 2.0)
@@ -40,51 +40,49 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
-    i18n (1.6.0)
+    i18n (1.8.3)
       concurrent-ruby (~> 1.0)
-    listen (3.1.5)
-      rb-fsevent (~> 0.9, >= 0.9.4)
-      rb-inotify (~> 0.9, >= 0.9.7)
-      ruby_dep (~> 1.2)
-    lumberjack (1.0.13)
-    method_source (0.9.2)
-    minitest (5.11.3)
+    listen (3.2.1)
+      rb-fsevent (~> 0.10, >= 0.10.3)
+      rb-inotify (~> 0.9, >= 0.9.10)
+    lumberjack (1.2.6)
+    method_source (1.0.0)
+    minitest (5.14.1)
     nenv (0.3.0)
     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)
-    pry-byebug (3.7.0)
+    pg (1.2.3)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
       byebug (~> 11.0)
-      pry (~> 0.10)
-    rake (10.5.0)
-    rb-fsevent (0.10.3)
-    rb-inotify (0.10.0)
+      pry (~> 0.13.0)
+    rake (13.0.1)
+    rb-fsevent (0.10.4)
+    rb-inotify (0.10.1)
       ffi (~> 1.0)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.2)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.4)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.1)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.2)
-    ruby_dep (1.5.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
     shellany (0.0.1)
-    sqlite3 (1.4.1)
-    thor (0.20.3)
+    sqlite3 (1.4.2)
+    thor (1.0.1)
     thread_safe (0.3.6)
-    tzinfo (1.2.5)
+    tzinfo (1.2.7)
       thread_safe (~> 0.1)
-    zeitwerk (2.1.9)
+    zeitwerk (2.3.0)
 
 PLATFORMS
   ruby
@@ -98,10 +96,10 @@ DEPENDENCIES
   pg
   pry
   pry-byebug
-  rake (~> 10.0)
+  rake (~> 13.0)
   rokaki!
   rspec (~> 3.0)
   sqlite3
 
 BUNDLED WITH
-   2.1.3
+   2.1.4

data/README.md

@@ -8,6 +8,12 @@ There are two modes of use `Filterable` and `FilterModel` that can be activated
 
 Add this line to your application's Gemfile:
 
+You can install from Rubygems:
+```
+gem 'rokaki'
+```
+Or from github
+
 ```ruby
 gem 'rokaki', git: 'https://github.com/tevio/rokaki.git'
 ```
@@ -190,7 +196,38 @@ end
 ```
 Or
 
-#### 2. The porcelain command syntax
+#### 2. The `filter_map` command syntax
+`filter_map` takes the model name, then a single 'query' field and maps it to fields named in the options, this is useful if you want to search for a single value across many different fields or associated tables simultaneously. (builds on `define_filter_map`)
+
+
+```ruby
+class AuthorFilter
+  include Rokaki::FilterModel
+
+  filter_map :author, :query,
+    like: {
+      articles: {
+        title: :circumfix,
+        reviews: {
+          title: :circumfix
+        }
+      },
+    }
+
+  attr_accessor :filters, :model
+
+  def initialize(filters:)
+    @filters = filters
+  end
+end
+
+filters = { query: "Jiddu" }
+filtered_authors = AuthorFilter.new(filters: filters).results
+```
+
+In the above example we search for authors who have written articles containing the word "Jiddu" in the title that also have reviews containing the sames word in their titles.
+
+#### 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/filter_model.rb

@@ -25,8 +25,19 @@ module Rokaki
 
       private
 
+      def filter_map(model, query_key, options)
+        filter_model(model)
+        @filter_map_query_key = query_key
+
+        @_filter_db = options[:db] || :postgres
+        like(options[:like]) if options[:like]
+        ilike(options[:ilike]) if options[:ilike]
+        filters(*options[:match]) if options[:match]
+      end
+
       def filter(model, options)
         filter_model(model)
+        @filter_map_query_key = nil
 
         @_filter_db = options[:db] || :postgres
         like(options[:like]) if options[:like]
@@ -35,7 +46,11 @@ module Rokaki
       end
 
       def filters(*filter_keys)
-        define_filter_keys(*filter_keys)
+        if @filter_map_query_key
+          define_filter_map(@filter_map_query_key, *filter_keys)
+        else
+          define_filter_keys(*filter_keys)
+        end
 
         @_chain_filters ||= []
         filter_keys.each do |filter_key|
@@ -86,9 +101,9 @@ module Rokaki
         end
       end
 
-      def associated_table(association)
-        @model.reflect_on_association(association).klass.table_name
-      end
+      # def associated_table(association)
+      #   @model.reflect_on_association(association).klass.table_name
+      # end
 
       def filter_model(model_class)
         @model = (model_class.is_a?(Class) ? model_class : Object.const_get(model_class.capitalize))

data/lib/rokaki/filter_model/like_keys.rb

@@ -16,15 +16,16 @@ module Rokaki
 
       def call
         args.keys.each do |key|
-          like_keys << map_keys(args[key], key)
+          map_keys(args[key], key)
         end
         like_keys
       end
 
       private
 
-      def map_keys(value, key)
+      def map_keys(value, key, key_path = [])
         key_result = {}
+        key_path << key
 
         if value.is_a? Hash
         value.keys.each do |sub_key|
@@ -35,18 +36,26 @@ module Rokaki
               key_result[key] << sub_key
             else
               key_result[key] = [ sub_key ]
+              @like_keys << deep_assign(key_path, key_result[key])
             end
 
           elsif sub_value.is_a? Hash
-            key_result[key] = map_keys(sub_value, sub_key)
+            map_keys(sub_value, sub_key, key_path)
           end
         end
         else
-          key_result = key
+          @like_keys = [key]
         end
 
         key_result
       end
+
+      # Many thanks Cary Swoveland
+      # https://stackoverflow.com/questions/56634950/ruby-dig-set-assign-values-using-hashdig/56635124
+      #
+      def deep_assign(keys, value)
+        keys[0..-2].reverse_each.reduce ({ keys.last => value }) { |h,key| { key=>h } }
+      end
     end
   end
 end

data/lib/rokaki/filter_model/nested_filter.rb

@@ -56,7 +56,7 @@ module Rokaki
       end
 
       def find_i_like_key(keys)
-        return nil unless like_semantics && i_like_semantics.keys.any?
+        return nil unless i_like_semantics && i_like_semantics.keys.any?
         current_like_key = i_like_semantics
         keys.each do |key|
           current_like_key = current_like_key[key]

data/lib/rokaki/filterable.rb

@@ -23,6 +23,10 @@ module Rokaki
         end
       end
 
+      def define_query_key(key = nil)
+        @filter_map_query_key = key
+      end
+
       def filter_key_prefix(prefix = nil)
         @filter_key_prefix ||= prefix
       end

data/lib/rokaki/version.rb

@@ -1,3 +1,3 @@
 module Rokaki
-  VERSION = "0.8.0-pre"
+  VERSION = "0.8.2"
 end

data/rokaki.gemspec

@@ -40,7 +40,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'pg'
   spec.add_development_dependency 'pry'
   spec.add_development_dependency 'pry-byebug'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rokaki
 version: !ruby/object:Gem::Version
-  version: 0.8.0.pre.pre
+  version: 0.8.2
 platform: ruby
 authors:
 - Steve Martin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-10 00:00:00.000000000 Z
+date: 2020-06-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -142,14 +142,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -222,9 +222,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.2
 signing_key: