{"id":3327,"date":"2018-03-16T11:05:16","date_gmt":"2018-03-16T05:35:16","guid":{"rendered":"https:\/\/www.botreetechnologies.com\/blog\/?p=3327"},"modified":"2022-12-13T16:38:01","modified_gmt":"2022-12-13T11:08:01","slug":"how-to-sort-records-in-custom-order-by-enum-value-in-rails","status":"publish","type":"post","link":"https:\/\/www.botreetechnologies.com\/blog\/how-to-sort-records-in-custom-order-by-enum-value-in-rails\/","title":{"rendered":"Sort Rails Records Using Enum Value"},"content":{"rendered":"\n

Ransack<\/a> empowers rails developers by enabling the creation of simple and advanced search forms in any Ruby on Rails application.<\/p>\n\n\n\n

If we are dealing with simple sort by column then it is very easy to use however if we have Enum but not in the order in which we want to sort is painful.<\/p>\n\n\n\n

Let’s take an example,<\/p>\n\n\n\n

class ClientVisit < ApplicationRecord<\/code><\/p>

enum status: [:inprocess, :completed, :incomplete, :resubmit]<\/code><\/p>

end<\/code><\/p><\/blockquote>\n\n\n\n

Here we have a status enum<\/code><\/i> where the index of each status defined as,<\/p>\n\n\n\n

{ inprocess: 0, completed: 1, incomplete: 2, resubmit: 3 }<\/code><\/p><\/blockquote>\n\n\n\n

Now if you try to sort status column using helper method sort_link<\/b>, it will always sort the data in its enum<\/code><\/i> value order (i.e., 0, 1, 2)<\/p>\n\n\n\n

STATUSES = [:inprocess, :completed, :incomplete]<\/code><\/p>

ClientVisit.where(status: STATUSES).ransack(params[:q]).result<\/code><\/p>

QUERY OUTPUT<\/code><\/p>

SELECT \"client_visits\".* FROM \"client_visits\"<\/code><\/p>

WHERE \"client_visits\".\"status\" IN (0, 1, 3) \"client_visits\".\"status\" ASC<\/code><\/p>

SO<\/code><\/p>

FOR \"ASC\" the order will be => [ 0, 1, 2 ]<\/code><\/p>

FOR \"DESC\" the Order will be => [ 2, 1, 0 ]<\/code><\/p><\/blockquote>\n\n\n\n

Now, if you want to order by status with specific order like sort by status in order:<\/p>\n\n\n\n

1. Completed.<\/p>\n\n\n\n

2. InComplete.<\/p>\n\n\n\n

0. InProcess.<\/p>\n\n\n\n

Now, please note here, we CAN NOT override the default sort. Instead, we can create custom scope and column which will fulfill our requirement.<\/p>\n\n\n\n

First, go to view file and use a custom column name:<\/p>\n\n\n\n

Ex.<\/p>\n\n\n\n

Previous:<\/code><\/p>

<%= sort_link(@q, :status, \"STATUS\", { action: 'client_visit' }, { remote: true }) %><\/code><\/p>

Updated<\/code><\/p>

<%= sort_link(@q, :custom_status, \"STATUS\", { action: 'client_visit' }, { remote: true }) %><\/code><\/p><\/blockquote>\n\n\n\n

Here is a gist of the model with the implementation:<\/p>\n\n\n\n