filter_me 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 1d20eaf1933fba4c0a52e4c6b04ab9e9bce510c2
-  data.tar.gz: eafa06100f1fd7cf77332a340f1213f7e344beae
+  metadata.gz: 18b40e6f2a9fcaf467a1f2166f05d0ba68105950
+  data.tar.gz: 0fb38eacbe1d68acaeadc9f45d6e10c8d8da2def
 SHA512:
-  metadata.gz: a5356b764fbe3b6a961fc1dae9a8e7b6a08dce53c4871772a13119fb0623e676acd4fa1074d7b308270d215e6dce9700cbb76ac6590c929643e8770a5891bf86
-  data.tar.gz: b07bbc44c7a7bd6bcec60cbfa453615e28eba848e8c30cc5d2069ac0edfb98f516ef80d26302bf0db7aa39f6188d34f062d7e6b7b87b43a49abb3b1f62e26f4f
+  metadata.gz: e0440632d4aa92aa9965db9fda965733749ef433bb4bbb2c0f3a437455b64c18b76a51b438bfb600592152cc4c1fcafb9b81a728c7796b2983b540538198ba2b
+  data.tar.gz: 5aefc9980ead5f85a92ac9b255bf00dd2ececb46b5d714e29bca934b383cbad3ffffdbba55c5c0dc3922f75d094d1cdd85ea6631ef1dbb1384fa92f502b2c91d

data/README.md

@@ -5,7 +5,7 @@ FilterMe
 
 ### A Rails/ActiveRecord filtering gem
 
-FilterMe provids helpers and classes that provides filtering using Ruby classes and object oriented development
+FilterMe provids helpers and classes that makes request filtering easy using Ruby classes and object oriented development.
 
 ## Installation
 ``` ruby
@@ -17,37 +17,59 @@ gem "filter_me", "0.1.0"
 ``` ruby
 class AccountsFilter < FilterMe::ActiveRecordFilter
   model Account
-    
-  field :type, [:matches, :eq, :not_eq] # Uses arel, so any Arel::Predications method should work
-  field :cost, [:lt, :gt, :lteq, :gteq, :eq] # Uses arel, so any Arel::Predications method should work
+  association :user
+
+  field :cost, :all
+  field :account_type, [:matches] # Symbols are Arel::Predications methods
 end
     
 class AccountsController < ApplicationController
   include FilterMe
-      
+
   def index
     @accounts = filter_me(Account.all)
+    respond_to do |format|
+      format.json { render json: @accounts }
+    end
   end
 end
+
 ```
 
-Given a controller that recieves params like the following:
-``` ruby
-params # => {filters: {type: {eq: "admin"} } }
+Plain request:
+http://0.0.0.0:3000/accounts.json
+``` json
+{"accounts":[
+  {"id":1, "cost":100000, "account_type":"admin"},
+  {"id":2, "cost":50000, "account_type":"paid"},
+  {"id":3, "cost":10000, "account_type":"free"}
+]}
+```
+Performs:
+``` SQL
+SELECT "accounts".* FROM "accounts"
 ```
 
-The following SQL would be performed (Using ActiveRecord):
+Now with some filtering:
+http://0.0.0.0:3000/accounts.json?filters%5Baccount_type%5D%5Bmatches%5D=paid
+``` json
+{"accounts":[
+  {"id":2, "cost":50000, "account_type":"paid"}
+]}
+```
+Performs:
 ``` SQL
-SELECT "accounts".* FROM "accounts" WHERE ("accounts"."type" = "admin")
+SELECT "accounts".* FROM "accounts" WHERE ("accounts"."account_type" LIKE 'paid')
 ```
 
 ## Nested Filtering:
 ``` ruby
 class UsersFilter < FilterMe::ActiveRecordFilter
   model User
-    
-  association :account, :filter_class => AccountsFilter
-  field :username, [:matches, :eq, :not_eq] # Uses arel, so any Arel::Predications method should work
+  association :account
+
+  field :username, [:matches, :eq, :not_eq] # Symbols are Arel::Predications methods
+  field :email, [:matches, :eq, :not_eq] # Symbols are Arel::Predications methods
 end
     
 class UsersController < ApplicationController
@@ -55,18 +77,61 @@ class UsersController < ApplicationController
       
   def index
     @users = filter_me(User.all)
+    respond_to do |format|
+      format.json { render json: @users }
+    end
   end
 end
 ```
 
-With the following params:
-``` ruby
-params # => {:filters => {:email => {:matches => "%test.com"}, :account => {:cost => {:lt => 100000} } } }
+Plain request:
+http://0.0.0.0:3000/users.json
+``` json
+{"users":[
+  {"id":1, "username":"test1", "email":"test2@test.com", "account": {
+    "id":1, "cost":100000, "account_type":"admin"
+  }},
+  {"id":2, "username":"test2", "email":"test2@test.com", "account":{
+    "id":2, "cost":50000, "account_type":"paid"
+  }},
+  {"id":3, "username":"test3", "email":"test3@spaz.com", "account":{
+    "id":3, "cost":10000, "account_type":"free"
+  }}
+]}
+Performs:
+``` SQL
+SELECT "users".* FROM "users"
+```
+
+Now with some filtering:
+http://0.0.0.0:3000/users.json?filters%5Baccount%5D%5Bcost%5D%5Blt%5D=50000
+``` json
+{"users":[
+  {"id":3, "username":"test3", "email":"test3@spaz.com", "account":{
+    "id":3,"cost":10000, "account_type":"free"
+  }}
+]}
 ```
 Performs:
 ``` SQL
 SELECT "users".* FROM "users" INNER JOIN "accounts" ON "accounts"."user_id" = "users"."id"
-    WHERE ("users"."email" LIKE '%test.com') AND ("accounts"."cost" < 100000)
+    WHERE ("accounts"."cost" < 50000)
+```
+
+Need to provide some top secret super duper special filtering? Go ahead:
+``` ruby
+class UsersFilter < FilterMe::ActiveRecordFilter
+  model User
+
+  def special_filter(relation, filters)
+    relation.where(id: filters)
+  end
+end
+```
+http://0.0.0.0:3000/users.json?filters%5Baccount%5D%5Bcost%5D%5Bgteq%5D=50000&filters%5Bspecial_filter%5D%5B%5D=3&filters%5Bspecial_filter%5D%5B%5D=2 Now performs:
+``` SQL
+SELECT "users".* FROM "users" INNER JOIN "accounts" ON "accounts"."user_id" = "users"."id"
+    WHERE ("accounts"."cost" >= 50000) AND "users"."id" IN (3, 2)
 ```
 
 ## License

data/lib/filter_me/filter/arel_field_filter.rb

@@ -8,7 +8,7 @@ module FilterMe
 				@configuration = configuration
 
 				unless validator.valid_filters?(filters)
-					raise FiltersNotWhiteListedError, "The filter types #{validator.invalid_filters(filters)} are not allowed."
+					raise FiltersNotWhiteListedError, "The filter types #{validator.invalid_filters(filters).map { |filter| filter[0] }} are not allowed."
 				end
 			end
 

data/lib/filter_me/filter/field_validator.rb

@@ -21,7 +21,7 @@ module FilterMe
 			end
 
 			def valid_filters?(filters)
-				filters.all? { |filter| whitelisted_filters.include? filter[0] }
+				filters.all? { |filter| whitelisted_filters.include?(filter[0]) || whitelisted_filters.include?(filter[0].to_sym) }
 			end
 
 			def invalid_filters(filters)

data/lib/filter_me/version.rb

@@ -1,3 +1,3 @@
 module FilterMe
-	VERSION = '0.1.1'
+	VERSION = '0.1.2'
 end

data/spec/unit/arel_field_filter_spec.rb

@@ -91,7 +91,7 @@ describe FilterMe::Filter::ArelFieldFilter do
 		end
 
 		it "builds the correct arel filter with two filter types of one filter value each" do
-			field_filter = FilterMe::Filter::ArelFieldFilter.new([[:gt, [1]], [:lt, [10]]], configuration)
+			field_filter = FilterMe::Filter::ArelFieldFilter.new([["gt", [1]], [:lt, [10]]], configuration)
 			relation_mock = double("relation")
 
 			arel_filter = arel_table[field].lt(10).and(arel_table[field].gt(1))
@@ -103,7 +103,7 @@ describe FilterMe::Filter::ArelFieldFilter do
 		end
 
 		it "builds the correct arel filter with two filter types of two filter value each" do
-			field_filter = FilterMe::Filter::ArelFieldFilter.new([[:matches, ["%hi%", "%hey%"]], [:lt, ["z", "Z"]]], configuration)
+			field_filter = FilterMe::Filter::ArelFieldFilter.new([[:matches, ["%hi%", "%hey%"]], ["lt", ["z", "Z"]]], configuration)
 			relation_mock = double("relation")
 
 			arel_filter = arel_table[field].lt("Z")

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filter_me
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Sam Clopton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-17 00:00:00.000000000 Z
+date: 2014-02-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord