Toller

URL-query-param-based filtering and sorting for Rails controllers.

Toller is a Rails engine that lets controllers declare filter_on/sort_on directives, then applies whichever filters and sorts are active for the current request to an ActiveRecord relation based on URL query parameters.

See the wiki for usage information.

• Ruby >= 3.3.0
• Rails >= 6.0

Add this line to your application's Gemfile:

gem 'toller', '~> 1.2'

And then execute:

$ bundle install

Filters are not automagically set up for you. You define the filters you want.

Filtering parameters are passed in the URL as such ?filters[visible]=1. Multiple filter parameters can be passed like so ?filters[visible]=1&filters[published_after]=2020-07-04.

More information is available in the wiki.

Sorting is not automagically set up for you. You define the sorting you want.

Sorting parameters are passed in the URL as such ?sort=position. Multiple sort parameters can be passed like so ?sort=-published_at,title.

More information is available in the wiki.

$ bin/test

Uses Appraisal2 (a maintained fork of Appraisal, still exposing the appraisal executable) to ensure various dependency versions work as expected

When dependencies change, run

$ bundle exec appraisal install
$ bundle exec appraisal generate-install

To run tests with Appraisal, run

$ bundle exec appraisal rspec

Without any flags, Appraisal2 defaults to running 2 appraisals in parallel. The test database is in-memory (database: ":memory:"), so each appraisal subprocess gets its own isolated database and parallel runs don't conflict. Pass -n 1 to force one Rails version at a time instead.

$ bundle exec appraisal rails-6-0 rspec
$ bundle exec appraisal rails-6-1 rspec
$ bundle exec appraisal rails-7-0 rspec
$ bundle exec appraisal rails-7-1 rspec
$ bundle exec appraisal rails-7-2 rspec
$ bundle exec appraisal rails-8-0 rspec
$ bundle exec appraisal rails-8-1 rspec

See Release.md

Various tools are used to ensure code is linted and formatted correctly.

RuboCop is a Ruby static code analyzer.

$ rubocop

YARD-Lint is a linter for YARD documentation.

$ bundle exec yard-lint

Yard is used to generate documentation. Online documentation is available

Build the documentation with one of the following

$ yard
$ yard doc

Build the documentation and list all undocumented objects

$ yard stats --list-undoc

1. Fork it (https://github.com/dfrerksen/toller/fork)
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create a new Pull Request

The gem is available as open source under the terms of the MIT License.