active_queryable 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 85318f4379a335f5d2398c1b85ab19ddb63cfbfa6955882c4dcd9e7a24a5168f
-  data.tar.gz: d9dbb94f9c174af1a34b680152b8add196cf1ddf1a38a895fc0f32370855a985
+  metadata.gz: 5bf4db93e62b6ef9584ed59ac624d983debc4a7792dc4debc252fe4958c0e3ac
+  data.tar.gz: 38bd3b1e7b4e9138be78e1cfed968b9dc499894c5d6aa5d1710bf5d1aa032d26
 SHA512:
-  metadata.gz: f64dda266de6dd21f1c6a21fae9bfba014a72a16f7acf6c560f6feea3771b4663db82b11b97c97fc751379963aa2b0b29b26a6a34339d2f8dade38576ee5868b
-  data.tar.gz: 89bad17c363651ddbc6c75ca6eeda418d436682c9376a1c9670e81bbc959e491b5a3b0acc1345cf71879ea01ad5ccf623fc8624a00e698c34a8131e1f1730c63
+  metadata.gz: fe31f1bacbd161809ede6ad71b12793f1515a4b189b59006b5558ef7d4b9cdd5c43bb905bd2e932d8d087f15e014efce399c7ce13631277265522e9fb3c6a589
+  data.tar.gz: 4f0b563933703484579689cee4fbabe5445ad021115c73bc863f76f9db3ee61df511fa29bd9041aabb81ffbfa1020215005a916cf6de0cc6e4905573c209d2f6

data/lib/active_queryable/version.rb

@@ -1,3 +1,3 @@
 module ActiveQueryable
-	VERSION = '0.2.0'
+	VERSION = '0.3.0'
 end

data/lib/active_queryable.rb

@@ -13,6 +13,7 @@ module ActiveQueryable
     class_attribute :_queryable_default_page
     class_attribute :_queryable_default_per
     class_attribute :_queryable_filter_keys
+    class_attribute :_queryable_expandable_filter_keys
 	end
 
 	module Initializer
@@ -26,12 +27,17 @@ module ActiveQueryable
       self._queryable_default_order = options[:order] || { id: :asc }
       self._queryable_default_page = options[:page] || 1
       self._queryable_default_per = options[:per] || 25
-      self._queryable_filter_keys = ((options[:filter] || []) + ['not']).map(&:to_sym)
+      self._queryable_filter_keys = (((options[:filter] || [])).map(&:to_sym))
 
       scope :query_by, ->(params) { queryable_scope(params) }
       scope :of_not, ->(ids) { where.not(id: ids) }
     end
 
+    def expand_queryable(options)
+      self._queryable_expandable_filter_keys ||= []
+      self._queryable_expandable_filter_keys += (((options[:filter] || [])).map(&:to_sym))
+    end
+
     def queryable_scope(params)
       params = params.to_unsafe_h if params.respond_to? :to_unsafe_h
       params = params.with_indifferent_access if params.respond_to?(:with_indifferent_access)
@@ -80,10 +86,11 @@ module ActiveQueryable
     def queryable_validate_filter_params(filter_params)
       return nil if filter_params.nil?
 
-      unpermitted = filter_params.except(*_queryable_filter_keys)
+      filters = (((self._queryable_filter_keys || []) | (self._queryable_expandable_filter_keys || [])) + ['not']).map(&:to_sym)
+      unpermitted = filter_params.except(*filters)
       Rails.logger.warn("Unpermitted queryable parameters: #{unpermitted.keys.join(', ')}") if unpermitted.present?
 
-      filter_params.slice(*_queryable_filter_keys)
+      filter_params.slice(*filters)
     end
 
     def queryable_parse_order_params(params)

data/spec/active_queryable/filters_spec.rb

@@ -3,8 +3,9 @@ require 'spec_helper'
 describe 'Filters' do
   context 'default filters' do
     it 'applies column name-based filters' do
-      query = Person.query_by(filter: { name: 'john doe' }, per: 'all')
+      query = Person.query_by(filter: { name: 'john doe', email: 'e@mail.com' }, per: 'all')
       expect(query.to_sql).to include('"people"."name" = \'john doe\'')
+      expect(query.to_sql).to include('"people"."email" = \'e@mail.com\'')
       expect(query).to include(Person.first)
     end
 

data/spec/support/schema.rb

@@ -5,9 +5,16 @@ ActiveRecord::Base.establish_connection(
   database: ':memory:'
 )
 
-class Person < ActiveRecord::Base
+class Common < ActiveRecord::Base
+  self.abstract_class = true
+
   as_queryable
-  queryable order: { name: :asc }, filter: ['name', 'article_title']
+  queryable order: { name: :asc }, filter: ['name']
+end
+
+class Person < Common
+  expand_queryable filter: ['email']
+  expand_queryable filter: ['article_title']
 
   has_many :articles
 
@@ -16,6 +23,7 @@ class Person < ActiveRecord::Base
 
 end
 
+
 class Article < ActiveRecord::Base
   as_queryable
   queryable order: { title: :asc }, filter: ['title']

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: active_queryable
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Mònade
@@ -19,7 +19,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -29,7 +29,7 @@ dependencies:
         version: '5'
     - - "<"
       - !ruby/object:Gem::Version
-        version: '7'
+        version: '8'
 - !ruby/object:Gem::Dependency
   name: kaminari-activerecord
   requirement: !ruby/object:Gem::Requirement
@@ -99,21 +99,21 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 2.3.0
+      version: 2.7.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.2.33
 signing_key: 
 specification_version: 4
 summary: Gem to make easier model's filtering, sorting and pagination
 test_files:
-- spec/spec_helper.rb
+- spec/active_queryable/filters_spec.rb
 - spec/active_queryable/ordering_spec.rb
 - spec/active_queryable/pagination_spec.rb
-- spec/active_queryable/filters_spec.rb
-- spec/support/schema.rb
+- spec/spec_helper.rb
 - spec/support/match_queries.rb
+- spec/support/schema.rb