rokaki 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53244b10ca9f4942f648d825156616dfc9057cf8b5c39afa4f995152f8f56091
-  data.tar.gz: 30b6db3fe0f4c6e68a6b4f628e254c85dcc7b72aa387d1ec91b1f5cd3c674010
+  metadata.gz: 7da479ed93b1e8e6aa8e91e080356e71b39061a647960175c49ef0f5a1b90855
+  data.tar.gz: 021aaa044351b96fec1566c1e900f816908cc9a7dcd53d7d8b2a547e7d120872
 SHA512:
-  metadata.gz: 13df19ccfa76fc0265e7f12c0dacbb7c4dba8b07169db9a3c08c7368fe07cc9f50cbd2ea056490f0c6cff1dbafe550d28998c94ac339b0316d868a95e350a569
-  data.tar.gz: 164ea95d95555b85ac86cc81fd2b2b9dca2b2245246241c6d52b7f16c8357aaa9e6c67d446b2f79d1213162aa35ece8b420f10545cd448517e32a8802d500e93
+  metadata.gz: 6f4b5be13f85b953aced1c4269539d5abe5c2611a22bbc3fdda2c19c8254e872116b51ec235e856015e0574f8439d761d3eb433c6f94499683590084814b560d
+  data.tar.gz: fb29f358eca0b1186afd6cb1417538bac16731a8a2c1faf06c9526afd7e00bc93bcbdfd642b1a8912b02fbe39318842e8730a738586e64ed5df5d7915e94a6b2

data/Gemfile.lock

@@ -2,6 +2,7 @@ PATH
   remote: .
   specs:
     rokaki (0.5.1)
+      activesupport
 
 GEM
   remote: https://rubygems.org/
@@ -17,6 +18,7 @@ GEM
       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)
     diff-lcs (1.3)
@@ -52,6 +54,9 @@ GEM
     pry (0.12.2)
       coderay (~> 1.1.0)
       method_source (~> 0.9.0)
+    pry-byebug (3.7.0)
+      byebug (~> 11.0)
+      pry (~> 0.10)
     rake (10.5.0)
     rb-fsevent (0.10.3)
     rb-inotify (0.10.0)
@@ -87,6 +92,7 @@ DEPENDENCIES
   guard
   guard-rspec
   pry
+  pry-byebug
   rake (~> 10.0)
   rokaki!
   rspec (~> 3.0)

data/Guardfile

@@ -36,6 +36,7 @@ guard :rspec, cmd: "bundle exec rspec" do
   watch(rspec.spec_support) { rspec.spec_dir }
   watch(rspec.spec_files)
 
+  watch(%r{^lib/rokaki/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
   # Ruby files
   ruby = dsl.ruby
   dsl.watch_spec_files_for(ruby.lib_files)

data/LICENSE.txt

@@ -19,3 +19,5 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 THE SOFTWARE.
+
+f007539360

data/README.md

@@ -84,9 +84,12 @@ filter = ArticleFilter.new(filters: params[:filters])
 filtered_results = filter.results
 
 ```
+### Arrays of params
+You can also filter collections of fields, simply pass an array of filter values instead of a single value, eg:- `{ date: '10-10-10', author: { first_name: ['Author1', 'Author2'] } }`.
+
 
 ### Partial matching
-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:-
+You can use `like` (or, if you use postgres, the case insensitive `ilike`) to perform a partial match on a specific field, there are 3 options:- `:prefix`, `:circumfix` and `:suffix`. There are two syntaxes you can use for this:-
 
 #### 1. The `filter` command syntax
 

data/lib/rokaki/filter_model/basic_filter.rb

@@ -0,0 +1,71 @@
+# frozen_string_literal: true
+
+module Rokaki
+  module FilterModel
+    class BasicFilter
+      def initialize(keys:, prefix:, infix:, like_semantics:, i_like_semantics:)
+        @keys = keys
+        @prefix = prefix
+        @infix = infix
+        @like_semantics = like_semantics
+        @i_like_semantics = i_like_semantics
+      end
+      attr_reader :keys, :prefix, :infix, :like_semantics, :i_like_semantics
+      attr_accessor :filter_method, :filter_template
+
+      def call
+        first_key = keys.shift
+        filter = "#{prefix}#{first_key}"
+        name = first_key
+
+        keys.each do |key|
+          filter += "#{infix}#{key}"
+          name += "#{infix}#{key}"
+        end
+
+        @filter_method = "def #{prefix}filter_#{name};" \
+          "#{_chain_filter_type(name)} end;"
+
+        # class_eval filter_method, __FILE__, __LINE__ - 2
+
+        @filter_template = "@model = #{prefix}filter_#{name} if #{filter};"
+      end
+
+      def _chain_filter_type(key)
+        filter = "#{prefix}#{key}"
+        query  = ''
+
+        if like_semantics && mode = like_semantics[key]
+          query = build_like_query(
+            type: 'LIKE',
+            query: query,
+            filter: filter,
+            mode: mode,
+            key: key
+          )
+        elsif i_like_semantics && mode = i_like_semantics[key]
+          query = build_like_query(
+            type: 'ILIKE',
+            query: query,
+            filter: filter,
+            mode: mode,
+            key: key
+          )
+        else
+          query = "@model.where(#{key}: #{filter})"
+        end
+
+        query
+      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
+        query
+      end
+    end
+  end
+end
+

data/lib/rokaki/filter_model/filter_chain.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module Rokaki
+  module FilterModel
+    class FilterChain
+      def initialize(keys)
+        @keys = keys
+        @filter_chain = []
+      end
+    end
+  end
+end
+

data/lib/rokaki/filter_model/like_keys.rb

@@ -2,6 +2,10 @@
 
 module Rokaki
   module FilterModel
+    # Converts deep hashes into keys
+    # effectively drops the leaf values and make's their
+    # keys the leaves
+    #
     class LikeKeys
       def initialize(args)
         @args = args

data/lib/rokaki/filter_model/nested_filter.rb

@@ -0,0 +1,148 @@
+# frozen_string_literal: true
+require 'active_support/inflector'
+
+module Rokaki
+  module FilterModel
+    class NestedFilter
+      def initialize(filter_key_object:, prefix:, infix:, like_semantics:, i_like_semantics:)
+        @filter_key_object = filter_key_object
+        @prefix = prefix
+        @infix = infix
+        @like_semantics = like_semantics
+        @i_like_semantics = i_like_semantics
+        @filter_methods = []
+        @filter_templates = []
+      end
+      attr_reader :filter_key_object, :prefix, :infix, :like_semantics, :i_like_semantics
+      attr_accessor :filter_methods, :filter_templates
+
+      def call # _chain_nested_filter
+        filter_key_object.keys.each do |key|
+          deep_chain([key], filter_key_object[key])
+        end
+      end
+
+      private
+
+      def deep_chain(keys, value)
+        if value.is_a? Hash
+          value.keys.map do |key|
+            _keys = keys.dup << key
+            deep_chain(_keys, value[key])
+          end
+        end
+
+        if value.is_a? Array
+          value.each do |av|
+            _keys = keys.dup << av
+            _build_deep_chain(_keys)
+          end
+        end
+
+        if value.is_a? Symbol
+          _keys = keys.dup << value
+          _build_deep_chain(_keys)
+        end
+      end
+
+      def find_like_key(keys)
+        return nil unless like_semantics && like_semantics.keys.any?
+        current_like_key = like_semantics
+        keys.each do |key|
+          current_like_key = current_like_key[key]
+        end
+        current_like_key
+      end
+
+      def find_i_like_key(keys)
+        return nil unless like_semantics && i_like_semantics.keys.any?
+        current_like_key = i_like_semantics
+        keys.each do |key|
+          current_like_key = current_like_key[key]
+        end
+        current_like_key
+      end
+
+      def _build_deep_chain(keys)
+        name    = '' # prefix.to_s
+        count   = keys.size - 1
+
+        joins_before = []
+        joins_after = []
+        joins = ''
+        where_before = []
+        where_after = []
+        out   = ''
+        mode = nil
+        type = nil
+        leaf = nil
+
+        if mode = find_like_key(keys)
+          type = 'LIKE'
+        elsif mode = find_i_like_key(keys)
+          type = 'ILIKE'
+        end
+        leaf = keys.pop
+
+        keys.each_with_index do |key, i|
+          if keys.length == 1
+            joins_before << ":#{key}"
+          else
+            if i == 0
+              joins_before << "#{key}: "
+            elsif (keys.length-1) == i
+              joins_before << " :#{key}"
+            else
+              joins_before << "{ #{key}:"
+              joins_after << " }"
+            end
+          end
+
+          name += "#{key}#{infix}"
+          where_before.push("{ #{key.to_s.pluralize}: ")
+          where_after.push(" }")
+        end
+
+        joins = joins_before + joins_after
+
+        name += "#{leaf}"
+        where_middle = ["{ #{leaf}: #{prefix}#{name} }"]
+
+        where = where_before + where_middle + where_after
+        joins = joins.join
+        where = where.join
+
+        if mode
+          query = build_like_query(
+            type: type,
+            query: '',
+            filter: "#{prefix}#{name}",
+            mode: mode,
+            key: keys.last.to_s.pluralize,
+            leaf: leaf
+          )
+
+          @filter_methods << "def #{prefix}filter#{infix}#{name};"\
+            "@model.joins(#{joins}).#{query}; end;"
+
+          @filter_templates << "@model = #{prefix}filter#{infix}#{name} if #{prefix}#{name};"
+        else
+          @filter_methods << "def #{prefix}filter#{infix}#{name};"\
+            "@model.joins(#{joins}).where(#{where}); end;"
+
+          @filter_templates << "@model = #{prefix}filter#{infix}#{name} if #{prefix}#{name};"
+        end
+      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
+        query
+      end
+
+    end
+  end
+end
+

data/lib/rokaki/filter_model.rb

@@ -21,62 +21,34 @@ module Rokaki
       end
 
       def filters(*filter_keys)
-        define_filter_keys *filter_keys
+        define_filter_keys(*filter_keys)
 
         @_chain_filters ||= []
         filter_keys.each do |filter_key|
-          _chain_filter([filter_key]) unless filter_key.is_a? Hash
-          _chain_nested(filter_key) if filter_key.is_a? Hash
-        end
 
-        define_results
-      end
+          # TODO: does the key need casting to an array here?
+          _chain_filter(filter_key) unless filter_key.is_a? Hash
 
-      def _chain_filter(keys)
-        first_key = keys.shift
-        filter = "#{filter_key_prefix}#{first_key}"
-        name = first_key
+          _chain_nested_filter(filter_key) if filter_key.is_a? Hash
 
-        keys.each do |key|
-          filter += "#{filter_key_infix}#{key}"
-          name += "#{filter_key_infix}#{key}"
         end
 
-        filter_method = "def #{filter_key_prefix}filter_#{name};" \
-          "#{_chain_filter_type(name)} end;"
-
-        class_eval filter_method, __FILE__, __LINE__ - 2
-
-        @_chain_filters << "@model = #{filter_key_prefix}filter_#{name} if #{filter};"
+        define_results # writes out all the generated filters
       end
 
-      def _chain_filter_type(key)
-        filter = "#{filter_key_prefix}#{key}"
-        query  = ''
-
-        if @_like_semantics && mode = @_like_semantics[key]
-          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(#{key}: #{filter})"
-        end
+      def _chain_filter(key)
+        basic_filter = BasicFilter.new(
+          keys: [key],
+          prefix: filter_key_prefix,
+          infix: filter_key_infix,
+          like_semantics: @_like_semantics,
+          i_like_semantics: @i_like_semantics
+        )
+        basic_filter.call
 
-        query
+        class_eval basic_filter.filter_method, __FILE__, __LINE__ - 2
+
+        @_chain_filters << basic_filter.filter_template
       end
 
       def like_semantics(type:, query:, filter:, mode:, key:)
@@ -87,40 +59,22 @@ module Rokaki
         query
       end
 
-      def _build_deep_chain(keys)
-        name    = filter_key_prefix.to_s
-        count   = keys.size - 1
-
-        joins = ''
-        where = ''
-        out   = ''
-
-        leaf = keys.pop
-
-        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} } }"
+      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
+        )
+        nested_filter.call
+
+        nested_filter.filter_methods.each do |filter_method|
+          class_eval filter_method, __FILE__, __LINE__ - 2
         end
 
-        joins = joins += out
-        where = where += out
-
-        # chain filter here?
-        #
-        filter_method = "def #{filter_key_prefix}filter_#{name};"\
-                   "@model.joins(#{joins}).where(#{where}); end;"
-
-        class_eval filter_method, __FILE__, __LINE__ - 2
-
-        @_chain_filters << "@model = #{filter_key_prefix}filter_#{name} if #{name};"
-      end
-
-      def _chain_nested(filters_object)
-        filters_object.keys.each do |key|
-          deep_chain([key], filters_object[key])
+        nested_filter.filter_templates.each do |filter_template|
+          @_chain_filters << filter_template
         end
       end
 
@@ -138,8 +92,9 @@ module Rokaki
         @_like_semantics = (@_like_semantics || {}).merge(args)
 
         key_builder = LikeKeys.new(args)
+        keys = key_builder.call
 
-        filters(*key_builder.call)
+        filters(*keys)
       end
 
       def ilike(args)
@@ -147,8 +102,9 @@ module Rokaki
         @i_like_semantics = (@i_like_semantics || {}).merge(args)
 
         key_builder = LikeKeys.new(args)
+        keys = key_builder.call
 
-        filters(*key_builder.call)
+        filters(*keys)
       end
 
       def deep_chain(keys, value)
@@ -176,7 +132,7 @@ module Rokaki
       # filter_model method
       #
       def define_results
-        results_def = 'def results;model;'
+        results_def = 'def results; model;'
         @_chain_filters.each do |item|
           results_def += item
         end

data/lib/rokaki/filterable.rb

@@ -50,7 +50,6 @@ module Rokaki
           end
         end
 
-
         if value.is_a? Array
           value.each do |av|
             _keys = keys.dup << av

data/lib/rokaki/version.rb

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

data/lib/rokaki.rb

@@ -4,6 +4,8 @@ require 'rokaki/version'
 require 'rokaki/filterable'
 require 'rokaki/filter_model'
 require 'rokaki/filter_model/like_keys'
+require 'rokaki/filter_model/basic_filter'
+require 'rokaki/filter_model/nested_filter'
 
 module Rokaki
   class Error < StandardError; end

data/rokaki.gemspec

@@ -1,39 +1,44 @@
-lib = File.expand_path("lib", __dir__)
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require "rokaki/version"
+require 'rokaki/version'
 
 Gem::Specification.new do |spec|
-  spec.name          = "rokaki"
+  spec.name          = 'rokaki'
   spec.version       = Rokaki::VERSION
-  spec.authors       = ["Steve Martin"]
-  spec.email         = ["steve@martian.media"]
+  spec.authors       = ['Steve Martin']
+  spec.email         = ['steve@martian.media']
 
-  spec.summary       = %q{A web request filtering library}
-  spec.description   = %q{A dsl for filtering data in web requests}
-  spec.homepage      = "https://github.com/tevio/rokaki"
-  spec.license       = "MIT"
+  spec.summary       = 'A web request filtering library'
+  spec.description   = 'A dsl for filtering data in web requests'
+  spec.homepage      = 'https://github.com/tevio/rokaki'
+  spec.license       = 'MIT'
 
   # spec.metadata["allowed_push_host"] = "TODO: Set to 'http://mygemserver.com'"
 
-  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata['homepage_uri'] = spec.homepage
   # spec.metadata["source_code_uri"] = "TODO: Put your gem's public repo URL here."
   # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
 
   # Specify which files should be added to the gem when it is released.
   # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
-  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
     `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
   end
-  spec.bindir        = "exe"
+  spec.bindir        = 'exe'
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
-  spec.require_paths = ["lib"]
-
-  spec.add_development_dependency "bundler", "~> 2.0"
-  spec.add_development_dependency "rake", "~> 10.0"
-  spec.add_development_dependency "rspec", "~> 3.0"
-  spec.add_development_dependency "guard"
-  spec.add_development_dependency "pry"
-  spec.add_development_dependency "guard-rspec"
-  spec.add_development_dependency "activerecord"
-  spec.add_development_dependency "sqlite3"
+  spec.require_paths = ['lib']
+
+  spec.add_dependency 'activesupport'
+
+  spec.add_development_dependency 'activerecord'
+  spec.add_development_dependency 'bundler', '~> 2.0'
+  spec.add_development_dependency 'guard'
+  spec.add_development_dependency 'guard-rspec'
+  spec.add_development_dependency 'pry'
+  spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'sqlite3'
 end

metadata

@@ -1,57 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: rokaki
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Steve Martin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-10-17 00:00:00.000000000 Z
+date: 2019-11-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
+  name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
-  type: :development
+        version: '0'
+  type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rake
+  name: activerecord
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '3.0'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: guard
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +67,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: guard-rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -81,7 +81,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: guard-rspec
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -95,7 +95,7 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: activerecord
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -108,6 +108,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  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: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -143,7 +171,10 @@ files:
 - bin/setup
 - lib/rokaki.rb
 - lib/rokaki/filter_model.rb
+- lib/rokaki/filter_model/basic_filter.rb
+- lib/rokaki/filter_model/filter_chain.rb
 - lib/rokaki/filter_model/like_keys.rb
+- lib/rokaki/filter_model/nested_filter.rb
 - lib/rokaki/filterable.rb
 - lib/rokaki/version.rb
 - rokaki.gemspec