scope_filter 0.9.1

data/LICENSE

@@ -0,0 +1,20 @@
+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

@@ -0,0 +1,88 @@
+# Scope-Filter
+
+scope_filter is a filter- and search-library for ActiveRecord models using scopes.
+
+You can define the filterable and sortable scopes and fields and filter records with the `scope_filter` method. 
+
+This lib is fully compatible with [kaminari](https://github.com/amatsuda/kaminari) or [will_paginate](https://github.com/mislav/will_paginate) as it uses ActiveRecord scopes only.
+
+## Install
+
+add the following line to your Gemfile
+
+`gem 'scope_filter'`
+
+or install it via rubygems
+
+`gem install scope_filter`
+
+## Usage
+
+Include `ScopeFilter::ActiveRecord` in your model and define the filterable and sortable fields with the `configure_scope_filter` method.
+
+You can configure the filter with the following methods:
+
+- `add_scope` and `add_scopes`: makes scopes of your model searchable (pass a boolean argument at the end to define if the scopes expect a parameter, defaults to false)
+- `eq`: equal comparator
+- `g`, `gt`: greater and greater than comparator
+- `l`, `lt`: less and less than comparator
+- `like`, `ilike`: like and ilike than comparator
+- `null`, `not_null`: is null and is not null than comparator
+- `sortable`: fields the resultset may be sorted by
+
+The first argument defines the name of the filter parameter. You can define arbitrary filter fields, i.e.:
+
+`config.like :firstname_ends_with, :field => 'firstname', :pattern => lambda { |v| "%#{v}" }`
+
+### Example
+
+```ruby
+class Person < ActiveRecord::Base
+  include ScopeFilter::ActiveRecord
+  
+  scope :dwarf,      where('age > ? AND height < ?', 16, 150)
+  scope :bastard,    where('lastname IN (?)', %w(Snow Sand Rivers))
+  scope :highborn,   where('lastname IN (?)', %w(Lannister Stark Targaryen Martell))
+  scope :older_than, lambda { |age| where('age > ?', age) }
+  scope :dead,       where('date_of_death IS NOT NULL')
+  scope :dragon,     where('lastname = ?', 'Targaryen')
+  
+  configure_scope_filter do |config|
+    config.add_scopes :dwarf, :bastard, :dead, :highborn
+    config.add_scope  :older_than, true
+    config.like       :firstname
+    config.eq         :knight
+    config.like       :firstname_ends_with, :field => 'firstname', :pattern => lambda { |v| "%#{v}" }
+    config.null       :alive, :field => 'date_of_death'
+    config.sortable   :lastname, :firstname
+  end
+
+end
+```
+
+use the `scope_filter` method to filter records, i.e.
+
+```ruby
+Person.scope_filter(:highborn => true, :knight => true, :_sort => 'lastname_desc')
+```
+
+which will return all highborn knights ordered descending by lastname.
+
+Or use the params hash:
+
+```ruby
+Person.scope_filter(params[:filter])
+```
+
+## Author
+
+[Lars Kuhnt](http://www.github.com/larskuhnt)
+Copyright (c) 2011
+
+## License
+
+Published under the MIT License.
+
+See [LICENSE](LICENSE) for details.
+
+

data/lib/scope_filter/active_record.rb

@@ -0,0 +1,41 @@
+# encoding: utf-8
+module ScopeFilter
+  module ActiveRecord
+    
+    def self.included(base)
+      base.extend(ClassMethods)
+    end
+
+    module ClassMethods
+    
+      def configure_scope_filter(&block)        
+        @@sf_config = Configuration.new
+        
+        yield @@sf_config
+        
+        def self.scope_filter(values = {})
+          init_scope = self.scoped
+          if sort = values.delete(:_sort)
+            sort_field, sort_dir = sort.to_s.split('_')
+            init_scope = self.order("#{sort_field} #{sort_dir.upcase}") if @@sf_config.sort_fields.include?(sort_field.to_sym)
+          end
+          values.inject(init_scope) do |rel, q|
+            field = q.first.to_sym
+            value = q.last
+            return rel if value.blank?
+            if cond = @@sf_config.fields[field]
+              rel = rel.where(cond[:condition], cond[:pattern] ? cond[:pattern].call(value) : value)
+            elsif cond = @@sf_config.scopes[field]
+              rel = cond[:arg] ? rel.send(field, value) : rel.send(field)
+            else
+              rel
+            end
+          end
+        end
+        
+      end
+      
+    end
+    
+  end
+end

data/lib/scope_filter/configuration.rb

@@ -0,0 +1,54 @@
+# encoding: utf-8
+
+module ScopeFilter
+  
+  class Configuration
+    
+    attr_reader :fields, :scopes, :sort_fields
+    
+    def initialize
+      @fields = {}
+      @scopes = {}
+      @sort_fields = []
+    end
+    
+    def add_field(field, cop, options = {})
+      pattern = options[:pattern]
+      @fields[field.to_sym] = { :condition => "#{options[:field] ? options[:field] : field} #{cop}#{pattern ? ' ?' : ''}", :pattern => pattern }
+    end
+    
+    def add_scope(name, arg = false)
+      @scopes[name.to_sym] = { :arg => arg }
+    end
+    
+    def add_scopes(*scopes)
+      arg = scopes.delete_at(scopes.size-1) if scopes.last.is_a?(TrueClass) || scopes.last.is_a?(FalseClass)
+      scopes.each { |s| add_scope(s, arg.nil? ? false : arg) }
+    end
+    
+    def method_missing(m, *args, &block)
+      field = args.first.to_sym
+      options = args.second || {}
+      idx = %w(eq g gt l lt neq like ilike).index(m.to_s)
+      if idx
+        comp = %w(= > >= < <= <> LIKE ILIKE)[idx]
+        add_field field, comp, add_default_pattern(comp, options)
+      end
+      add_field field, 'IS NULL', options if m == :null
+      add_field field, 'IS NOT NULL', options if m == :not_null
+    end
+    
+    def sortable(*fields)
+      @sort_fields += fields.map(&:to_sym)
+    end
+    
+    private 
+    
+    def add_default_pattern(comp, options)
+      return options if options[:pattern]
+      options.merge(:pattern => lambda { |v| comp =~ /LIKE/ ? "%#{v}%" : v })
+    end
+    
+  end
+  
+end

data/lib/scope_filter.rb

@@ -0,0 +1,9 @@
+# encoding: utf-8
+
+require 'active_record'
+require 'scope_filter/configuration'
+require 'scope_filter/active_record'
+
+module ScopeFilter
+  VERSION = '0.9.1'
+end

metadata

@@ -0,0 +1,108 @@
+--- !ruby/object:Gem::Specification
+name: scope_filter
+version: !ruby/object:Gem::Version
+  version: 0.9.1
+  prerelease: 
+platform: ruby
+authors:
+- Lars Kuhnt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-11 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activerecord
+  requirement: &70198313009400 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: *70198313009400
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70198313009020 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70198313009020
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: &70198313008560 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70198313008560
+- !ruby/object:Gem::Dependency
+  name: factory_girl
+  requirement: &70198313008140 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70198313008140
+- !ruby/object:Gem::Dependency
+  name: guard-rspec
+  requirement: &70198313007720 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70198313007720
+description: scope_filter is a filter- and search-library for ActiveRecord models
+  using scopes
+email:
+- lars.kuhnt@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/scope_filter/active_record.rb
+- lib/scope_filter/configuration.rb
+- lib/scope_filter.rb
+- LICENSE
+- README.md
+- CHANGELOG.md
+- ROADMAP.md
+homepage: http://github.com/larskuhnt/scope_filter
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.3.6
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: ActiveRecord filter- and search-library using scopes
+test_files: []