Enhances Rails with database-backed ordered sorting via controllers, models, and views.
Table of Contents
- Code of Conduct
- Enables models to be sortable.
- Adds view helpers and jQuery UI positioning controls with AJAX support.
- Enables controllers to handle sortable resources (i.e. models) and respond to AJAX requests.
For a secure install, type the following from the command line (recommended):
gem cert --add <(curl -Ls https://www.alchemists.io/gem-public.pem) gem install sorter --trust-policy MediumSecurity
NOTE: A HighSecurity trust policy would be best but MediumSecurity enables signed gem verification while allowing the installation of unsigned dependencies since they are beyond the scope of this gem.
For an insecure install, type the following (not recommended):
gem install sorter
Add the following to your Gemfile file:
Add the following to your application.js file:
//= require jquery.sorter
Add the following to your application.css file:
*= require jquery.sorter
For models, add the following:
class Photo < ActiveRecord::Base sorter end
This assumes the column used for storing position information is called "position". If this is not the case, you can change the defaults as follows:
class Photo < ActiveRecord::Base sorter column: :rank end
For controllers, add the following:
class PhotosController < ApplicationController sorter end
This assumes the resource (i.e. model) associated with this controller is call Photo. If this is not the case, you can change the defaults as follows:
class PhotosController < ApplicationController sorter model_class: RecordPhoto end
This will allow you to use the render_position_control helper method which will yield position controls (i.e. drag-n-drop, move to top, move up by one, move down by one, and move to bottom). All changes take place via AJAX calls back to your controller so that changes in your views are reflected back in the database.
To test, run:
bundle exec rake
Read Semantic Versioning for details. Briefly, it means:
- Patch (x.y.Z) - Incremented for small, backwards compatible bug fixes.
- Minor (x.Y.z) - Incremented for new, backwards compatible public API enhancements and/or bug fixes.
- Major (X.y.z) - Incremented for any backwards incompatible public API changes.
Code of Conduct
Please note that this project is released with a CODE OF CONDUCT. By participating in this project you agree to abide by its terms.
Read CONTRIBUTING for details.