Send a backgrid:sorted event from Body#sort

Author: wyuenho

lib/backgrid.js

@@ -2491,8 +2491,8 @@ var Body = Backgrid.Body = Backbone.View.extend({
      Backbone.PageableCollection, sorting will be done globally on all the pages
      and the current page will then be returned.
 
-     Triggers a Backbone `backgrid:sort` event from the collection when done
-     with the column, direction, comparator and a reference to the collection.
+     Triggers a Backbone `backgrid:sorted` event from the collection when done
+     with the column, direction and a reference to the collection.
 
      @param {Backgrid.Column} column
      @param {null|"ascending"|"descending"} direction
@@ -2528,16 +2528,23 @@ var Body = Backgrid.Body = Backbone.View.extend({
                             {sortValue: column.sortValue()});
 
       if (collection.fullCollection) {
+        // If order is null, pageable will remove the comparator on both sides,
+        // in this case the default insertion order comparator needs to be
+        // attached to get back to the order before sorting.
         if (collection.fullCollection.comparator == null) {
           collection.fullCollection.comparator = comparator;
         }
         collection.fullCollection.sort();
+        collection.trigger("backgrid:sorted", column, direction, collection);
       }
-      else collection.fetch({reset: true});
+      else collection.fetch({reset: true, success: function () {
+        collection.trigger("backgrid:sorted", column, direction, collection);
+      }});
     }
     else {
       collection.comparator = comparator;
       collection.sort();
+      collection.trigger("backgrid:sorted", column, direction, collection);
     }
 
     column.set("direction", direction);

src/body.js

@@ -241,8 +241,8 @@ var Body = Backgrid.Body = Backbone.View.extend({
      Backbone.PageableCollection, sorting will be done globally on all the pages
      and the current page will then be returned.
 
-     Triggers a Backbone `backgrid:sort` event from the collection when done
-     with the column, direction, comparator and a reference to the collection.
+     Triggers a Backbone `backgrid:sorted` event from the collection when done
+     with the column, direction and a reference to the collection.
 
      @param {Backgrid.Column} column
      @param {null|"ascending"|"descending"} direction
@@ -278,16 +278,23 @@ var Body = Backgrid.Body = Backbone.View.extend({
                             {sortValue: column.sortValue()});
 
       if (collection.fullCollection) {
+        // If order is null, pageable will remove the comparator on both sides,
+        // in this case the default insertion order comparator needs to be
+        // attached to get back to the order before sorting.
         if (collection.fullCollection.comparator == null) {
           collection.fullCollection.comparator = comparator;
         }
         collection.fullCollection.sort();
+        collection.trigger("backgrid:sorted", column, direction, collection);
       }
-      else collection.fetch({reset: true});
+      else collection.fetch({reset: true, success: function () {
+        collection.trigger("backgrid:sorted", column, direction, collection);
+      }});
     }
     else {
       collection.comparator = comparator;
       collection.sort();
+      collection.trigger("backgrid:sorted", column, direction, collection);
     }
 
     column.set("direction", direction);

test/body.js

@@ -334,11 +334,19 @@ describe("A Body", function () {
     expect(body.collection.at(0).get("id")).toBe(1);
     expect(body.collection.at(1).get("id")).toBe(2);
 
+    var onBackgridSortedCallArgs = [];
+    col.on("backgrid:sorted", function () {
+      onBackgridSortedCallArgs.push([].slice.apply(arguments));
+    });
+
     body.collection.trigger("backgrid:sort", body.columns.at(0), "descending");
 
     expect(body.collection.at(0).get("id")).toBe(2);
     expect(body.collection.at(1).get("id")).toBe(1);
     expect(body.columns.at(0).get("direction"), "descending");
+    expect(onBackgridSortedCallArgs.length).toBe(1);
+    expect(onBackgridSortedCallArgs[0][0]).toBe(body.columns.at(0));
+    expect(onBackgridSortedCallArgs[0][1]).toBe("descending");
 
     $.ajax = oldAjax;
   });
@@ -365,31 +373,42 @@ describe("A Body", function () {
 
     body.render();
 
-    col.trigger("backgrid:sort", body.columns.at(0), "ascending");
+    var onBackgridSortedCallArgs = [];
+    col.on("backgrid:sorted", function () {
+      onBackgridSortedCallArgs.push([].slice.apply(arguments));
+    });
 
+    col.trigger("backgrid:sort", body.columns.at(0), "ascending");
     expect(body.collection.toJSON()).toEqual([{id: 3}]);
     expect(body.columns.at(0).get("direction"), "ascending");
+    expect(onBackgridSortedCallArgs.length).toBe(1);
+    expect(onBackgridSortedCallArgs[0][0]).toBe(body.columns.at(0));
+    expect(onBackgridSortedCallArgs[0][1]).toBe("ascending");
+    expect(onBackgridSortedCallArgs[0][2]).toBe(col);
 
     body.collection.getPage(2);
-
     expect(body.collection.toJSON()).toEqual([{id: 2}]);
 
     body.collection.getPage(3);
-
     expect(body.collection.toJSON()).toEqual([{id: 1}]);
 
     body.collection.getFirstPage();
 
     col.trigger("backgrid:sort", body.columns.at(0), "descending");
     expect(body.columns.at(0).get("direction"), "descending");
-
     expect(body.collection.toJSON()).toEqual([{id: 1}]);
+    expect(onBackgridSortedCallArgs.length).toBe(2);
+    expect(onBackgridSortedCallArgs[1][0]).toBe(body.columns.at(0));
+    expect(onBackgridSortedCallArgs[1][1]).toBe("descending");
+    expect(onBackgridSortedCallArgs[1][2]).toBe(col);
 
     col.trigger("backgrid:sort", body.columns.at(0), null);
     expect(body.columns.at(0).get("direction"), null);
-
     expect(body.collection.toJSON()).toEqual([{id: 2}]);
-
+    expect(onBackgridSortedCallArgs.length).toBe(3);
+    expect(onBackgridSortedCallArgs[2][0]).toBe(body.columns.at(0));
+    expect(onBackgridSortedCallArgs[2][1]).toBe(null);
+    expect(onBackgridSortedCallArgs[2][2]).toBe(col);
   });
 
   it("will put the next editable and renderable cell in edit mode when a save or one of the navigation commands is triggered via backgrid:edited from the collection", function () {