GUAC-1140: Add class which allows easy dynamic reordering of the sorting predicate used by the orderBy filter.

guacamole/src/main/webapp/app/manage/types/StableSort.js

@@ -0,0 +1,115 @@
+/*
+ * Copyright (C) 2015 Glyptodon LLC
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+/**
+ * A service for defining the StableSort class.
+ */
+angular.module('manage').factory('StableSort', [
+    function defineStableSort() {
+
+    /**
+     * Maintains a sorting predicate as required by the Angular orderBy filter.
+     * The order of properties sorted by the predicate can be altered while
+     * otherwise maintaining the sort order.
+     *
+     * @constructor
+     * @param {String[]} predicate
+     *     The properties to sort by, in order of precidence.
+     */
+    var StableSort = function StableSort(predicate) {
+
+        /**
+         * Reference to this instance.
+         *
+         * @type StableSort
+         */
+        var stableSort = this;
+
+        /**
+         * The current sorting predicate.
+         *
+         * @type String[]
+         */
+        this.predicate = predicate;
+
+        /**
+         * The name of the highest-precedence sorting property.
+         *
+         * @type String
+         */
+        this.primary = predicate[0];
+
+        /**
+         * Whether the highest-precedence sorting property is sorted in
+         * descending order.
+         *
+         * @type Boolean
+         */
+        this.descending = false;
+
+        // Handle initially-descending primary properties
+        if (this.primary.charAt(0) === '-') {
+            this.primary = this.primary.substring(1);
+            this.descending = true;
+        }
+
+        /**
+         * Reorders the currently-defined predicate such that the named
+         * property takes precidence over all others. The property will be
+         * sorted in ascending order unless otherwise specified.
+         *
+         * @param {String} name
+         *     The name of the property to reorder by.
+         *
+         * @param {Boolean} [descending=false]
+         *     Whether the property should be sorted in descending order. By
+         *     default, all properties are sorted in ascending order.
+         */
+        this.reorder = function reorder(name, descending) {
+
+            // Build ascending and descending predicate components
+            var ascendingName  = name;
+            var descendingName = '-' + name;
+
+            // Remove requested property from current predicate
+            stableSort.predicate = stableSort.predicate.filter(function notRequestedProperty(current) {
+                return current !== ascendingName
+                    && current !== descendingName;
+            });
+
+            // Add property to beginning of predicate
+            if (descending)
+                stableSort.predicate.unshift(descendingName);
+            else
+                stableSort.predicate.unshift(ascendingName);
+
+            // Update sorted state
+            stableSort.primary    = name;
+            stableSort.descending = !!descending;
+
+        };
+
+    };
+
+    return StableSort;
+
+}]);