Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jhund/filterrific
Filterrific is a Rails Engine plugin that makes it easy to filter, search, and sort your ActiveRecord lists.
https://github.com/jhund/filterrific
activerecord filter ruby-on-rails
Last synced: 7 days ago
JSON representation
Filterrific is a Rails Engine plugin that makes it easy to filter, search, and sort your ActiveRecord lists.
- Host: GitHub
- URL: https://github.com/jhund/filterrific
- Owner: jhund
- License: mit
- Created: 2010-02-15T21:51:48.000Z (almost 15 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T05:46:08.000Z (6 months ago)
- Last Synced: 2025-01-21T17:01:53.104Z (14 days ago)
- Topics: activerecord, filter, ruby-on-rails
- Language: Ruby
- Homepage: http://filterrific.clearcove.ca
- Size: 1020 KB
- Stars: 910
- Watchers: 25
- Forks: 126
- Open Issues: 100
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: MIT-LICENSE
Awesome Lists containing this project
- awesome-ruby-toolbox - filterrific - Filterrific is a Rails Engine plugin that makes it easy to filter, search, and sort your ActiveRecord lists. (Active Record Plugins / Active Record Named Scopes)
README
# Filterrific
Filterrific is a Rails Engine plugin that makes it easy to filter,
search, and sort your ActiveRecord lists:
### Features
* Makes heavy use of ActiveRecord Scopes
* ActionController helpers to shuttle filter params from ActionView forms to ActiveRecord based models, and to return matching records back from ActiveRecord to ActionView.
* Form helpers to build powerful search and filter forms with ease.
* Javascript assets to auto-submit filter form on change via AJAX.
* Image asset to show a spinner in the Filterrific form when new records are being loaded via AJAX.
* API option to use Filterrific with Rails API mode. Just use `gem 'filterrific', require: 'filterrific_api'` in your Gemfile.
***
***
### Installation
`gem install filterrific`
or with bundler in your Gemfile:
`gem 'filterrific'`
### Usage
Make sure to go to the fantastic [Filterrific documentation](http://filterrific.clearcove.ca)
to find out more!
### Compatibility
Every commit to Filterrific is automatically tested against the following scenarios:
|Filterrific version | Rails version | Ruby environments | Database adapters | Build status |
|--------------------|---------------------|--------------------------------|------------------------------------|--------------|
| 5.x | Rails 5.x, 6.x, 7.x, 8.x | MRI 2.0.0, 2.1.7, 2.2.3, 2.3.1 | mysql2, postgresql |[](https://travis-ci.org/jhund/filterrific_demo)|
| 4.x | Rails 4.x | MRI 2.0.0, 2.1.7, 2.2.3, 2.3.1 | mysql, mysql2, postgresql, sqlite3 |[](https://travis-ci.org/jhund/filterrific_demo)|
| 3.x | Rails 3.2 | MRI 2.0.0, 2.1.7 | mysql, mysql2, postgresql, sqlite3 | Not tested|
| 2.x | Rails 3.2 | MRI 1.9.3 | mysql, mysql2, postgresql, sqlite3 | Not tested|
| 1.x | < 3.2 | MRI <= 1.9.3 | mysql, mysql2, postgresql, sqlite3 | Not tested|
### Guidelines for submitting issues
Please post questions related to usage at [StackOverflow](http://stackoverflow.com/questions/tagged/filterrific) under the `filterrific` tag.
If you think you've found a bug, or have a feature request, then create an issue here on Github. You'll make my job easier if you follow these guidelines:
* Please keep in mind that I do this in my spare time. To you this software is free as in `beer`, to me it's free as in `baby`. I appreciate it if you first do everything you can on your own: read the detailed [Filterrific documentation](http://filterrific.clearcove.ca), look for similar issues on [StackOverflow](http://stackoverflow.com/questions/tagged/filterrific), search the internets, etc.
* If you're stuck, give me sufficient context so that I have a chance to identify the issue:
* what version of filterrific are you using? (look in your `Gemfile.lock`)
* what version of Rails are you using? (look in your `Gemfile.lock`)
* what version of Ruby are you using? (run `ruby -v` in your app root)
* If you get an exception, include the entire stack trace, including the error message.
* Include any relevant code snippets (your model, controller, and view code).
* When pasting code, please use [markdown code formatting](https://help.github.com/articles/github-flavored-markdown/#fenced-code-blocks). It will be much easier to read.
### Resources
* [Documentation](http://filterrific.clearcove.ca)
* [Demo App](https://github.com/jhund/filterrific_demo) using classic Rails views.
* [API Demo App](https://github.com/jhund/filterrific_json_api_demo) using React and Mobx.
* [Changelog](https://github.com/jhund/filterrific/blob/master/CHANGELOG.md)
* [Source code (github)](https://github.com/jhund/filterrific)
* [Issues](https://github.com/jhund/filterrific/issues)
* [Questions on Stack Overflow](http://stackoverflow.com/questions/tagged/filterrific) (tagged `filterrific`)
* [Rubygems.org](http://rubygems.org/gems/filterrific)
[](https://travis-ci.org/jhund/filterrific)
[](https://codeclimate.com/github/jhund/filterrific)
### License
[MIT licensed](https://github.com/jhund/filterrific/blob/master/MIT-LICENSE).
### Copyright
Copyright (c) 2010 - 2023 Jo Hund. See [(MIT) LICENSE](https://github.com/jhund/filterrific/blob/master/MIT-LICENSE) for details.