all_sorts

All Sorts

A DSL for sorting active record results based on hash keys with the term sort in them.

Installation

Bundler

gem 'all_sorts'

Other

gem install all_sorts

Usage

All Sorts was originally developed to fill the need of being able to sort by one or multiple columns passed in the URL, however it works with ActiveRecord and basically takes in a hash. Included as a concern, this gem adds a ".sort" method to ActiveRecord which basically does some clever stuff by looking at the hash keys, creates a string by which to sort results, and calls ".order" with that string.

It also adds a ".sortable_fields" method for you to limit by which fields the records may be ordered.

Globally

Adds .sort, .sortable_fields methods to all of you models Somewhere in your apps bootstrap/startup code:

ActiveRecord::Base.include(AllSorts)

Locally (in a model)

Adds .sort, .sortable_fields methods to only the User model

class User < ActiveRecord::Base
	include AllSorts
end

URL Examples

• http://whatever.com/wherever/?sort_name=asc
• http://whatever.com/wherever/?sort_1_name=asc
• http://whatever.com/wherever/?sort_1_name=asc&sort_2_salary=desc

Model

In the model you can limit which fields are sortable. This is optional. If this isn't in your model, all fields are sortable.

class User < ActiveRecord::Base
  sortable_fields :name, :salary
end

Active Record Calls

Using with all the "params" from the URL (usual usage)

users = User.sort(params).all

Example of how it just takes in a Hash

#GIVEN THE DATA IN THE DB IS AS FOLLOWS:
adam:
  id: 1
  name: Adam
  salary: 80000
  bonus: true

dave1:
  id: 2
  name: Dave
  salary: 9000
  bonus: true

dave2:
  id: 3
  name: Dave
  salary: 70000
  bonus: true

admin:
  id: 12
  name: admin
  salary: 10000
  bonus: false

goofy:
  id: 13
  name: Goofy
  salary: 11000
  bonus: false

#THE CALL
users = User.sort({'sort_1_name' => 'asc', 'sort_2_salary' => 'desc'}).all

#RESULTS
[#<User id: 1, name: "Adam", salary: 80000, bonus: true, created_at: "2011-06-08 15:30:06", updated_at: "2011-06-08 15:30:06">,
#<User id: 3, name: "Dave", salary: 70000, bonus: true, created_at: "2011-06-08 15:30:06", updated_at: "2011-06-08 15:30:06">,
#<User id: 2, name: "Dave", salary: 9000, bonus: true, created_at: "2011-06-08 15:30:06", updated_at: "2011-06-08 15:30:06">,
#<User id: 13, name: "Goofy", salary: 11000, bonus: false, created_at: "2011-06-08 15:30:06", updated_at: "2011-06-08 15:30:06">, 
#<User id: 12, name: "admin", salary: 10000, bonus: false, created_at: "2011-06-08 15:30:06", updated_at: "2011-06-08 15:30:06">]