Fix #426. Calling Grid#sort will now correctly reset the directions of the columns not being sorted on.

Author: wyuenho

lib/backgrid.js

@@ -2069,26 +2069,23 @@ var HeaderCell = Backgrid.HeaderCell = Backbone.View.extend({
                       }
                     }
                   });
-    this.listenTo(column, "change:direction", this.setCellDirectionMaybe);
+    this.listenTo(column, "change:direction", this.setCellDirection);
     this.listenTo(column, "change:name change:label", this.render);
 
     if (Backgrid.callByNeed(column.editable(), column, collection)) $el.addClass("editable");
     if (Backgrid.callByNeed(column.sortable(), column, collection)) $el.addClass("sortable");
     if (Backgrid.callByNeed(column.renderable(), column, collection)) $el.addClass("renderable");
 
-    this.listenTo(collection, "backgrid:sort", this.removeCellDirectionMaybe);
+    this.listenTo(collection, "sort", this.removeCellDirection);
   },
 
   /**
-     Event handler for the collection's `backgrid:sort` event. Removes all the
-     CSS direction classes if the column being sorted on is not the same as this
-     header cell's.
+     Event handler for the collection's `sort` event. Removes all the CSS
+     direction classes.
    */
-  removeCellDirectionMaybe: function (columnToSort) {
-    if (columnToSort.cid != this.column.cid) {
-      this.$el.removeClass("ascending").removeClass("descending");
-      this.column.set("direction", null);
-    }
+  removeCellDirection: function () {
+    this.$el.removeClass("ascending").removeClass("descending");
+    this.column.set("direction", null);
   },
 
   /**
@@ -2097,9 +2094,9 @@ var HeaderCell = Backgrid.HeaderCell = Backbone.View.extend({
      CSS class to the header cell. Removes all the CSS direction classes
      otherwise.
    */
-  setCellDirectionMaybe: function (columnToSort, direction) {
+  setCellDirection: function (column, direction) {
     this.$el.removeClass("ascending").removeClass("descending");
-    if (columnToSort.cid == this.column.cid) this.$el.addClass(direction);
+    if (column.cid == this.column.cid) this.$el.addClass(direction);
   },
 
   /**

src/header.js

@@ -49,26 +49,23 @@ var HeaderCell = Backgrid.HeaderCell = Backbone.View.extend({
                       }
                     }
                   });
-    this.listenTo(column, "change:direction", this.setCellDirectionMaybe);
+    this.listenTo(column, "change:direction", this.setCellDirection);
     this.listenTo(column, "change:name change:label", this.render);
 
     if (Backgrid.callByNeed(column.editable(), column, collection)) $el.addClass("editable");
     if (Backgrid.callByNeed(column.sortable(), column, collection)) $el.addClass("sortable");
     if (Backgrid.callByNeed(column.renderable(), column, collection)) $el.addClass("renderable");
 
-    this.listenTo(collection, "backgrid:sort", this.removeCellDirectionMaybe);
+    this.listenTo(collection, "sort", this.removeCellDirection);
   },
 
   /**
-     Event handler for the collection's `backgrid:sort` event. Removes all the
-     CSS direction classes if the column being sorted on is not the same as this
-     header cell's.
+     Event handler for the collection's `sort` event. Removes all the CSS
+     direction classes.
    */
-  removeCellDirectionMaybe: function (columnToSort) {
-    if (columnToSort.cid != this.column.cid) {
-      this.$el.removeClass("ascending").removeClass("descending");
-      this.column.set("direction", null);
-    }
+  removeCellDirection: function () {
+    this.$el.removeClass("ascending").removeClass("descending");
+    this.column.set("direction", null);
   },
 
   /**
@@ -77,9 +74,9 @@ var HeaderCell = Backgrid.HeaderCell = Backbone.View.extend({
      CSS class to the header cell. Removes all the CSS direction classes
      otherwise.
    */
-  setCellDirectionMaybe: function (columnToSort, direction) {
+  setCellDirection: function (column, direction) {
     this.$el.removeClass("ascending").removeClass("descending");
-    if (columnToSort.cid == this.column.cid) this.$el.addClass(direction);
+    if (column.cid == this.column.cid) this.$el.addClass(direction);
   },
 
   /**

test/header.js

@@ -190,12 +190,10 @@ describe("A HeaderCell", function () {
     expect(cell.$el.hasClass("descending")).toBe(false);
   });
 
-  it("will remove its direction CSS class if `backgrid:sort` is triggered with a different column", function () {
+  it("will remove its direction CSS class if `sort` is triggered", function () {
     cell.column.set("direction", "ascending");
-    cell.collection.trigger("backgrid:sort", new Backgrid.Column({
-      name: "name",
-      cell: "string"
-    }), "descending");
+    cell.collection.comparator = "id";
+    cell.collection.sort();
     expect(cell.$el.hasClass("ascending")).toBe(false);
     expect(cell.$el.hasClass("descending")).toBe(false);
   });