Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Enhances Rails with database-backed ordered sorting.
Ruby
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
gemfiles
lib
spec
vendor/assets
.gitignore
.ruby-version
.travis.yml
CHANGELOG.md
CODE_OF_CONDUCT.md
CONTRIBUTING.md
Gemfile
Gemfile.lock
Guardfile
LICENSE.md
README.md
Rakefile
sorter.gemspec

README.md

Sorter

Gem Version Code Climate GPA Code Climate Coverage Gemnasium Status Travis CI Status

Enhances Rails with database-backed ordered sorting via controllers, models, and views.

Table of Contents

Features

  • 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.
  • Provides JavaScript and CSS Rails Engine assets.

Requirements

  1. MRI 2.x.x.
  2. Ruby on Rails 4.x.x.

Setup

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:

gem "sorter"

Add the following to your application.js file:

//= require jquery.sorter

Add the following to your application.css file:

*= require jquery.sorter

Usage

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

The JavaScript code can be enabled via any .js file as follows:

$.sorter();

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.

Tests

To test, run:

bundle exec rspec spec

Versioning

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.

Contributions

Read CONTRIBUTING for details.

License

Copyright (c) 2011 Alchemists. Read the LICENSE for details.

History

Read the CHANGELOG for details. Built with Gemsmith.

Credits

Developed by Brooke Kuhlmann at Alchemists

Something went wrong with that request. Please try again.