smart_filter 0.1.1

data/Manifest

@@ -0,0 +1,6 @@
+Manifest
+README.rdoc
+Rakefile
+init.rb
+lib/smart_filter.rb
+smart_filter.gemspec

data/README.rdoc

@@ -0,0 +1,63 @@
+= SmartFilter
+
+Rails gem to extend ActiveRecord with a smart_filter method.
+
+
+== Installation
+
+[As a gem (using Bundler)] gem "smart_filter", "~> 0.1.0" # hosted on rubygems.com
+[As a plugin] script/plugin install git://github.com/vvohra87/smart_filter.git
+
+
+== Why smart_filter?
+
+In most applications, I need the following types of search / filter options:
+1. %LIKE% matches for any text or string field such as "name", "description", "email", "address", etc
+2. Exact matches for any integer, date or datetime field such as "quantity", "id", "created_at", "start", "age", etc
+3. Range matches for any integer, decimal, float, date or datetime such as "price", "age", "created_at", etc
+
+SmartFilter simply provides a simple way to do just that.
+
+This is not meant to replace gems like meta-where / arel-table based query builders / search engines, just make life easier by having to write less code! (and apparently more documentation!)
+
+
+== How it works
+
+Once you have included the gem in your app, you now have a +smart_filter+ method for all your models.
+
+The method takes in a hash whose keys are dependent on the model definition.
+
+For numeric and datetime based columns it will accept 3 different inputs:
+1. column => value 	  # will return exact match for value
+2. column_min => value # will return all records where attribute has value greater than or equal to specified value
+3. column_max => value # will return all records where attribute has value less than or equal to specified value
+
+For string and text based columns it will accept only the column name.
+
+
+== Example
+
+Let's say that you have a Product model with the following attributes:
+
+    title: string
+    description: text
+    price: float
+    current_stock: integer
+    created_at: datetime
+
+
+So, on this the full set of options you would have is:
+
+    Product.smart_filter(
+        :title => "abc"	# where the title contains 'abc'
+    	:description => "cba" # where the description contains 'cba'
+    	:price => 5.0	# where the price is exactly 5.0
+    	:price_min => 10.0	# where the price is greater than or equal to 10.0
+    	:price_max => 20.0	# where the price is less than or equal to 20.0
+    	:current_stock => 55	# where the current stock is exactly 55
+    	:current_stock_min => 20	# .....etc.....
+    	:current_stock_max => 100	# .....etc.....
+    	:created_at => Time.now		
+    	:created_at_min => Time.now - 1.week
+    	:created_at_max => Time.now - 2.days
+    )

data/Rakefile

@@ -0,0 +1,14 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('smart_filter', '0.1.1') do |p|
+  p.description     = "Extend Active Record to provide a smart filter function."
+  p.url             = "http://github.com/vvohra87/smart_filter"
+  p.author          = "Varun Vohra"
+  p.email           = "varun@genii.in"
+  p.ignore_pattern  = ["tmp/*", "script/*"]
+  p.development_dependencies = []
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/init.rb

@@ -0,0 +1 @@
+require 'smart_filter'

data/lib/smart_filter.rb

@@ -0,0 +1,46 @@
+module SmartFilter
+  def self.included(base)
+    base.extend ClassMethods
+  end
+
+  module ClassMethods
+
+    def smart_filter(args = {})
+      numerics = []
+      strings = []
+      self.columns.each do |column|
+        case column.type
+        when :integer, :decimal, :float, :date, :datetime
+          numerics.push(column.name.to_sym)
+          numerics.push((column.name.to_s + "_min").to_sym)
+          numerics.push((column.name.to_s + "_max").to_sym)
+        when :string, :text
+          strings.push(column.name.to_sym)
+        end
+      end
+
+      results = self.select("*")
+
+      args.each do |key, value|
+        if numerics.include?(key)
+          if key.ends_with("_min")
+            results = results.where("#{key} >= #{value}")
+          elsif key.ends_with("_max")
+            results = results.where("#{key} <= #{value}")
+          else
+            results = results.where("#{key} = #{value}")
+          end
+        end
+        if strings.include?(key)
+          results = results.where("#{key} like '%#{value}%'")
+        end
+      end
+      results
+    end
+
+  end
+end
+
+class ActiveRecord::Base
+  include SmartFilter
+end

data/smart_filter.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = "smart_filter"
+  s.version = "0.1.1"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Varun Vohra"]
+  s.date = "2012-01-31"
+  s.description = "Extend Active Record to provide a smart filter function."
+  s.email = "varun@genii.in"
+  s.extra_rdoc_files = ["README.rdoc", "lib/smart_filter.rb"]
+  s.files = ["Manifest", "README.rdoc", "Rakefile", "init.rb", "lib/smart_filter.rb", "smart_filter.gemspec"]
+  s.homepage = "http://github.com/vvohra87/smart_filter"
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Smart_filter", "--main", "README.rdoc"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = "smart_filter"
+  s.rubygems_version = "1.8.13"
+  s.summary = "Extend Active Record to provide a smart filter function."
+
+  if s.respond_to? :specification_version then
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

metadata

@@ -0,0 +1,77 @@
+--- !ruby/object:Gem::Specification 
+name: smart_filter
+version: !ruby/object:Gem::Version 
+  hash: 25
+  prerelease: 
+  segments: 
+  - 0
+  - 1
+  - 1
+  version: 0.1.1
+platform: ruby
+authors: 
+- Varun Vohra
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-31 00:00:00 Z
+dependencies: []
+
+description: Extend Active Record to provide a smart filter function.
+email: varun@genii.in
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+- lib/smart_filter.rb
+files: 
+- Manifest
+- README.rdoc
+- Rakefile
+- init.rb
+- lib/smart_filter.rb
+- smart_filter.gemspec
+homepage: http://github.com/vvohra87/smart_filter
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Smart_filter
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: smart_filter
+rubygems_version: 1.8.13
+signing_key: 
+specification_version: 3
+summary: Extend Active Record to provide a smart filter function.
+test_files: []
+