filter_me 0.1.0 → 0.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 48be03e95db1c79700cb86c0e4d7d5fc3bb0105f
-  data.tar.gz: 1dadc42cd98cf3c249139deff59d5bb381e02f93
+  metadata.gz: 1d20eaf1933fba4c0a52e4c6b04ab9e9bce510c2
+  data.tar.gz: eafa06100f1fd7cf77332a340f1213f7e344beae
 SHA512:
-  metadata.gz: 0176700ff8445af02e848c65c8ad4e9018bce1c863ad8dab7932d349c1a5574a67c68190a0e21f28eacf320d82ef6b27c2d7a3e6414ebe7d4c656600b153d764
-  data.tar.gz: ef3971291473338f4d2728d9fa99d11e12be7f78b3bc962da835567b2f64bea9ea6e728ba404aa3027dd10458395d18d2fefd3c72a48165fe17414f5d7089d15
+  metadata.gz: a5356b764fbe3b6a961fc1dae9a8e7b6a08dce53c4871772a13119fb0623e676acd4fa1074d7b308270d215e6dce9700cbb76ac6590c929643e8770a5891bf86
+  data.tar.gz: b07bbc44c7a7bd6bcec60cbfa453615e28eba848e8c30cc5d2069ac0edfb98f516ef80d26302bf0db7aa39f6188d34f062d7e6b7b87b43a49abb3b1f62e26f4f

data/README.md

@@ -1,11 +1,73 @@
-[![Code Climate](https://codeclimate.com/github/Samsinite/filter_me.png)](https://codeclimate.com/github/Samsinite/filter_me)
-filter_me
+FilterMe
 =========
 
-A Rails/ActiveRecord filtering gem
+[![Build Status](https://travis-ci.org/Samsinite/filter_me.png?branch=master)](https://travis-ci.org/Samsinite/filter_me) [![Code Climate](https://codeclimate.com/github/Samsinite/filter_me.png)](https://codeclimate.com/github/Samsinite/filter_me) [![Gem Version](https://badge.fury.io/rb/filter_me.png)](http://badge.fury.io/rb/filter_me)
 
-### Coming Soon to a application near you!
+### A Rails/ActiveRecord filtering gem
 
+FilterMe provids helpers and classes that provides filtering using Ruby classes and object oriented development
+
+## Installation
+``` ruby
+gem "filter_me", "0.1.0"
+```
+
+## Filter:
+\* Highly subject to change as the API moves closer to 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
+end
+    
+class AccountsController < ApplicationController
+  include FilterMe
+      
+  def index
+    @accounts = filter_me(Account.all)
+  end
+end
+```
+
+Given a controller that recieves params like the following:
+``` ruby
+params # => {filters: {type: {eq: "admin"} } }
+```
+
+The following SQL would be performed (Using ActiveRecord):
+``` SQL
+SELECT "accounts".* FROM "accounts" WHERE ("accounts"."type" = "admin")
+```
+
+## 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
+end
+    
+class UsersController < ApplicationController
+  include FilterMe
+      
+  def index
+    @users = filter_me(User.all)
+  end
+end
+```
+
+With the following params:
+``` ruby
+params # => {:filters => {:email => {:matches => "%test.com"}, :account => {:cost => {:lt => 100000} } } }
+```
+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)
+```
 
 ## License
 Copyright (c) 2014, Filter Me is developed and maintained by Sam Clopton, and is released under the open MIT Licence.

data/filter_me.gemspec

@@ -20,7 +20,6 @@ Gem::Specification.new do |s|
 
 	s.add_runtime_dependency     'activerecord', '>= 3.2.0'
 	s.add_runtime_dependency     'activesupport', '>= 3.2.0'
-	#s.add_runtime_dependency     'activemodel', '>= 3.2.0'
 	s.add_development_dependency 'combustion',   '~> 0.5.1'
 	s.add_development_dependency 'rspec-rails',  '~> 2.13'
 	s.add_development_dependency 'sqlite3',      '~> 1.3.7'

data/lib/filter_me/filter/arel_field_filter.rb

@@ -13,7 +13,7 @@ module FilterMe
 			end
 
 			def filter(relation)
-				arel_filters.inject { |arel_relation, filter| filter.and(arel_relation) }
+				model_class.where(arel_filters.inject { |arel_relation, filter| filter.and(arel_relation) })
 			end
 
 			private

data/lib/filter_me/filter/dsl.rb

@@ -51,14 +51,12 @@ module FilterMe
 			private
 
 			def filter(name, klass, configuration, association = nil)
-				this = self
 				filter_class.send(:define_method, name) do |relation, filters|
 					filter = klass.new(filters, configuration)
 					if association
-						relation = relation.joins(name.to_sym)
-						filter.filter(relation)
+						relation.joins(name.to_sym).merge(filter.filter(relation))
 					else
-						relation.where(filter.filter(relation))
+						relation.merge(filter.filter(relation))
 					end
 				end
 			end

data/lib/filter_me/version.rb

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

data/spec/acceptance/filters/users_filter_spec.rb

@@ -48,4 +48,20 @@ describe UsersFilter do
 			expect(user.account.cost).to be < 100000
 		end
 	end
+
+	it "can do a deeply nested filter" do
+		mock_controller.params = {:filters => {
+			:businesses => {
+				:jobs => {:name => {:matches => "find%"}}
+			}
+		}}
+
+		mock_controller.index.each do |user|
+			user.businesses.each do |business|
+				business.jobs.each do |job|
+					expect(job.name).to start_with "find"
+				end
+			end
+		end
+	end
 end

data/spec/internal/app/filters/companies_filter.rb

@@ -0,0 +1,5 @@
+class CompaniesFilter < FilterMe::ActiveRecordFilter
+	model Company
+
+	association :jobs, :filter_class => JobsFilter
+end

data/spec/internal/app/filters/jobs_filter.rb

@@ -0,0 +1,5 @@
+class JobsFilter < FilterMe::ActiveRecordFilter
+	model Job
+
+	field :name, [:matches]
+end

data/spec/internal/app/filters/users_filter.rb

@@ -2,6 +2,7 @@ class UsersFilter < FilterMe::ActiveRecordFilter
 	model User
 
 	association :account, :filter_class => AccountsFilter
+	association :businesses, :filter_class => CompaniesFilter
 	field :email, :all
 	field :username, :matches
 end

data/spec/internal/app/models/company.rb

@@ -0,0 +1,4 @@
+class Company < ActiveRecord::Base
+	belongs_to :owner, :class_name => User
+	has_many :jobs, :inverse_of => :company
+end

data/spec/internal/app/models/job.rb

@@ -0,0 +1,3 @@
+class Job < ActiveRecord::Base
+	belongs_to :company, :inverse_of => :jobs
+end

data/spec/internal/app/models/user.rb

@@ -1,3 +1,5 @@
 class User < ActiveRecord::Base
 	has_one :account
+	has_many :businesses, :class_name => Company, :foreign_key => :owner_id, :inverse_of => :owner
+	has_many :jobs, :through => :businesses
 end

data/spec/internal/db/fixtures/jobs.rb

@@ -0,0 +1,6 @@
+module Fixtures
+	module Accounts
+		def load_jobs
+		end
+	end
+end

data/spec/internal/db/fixtures/users.rb

@@ -8,19 +8,27 @@ module Fixtures
 				user.create_account!(:cost => 100000)
 			end
 
-			User.create! do |user|
+			user = User.create! do |user|
 				user.username = "test2"
 				user.email = "test2@test.com"
 
 				user.create_account!(:cost => 50000)
 			end
+			business = user.businesses.create! do |business|
+				business.name = "Test"
+			end
+			business.jobs.create!(:name => "find_me")
 
-			User.create! do |user|
+			user = User.create! do |user|
 				user.username = "test3"
 				user.email = "test3@spaz.com"
 
 				user.create_account!(:cost => 10000)
 			end
+			business = user.businesses.create! do |business|
+				business.name = "Test2"
+			end
+			business.jobs.create!(:name => "dont_find_me")
 		end
 	end
 end

data/spec/internal/db/schema.rb

@@ -10,4 +10,16 @@ ActiveRecord::Schema.define do
 		t.integer :cost
 		t.timestamps
 	end
+
+	create_table :companies, :force => true do |t|
+		t.integer :owner_id
+		t.string :name
+		t.timestamps
+	end
+
+	create_table :jobs, :force => true do |t|
+		t.integer :company_id
+		t.string :name
+		t.timestamps
+	end
 end

data/spec/unit/arel_field_filter_spec.rb

@@ -70,7 +70,12 @@ describe FilterMe::Filter::ArelFieldFilter do
 			relation_mock = double("relation")
 
 			arel_filter = arel_table[field].lt(10)
-			expect(field_filter.filter(relation_mock)).to eq(arel_filter)
+
+			expect(model_class).to receive(:where) do |arel_combine_filter|
+				expect(arel_combine_filter).to eq(arel_filter)
+			end
+
+			field_filter.filter(relation_mock)
 		end
 
 		it "builds the correct arel filter with one filter type of two filter values" do
@@ -78,7 +83,11 @@ describe FilterMe::Filter::ArelFieldFilter do
 			relation_mock = double("relation")
 
 			arel_filter = arel_table[field].matches("%hey%").and(arel_table[field].matches("%hi%"))
-			expect(field_filter.filter(relation_mock)).to eq(arel_filter)
+			expect(model_class).to receive(:where) do |arel_combine_filter|
+				expect(arel_combine_filter).to eq(arel_filter)
+			end
+
+			field_filter.filter(relation_mock)
 		end
 
 		it "builds the correct arel filter with two filter types of one filter value each" do
@@ -86,7 +95,11 @@ describe FilterMe::Filter::ArelFieldFilter do
 			relation_mock = double("relation")
 
 			arel_filter = arel_table[field].lt(10).and(arel_table[field].gt(1))
-			expect(field_filter.filter(relation_mock)).to eq(arel_filter)
+			expect(model_class).to receive(:where) do |arel_combine_filter|
+				expect(arel_combine_filter).to eq(arel_filter)
+			end
+
+			field_filter.filter(relation_mock)
 		end
 
 		it "builds the correct arel filter with two filter types of two filter value each" do
@@ -97,7 +110,11 @@ describe FilterMe::Filter::ArelFieldFilter do
 			                               .and(arel_table[field].lt("z")
 			                               .and(arel_table[field].matches("%hey%")
 			                               .and(arel_table[field].matches("%hi%"))))
-			expect(field_filter.filter(relation_mock)).to eq(arel_filter)
+			expect(model_class).to receive(:where) do |arel_combine_filter|
+				expect(arel_combine_filter).to eq(arel_filter)
+			end
+
+			field_filter.filter(relation_mock)
 		end
 	end
 end

data/spec/unit/filter_arel_dsl_spec.rb

@@ -18,7 +18,7 @@ describe FilterMe::Filter::ArelDSL do
 		it "initializes a ArelFieldFilter instance with the values to filter and the filter field configuration" do
 			filters = [:test1, :test2]
 			relation_mock = double("relation")
-			expect(relation_mock).to receive(:where) { |relation| relation }
+			allow(relation_mock).to receive(:merge)
 			
 			model_mock = double("model")
 
@@ -26,8 +26,8 @@ describe FilterMe::Filter::ArelDSL do
 				obj.whitelisted_filters == self.whitelisted_filters
 			end
 
-			field_filter_instance = double("field filter instance")
-			allow(field_filter_instance).to receive(:filter).once
+			field_filter_instance_mock = double("field filter instance")
+			allow(field_filter_instance_mock).to receive(:filter)
 
 			field_filter_class = double("field filter class")
 			allow(field_filter_class).to receive(:new) do |filters, configuration|
@@ -38,7 +38,7 @@ describe FilterMe::Filter::ArelDSL do
 					:model_class => model_mock
 				})
 
-				field_filter_instance
+				field_filter_instance_mock
 			end
 
 			stub_const("FilterMe::Filter::ArelFieldFilter", field_filter_class)
@@ -59,12 +59,12 @@ describe FilterMe::Filter::ArelDSL do
 
 		it "calls filter on the initialized ArelFieldFilter instance with the relation" do
 			relation_mock = double("relation")
-			expect(relation_mock).to receive(:where) { |relation| relation }
+			allow(relation_mock).to receive(:merge)
 
 			model_mock = double("model")
 
 			field_filter_instance = double("field filter instance")
-			expect(field_filter_instance).to receive(:filter) { |relation| relation }
+			expect(field_filter_instance).to receive(:filter).once
 
 			field_filter_class = double("field filter class")
 			allow(field_filter_class).to receive(:new) { |filters, configuration| field_filter_instance }
@@ -83,7 +83,7 @@ describe FilterMe::Filter::ArelDSL do
 
 			filter_instance = filter_class.new
 
-			expect(filter_instance.test(relation_mock, [:test1, :test2])).to eq(relation_mock)
+			filter_instance.test(relation_mock, [:test1, :test2])
 		end
 	end
 
@@ -107,7 +107,7 @@ describe FilterMe::Filter::ArelDSL do
 			filters = [:test1, :test2]
 			relation_mock = double("relation")
 			allow(relation_mock).to receive(:joins) { relation_mock }
-			allow(relation_mock).to receive(:where) { relation_mock }
+			allow(relation_mock).to receive(:merge)
 
 			model = double("model")
 			allow(model).to receive(:name) { "Model" }
@@ -116,8 +116,6 @@ describe FilterMe::Filter::ArelDSL do
 			allow(mock_association_filter).to receive(:filter) { relation_mock }
 
 			mock_association_filter_class = double("assocation filter class")
-			mock_association_filter_class.stub(:new).and_return(mock_association_filter)
-
 			expect(mock_association_filter_class).to receive(:new) do |filters, configuration| 
 				expect(filters).to eq(filters)
 				expect(configuration).to eq({})
@@ -149,7 +147,7 @@ describe FilterMe::Filter::ArelDSL do
 			filters = [:test1, :test2]
 			relation_mock = double("relation")
 			allow(relation_mock).to receive(:joins) { relation_mock }
-			allow(relation_mock).to receive(:where) { relation_mock }
+			allow(relation_mock).to receive(:merge)
 
 			model = double("model")
 			allow(model).to receive(:name) { "Model" }

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: filter_me
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.1.1
 platform: ruby
 authors:
 - Sam Clopton
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-02-16 00:00:00.000000000 Z
+date: 2014-02-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -106,11 +106,16 @@ files:
 - spec/acceptance/filters/accounts_filter_spec.rb
 - spec/acceptance/filters/users_filter_spec.rb
 - spec/internal/app/filters/accounts_filter.rb
+- spec/internal/app/filters/companies_filter.rb
+- spec/internal/app/filters/jobs_filter.rb
 - spec/internal/app/filters/users_filter.rb
 - spec/internal/app/models/account.rb
+- spec/internal/app/models/company.rb
+- spec/internal/app/models/job.rb
 - spec/internal/app/models/user.rb
 - spec/internal/config/database.yml
 - spec/internal/db/fixtures/accounts.rb
+- spec/internal/db/fixtures/jobs.rb
 - spec/internal/db/fixtures/users.rb
 - spec/internal/db/schema.rb
 - spec/internal/log/.gitignore