rokaki 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa778301c8cf01a3b8743a3a6c42e3dba3412e914138915c08e2a19879695b85
-  data.tar.gz: f41cb7515c3334f4182109fb1f159558a6ee5ad5b78bdfdd201de73e507ac155
+  metadata.gz: 732268408b0eaebe95dc53cfd1cb3788c10d198bb47eddb3f4c75d0ff796d98c
+  data.tar.gz: d698e633dd2d8b48ee086c37e35121c870bc16c40a43070f8c8a5f1db04fc8fd
 SHA512:
-  metadata.gz: d44fec91020ac46a37df80aced0f349e9827fcdb9bc918c010464c9df8a8a792e9abf037839db1936984ce3723801dc218887482eb246fad34b1524db4c3675b
-  data.tar.gz: 07b29041a2550fe70ab710dda94e637dab627c7210b2f740f1b9e655b0a4ec6058d58557af7bf71c7dae4c298f1f5046a4d6d6710e4c742f4eaef4a3a803d473
+  metadata.gz: f2d9eb53031c10422b3133063792d99f534f4e47ef12fcabe61e52f244d221dae997c437665dada3b7036e017fdd6245f24f54b3507a4ee30dfa0ba976cb8c1e
+  data.tar.gz: e632c271dfc09265b2717e348b7becf7fdf401c1921e34edc6cdae67b52cfc0eeebe481815bd608695236cdfb0008c7a6c662b93c89bb605d8ca10fa8cfa2f37

data/Gemfile.lock

@@ -6,7 +6,19 @@ PATH
 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)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.1, >= 2.1.8)
     coderay (1.1.2)
+    concurrent-ruby (1.1.5)
     diff-lcs (1.3)
     ffi (1.11.1)
     formatador (0.2.5)
@@ -24,12 +36,15 @@ GEM
       guard (~> 2.1)
       guard-compat (~> 1.1)
       rspec (>= 2.99.0, < 4.0)
+    i18n (1.6.0)
+      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)
     nenv (0.3.0)
     notiffany (0.1.3)
       nenv (~> 0.1)
@@ -56,12 +71,18 @@ GEM
     rspec-support (3.8.2)
     ruby_dep (1.5.0)
     shellany (0.0.1)
+    sqlite3 (1.4.1)
     thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+    zeitwerk (2.1.9)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  activerecord
   bundler (~> 2.0)
   guard
   guard-rspec
@@ -69,6 +90,7 @@ DEPENDENCIES
   rake (~> 10.0)
   rokaki!
   rspec (~> 3.0)
+  sqlite3
 
 BUNDLED WITH
    2.0.2

data/README.md

@@ -9,17 +9,13 @@ It's a simple gem that just provides you with a basic dsl based on the filter pa
 Add this line to your application's Gemfile:
 
 ```ruby
-gem 'rokaki'
+gem 'rokaki', git: 'https://github.com/tevio/rokaki.git'
 ```
 
 And then execute:
 
     $ bundle
 
-Or install it yourself as:
-
-    $ gem install rokaki
-
 ## Usage
 
 To use the basic DSL include the `Rokaki::Filterable` module
@@ -45,7 +41,7 @@ A simple example might be:-
   end
 ```
 
-This would map attributes `date`, `author_first_name` and `author_last_name`, from a filters object with the structure `{ date: '10-10-10', author: { first_name: 'Shteeve' } }`.
+This maps attributes `date`, `author_first_name` and `author_last_name` to a filters object with the structure `{ date: '10-10-10', author: { first_name: 'Shteeve' } }`.
 
 ## Additional options
 You can specify a `filter_key_prefix` and a `filter_key_infix` to change the structure of the accessors.
@@ -53,6 +49,41 @@ You can specify a `filter_key_prefix` and a `filter_key_infix` to change the str
 `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
+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:-
+
+```
+# Given the models
+class Author < ActiveRecord::Base
+  has_many :articles, inverse_of: :author
+end
+
+class Article < ActiveRecord::Base
+  belongs_to :author, inverse_of: :articles, required: true
+end
+
+
+class ArticleFilter
+  include FilterModel
+
+  filters :date, :title, author: [:first_name, :last_name]
+
+  attr_accessor :filters
+
+  def initialize(filters:, model: Article)
+    @filters = filters
+    @model = model
+  end
+end
+
+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)
+```
+
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake spec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
@@ -61,7 +92,7 @@ To install this gem onto your local machine, run `bundle exec rake install`. To
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/rokaki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+Bug reports and pull requests are welcome on GitHub at https://github.com/tevio/rokaki. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
@@ -69,4 +100,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the Rokaki project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/rokaki/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the Rokaki project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tevio/rokaki/blob/master/CODE_OF_CONDUCT.md).

data/lib/rokaki/filter_model.rb

@@ -0,0 +1,114 @@
+module Rokaki
+  module FilterModel
+    include Filterable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+      include Filterable::ClassMethods
+      private
+
+      def filters(*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
+
+      def _chain_filter(key)
+        @_chain_filters << "@model = @model.where(#{key.to_s}: #{key.to_s}) if #{key.to_s};"
+      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|
+          if keys.length == 1
+            name  = "#{key}#{filter_key_infix.to_s}#{leaf}"
+            joins = ":#{key}"
+
+            where = "{ #{key.to_s.pluralize}: { #{leaf}: #{name} } }"
+          end
+        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};"
+      end
+
+      def _chain_nested(filters_object)
+        filters_object.keys.each do |key|
+          deep_chain([key], filters_object[key])
+        end
+      end
+
+      def associated_table(association)
+        @model.reflect_on_association(association).klass.table_name
+      end
+
+      def filter_model(model)
+        @model = model
+      end
+
+      def like(*args)
+
+      end
+
+      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 define_results
+        results_def = "def results;"
+        @_chain_filters.each do |item|
+          results_def += item
+        end
+        results_def += '@model;end;'
+        class_eval results_def
+      end
+    end
+  end
+end

data/lib/rokaki/filterable.rb

@@ -0,0 +1,76 @@
+module Rokaki
+  module Filterable
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    # class methods such as define_filter_keys which comprise the dsl
+    #
+    module ClassMethods
+      private
+
+      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
+        end
+      end
+
+      def filter_key_prefix(prefix)
+        @filter_key_prefix ||= prefix
+      end
+
+      def filter_key_infix(infix = :_)
+        @filter_key_infix ||= infix
+      end
+
+      def _build_filter(keys)
+        name    = @filter_key_prefix.to_s
+        filters = "filters"
+        count   = keys.size - 1
+
+        keys.each_with_index do |key, i|
+          name += key.to_s
+          name += filter_key_infix.to_s unless count == i
+
+          filters += "[:#{key}]"
+        end
+
+        class_eval "def #{name}; filters.dig(*#{keys}); end;", __FILE__, __LINE__
+      end
+
+      def _nested_key(filters_object)
+        filters_object.keys.each do |key|
+          deep_map([key], filters_object[key])
+        end
+      end
+
+      def deep_map(keys, value)
+        if value.is_a? Hash
+          value.keys.map do |key|
+            _keys = keys.dup << key
+            deep_map(_keys, value[key])
+          end
+        end
+
+        if value.is_a? Array
+          value.each do |av|
+            _keys = keys.dup << av
+            _build_filter(_keys)
+          end
+        end
+
+        if value.is_a? Symbol
+          _keys = keys.dup << value
+          _build_filter(_keys)
+        end
+      end
+
+    end
+
+    def filters
+      raise Error, "Filterable object must implement 'filters' method that returns a hash"
+    end
+
+  end
+end

data/lib/rokaki/version.rb

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

data/lib/rokaki.rb

@@ -1,84 +1,12 @@
 # frozen_string_literal: true
 
 require 'rokaki/version'
+require 'rokaki/filterable'
+require 'rokaki/filter_model'
 
 module Rokaki
   class Error < StandardError; end
 
   # include this module for filters dsl in an object
   #
-  module Filterable
-    def self.included(base)
-      base.extend(ClassMethods)
-    end
-
-    # class methods such as define_filter_keys which comprise the dsl
-    #
-    module ClassMethods
-      private
-
-      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
-        end
-      end
-
-      def filter_key_prefix(prefix)
-        @filter_key_prefix ||= prefix
-      end
-
-      def filter_key_infix(infix = :_)
-        @filter_key_infix ||= infix
-      end
-
-      def _build_filter(keys)
-        name    = @filter_key_prefix.to_s
-        filters = "filters"
-        count   = keys.size - 1
-
-        keys.each_with_index do |key, i|
-          name += key.to_s
-          name += filter_key_infix.to_s unless count == i
-
-          filters += "[:#{key}]"
-        end
-
-        class_eval "def #{name}; #{filters}; end;", __FILE__, __LINE__
-      end
-
-      def _nested_key(filters_object)
-        filters_object.keys.each do |key|
-          deep_map([key], filters_object[key])
-        end
-      end
-
-      def deep_map(keys, value)
-        if value.is_a? Hash
-          value.keys.map do |key|
-            _keys = keys.dup << key
-            deep_map(_keys, value[key])
-          end
-        end
-
-        if value.is_a? Array
-          value.each do |av|
-            _keys = keys.dup << av
-            _build_filter(_keys)
-          end
-        end
-
-        if value.is_a? Symbol
-          _keys = keys.dup << value
-          _build_filter(_keys)
-        end
-      end
-
-    end
-
-    def filters
-      raise Error, "Filterable object must implement 'filters' method that returns a hash"
-    end
-
-  end
 end

data/rokaki.gemspec

@@ -10,12 +10,12 @@ Gem::Specification.new do |spec|
 
   spec.summary       = %q{A web request filtering library}
   spec.description   = %q{A dsl for filtering data in web requests}
-  # spec.homepage      = "Rokaki"
+  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."
 
@@ -34,4 +34,6 @@ Gem::Specification.new do |spec|
   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"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rokaki
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Steve Martin
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-09-01 00:00:00.000000000 Z
+date: 2019-09-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -94,6 +94,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  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'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  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
@@ -114,12 +142,15 @@ files:
 - bin/console
 - bin/setup
 - lib/rokaki.rb
+- lib/rokaki/filter_model.rb
+- lib/rokaki/filterable.rb
 - lib/rokaki/version.rb
 - rokaki.gemspec
-homepage: 
+homepage: https://github.com/tevio/rokaki
 licenses:
 - MIT
-metadata: {}
+metadata:
+  homepage_uri: https://github.com/tevio/rokaki
 post_install_message: 
 rdoc_options: []
 require_paths: