Add :sort filter run prefix (#5653)

* Add :sort filter run prefix, docs and tests. Also extended .utils.makeCompareFunction with a flag for caseSensitivity.

* Documentation updates

* Move case sensitivity handling entirely to utils method so it is reusable

core/modules/filterrunprefixes/sort.js

@@ -0,0 +1,58 @@
+/*\
+title: $:/core/modules/filterrunprefixes/sort.js
+type: application/javascript
+module-type: filterrunprefix
+
+\*/
+(function(){
+
+/*jslint node: true, browser: true */
+/*global $tw: false */
+"use strict";
+
+/*
+Export our filter prefix function
+*/
+exports.sort = function(operationSubFunction,options) {
+	return function(results,source,widget) {
+		if(results.length > 0) {
+			var suffixes = options.suffixes,
+				sortType = (suffixes[0] && suffixes[0][0]) ? suffixes[0][0] : "string",
+				invert = suffixes[1] ? (suffixes[1].indexOf("reverse") !== -1) : false,
+				isCaseSensitive = suffixes[1] ? (suffixes[1].indexOf("casesensitive") !== -1) : false,
+				inputTitles = results.toArray(),
+				sortKeys = [],
+				indexes = new Array(inputTitles.length),
+				compareFn;	
+			results.each(function(title) {
+				var key = operationSubFunction(options.wiki.makeTiddlerIterator([title]),{
+						getVariable: function(name) {
+							switch(name) {
+								case "currentTiddler":
+									return "" + title;
+								default:
+									return widget.getVariable(name);
+							}
+						}
+					});
+				sortKeys.push(key[0] || "");
+			});
+			results.clear();
+			// Prepare an array of indexes to sort
+			for(var t=0; t<inputTitles.length; t++) {
+				indexes[t] = t;
+			}
+			// Sort the indexes
+			compareFn = $tw.utils.makeCompareFunction(sortType,{defaultType: "string", invert:invert, isCaseSensitive:isCaseSensitive});
+			indexes = indexes.sort(function(a,b) {
+					return compareFn(sortKeys[a],sortKeys[b]);
+			});
+			// Add to results in correct order
+			$tw.utils.each(indexes,function(index) {
+				results.push(inputTitles[index]);
+			});
+		}
+	}
+};
+
+})();

core/modules/utils/utils.js

@@ -876,7 +876,9 @@ exports.stringifyNumber = function(num) {
 
 exports.makeCompareFunction = function(type,options) {
 	options = options || {};
-	var gt = options.invert ? -1 : +1,
+	// set isCaseSensitive to true if not defined in options
+	var isCaseSensitive = (options.isCaseSensitive === false) ? false : true,
+		gt = options.invert ? -1 : +1,
 		lt = options.invert ? +1 : -1,
 		compare = function(a,b) {
 			if(a > b) {
@@ -895,7 +897,11 @@ exports.makeCompareFunction = function(type,options) {
 				return compare($tw.utils.parseInt(a),$tw.utils.parseInt(b));
 			},
 			"string": function(a,b) {
-				return compare("" + a,"" +b);
+				if(!isCaseSensitive) {
+					a = a.toLowerCase();
+					b = b.toLowerCase();
+				}
+				return compare("" + a,"" + b);
 			},
 			"date": function(a,b) {
 				var dateA = $tw.utils.parseDate(a),
@@ -910,6 +916,13 @@ exports.makeCompareFunction = function(type,options) {
 			},
 			"version": function(a,b) {
 				return $tw.utils.compareVersions(a,b);
+			},
+			"alphanumeric": function(a,b) {
+				if(!isCaseSensitive) {
+					a = a.toLowerCase();
+					b = b.toLowerCase();
+				}
+				return options.invert ? b.localeCompare(a,undefined,{numeric: true,sensitivity: "base"}) : a.localeCompare(b,undefined,{numeric: true,sensitivity: "base"});
 			}
 		};
 	return (types[type] || types[options.defaultType] || types.number);