README.rdoc

WillFilter

will_filter is a Rails engine plugin that provides a GUI for filtering your
ActiveRecord models.

Preamble

If you ever had to build an admin tool for your web site that displayed a
list of objects that can be filtered using various criteria, this plugin
will make your life easier. Adding a filtered page can now be a matter of
adding two lines of code - one to your controller and one to your view. See
examples below.

Installation Instructions

Add the following gems to your Gemfile:

gem 'will_filter', "~> 3.1.0"
gem 'kaminari'

And run:

$ bundle

To configure and initialize will_filter engine, run the following commands:

$ rails generate will_filter
$ rake db:migrate

At the top of your routes.rb file, add the following line:

mount WillFilter::Engine => "/will_filter"

Examples

To add a filtered result-set to your controller use the following method
call: