simple_filter 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/Gemfile

@@ -0,0 +1,6 @@
+source 'http://ruby.taobao.org'
+
+# Specify your gem's dependencies in simple_filter.gemspec
+gemspec
+
+gem 'rspec'

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 ryancheung
+
+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,101 @@
+# SimpleFilter
+
+Simple filter for replacing the awkward search method or scopes of models.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'simple_filter'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install simple_filter
+
+## Usage
+
+**SimpleFilter** was designed to replace the awkward search method or scopes in your models when
+doing filtering. It encapsulate all of the filter logic to filter class, which will make your
+model more cleaner. And it defaults to provider sort and pagination filter, relieving you from
+keep writing `sort` or `pagination` filter for each models.
+
+To start using **SimpleFilter** you just need to generate a filter class for your model:
+
+    rails generate simple_filter your_model_name
+
+Then in your `app/filters/` directory you'll find filter file like this:
+
+```ruby
+class UserFilter < SimpleFilter::Base
+  # Rewrite default filter options in case you need.
+  # config per_page: 20, order_by: :name
+
+  # There're default filters including :sort, :pagination. You can use them along with
+  # your custom filters like this:
+  #
+  filter :sort
+  #
+  # private
+  #
+  # def by_name
+  #   if params[:name].present?
+  #     @scope = scope.where(:name => params[:name])
+  #   end
+  # end
+end
+```
+
+Here you can customize your filters with the `filter` DSL. For example:
+
+```ruby
+class UserFilter < SimpleFilter::Base
+  filter :by_name, :sort, :pagination
+
+  private
+
+  def by_name
+    if params[:name].present?
+      @scope = scope.where(:name => params[:name])
+    end
+  end
+end
+```
+
+In case your filter class name was not consist with the ActiveModel name, you could
+use `scope` DSL to config this manually:
+
+```ruby
+class PersonFilter < SimpleFilter::Base
+  scope :user
+
+  filter :sort
+
+  # other filters
+end
+```
+
+In your controller you can use it like this:
+
+```ruby
+class Admin::UsersController < Admin::BaseController
+  def index
+    @users = UserFilter.all(params)
+  end
+
+  # other actions...
+end
+```
+
+As you see it, it's very simple, enjoy it!
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new('spec')
+
+# If you want to make this the default task
+task :default => :spec

data/lib/generators/simple_filter/USAGE

@@ -0,0 +1,3 @@
+To generate a filter for your model, just do:
+
+    rails generate simple_filter your_model_name

data/lib/generators/simple_filter/simple_filter_generator.rb

@@ -0,0 +1,16 @@
+class SimpleFilterGenerator < Rails::Generators::Base
+  desc "Create a filter for model specified"
+  argument :model_name, :type => :string, :default => ""
+
+  def self.source_root
+    @source_root ||= File.join(File.dirname(__FILE__), 'templates')
+  end
+
+  def create_filter
+    if model_name.blank?
+      puts "No model name provided, aborted!"
+    else
+      template 'filter.rb', File.join('app/filters', "#{model_name}_filter.rb")
+    end
+  end
+end

data/lib/generators/simple_filter/templates/filter.rb

@@ -0,0 +1,17 @@
+class <%= model_name.camelize %>Filter < SimpleFilter::Base
+  # Rewrite default filter options in case you need.
+  # config per_page: 20, order_by: :name
+
+  # There're default filters including :sort, :pagination. You can use them along with
+  # your custom filters like this:
+  #
+  # filter :sort, :by_name
+  #
+  # private
+  #
+  # def by_name
+  #   if params[:name].present?
+  #     @scope = scope.where(:name => params[:name])
+  #   end
+  # end
+end

data/lib/simple_filter.rb

@@ -0,0 +1,9 @@
+require "simple_filter/version"
+
+module SimpleFilter
+  autoload :Configuration,  'simple_filter/configuration'
+  autoload :Base, 'simple_filter/base'
+
+  require 'simple_filter/railtie' if defined?(Rails)
+  # Your code goes here...
+end

data/lib/simple_filter/base.rb

@@ -0,0 +1,88 @@
+module SimpleFilter
+  class Base
+    class_attribute :filters, :configuration
+
+    # The params are the parameters you might have entered in your form.
+    attr_reader :params
+
+    self.filters = []
+    self.configuration = Configuration.new
+
+    # Call filter to define which filters are available.
+    # These will all be run in the order you specified
+    def self.filter(*filters)
+      self.filters = self.filters + filters
+    end
+
+    # possible options:
+    #   per_page 10
+    #   order_by :id
+    def self.config(options = {})
+      configuration.per_page = options[:per_page] unless options[:per_page].blank?
+      configuration.order_by = options[:order_by] unless options[:order_by].blank?
+    end
+
+    def self.all(*args)
+      new(*args).all
+    end
+
+    def initialize(params)
+      @params = params
+    end
+
+    # Get all filtered results. This is the public facing method that
+    # you'd want to call when getting the results of the filter.
+    def all
+      apply_filters
+      scope
+    end
+
+    private
+
+    # As part of the contract, set the default scope by overriding this method.
+    def scope
+      raise NotImplementedError
+    end
+
+    # Run all the filters, specified in subclasses.
+    def apply_filters
+      filters.each { |filter| send(filter) }
+    end
+
+    # Probably every filter should be able to paginate the results.
+    # remember to call pagination last, because will_paginate won't return
+    # a real ActiveRecord::Relation object.
+    def pagination
+      @scope = scope.paginate(:page => page, :per_page => per_page)
+    end
+
+    def page
+      params[:page] || 1
+    end
+
+    def per_page
+      params[:per_page] || self.class.configuration.per_page
+    end
+
+    # Similar to pagination, sorting is something common to all filters,
+    # The default order is :id, because that will be available on every
+    # model. You can override it easily however.
+    def sort(default = self.class.configuration.order_by)
+      @scope = scope.order(params[:order] || default)
+      @scope = scope.reverse_order if params[:direction] == 'desc'
+    end
+
+    class << self
+      def scope(model_name)
+        define_method(:scope) do
+          @scope ||= model_name.to_s.camelize.constantize.scoped
+        end
+      end
+
+      def inherited(klass)
+        klass.send(:scope, klass.to_s.sub('Filter', '').underscore)
+        klass.configuration = self.configuration.dup
+      end
+    end
+  end
+end

data/lib/simple_filter/configuration.rb

@@ -0,0 +1,14 @@
+module SimpleFilter
+  class Configuration
+    attr_writer :per_page
+    attr_writer :order_by
+
+    def per_page
+      @per_page || 10
+    end
+
+    def order_by
+      @order_by || :id
+    end
+  end
+end

data/lib/simple_filter/railtie.rb

@@ -0,0 +1,6 @@
+module SimpleFilter
+  module Rails
+    class Railtie < ::Rails::Railtie
+    end
+  end
+end

data/lib/simple_filter/version.rb

@@ -0,0 +1,3 @@
+module SimpleFilter
+  VERSION = "0.0.1"
+end

data/simple_filter.gemspec

@@ -0,0 +1,17 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/simple_filter/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["ryancheung"]
+  gem.email         = ["ryancheung.go@gmail.com"]
+  gem.description   = %q{Filter for ActiveModel}
+  gem.summary       = %q{Simple filter for replacing the awkward search method or scopes of models.}
+  gem.homepage      = "https://github.com/ryancheung/simple_filter"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "simple_filter"
+  gem.require_paths = ["lib"]
+  gem.version       = SimpleFilter::VERSION
+end

metadata

@@ -0,0 +1,59 @@
+--- !ruby/object:Gem::Specification
+name: simple_filter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- ryancheung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-11-19 00:00:00.000000000 Z
+dependencies: []
+description: Filter for ActiveModel
+email:
+- ryancheung.go@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- lib/generators/simple_filter/USAGE
+- lib/generators/simple_filter/simple_filter_generator.rb
+- lib/generators/simple_filter/templates/filter.rb
+- lib/simple_filter.rb
+- lib/simple_filter/base.rb
+- lib/simple_filter/configuration.rb
+- lib/simple_filter/railtie.rb
+- lib/simple_filter/version.rb
+- simple_filter.gemspec
+homepage: https://github.com/ryancheung/simple_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: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Simple filter for replacing the awkward search method or scopes of models.
+test_files: []