syto 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: af0ab05e31639381af798d997f30b3ae2a9501eedea8e4dd957664470f220b34
-  data.tar.gz: 306a9a88c49031e7b7c51c35f3ad6be9cfa4db3ac2596b01d33a65380ad98893
+  metadata.gz: a2bfcad4813be0e102392f0d0a672df0c51afd81b28698851ccca8570ca97e8e
+  data.tar.gz: 779c5ff077f7a176957808f5e8676dba03639e2801b8093fa9e4a6b1f3027656
 SHA512:
-  metadata.gz: edb0033f9f3757b4269d0dd0b3ffdb638748c565c01727784df40041e6defa07658c3766ea98078233d8f32bdea6f9d2a5f88d1739bbea7d59f346c7411d842f
-  data.tar.gz: ad7e6e1dc71ff96a682c1196e4eb41bd18756b5e0e8b5c7961ad55eff53f36b897bf46939830f30a66d96f3a20aa91fba70c7a4aa99d1d44864d6b43285f969a
+  metadata.gz: eda3ccca8097c36c48b47dd7e0ea03e7650eb255f1ac79a71293213fa45bc5cb7c3c3203e16a17f3ce46fd29c3a5436556cb8d40cd93a512ed753264daa80603
+  data.tar.gz: c48ee3f1cb9416e1e5d6a9d2c06b55f3e50ee523bd7413745c88758925dca2f220ef5337fc18be2025742c519b412bab07fe94dfc911d04e9ef7335135766580

data/README.md

@@ -28,10 +28,12 @@ Define filters for attributes `country`, `area_id` and `rate`
 # app/model/user.rb
 class User < ActiveModel
   include Syto
-  syto_attrs_map :active, 
-                 country: { key: :country, case_insensitive: true }, # allows to filter by 'users.country'
-                 area_id: { key: :region },                          # allows to filter by 'users.area_id' as 'region'
-                 rate: { key_from: :rate_from, key_to: :rate_to }    # allows to filter by 'users.rate' with range
+  syto_attrs_map :active,                             # filter by users.active
+                 country: { case_insensitive: true }, # allows to filter by 'users.country'
+                 region: { field: :area_id },         # allows to filter by 'users.area_id' with "region" key in params 
+                 rate: { type: :range },              # allows to filter by 'users.rate' with "rate_from" and "rate_to" keys in params
+                 date: { type: :range, field: :created_at,        
+                         key_from: :start_date, key_to: :end_date } # filter by 'users.created_at'
 end
 ```
 
@@ -51,25 +53,35 @@ Tip: There are 3 methods available in Syto  for use in `extended_filters`:
 ```ruby
 # app/models/concerns/post_filter.rb
 class PostFilters < Syto
+    # map for converting params { author: 52, strat_date: '2020-01-01', end_date: '2021-12-31' }
+    # to query like WHERE user_id = 52 AND created_at BETWEEN '2020-01-01' AND '2021-12-31'
+    filters_attrs_map author: :user_id,
+                      date: { field: :created_at, type: :range, key_from: :start_date, key_to: :end_date }
+    
   def extended_filters
     # base_class contains Post
     return if params[:published].blank?
 
     self.result = result.where(published: params[:published])
-    filter_by_range(:published_at, key_from: :pub_from, key_to: :pub_to)
+    filter_by_range(:published, field: :published_at, key_from: :pub_from, key_to: :pub_to)
   end
 end
 ```
 
 Use in code:
 
+```ruby
+params = { author: 21, start_date: '2022-01-01' }
+User.filter_by(params) # where user_id = 21 and created_at >= '2022-01-01'
+```
+
 ```ruby
 params = { country: 'UA', rate_from: 2, rate_to: 3 }
 User.filter_by(params)
 ```
 
 ```ruby
-params = { published: true, pub_from: '2021-01-01' }
+params = { pub_from: '2021-01-01' }
 Post.filter_by(params) # select published posts from 2021
 ```
 

data/lib/syto/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Syto
-  VERSION = '0.2.0'
+  VERSION = '0.3.0'
 end

data/lib/syto.rb

@@ -131,47 +131,56 @@ module Syto
 
     # Filter by attribute
     #
-    # @param [String. Symbol] attr
-    # @param [Hash] params_key
+    # @param [String, Symbol] key
+    # @param [String, Symbol, NilClass] field_name
     #
-    def scalar_filter(attr, params_key = nil)
-      params_key ||= attr
-      params_key = params_key.to_sym
-      return unless @params[params_key]
+    def scalar_filter(key, field_name = nil)
+      return unless @params[key]
 
-      @result = @result.where(attr => @params[params_key])
+      field_name ||= key
+      @result = @result.where(field_name => @params[key])
     end
 
     # Filter by attribute with options
     #
-    # @param [Hash] attrs
+    # @param [Hash] keys
     #
-    def hash_filter(attrs)
-      attrs.each do |attr, options|
+    def hash_filter(keys)
+      keys.each do |key, options|
         case options
         when String, Symbol
-          scalar_filter attr, options
+          scalar_filter key, options
         when Hash
-          filter_hash_options(attr, options)
+          filter_hash_options(key, options)
         end
       end
     end
 
-    def filter_hash_options(attr, options)
-      filter_by_value attr, options if options.key?(:key)
-      filter_by_range attr, options if options.key?(:key_from) && options.key?(:key_to)
+    def filter_hash_options(key, options)
+      puts key
+      puts options
+      if options[:type] == :range
+        filter_by_range key, options
+      else
+        filter_by_value key, options
+      end
     end
 
     # Filter by single value
     #
-    # @param [Symbol] field_name
+    # @param [Symbol] key
     # @param [Hash] options
     #
-    def filter_by_value(field_name, options = {})
+    # available options:
+    # - field
+    # - case_insensitive
+    #
+    def filter_by_value(key, options = {})
+      return unless @params.key?(key)
+
       options ||= {}
 
-      key ||= options[:key] || field_name
-      return unless @params.key?(key)
+      field_name = options[:field] || key
 
       value = @params[key]
 
@@ -184,17 +193,20 @@ module Syto
 
     # Filter by range
     #
-    # @param [Symbol] field_name
+    # @param [Symbol] key
     # @param [Hash{Symbol->Object}] options
     #
-    # options:
+    # available options:
+    # - field
     # - key_from,
     # - key_to,
     #
-    def filter_by_range(field_name, options = {})
-      key_from  = options[:key_from] || :"#{field_name}_from"
-      key_to    = options[:key_to]   || :"#{field_name}_to"
+    def filter_by_range(key, options = {})
+      options ||= {}
 
+      key_from   = options[:key_from] || :"#{key}_from"
+      key_to     = options[:key_to]   || :"#{key}_to"
+      field_name = options[:field]    || key
       value_from = @params[key_from]
       value_to   = @params[key_to]
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: syto
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Vadym Lukavyi
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2022-02-12 00:00:00.000000000 Z
+date: 2022-02-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord