From aa39b1e28e79f914ae766a138b78cb6c75e3d6fb Mon Sep 17 00:00:00 2001
From: Yashashvi Dave <yashashvidave@gmail.com>
Date: Sat, 9 Jun 2018 13:07:59 +0530
Subject: [PATCH] custom field: Allow admin to change custom fields order using
 drag & drop.

Using sortablejs library, allow admin to modify custom fields order
in admin settings using drag and drop of custom field list element.

Fixes #9351
---
 .../node_tests/settings_profile_fields.js     |  5 +--
 static/js/settings_profile_fields.js          | 43 ++++++++-----------
 .../admin_profile_field_list.handlebars       |  9 ++--
 3 files changed, 22 insertions(+), 35 deletions(-)

diff --git a/frontend_tests/node_tests/settings_profile_fields.js b/frontend_tests/node_tests/settings_profile_fields.js
index bac5d64fb4..bf377eea54 100644
--- a/frontend_tests/node_tests/settings_profile_fields.js
+++ b/frontend_tests/node_tests/settings_profile_fields.js
@@ -4,6 +4,7 @@ set_global('$', global.make_zjquery());
 set_global('templates', {});
 set_global('page_params', {});
 set_global('loading', {});
+set_global('Sortable', {create: () => {}});
 
 
 const SHORT_TEXT = 1;
@@ -81,8 +82,6 @@ run_test('populate_profile_fields', () => {
                 is_choice_field: false,
             },
             can_modify: true,
-            first: true,
-            last: false,
         },
         {
             profile_field: {
@@ -97,8 +96,6 @@ run_test('populate_profile_fields', () => {
                 is_choice_field: true,
             },
             can_modify: true,
-            first: false,
-            last: true,
         },
     ];
 
diff --git a/static/js/settings_profile_fields.js b/static/js/settings_profile_fields.js
index b9607c8c39..c6dad3b3eb 100644
--- a/static/js/settings_profile_fields.js
+++ b/static/js/settings_profile_fields.js
@@ -85,26 +85,6 @@ function delete_choice_row(e) {
     row.remove();
 }
 
-function move_field(e, btn, direction) {
-    e.preventDefault();
-    e.stopPropagation();
-    var button_id = parseInt(btn.attr('data-profile-field-id'), 10);
-    var button_index = order.indexOf(button_id);
-    order[button_index] = order[button_index + direction];
-    order[button_index + direction] = button_id;
-    settings_ui.do_settings_change(channel.patch, "/json/realm/profile_fields",
-                                   {order: JSON.stringify(order)},
-                                   $('#admin-profile-field-status').expectOne());
-}
-
-function move_field_up(e) {
-    move_field(e, $(this), -1);
-}
-
-function move_field_down(e) {
-    move_field(e, $(this), 1);
-}
-
 function get_profile_field_info(id) {
     var info = {};
     info.row = $("tr.profile-field-row[data-profile-field-id='" + id + "']");
@@ -166,6 +146,16 @@ exports.reset = function () {
     meta.loaded = false;
 };
 
+function update_field_order() {
+    order = [];
+    $('.profile-field-row').each(function () {
+        order.push(parseInt($(this).attr('data-profile-field-id'), 10));
+    });
+    settings_ui.do_settings_change(channel.patch, "/json/realm/profile_fields",
+                                   {order: JSON.stringify(order)},
+                                   $('#admin-profile-field-status').expectOne());
+}
+
 exports.populate_profile_fields = function (profile_fields_data) {
     if (!meta.loaded) {
         // If outside callers call us when we're not loaded, just
@@ -178,10 +168,11 @@ exports.populate_profile_fields = function (profile_fields_data) {
 exports.do_populate_profile_fields = function (profile_fields_data) {
     // We should only call this internally or from tests.
     var profile_fields_table = $("#admin_profile_fields_table").expectOne();
+
     profile_fields_table.find("tr.profile-field-row").remove();  // Clear all rows.
     profile_fields_table.find("tr.profile-field-form").remove();  // Clear all rows.
     order = [];
-    _.each(profile_fields_data, function (profile_field, index) {
+    _.each(profile_fields_data, function (profile_field) {
         order.push(profile_field.id);
         var field_data = {};
         if (profile_field.field_data !== "") {
@@ -220,12 +211,16 @@ exports.do_populate_profile_fields = function (profile_fields_data) {
                         is_choice_field: is_choice_field,
                     },
                     can_modify: page_params.is_admin,
-                    first: index === 0,
-                    last: index === _.size(profile_fields_data) - 1,
                 }
             )
         );
     });
+    if (page_params.is_admin) {
+        var field_list = $("#admin_profile_fields_table")[0];
+        Sortable.create(field_list, {
+            onUpdate: update_field_order,
+        });
+    }
     loading.destroy_indicator($('#admin_page_profile_fields_loading_indicator'));
 };
 
@@ -260,8 +255,6 @@ exports.set_up = function () {
     $('#admin_profile_fields_table').on('click', '.delete', delete_profile_field);
     $(".organization").on("submit", "form.admin-profile-field-form", create_profile_field);
     $("#admin_profile_fields_table").on("click", ".open-edit-form", open_edit_form);
-    $("#admin_profile_fields_table").on("click", ".move-field-up", move_field_up);
-    $("#admin_profile_fields_table").on("click", ".move-field-down", move_field_down);
     set_up_choices_field();
 };
 
diff --git a/static/templates/admin_profile_field_list.handlebars b/static/templates/admin_profile_field_list.handlebars
index d7b9bc49c2..4b9f33eca6 100644
--- a/static/templates/admin_profile_field_list.handlebars
+++ b/static/templates/admin_profile_field_list.handlebars
@@ -1,6 +1,9 @@
 {{#with profile_field}}
 <tr class="profile-field-row" data-profile-field-id="{{id}}">
     <td>
+        {{#if ../can_modify}}
+        <i class="fa fa-sort"></i>
+        {{/if}}
         <span class="profile_field_name">{{name}}</span>
     </td>
     <td>
@@ -17,12 +20,6 @@
         <button class="button rounded small btn-warning open-edit-form" title="{{t 'Edit' }}" data-profile-field-id="{{id}}">
             <i class="icon-vector-pencil"></i>
         </button>
-        <button class="button rounded small btn-warning move-field-up" {{#if ../first}}disabled="disabled"{{/if}} title="{{t 'Up' }}" data-profile-field-id="{{id}}">
-            <i class="icon-vector-chevron-up"></i>
-        </button>
-        <button class="button rounded small btn-warning move-field-down" {{#if ../last}}disabled="disabled"{{/if}} title="{{t 'Down' }}" data-profile-field-id="{{id}}">
-            <i class="icon-vector-chevron-down"></i>
-        </button>
     </td>
     {{/if}}
 </tr>