filterism 1.0.0

data/.autotest

@@ -0,0 +1 @@
+require 'autotest/bundler'

data/.gitignore

@@ -0,0 +1,41 @@
+!.gitignore
+*.gem
+*.rbc
+*.sw[a-p]
+*.tmproj
+*.tmproject
+*.un~
+*~
+.DS_Store
+.Spotlight-V100
+.Trashes
+._*
+.bundle
+.config
+.directory
+.elc
+.redcar
+.yardoc
+/.emacs.desktop
+/.emacs.desktop.lock
+Desktop.ini
+Gemfile.lock
+Icon?
+InstalledFiles
+Session.vim
+Thumbs.db
+\#*\#
+_yardoc
+auto-save-list
+coverage
+doc/
+lib/bundler/man
+pkg
+pkg/*
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+tmtags
+tramp

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--format=nested
+--backtrace

data/.yardopts

@@ -0,0 +1,3 @@
+--markup markdown
+-
+LICENSE.md

data/Gemfile

@@ -0,0 +1,4 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in gem_template.gemspec
+gemspec

data/LICENSE.md

@@ -0,0 +1,10 @@
+Copyright (c) 2011, Code for America
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:
+
+* Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
+* Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
+* Neither the name of Code for America nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,74 @@
+# Filterism
+
+A DSL for filtering active record results based on hash keys with the
+term _is_ in them.
+
+## Installation
+
+### Bundler
+gem 'filterism'
+
+### Other
+gem install filterism
+
+## Usage
+Filterism was developed to fill the need of being able to filter Active Record results by aguments passed in the URL, however, it basically takes in a hash.  Usually that hash would be "params" passed from the controller.  The syntax of the keys in the hash control how the data is filtered.
+
+It also adds a ".filterable_fields" method for you to limit by which fields
+the records may be filtered.
+
+## Example
+### URL
+    http://whatever.com/whatever/?name_is_in=Dave,Jamis,David&salary_is_greater_than=10000
+
+So as you see above, the syntax is [field]\_is\_[comparator]=value.
+
+In the first argument, name is the [field] and [in] is the comparator.
+
+In the second argument, salary is the [field] and [greater_than] is the comparator.
+
+### Model
+In the model you can limit which fields are filterable.  This is optional.  If this isn't in your model, all fields are filterable.
+
+``` ruby
+class User < ActiveRecord::Base
+  filterable_fields :name, :salary
+end
+```
+
+### Controller
+This gem adds the ".filter" class method to any active record class.  You can pass in any hash, it doesn't have to operate from params.  It will only look at keys that have the "\_is\_" syntax.
+
+``` ruby
+users = User.filter(params).all
+```
+
+## Comparators
+The current list of comparators are as follows. (taken right from the code)
+
+``` ruby
+COMPARATORS = {
+    'equal_to' => '=',
+    'not_equal_to' => '!=',
+
+    'greater_than' => '>',
+    'gt' => '>',
+    'after' => '>',
+    'greater_than_or_equal_to' => '>=',
+    'gtet' => '>=',
+
+    'less_than' => '<',
+    'lt' => '<',
+    'before' => '<',
+    'less_than_or_equal_to' => '<=',
+    'ltet' => '<=',
+
+    'like' => 'LIKE',
+
+    'in' => 'IN'
+  }
+```
+
+You can see that you can do things like [field]_is_gt=4000 or [field]_is_in=4,66,19
+
+Please see https://github.com/philspitler/filterism/blob/master/spec/filterism_spec.rb for more examples of using ".filter"

data/Rakefile

@@ -0,0 +1,18 @@
+#!/usr/bin/env rake
+
+require 'bundler'
+Bundler::GemHelper.install_tasks
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+task :test => :spec
+
+require 'yard'
+namespace :doc do
+  YARD::Rake::YardocTask.new do |task|
+    task.files   = ['LICENSE.md', 'lib/**/*.rb']
+    task.options = ['--markup', 'markdown']
+  end
+end

data/filterism.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/filterism/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.name        = 'filterism'
+  gem.version     = Filterism::VERSION
+  gem.author      = "Phil Spitler"
+  gem.email       = 'pspitler@gmail.com'
+  gem.homepage    = 'https://github.com/philspitler/filterism'
+  gem.summary     = 'A DSL for filtering active record results based on hash keys with the term _is_ in them.'
+  gem.description = ''
+
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{|f| File.basename(f)}
+  gem.require_paths = ['lib']
+
+  gem.add_development_dependency 'maruku', '~> 0.6'
+  gem.add_development_dependency 'rake', '~> 0.9'
+  gem.add_development_dependency 'rspec', '~> 2.6'
+  gem.add_development_dependency 'simplecov', '~> 0.4'
+  gem.add_development_dependency 'yard', '~> 0.7'
+  gem.add_development_dependency 'sqlite3'
+
+  gem.add_dependency 'activerecord', '>= 3.0.1'
+end

data/lib/filterism.rb

@@ -0,0 +1,79 @@
+require 'active_record'
+
+module Filterism
+  attr_accessor :filterable_fields
+
+  COMPARATORS = {
+    'equal_to' => '=',
+    'not_equal_to' => '!=',
+
+    'greater_than' => '>',
+    'gt' => '>',
+    'after' => '>',
+    'greater_than_or_equal_to' => '>=',
+    'gtet' => '>=',
+
+    'less_than' => '<',
+    'lt' => '<',
+    'before' => '<',
+    'less_than_or_equal_to' => '<=',
+    'ltet' => '<=',
+
+    'like' => 'LIKE',
+
+    'in' => 'IN'
+  }
+  
+  def filter(params)
+
+    #remove non filter params
+    params.delete_if { |key, value| key.to_s.index('_is_').nil? }
+
+    where_clause = ""
+    values = []
+
+    params.each do |key, value|
+      keysplit = key.to_s.split('_is_')
+      unless @filterable_fields and not @filterable_fields.include?(keysplit[0].to_sym)
+
+        if COMPARATORS.keys.include?(keysplit[1])
+          column = keysplit[0]
+          comparator = COMPARATORS[keysplit[1]]
+
+          where_mark = '?'
+
+          if comparator == 'LIKE'
+            values << "%#{value}%"
+          elsif comparator == 'IN'
+            where_mark = '(?)'
+            values << value.split(',')
+          else
+            values << convert_if_string_is_boolean(value)
+          end
+
+          where_clause << " AND" unless where_clause.empty?
+
+          where_clause << " #{column} #{comparator} #{where_mark}"
+        end
+      end
+
+    end
+
+    where(where_clause, *values)
+  end
+
+  def filterable_fields(*fields)
+    @filterable_fields = fields
+  end
+  
+  private
+  def convert_if_string_is_boolean(value)
+    if value == "true" || value == "false"
+      value = "true" ? true : false
+    end
+    return value
+  end
+
+end
+
+ActiveRecord::Base.extend Filterism

data/lib/filterism/version.rb

@@ -0,0 +1,3 @@
+module Filterism
+  VERSION = "1.0.0"
+end

data/spec/filterism_spec.rb

@@ -0,0 +1,91 @@
+require 'helper'
+require 'finders/activerecord_test_connector'
+ActiverecordTestConnector.setup
+
+describe Filterism do
+  extend ActiverecordTestConnector::FixtureSetup
+  fixtures :users
+  fixtures :posts
+
+  it "defines the COMPARATORS constant" do
+    Filterism::COMPARATORS.should be
+    Filterism::COMPARATORS.should be_a Hash
+  end
+
+  it "fitlers on equal_to" do
+    User.filter({'name_is_equal_to' => 'David'}).first.id.should == 1
+    User.filter({'name_is_equal_to' => 'Dave'}).first.id.should == 2
+  end
+
+  it "filters on not_equal_to" do
+    User.filter({'name_is_not_equal_to' => 'David'}).all.count.should == 4
+  end
+
+  it "filters on greater_than" do
+    User.filter({'salary_is_greater_than' => '80000'}).all.count.should == 1
+  end
+
+  it "filters on gt" do
+    User.filter({'salary_is_gt' => '70000'}).all.count.should == 2
+  end
+
+  it "filters on after" do
+    User.filter({'salary_is_after' => '9000'}).all.count.should == 4
+  end
+
+  it "filters on greater_than_or_equal_to" do
+    User.filter({'salary_is_greater_than_or_equal_to' => '80000'}).all.count.should == 2
+  end
+
+  it "filters on gtet" do
+    User.filter({'salary_is_gtet' => '80000'}).all.count.should == 2
+  end
+
+  it "filters on less_than" do
+    User.filter({'salary_is_less_than' => '80000'}).all.count.should == 3
+  end
+
+  it "filters on lt" do
+    User.filter({'salary_is_lt' => '70000'}).all.count.should == 3
+  end
+
+  it "filters on before" do
+    User.filter({'salary_is_before' => '10000'}).all.count.should == 1
+  end
+
+  it "filters on less_than_or_equal_to" do
+    User.filter({'salary_is_less_than_or_equal_to' => '80000'}).all.count.should == 4
+  end
+
+  it "filters on ltet" do
+    User.filter({'salary_is_ltet' => '80000'}).all.count.should == 4
+  end
+
+  it "filters on like" do
+    User.filter({'name_is_like' => 'Dav'}).all.count.should == 2
+  end
+
+  it "filters on in" do
+    User.filter({'id_is_in' => '1,2,3'}).all.count.should == 3
+    User.filter({'name_is_in' => 'Dave,Jamis'}).all.count.should == 2
+  end
+
+  it "fitlers on multiple expressions" do
+    User.filter({'name_is_in' => 'Dave,Jamis,David', 'salary_is_gt' => '10000'}).all.count.should == 2
+  end
+
+  it "handles booleans properly" do
+    User.filter({'bonus_is_equal_to' => 'true'}).all.count.should == 3
+
+  end
+
+  it "doesn't filter if passed invalid expression" do
+    User.filter({'name_is_garbage' => 'David'}).all.count.should == User.all.count
+  end
+
+  it "uses filterable fields" do
+    Post.filter({'title_is_equal_to' => 'Post 1 title'}).all.count.should == 1
+    Post.filter({'body_is_equal_to' => 'Post 1 body'}).all.count.should == 3
+  end
+
+end

data/spec/finders/activerecord_test_connector.rb

@@ -0,0 +1,104 @@
+require 'active_record'
+require 'active_record/version'
+require 'active_record/fixtures'
+require 'active_support/multibyte' # needed for Ruby 1.9.1
+
+$query_count = $query_sql = nil
+
+module ActiverecordTestConnector
+  extend self
+  
+  attr_accessor :able_to_connect
+  attr_accessor :connected
+
+  FIXTURES_PATH = File.expand_path('../../fixtures', __FILE__)
+
+  # Set our defaults
+  self.connected = false
+  self.able_to_connect = true
+
+  def setup
+    unless self.connected || !self.able_to_connect
+      setup_connection
+      load_schema
+      add_load_path FIXTURES_PATH
+      self.connected = true
+    end
+  rescue Exception => e  # errors from ActiveRecord setup
+    $stderr.puts "\nSkipping ActiveRecord tests: #{e}\n\n"
+    self.able_to_connect = false
+  end
+
+  private
+  
+  def add_load_path(path)
+    dep = defined?(ActiveSupport::Dependencies) ? ActiveSupport::Dependencies : ::Dependencies
+    dep.autoload_paths.unshift path
+  end
+
+  def setup_connection
+    ActiveRecord::Base.establish_connection(
+      :adapter => "sqlite3",
+      :database => ":memory:"
+    )
+    prepare ActiveRecord::Base.connection
+  end
+
+  def load_schema
+    ActiveRecord::Base.silence do
+      ActiveRecord::Migration.verbose = false
+      load File.join(FIXTURES_PATH, 'schema.rb')
+    end
+  end
+
+  def prepare(conn)
+    class << conn
+      IGNORED_SQL = /^(?:PRAGMA|SELECT (?:currval|CAST|@@IDENTITY|@@ROWCOUNT)|SHOW FIELDS)\b/
+
+      def execute_with_counting(sql, name = nil, &block)
+        if $query_count and IGNORED_SQL !~ sql
+          $query_count += 1
+          $query_sql << sql
+        end
+        execute_without_counting(sql, name, &block)
+      end
+
+      alias_method_chain :execute, :counting
+    end
+  end
+  
+  module FixtureSetup
+    def fixtures(*tables)
+      table_names = tables.map { |t| t.to_s }
+
+      fixtures = Fixtures.create_fixtures ActiverecordTestConnector::FIXTURES_PATH, table_names
+      @@loaded_fixtures = {}
+      @@fixture_cache = {}
+
+      unless fixtures.nil?
+        if fixtures.instance_of?(Fixtures)
+          @@loaded_fixtures[fixtures.table_name] = fixtures
+        else
+          fixtures.each { |f| @@loaded_fixtures[f.table_name] = f }
+        end
+      end
+
+      table_names.each do |table_name|
+        define_method(table_name) do |*fixtures|
+          @@fixture_cache[table_name] ||= {}
+
+          instances = fixtures.map do |fixture|
+            if @@loaded_fixtures[table_name][fixture.to_s]
+              @@fixture_cache[table_name][fixture] ||= @@loaded_fixtures[table_name][fixture.to_s].find
+            else
+              raise StandardError, "No fixture with name '#{fixture}' found for table '#{table_name}'"
+            end
+          end
+
+          instances.size == 1 ? instances.first : instances
+        end
+      end
+    end
+  end
+end
+

data/spec/fixtures/post.rb

@@ -0,0 +1,3 @@
+class Post < ActiveRecord::Base
+  filterable_fields :title, :published_at
+end

data/spec/fixtures/posts.yml

@@ -0,0 +1,16 @@
+post1:
+  id: 1
+  title: "Post 1 title"
+  body: "Post 1 body"
+
+post2:
+  id: 2
+  title: "Post 2 title"
+  body: "Post 2 body"
+
+post3:
+  id: 3
+  title: "Post 3 title"
+  body: "Post 3 body"
+
+

data/spec/fixtures/schema.rb

@@ -0,0 +1,17 @@
+ActiveRecord::Schema.define do
+  create_table "users", :force => true do |t|
+    t.column "name", :text
+    t.column "salary", :integer, :default => 70000
+    t.column "bonus", :boolean, :default => false
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+  end
+  
+  create_table "posts", :force => true do |t|
+    t.column "title", :string
+    t.column "body", :text
+    t.column "published_at", :datetime
+    t.column "created_at", :datetime
+    t.column "updated_at", :datetime
+  end
+end

data/spec/fixtures/user.rb

@@ -0,0 +1,2 @@
+class User < ActiveRecord::Base
+end

data/spec/fixtures/users.yml

@@ -0,0 +1,30 @@
+david:
+  id: 1
+  name: David
+  salary: 80000
+  bonus: true
+
+dave:
+  id: 2
+  name: Dave
+  salary: 150000
+  bonus: true
+
+poor_jamis:
+  id: 3
+  name: Jamis
+  salary: 9000
+  bonus: true
+
+admin:
+  id: 12
+  name: admin
+  salary: 10000
+  bonus: false
+
+goofy:
+  id: 13
+  name: Goofy
+  salary: 11000
+  bonus: false
+

data/spec/helper.rb

@@ -0,0 +1,6 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+require 'simplecov'
+SimpleCov.start
+require 'filterism'
+require 'rspec'

metadata

@@ -0,0 +1,187 @@
+--- !ruby/object:Gem::Specification 
+name: filterism
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- Phil Spitler
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-09 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: maruku
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 6
+        version: "0.6"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rake
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        - 6
+        version: "2.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: simplecov
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 4
+        version: "0.4"
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: yard
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 7
+        version: "0.7"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: sqlite3
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 3
+        - 0
+        - 1
+        version: 3.0.1
+  type: :runtime
+  version_requirements: *id007
+description: ""
+email: pspitler@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .autotest
+- .gemtest
+- .gitignore
+- .rspec
+- .yardopts
+- Gemfile
+- LICENSE.md
+- README.md
+- Rakefile
+- filterism.gemspec
+- lib/filterism.rb
+- lib/filterism/version.rb
+- spec/filterism_spec.rb
+- spec/finders/activerecord_test_connector.rb
+- spec/fixtures/post.rb
+- spec/fixtures/posts.yml
+- spec/fixtures/schema.rb
+- spec/fixtures/user.rb
+- spec/fixtures/users.yml
+- spec/helper.rb
+has_rdoc: true
+homepage: https://github.com/philspitler/filterism
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: A DSL for filtering active record results based on hash keys with the term _is_ in them.
+test_files: 
+- spec/filterism_spec.rb
+- spec/finders/activerecord_test_connector.rb
+- spec/fixtures/post.rb
+- spec/fixtures/posts.yml
+- spec/fixtures/schema.rb
+- spec/fixtures/user.rb
+- spec/fixtures/users.yml
+- spec/helper.rb