filterism 1.0.0 → 2.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5702e936b3509a35a0988602855c6ec4a8e0e758
+  data.tar.gz: 91adb5ae786eee091d36df6938391660b7b68d36
+SHA512:
+  metadata.gz: 9205254ef687c7a6dfbd695ff9833b5feef1b8efaf7554ad16e03f3d4b67b4b6dfcdd71e86ffd9c2cbda08634fce39fb4492d1c345bbafa58b3610d42137c67e
+  data.tar.gz: 32035e5f2ac954fc310c82ca6f2a68a5a44de173f00d52c325f8331e112d3a827aed00151317ec5e97c019e997a07113fdec3f694ddf3aab0fb2ead7298d6b3b

data/.gitignore

@@ -1,41 +1,22 @@
-!.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
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.irbrc

@@ -0,0 +1,2 @@
+require 'bond'
+Bond.start

data/.rspec

@@ -1,3 +1,2 @@
 --color
---format=nested
---backtrace
+--format progress

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Phil Spitler
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,7 +1,6 @@
 # Filterism
 
-A DSL for filtering active record results based on hash keys with the
-term _is_ in them.
+A DSL for filtering items (usually in some form of record store).
 
 ## Installation
 
@@ -12,6 +11,25 @@ gem 'filterism'
 gem install filterism
 
 ## Usage
+All examples use the ActiveRecordAdapter which is included with the gem.  Other adapters may be created to meet your needs.  These adapters generate the syntax to speak to whatever record store you need.
+
+### Globally
+Adds .filter, .filterable_fields and .unfilterable_fields methods to all of you models
+Somewhere in your apps bootstrap/startup code:
+
+``` ruby
+ActiveRecord::Base.include(Filterism)
+```
+
+### Locally (in a model)
+Adds .filter, .filterable_fields and .unfilterable_fields methods to only the User model
+
+``` ruby
+class User < ActiveRecord::Base
+	include Filterism
+end
+```
+
 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
@@ -28,13 +46,24 @@ 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
+#### Filterable Fields
 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
+  filterable_fields :name
+end
+```
+
+#### Unfilterable Fields
+
+``` ruby
+class User < ActiveRecord::Base
+  unfilterable_fields :salary
 end
 ```
+The examples above are equivalent.  If you have a long list of fields, you can use either a whitelist or blacklist depending on your needs
+
 
 ### 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.
@@ -71,4 +100,12 @@ COMPARATORS = {
 
 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"
+Please see https://github.com/philspitler/filterism/blob/master/spec/filterism_spec.rb for more examples of using ".filter"
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/filterism/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -1,18 +1,2 @@
-#!/usr/bin/env rake
+require "bundler/gem_tasks"
 
-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/exec/autospec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'autospec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'autospec')

data/exec/htmldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'htmldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'htmldiff')

data/exec/ldiff

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'ldiff' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('diff-lcs', 'ldiff')

data/exec/rake

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rake' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rake', 'rake')

data/exec/rspec

@@ -0,0 +1,16 @@
+#!/usr/bin/env ruby
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require 'pathname'
+ENV['BUNDLE_GEMFILE'] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require 'rubygems'
+require 'bundler/setup'
+
+load Gem.bin_path('rspec-core', 'rspec')

data/filterism.gemspec

@@ -1,26 +1,29 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path('../lib/filterism/version', __FILE__)
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'filterism/version'
 
-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::Specification.new do |spec|
+  spec.name          = "filterism"
+  spec.version       = Filterism::VERSION
+  spec.authors       = ["Phil Spitler"]
+  spec.email         = ["pspitler@gmail.com"]
+  spec.summary       = "DSL for communicating filter intent via HTTP parameters in the URL"
+  spec.description   = ""
+  spec.homepage      = "http://sproutkey.com"
+  spec.license       = "MIT"
 
-  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']
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.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'
+  spec.add_development_dependency "bundler", "~> 1.6"
+  spec.add_development_dependency "rake"
+  spec.add_development_dependency "rspec"
+  spec.add_development_dependency "bond"
+  spec.add_development_dependency "simplecov"
+  spec.add_development_dependency "activerecord"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "factory_girl", "~> 4.0"
 end

data/lib/filterism.rb

@@ -1,79 +1,3 @@
-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
+require "filterism/version"
+require "filterism/parsers/params_parser"
+require "filterism/adapters/active_record_adapter"

data/lib/filterism/adapters/active_record_adapter.rb

@@ -0,0 +1,45 @@
+require 'active_record'
+
+module Filterism
+  extend ActiveSupport::Concern
+
+  module ClassMethods
+    def filterable_fields(*fields)
+      @filterable_fields = fields.to_s
+    end
+    def unfilterable_fields(*fields)
+      @unfilterable_fields = fields.to_s
+    end
+    def filter(conditions)
+      where_clause = ""
+      values = []
+      where_mark = '?'
+      conditions.each do |condition|
+        unless (@filterable_fields and not @filterable_fields.include?(condition[:key])) or (@unfilterable_fields and @unfilterable_fields.include?(condition[:key]))
+          if condition[:comparator] == 'LIKE'
+            values << "%#{condition[:value]}%"
+          elsif condition[:comparator] == 'IN'
+            where_mark = '(?)'
+            values << condition[:value].split(',')
+          else
+            values << convert_if_string_is_boolean(condition[:value])
+          end
+
+          where_clause << " AND" unless where_clause.empty?
+
+          where_clause << " #{condition[:key]} #{condition[:comparator]} #{where_mark}"
+        end
+      end
+
+      where(where_clause, *values)
+    end
+
+    private
+    def convert_if_string_is_boolean(value)
+      if value == "true" || value == "false"
+        value = (value == "true" ? "t" : "f")
+      end
+      return value
+    end
+  end
+end