Toller

URL based filtering and sorting. See the wiki for usage information.

Installation

Add this line to your application's Gemfile:

gem 'toller'

And then execute:

$ bundle install

Filtering

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

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.

Testing

$ bin/test

Appraisal

$ bundle exec appraisal install
$ bundle exec appraisal rails-5 bin/test
$ bundle exec appraisal rails-6 bin/test

WWTD

Test against the Travis simulator. Note that WWTD needs to be installed (install with gem install wwtd)

$ wwtd

Release

  1. Bump the gem version in lib/toller/version.rb
  2. Build the gem with
   $ bundle exec rake build

This will create a new .gem file in pkg/. Fix any errors or warnings that come up.

  1. Commit the version change to git with a commit message similar to "Release [X.Y.Z]"
  2. Create the gem, tag it in Github and release to Rubygems
   $ bundle exec rake release

Contributing

  1. Fork it (https://github.com/dfrerksen/recieve/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

License

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