filtrate 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+.bundle/
+log/*.log
+pkg/
+test/dummy/db/*.sqlite3
+test/dummy/log/*.log
+test/dummy/tmp/

data/Gemfile

@@ -0,0 +1,14 @@
+source "http://rubygems.org"
+
+gem "rails", "3.0.4"
+gem "arel"
+
+group :development, :test do
+  gem "launchy"
+  gem "capybara", ">= 0.4.0"
+  gem "sqlite3"
+end
+
+# To use debugger (ruby-debug for Ruby 1.8.7+, ruby-debug19 for Ruby 1.9.2+)
+# gem 'ruby-debug'
+# gem 'ruby-debug19'

data/Gemfile.lock

@@ -0,0 +1,105 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    abstract (1.0.0)
+    actionmailer (3.0.4)
+      actionpack (= 3.0.4)
+      mail (~> 2.2.15)
+    actionpack (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      erubis (~> 2.6.6)
+      i18n (~> 0.4)
+      rack (~> 1.2.1)
+      rack-mount (~> 0.6.13)
+      rack-test (~> 0.5.7)
+      tzinfo (~> 0.3.23)
+    activemodel (3.0.4)
+      activesupport (= 3.0.4)
+      builder (~> 2.1.2)
+      i18n (~> 0.4)
+    activerecord (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+      arel (~> 2.0.2)
+      tzinfo (~> 0.3.23)
+    activeresource (3.0.4)
+      activemodel (= 3.0.4)
+      activesupport (= 3.0.4)
+    activesupport (3.0.4)
+    arel (2.0.9)
+    builder (2.1.2)
+    capybara (0.4.1.1)
+      celerity (>= 0.7.9)
+      culerity (>= 0.2.4)
+      mime-types (>= 1.16)
+      nokogiri (>= 1.3.3)
+      rack (>= 1.0.0)
+      rack-test (>= 0.5.4)
+      selenium-webdriver (>= 0.0.27)
+      xpath (~> 0.1.3)
+    celerity (0.8.7)
+    childprocess (0.1.6)
+      ffi (~> 0.6.3)
+    configuration (1.2.0)
+    culerity (0.2.15)
+    erubis (2.6.6)
+      abstract (>= 1.0.0)
+    ffi (0.6.3)
+      rake (>= 0.8.7)
+    i18n (0.5.0)
+    json_pure (1.5.1)
+    launchy (0.3.7)
+      configuration (>= 0.0.5)
+      rake (>= 0.8.1)
+    mail (2.2.19)
+      activesupport (>= 2.3.6)
+      i18n (>= 0.4.0)
+      mime-types (~> 1.16)
+      treetop (~> 1.4.8)
+    mime-types (1.16)
+    nokogiri (1.4.4)
+    polyglot (0.3.1)
+    rack (1.2.3)
+    rack-mount (0.6.14)
+      rack (>= 1.0.0)
+    rack-test (0.5.7)
+      rack (>= 1.0)
+    rails (3.0.4)
+      actionmailer (= 3.0.4)
+      actionpack (= 3.0.4)
+      activerecord (= 3.0.4)
+      activeresource (= 3.0.4)
+      activesupport (= 3.0.4)
+      bundler (~> 1.0)
+      railties (= 3.0.4)
+    railties (3.0.4)
+      actionpack (= 3.0.4)
+      activesupport (= 3.0.4)
+      rake (>= 0.8.7)
+      thor (~> 0.14.4)
+    rake (0.9.1)
+    rubyzip (0.9.4)
+    selenium-webdriver (0.1.2)
+      childprocess (~> 0.1.5)
+      ffi (~> 0.6.3)
+      json_pure
+      rubyzip
+    sqlite3 (1.3.3)
+    thor (0.14.6)
+    treetop (1.4.9)
+      polyglot (>= 0.3.1)
+    tzinfo (0.3.27)
+    xpath (0.1.3)
+      nokogiri (~> 1.3)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  arel
+  capybara (>= 0.4.0)
+  launchy
+  rails (= 3.0.4)
+  sqlite3

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2011 Jared Fraser
+
+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.markdown

@@ -0,0 +1,19 @@
+Filtrate
+========
+
+
+Controller
+
+```ruby
+@filtered = User.filtered(params[:filters]).all
+```
+
+
+Views
+
+```ruby
+<%= filtrate users_path do |f|%>
+  <%= f.filter :name %>
+  <%= f.submit "Submit" %>
+<% end %>
+```

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/filtrate.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "filtrate/version"
+
+Gem::Specification.new do |s|
+  s.name        = "filtrate"
+  s.version     = Filtrate::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Jared Fraser"]
+  s.email       = ["j.fraser@modsognir.com"]
+  s.homepage    = "http://github.com/modsognir/filtrate"
+  s.summary     = %q{Rails record filtering}
+  s.description = %q{Helpers for building interfaces to filter records easily}
+
+  s.rubyforge_project = "filtrate"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/filtrate.rb

@@ -0,0 +1,26 @@
+require 'active_record'
+require 'active_support'
+require 'action_view/helpers'
+
+
+require 'filtrate/filterable'
+require 'filtrate/helpers/form_helper'
+
+module Filtrate
+  extend ActiveSupport::Concern
+  extend ActiveSupport::Autoload
+  
+  autoload :Filter, 'filtrate/filter'
+  autoload :Filterable, 'filtrate/filterable'
+  autoload :FilterBuilder, 'filtrate/filter_builder'
+  
+  module ClassMethods
+    def filterable
+      extend Filterable
+    end
+  end  
+end
+
+ActiveRecord::Base.class_eval{ include Filtrate }
+ActiveRecord::Relation.class_eval{ include Filterable }
+ActionView::Helpers.class_eval{ include Filtrate::Helpers::FormHelper }

data/lib/filtrate/filter.rb

@@ -0,0 +1,24 @@
+require 'arel'
+
+module Filtrate
+  class Filter
+    def initialize(scope, attr, val)
+      @scope = scope
+      @attr = attr
+      @value = val
+      @type = @scope.columns_hash[attr].try(:type)
+      @col = @scope.table[attr]
+    end
+    
+    def to_scope
+      case @type
+      when :string
+        @scope.where(@col.matches("%#{@value}%"))
+      when :date
+        @scope.where(@attr => @value['from']..@value['to'])
+      else
+        @scope
+      end
+    end
+  end
+end

data/lib/filtrate/filter_builder.rb

@@ -0,0 +1,38 @@
+require 'action_view/helpers/form_tag_helper'
+
+module Filtrate
+  class FilterBuilder
+    include ActionView::Helpers::FormTagHelper
+
+    def filter(attr, name=nil, value="", text_field_opts={})
+      label_tag("filters[#{attr}]", (name || attr.to_s.humanize)) + text_field_tag("filters[#{attr}]", value, text_field_opts)
+    end
+
+    # FIXME: Date field stuff is very messy.
+    def filter_date(attr, label_options={}, value="", text_field_options={})
+      label_options[:prefix] ||= nil
+      label_options[:from] ||= "From"
+      label_options[:to] ||= "To"
+      [:to, :from].map {|type| date_field_set(type, attr, label_options, value, text_field_options) }.join('').html_safe
+    end
+
+    def date_field_set(type, attr, label_options={}, value="", text_field_opts={})
+      date_label(type, attr, label_options) + date_field(type, attr, value, text_field_opts)
+    end
+    
+    def date_label(type, attr, opts={})
+      label_tag("filters[#{attr}][#{type}]", "#{opts[:prefix]} #{opts[type].try(:humanize)}".strip)
+    end
+    
+    def date_field(type, attr, value, opts)
+      text_field_tag("filters[#{attr}][#{type}]", value, opts)
+    end
+      
+    def submit(value="Save changes", options={})
+      submit_tag(value, options)
+    end
+    
+    def method_missing(method, *args)
+    end
+  end
+end

data/lib/filtrate/filterable.rb

@@ -0,0 +1,14 @@
+module Filterable
+  def filtered(opts)
+    opts ||= {}
+    scope = self.scoped
+    opts.each do |attr, val|
+      if val.kind_of? Hash
+        scope = Filtrate::Filter.new(scope, attr, val).to_scope if val['from'].present? && val['to'].present?
+      else
+        scope = Filtrate::Filter.new(scope, attr, val).to_scope if val.present?
+      end
+    end
+    scope
+  end
+end

data/lib/filtrate/helpers.rb

@@ -0,0 +1,10 @@
+module Filtrate
+  module Helpers
+    extend ActiveSupport::Autoload
+
+    autoload :FormHelper, 'filtrate/helpers/form_helper'
+    autoload :FilterBuilder, 'filtrate/filter_builder'
+
+    include Filtrate::Helpers::FormHelper
+  end
+end

data/lib/filtrate/helpers/form_helper.rb

@@ -0,0 +1,13 @@
+module Filtrate
+  module Helpers
+    module FormHelper
+      def filtrate(url_for_options = {}, options = {}, *parameters_for_url, &block)
+        builder = Filtrate::FilterBuilder.new
+        builder.send(:include, ActionView::Helpers::FormTagHelper)
+        form_tag(url_for_options, options.merge({:method => :get}), *parameters_for_url) do
+          yield builder
+        end
+      end
+    end
+  end
+end

data/lib/filtrate/version.rb

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

data/test/dummy/Rakefile

@@ -0,0 +1,7 @@
+# Add your own tasks in files placed in lib/tasks ending in .rake,
+# for example lib/tasks/capistrano.rake, and they will automatically be available to Rake.
+
+require File.expand_path('../config/application', __FILE__)
+require 'rake'
+
+Dummy::Application.load_tasks

data/test/dummy/app/controllers/application_controller.rb

@@ -0,0 +1,3 @@
+class ApplicationController < ActionController::Base
+  protect_from_forgery
+end

data/test/dummy/app/controllers/users_controller.rb

@@ -0,0 +1,5 @@
+class UsersController < ApplicationController
+  def index
+    @filtered = User.filtered(params[:filters]).all
+  end
+end

data/test/dummy/app/helpers/application_helper.rb

@@ -0,0 +1,2 @@
+module ApplicationHelper
+end

data/test/dummy/app/models/user.rb

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

data/test/dummy/app/views/layouts/application.html.erb

@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Dummy</title>
+  <%= stylesheet_link_tag :all %>
+  <%= javascript_include_tag :defaults %>
+  <%= csrf_meta_tag %>
+</head>
+<body>
+
+<%= yield %>
+
+</body>
+</html>

data/test/dummy/app/views/users/index.html.erb

@@ -0,0 +1,17 @@
+<p><%= params.inspect %></p>
+<table>
+  <tr>
+    <th>Name</th>
+  </tr>
+  <% @filtered.each do |record| %>
+    <tr>
+      <td><%= record.name %></td>
+    </tr>
+  <% end %>
+<table>
+  
+<%= filtrate users_path do |f|%>
+  <%= f.filter :name %>
+  <%= f.filter_date :date_of_birth, :prefix => "Date of Birth" %>
+  <%= f.submit "Submit" %>
+<% end %>

data/test/dummy/config.ru

@@ -0,0 +1,4 @@
+# This file is used by Rack-based servers to start the application.
+
+require ::File.expand_path('../config/environment',  __FILE__)
+run Dummy::Application

data/test/dummy/config/application.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../boot', __FILE__)
+
+require "active_model/railtie"
+require "active_record/railtie"
+require "action_controller/railtie"
+require "action_view/railtie"
+require "action_mailer/railtie"
+
+Bundler.require
+require "filtrate"
+
+module Dummy
+  class Application < Rails::Application
+    # Settings in config/environments/* take precedence over those specified here.
+    # Application configuration should go into files in config/initializers
+    # -- all .rb files in that directory are automatically loaded.
+
+    # Custom directories with classes and modules you want to be autoloadable.
+    # config.autoload_paths += %W(#{config.root}/extras)
+
+    # Only load the plugins named here, in the order given (default is alphabetical).
+    # :all can be used as a placeholder for all plugins not explicitly named.
+    # config.plugins = [ :exception_notification, :ssl_requirement, :all ]
+
+    # Activate observers that should always be running.
+    # config.active_record.observers = :cacher, :garbage_collector, :forum_observer
+
+    # Set Time.zone default to the specified zone and make Active Record auto-convert to this zone.
+    # Run "rake -D time" for a list of tasks for finding time zone names. Default is UTC.
+    # config.time_zone = 'Central Time (US & Canada)'
+
+    # The default locale is :en and all translations from config/locales/*.rb,yml are auto loaded.
+    # config.i18n.load_path += Dir[Rails.root.join('my', 'locales', '*.{rb,yml}').to_s]
+    # config.i18n.default_locale = :de
+
+    # JavaScript files you want as :defaults (application.js is always included).
+    # config.action_view.javascript_expansions[:defaults] = %w(jquery rails)
+
+    # Configure the default encoding used in templates for Ruby 1.9.
+    config.encoding = "utf-8"
+
+    # Configure sensitive parameters which will be filtered from the log file.
+    config.filter_parameters += [:password]
+  end
+end