ActiveSorting

Code Climate Build Status Coverage Status Inline docs security

Allows sorting Rails models using a custom field.

Code Documentation

Requirements

Minimum requirements are:

  1. Rails 4.0.0+
  2. Ruby 2.0.0+

Installation

Add this line to your application's Gemfile:

gem 'activesorting'

And then execute:

$ bundle

Or install it yourself as:

$ gem install activesorting

Usage

Adds sorting support to Rails models.

To sort by a model field position:

class Example < ActiveRecord::Base
  sortable :position
end

You can customize the sorting behavior by passing an options hash. The following keys are supported:

order sorting direction, defaults to :asc step stepping value, defaults to 500 scope scopes, defaults to []

Development

After checking out the repo, run bin/setup to install dependencies. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Please see CONTRIBUTING.md for details.

Credits