will_filter 3.0.0

data/config/environment.rb

@@ -0,0 +1,13 @@
+# Load the rails application
+require File.expand_path('../application', __FILE__)
+
+["../lib/core_ext/**",
+ "../lib/will_filter",
+ "../lib/will_filter/containers"].each do |dir|
+    Dir[File.expand_path("#{File.dirname(__FILE__)}/#{dir}/*.rb")].sort.each do |file|
+      require file
+    end
+end
+
+# Initialize the rails application
+WillFilter::Application.initialize!

data/config/environments/development.rb

@@ -0,0 +1,26 @@
+WillFilter::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # In the development environment your application's code is reloaded on
+  # every request.  This slows down response time but is perfect for development
+  # since you don't have to restart the webserver when you make code changes.
+  config.cache_classes = false
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_view.debug_rjs             = true
+  config.action_controller.perform_caching = false
+
+  # Don't care if the mailer can't send
+  config.action_mailer.raise_delivery_errors = false
+
+  # Print deprecation notices to the Rails logger
+  config.active_support.deprecation = :log
+
+  # Only use best-standards-support built into browsers
+  config.action_dispatch.best_standards_support = :builtin
+end
+

data/config/environments/production.rb

@@ -0,0 +1,49 @@
+WillFilter::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The production environment is meant for finished, "live" apps.
+  # Code is not reloaded between requests
+  config.cache_classes = true
+
+  # Full error reports are disabled and caching is turned on
+  config.consider_all_requests_local       = false
+  config.action_controller.perform_caching = true
+
+  # Specifies the header that your server uses for sending files
+  config.action_dispatch.x_sendfile_header = "X-Sendfile"
+
+  # For nginx:
+  # config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'
+
+  # If you have no front-end server that supports something like X-Sendfile,
+  # just comment this out and Rails will serve the files
+
+  # See everything in the log (default is :info)
+  # config.log_level = :debug
+
+  # Use a different logger for distributed setups
+  # config.logger = SyslogLogger.new
+
+  # Use a different cache store in production
+  # config.cache_store = :mem_cache_store
+
+  # Disable Rails's static asset server
+  # In production, Apache or nginx will already do this
+  config.serve_static_assets = false
+
+  # Enable serving of images, stylesheets, and javascripts from an asset server
+  # config.action_controller.asset_host = "http://assets.example.com"
+
+  # Disable delivery errors, bad email addresses will be ignored
+  # config.action_mailer.raise_delivery_errors = false
+
+  # Enable threaded mode
+  # config.threadsafe!
+
+  # Enable locale fallbacks for I18n (makes lookups for any locale fall back to
+  # the I18n.default_locale when a translation can not be found)
+  config.i18n.fallbacks = true
+
+  # Send deprecation notices to registered listeners
+  config.active_support.deprecation = :notify
+end

data/config/environments/test.rb

@@ -0,0 +1,38 @@
+WillFilter::Application.configure do
+  # Settings specified here will take precedence over those in config/application.rb
+
+  # The test environment is used exclusively to run your application's
+  # test suite.  You never need to work with it otherwise.  Remember that
+  # your test database is "scratch space" for the test suite and is wiped
+  # and recreated between test runs.  Don't rely on the data there!
+  config.cache_classes = true
+
+  # Log error messages when you accidentally call methods on nil.
+  config.whiny_nils = true
+
+  # Show full error reports and disable caching
+  config.consider_all_requests_local       = true
+  config.action_controller.perform_caching = false
+
+  # Raise exceptions instead of rendering exception templates
+  config.action_dispatch.show_exceptions = false
+
+  # Disable request forgery protection in test environment
+  config.action_controller.allow_forgery_protection    = false
+
+  # Tell Action Mailer not to deliver emails to the real world.
+  # The :test delivery method accumulates sent emails in the
+  # ActionMailer::Base.deliveries array.
+  config.action_mailer.delivery_method = :test
+
+  # Use SQL instead of Active Record's schema dumper when creating the test database.
+  # This is necessary if your schema can't be completely dumped by the schema dumper,
+  # like if you have constraints or database-specific column types
+  # config.active_record.schema_format = :sql
+
+  # Print deprecation notices to the stderr
+  config.active_support.deprecation = :stderr
+  
+  
+  
+end

data/config/routes.rb

@@ -0,0 +1,64 @@
+Rails.application.routes.draw do 
+  # The priority is based upon order of creation:
+  # first created -> highest priority.
+
+  # Sample of regular route:
+  #   match 'products/:id' => 'catalog#view'
+  # Keep in mind you can assign values other than :controller and :action
+
+  # Sample of named route:
+  #   match 'products/:id/purchase' => 'catalog#purchase', :as => :purchase
+  # This route can be invoked with purchase_url(:id => product.id)
+
+  # Sample resource route (maps HTTP verbs to controller actions automatically):
+  #   resources :products
+
+  # Sample resource route with options:
+  #   resources :products do
+  #     member do
+  #       get 'short'
+  #       post 'toggle'
+  #     end
+  #
+  #     collection do
+  #       get 'sold'
+  #     end
+  #   end
+
+  # Sample resource route with sub-resources:
+  #   resources :products do
+  #     resources :comments, :sales
+  #     resource :seller
+  #   end
+
+  # Sample resource route with more complex sub-resources
+  #   resources :products do
+  #     resources :comments
+  #     resources :sales do
+  #       get 'recent', :on => :collection
+  #     end
+  #   end
+
+  # Sample resource route within a namespace:
+  #   namespace :admin do
+  #     # Directs /admin/products/* to Admin::ProductsController
+  #     # (app/controllers/admin/products_controller.rb)
+  #     resources :products
+  #   end
+
+  # You can have the root of your site routed with "root"
+  # just remember to delete public/index.html.
+  root :to => "will_filter/filter#index"
+
+#  mount_at = WillFilter::Engine.config.mount_at
+#  match mount_at => 'will_filter/filter#index'
+#  map.resources :filter, :controller => "will_filter/filter", :path_prefix => mount_at, :name_prefix => "will_filter_"
+
+  # See how all your routes lay out with "rake routes"
+
+  # This is a legacy wild controller route that's not recommended for RESTful applications.
+  # Note: This route will make all actions in every controller accessible via GET requests.
+  match ':controller(/:action(/:id(.:format)))'
+  match ':controller(/:action(/:id))', :controller => /will_filter\/[^\/]+/
+  
+end

data/config/will_filter/config.yml

@@ -0,0 +1,97 @@
+#############################################################################
+# will_filter configuration
+#
+# Default settings for all environments
+# 
+# You can overload any feature for any environment by changing the 
+# environment settings at the bottom of the file. 
+#
+# Alternatively, you can overload any of the methods of WillFilter::Config
+#############################################################################
+
+defaults: &defaults
+  effects_options:
+    enabled:              false
+    script_path:          "/will_filter/javascripts/will_filter_prototype_effects.js"
+    
+  save_options: 
+    enabled:              true
+    user_filters_enabled: false   # if set to true, the filters will be private
+    user_class_name:      User 
+    current_user_method:  current_user 
+
+  export_options:         
+    enabled:              true
+    default_formats:      [html, csv, xml, json]
+  
+  containers:             # container implementation mapping
+    nil:                  WillFilter::Containers::Nil
+    numeric:              WillFilter::Containers::Numeric
+    numeric_range:        WillFilter::Containers::NumericRange
+    numeric_delimited:    WillFilter::Containers::NumericDelimited
+    date_time_range:      WillFilter::Containers::DateTimeRange
+    single_date:          WillFilter::Containers::SingleDate
+    date:                 WillFilter::Containers::Date
+    date_time:            WillFilter::Containers::DateTime
+    date_range:           WillFilter::Containers::DateRange
+    text:                 WillFilter::Containers::Text
+    text_delimited:       WillFilter::Containers::TextDelimited
+    boolean:              WillFilter::Containers::Boolean
+    list:                 WillFilter::Containers::List
+    filter_list:          WillFilter::Containers::FilterList
+    
+  data_types:             # mapping between data types and containers   
+    bigint:               [nil, numeric, numeric_range, numeric_delimited]
+    numeric:              [nil, numeric, numeric_range, numeric_delimited]
+    smallint:             [nil, numeric, numeric_range, numeric_delimited]
+    integer:              [nil, numeric, numeric_range, numeric_delimited]
+    int:                  [nil, numeric, numeric_range, numeric_delimited]
+    double:               [nil, numeric, numeric_range, numeric_delimited]
+    timestamp:            [nil, date_time, date_time_range, single_date]
+    datetime:             [nil, date_time, date_time_range, single_date]
+    date:                 [nil, date, date_range]
+    character:            [nil, text, text_delimited]
+    varchar:              [nil, text, text_delimited]
+    text:                 [nil, text, text_delimited]
+    text[]:               [nil, text, text_delimited]
+    bytea:                [nil, text, text_delimited]
+    boolean:              [nil, boolean]
+    tinyint:              [nil, boolean]
+
+  operators:              # operators precedence
+    is:                   100
+    is_not:               200
+    is_on:                300
+    is_in:                400
+    is_provided:          500
+    is_not_provided:      600 
+    is_after:             700
+    is_before:            800
+    is_in_the_range:      900
+    contains:             1000
+    does_not_contain:     1100
+    starts_with:          1200
+    ends_with:            1300
+    is_greater_than:      1400
+    is_less_than:         1500
+    is_filtered_by:       1600
+    
+    
+#############################################################################
+# Environment Settings
+# You can overload any feature defined in the defaults for any environment
+#############################################################################
+development:
+  <<: *defaults
+  
+test:
+  <<: *defaults
+      
+qa:
+  <<: *defaults
+
+stage:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/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 WillFilter::Application

data/db/migrate/20090730070119_create_will_filter_tables.rb

@@ -0,0 +1,19 @@
+class CreateWillFilterTables < ActiveRecord::Migration
+  def self.up
+    create_table :wf_filters do |t|
+      t.string      :type
+      t.string      :name
+      t.text        :data
+      t.integer     :user_id
+      t.string      :model_class_name
+      
+      t.timestamps
+    end
+    
+    add_index :wf_filters, [:user_id]
+  end
+  
+  def self.down
+    drop_table :wf_filters
+  end
+end

data/db/seeds.rb

@@ -0,0 +1,7 @@
+# This file should contain all the record creation needed to seed the database with its default values.
+# The data can then be loaded with the rake db:seed (or created alongside the db with db:setup).
+#
+# Examples:
+#
+#   cities = City.create([{ :name => 'Chicago' }, { :name => 'Copenhagen' }])
+#   Mayor.create(:name => 'Daley', :city => cities.first)

data/doc/README_FOR_APP

@@ -0,0 +1,2 @@
+Use this README file to introduce your application and point to useful places in the API for learning more.
+Run "rake doc:app" to generate API documentation for your models, controllers, helpers, and libraries.

data/examples/README

@@ -0,0 +1 @@
+Please install will_filter_examples project to see how to configure the model_filters.

data/lib/application_helper.rb

@@ -0,0 +1,45 @@
+#--
+# Copyright (c) 2011 Michael Berkovich
+#
+# 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.
+#++
+
+module ApplicationHelper
+  def will_filter(results)
+    render(:partial => "/will_filter/filter/container", :locals => {:wf_filter => results.wf_filter})
+  end
+
+  def will_filter_scripts_tag
+    render(:partial => "/will_filter/common/scripts")
+  end
+  
+  def will_filter_table_tag(results, opts = {})
+    filter = results.wf_filter
+    opts[:columns] ||= filter.model_column_keys
+    render(:partial => "/will_filter/common/results_table", :locals => {:results => results, :filter => filter, :opts => opts})
+  end
+
+  def will_filter_actions_bar_tag(results, actions, opts = {})
+    filter = results.wf_filter
+    opts[:class] ||= "wf_actions_bar_blue"
+    opts[:style] ||= ""
+    render(:partial => "/will_filter/common/actions_bar", :locals => {:results => results, :filter => filter, :actions => actions, :opts => opts})
+  end
+end

data/lib/core_ext/active_record/base.rb

@@ -0,0 +1,44 @@
+#--
+# Copyright (c) 2011 Michael Berkovich
+#
+# 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.
+#++
+
+class ActiveRecord::Base
+  def self.filter(opts = {})
+    if ActiveRecord::Base == self.class
+      raise WillFilter::FilterException.new("Cannot apply filter to the ActiveRecord::Base object")
+    end
+
+    params = opts[:params] || {}
+    
+    if opts[:filter]
+      case opts[:filter].class.name
+        when "String" then filter_class = opts[:filter].constantize
+        when "Symbol" then filter_class = opts[:filter].to_s.camelcase.constantize
+        else filter_class = opts[:filter]
+      end
+    else
+      filter_class = WillFilter::Filter
+    end
+  
+    filter_class.new(self).deserialize_from_params(params).results
+  end
+end

data/lib/core_ext/array.rb

@@ -0,0 +1,34 @@
+#--
+# Copyright (c) 2011 Michael Berkovich
+#
+# 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.
+#++
+
+class Array
+  
+  def wf_filter=(filter)
+    @wf_filter = filter
+  end
+  
+  def wf_filter
+    @wf_filter
+  end
+  
+end

data/lib/core_ext/object.rb

@@ -0,0 +1,34 @@
+#--
+# Copyright (c) 2011 Michael Berkovich
+#
+# 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.
+#++
+
+class Object
+  
+  def wf_filter=(filter)
+    @wf_filter = filter
+  end
+  
+  def wf_filter
+    @wf_filter
+  end
+  
+end

data/lib/generators/will_filter/templates/config.yml

@@ -0,0 +1,97 @@
+#############################################################################
+# will_filter configuration
+#
+# Default settings for all environments
+# 
+# You can overload any feature for any environment by changing the 
+# environment settings at the bottom of the file. 
+#
+# Alternatively, you can overload any of the methods of WillFilter::Config
+#############################################################################
+
+defaults: &defaults
+  effects_options:
+    enabled:              false
+    script_path:          "/will_filter/javascripts/will_filter_prototype_effects.js"
+    
+  save_options: 
+    enabled:              true
+    user_filters_enabled: false   # if set to true, the filters will be private
+    user_class_name:      User 
+    current_user_method:  current_user 
+
+  export_options:         
+    enabled:              true
+    default_formats:      [html, csv, xml, json]
+  
+  containers:             # container implementation mapping
+    nil:                  WillFilter::Containers::Nil
+    numeric:              WillFilter::Containers::Numeric
+    numeric_range:        WillFilter::Containers::NumericRange
+    numeric_delimited:    WillFilter::Containers::NumericDelimited
+    date_time_range:      WillFilter::Containers::DateTimeRange
+    single_date:          WillFilter::Containers::SingleDate
+    date:                 WillFilter::Containers::Date
+    date_time:            WillFilter::Containers::DateTime
+    date_range:           WillFilter::Containers::DateRange
+    text:                 WillFilter::Containers::Text
+    text_delimited:       WillFilter::Containers::TextDelimited
+    boolean:              WillFilter::Containers::Boolean
+    list:                 WillFilter::Containers::List
+    filter_list:          WillFilter::Containers::FilterList
+    
+  data_types:             # mapping between data types and containers   
+    bigint:               [nil, numeric, numeric_range, numeric_delimited]
+    numeric:              [nil, numeric, numeric_range, numeric_delimited]
+    smallint:             [nil, numeric, numeric_range, numeric_delimited]
+    integer:              [nil, numeric, numeric_range, numeric_delimited]
+    int:                  [nil, numeric, numeric_range, numeric_delimited]
+    double:               [nil, numeric, numeric_range, numeric_delimited]
+    timestamp:            [nil, date_time, date_time_range, single_date]
+    datetime:             [nil, date_time, date_time_range, single_date]
+    date:                 [nil, date, date_range]
+    character:            [nil, text, text_delimited]
+    varchar:              [nil, text, text_delimited]
+    text:                 [nil, text, text_delimited]
+    text[]:               [nil, text, text_delimited]
+    bytea:                [nil, text, text_delimited]
+    boolean:              [nil, boolean]
+    tinyint:              [nil, boolean]
+
+  operators:              # operators precedence
+    is:                   100
+    is_not:               200
+    is_on:                300
+    is_in:                400
+    is_provided:          500
+    is_not_provided:      600 
+    is_after:             700
+    is_before:            800
+    is_in_the_range:      900
+    contains:             1000
+    does_not_contain:     1100
+    starts_with:          1200
+    ends_with:            1300
+    is_greater_than:      1400
+    is_less_than:         1500
+    is_filtered_by:       1600
+    
+    
+#############################################################################
+# Environment Settings
+# You can overload any feature defined in the defaults for any environment
+#############################################################################
+development:
+  <<: *defaults
+  
+test:
+  <<: *defaults
+      
+qa:
+  <<: *defaults
+
+stage:
+  <<: *defaults
+
+production:
+  <<: *defaults

data/lib/generators/will_filter/templates/create_will_filter_tables.rb

@@ -0,0 +1,19 @@
+class CreateWillFilterTables < ActiveRecord::Migration
+  def self.up
+    create_table :wf_filters do |t|
+      t.string      :type
+      t.string      :name
+      t.text        :data
+      t.integer     :user_id
+      t.string      :model_class_name
+      
+      t.timestamps
+    end
+    
+    add_index :wf_filters, [:user_id]
+  end
+  
+  def self.down
+    drop_table :wf_filters
+  end
+end

data/lib/generators/will_filter/will_filter_generator.rb

@@ -0,0 +1,24 @@
+require 'rails/generators'
+require 'rails/generators/migration'
+
+class WillFilterGenerator < Rails::Generators::Base
+  include Rails::Generators::Migration
+
+  def self.source_root
+    @source_root ||= File.expand_path('../templates', __FILE__)
+  end
+
+  # Implement the required interface for Rails::Generators::Migration.
+  def self.next_migration_number(dirname)
+    if ActiveRecord::Base.timestamped_migrations
+      Time.now.utc.strftime("%Y%m%d%H%M%S")
+    else
+      "%.3d" % (current_migration_number(dirname) + 1)
+    end
+  end
+
+  def create_migration_file
+    migration_template 'create_will_filter_tables.rb', 'db/migrate/create_will_filter_tables.rb'
+    copy_file 'config.yml', 'config/will_filter/config.yml'
+  end
+end