Deprecate and simplify some utility functions (#9251)

* Deprecate some utility functions

* Drop IE support

* Update two function

* Update comment

* Further simplify with arrow function

* Fix node error

* Deprecate logTable

* Deprecate class functions

* Attempt to fix error

* Deprecate two functions

* Remove deprecation for getLocationPath

* Deprecate stringifyNumber, domContains, domMatchesSelector

* Deprecate $tw.utils.each

* Revert "Deprecate $tw.utils.each"

This reverts commit 650df1d575.

* Simplify getFullScreenApis

* Replace LLMap with Map

* Revert "Replace LLMap with Map"

This reverts commit 4410ac194a.

* Move some deprecated functions to deprecated.js

* Remove Opera & MS prefix

* Deprecate getLocationPath

* Fix code style

* Revert "Remove Opera & MS prefix"

This reverts commit e5771c00be.

* Revert "Simplify getFullScreenApis"

This reverts commit 894cb479ea.

* Further simplify toggleClass

* Second attempt to simplify $tw.utils.each

* Revert "Second attempt to simplify $tw.utils.each"

This reverts commit 74cb4f766e.

* Third attempt to simplify $tw.utils.each

* Add missing comma

* Update comments

* Deprecate hopArray

Since it is easy to implement it with some method

* Update change notes

* Deprecate tagToCssSelector

Since tc-tagged-* classes are deprecated

core/modules/utils/deprecated.js

@@ -0,0 +1,58 @@
+/*\
+title: $:/core/modules/utils/deprecated.js
+type: application/javascript
+module-type: utils
+
+Deprecated util functions
+
+\*/
+
+exports.logTable = data => console.table(data);
+
+exports.repeat = (str,count) => str.repeat(count);
+
+exports.startsWith = (str,search) => str.startsWith(search);
+
+exports.endsWith = (str,search) => str.endsWith(search);
+
+exports.trim = function(str) {
+	if(typeof str === "string") {
+		return str.trim();
+	} else {
+		return str;
+	}
+};
+
+exports.hopArray = (object,array) => array.some(element => $tw.utils.hop(object,element));
+
+exports.sign = Math.sign;
+
+exports.strEndsWith = (str,ending,position) => str.endsWith(ending,position);
+
+exports.stringifyNumber = num => num.toString();
+
+exports.tagToCssSelector = function(tagName) {
+	return "tc-tagged-" + encodeURIComponent(tagName).replace(/[!"#$%&'()*+,\-./:;<=>?@[\\\]^`{\|}~,]/mg,function(c) {
+		return "\\" + c;
+	});
+};
+
+exports.domContains = (a,b) => a.compareDocumentPosition(b) & 16;
+
+exports.domMatchesSelector = (node,selector) => node.matches(selector);
+
+exports.hasClass = (el,className) => el.classList && el.classList.contains(className);
+
+exports.addClass = function(el,className) {
+	el.classList && el.classList.add(className);
+};
+
+exports.removeClass = function(el,className) {
+	el.classList && el.classList.remove(className);
+};
+
+exports.toggleClass = function(el,className,status) {
+	el.classList && el.classList.toggle(className, status);
+};
+
+exports.getLocationPath = () => window.location.origin + window.location.pathname;

core/modules/utils/dom/dom.js

@@ -11,19 +11,6 @@ Various static DOM-related utility functions.
 
 var Popup = require("$:/core/modules/utils/dom/popup.js");
 
-/*
-Determines whether element 'a' contains element 'b'
-Code thanks to John Resig, http://ejohn.org/blog/comparing-document-position/
-*/
-exports.domContains = function(a,b) {
-	return a.contains ?
-		a !== b && a.contains(b) :
-		!!(a.compareDocumentPosition(b) & 16);
-};
-
-exports.domMatchesSelector = function(node,selector) {
-	return node.matches ? node.matches(selector) : node.msMatchesSelector(selector);
-};
 
 /*
 Select text in a an input or textarea (setSelectionRange crashes on certain input types)
@@ -49,38 +36,6 @@ exports.removeChildren = function(node) {
 	}
 };
 
-exports.hasClass = function(el,className) {
-	return el && el.hasAttribute && el.hasAttribute("class") && el.getAttribute("class").split(" ").indexOf(className) !== -1;
-};
-
-exports.addClass = function(el,className) {
-	var c = (el.getAttribute("class") || "").split(" ");
-	if(c.indexOf(className) === -1) {
-		c.push(className);
-		el.setAttribute("class",c.join(" "));
-	}
-};
-
-exports.removeClass = function(el,className) {
-	var c = (el.getAttribute("class") || "").split(" "),
-		p = c.indexOf(className);
-	if(p !== -1) {
-		c.splice(p,1);
-		el.setAttribute("class",c.join(" "));
-	}
-};
-
-exports.toggleClass = function(el,className,status) {
-	if(status === undefined) {
-		status = !exports.hasClass(el,className);
-	}
-	if(status) {
-		exports.addClass(el,className);
-	} else {
-		exports.removeClass(el,className);
-	}
-};
-
 /*
 Get the first parent element that has scrollbars or use the body as fallback.
 */
@@ -297,10 +252,6 @@ exports.copyToClipboard = function(text,options) {
 	document.body.removeChild(textArea);
 };
 
-exports.getLocationPath = function() {
-	return window.location.toString().split("#")[0];
-};
-
 /*
 Collect DOM variables
 */

core/modules/utils/utils.js

@@ -48,31 +48,6 @@ exports.warning = function(text) {
 	exports.log(text,"brown/orange");
 };
 
-/*
-Log a table of name: value or name: [values...] pairs
-*/
-exports.logTable = function(data) {
-	var hasArrays = false;
-	$tw.utils.each(data,function(value,name) {
-		if($tw.utils.isArray(value)) {
-			hasArrays = true;
-		}
-	});
-	if(console.table && !hasArrays) {
-		console.table(data);
-	} else {
-		$tw.utils.each(data,function(value,name) {
-			if($tw.utils.isArray(value)) {
-				for(var t=0; t<value.length; t++) {
-					console.log(`${name}[${t}]: ${value[t]}`);
-				}
-			} else {
-				console.log(`${name}: ${value}`);
-			}
-		});
-	}
-}
-
 /*
 Return the integer represented by the str (string).
 Return the dflt (default) parameter if str is not a base-10 number.
@@ -91,43 +66,6 @@ exports.replaceString = function(text,search,replace) {
 	});
 };
 
-/*
-Repeats a string
-*/
-exports.repeat = function(str,count) {
-	var result = "";
-	for(var t=0;t<count;t++) {
-		result += str;
-	}
-	return result;
-};
-
-/*
-Check if a string starts with another string
-*/
-exports.startsWith = function(str,search) {
-	return str.substring(0, search.length) === search;
-};
-
-/*
-Check if a string ends with another string
-*/
-exports.endsWith = function(str,search) {
-	return str.substring(str.length - search.length) === search;
-};
-
-/*
-Trim whitespace from the start and end of a string
-Thanks to Steven Levithan, http://blog.stevenlevithan.com/archives/faster-trim-javascript
-*/
-exports.trim = function(str) {
-	if(typeof str === "string") {
-		return str.replace(/^\s\s*/, '').replace(/\s\s*$/, '');
-	} else {
-		return str;
-	}
-};
-
 exports.trimPrefix = function(str,unwanted) {
 	if(typeof str === "string" && typeof unwanted === "string") {
 		if(unwanted === "") {
@@ -212,18 +150,6 @@ exports.count = function(object) {
 	return Object.keys(object || {}).length;
 };
 
-/*
-Determine whether an array-item is an object-property
-*/
-exports.hopArray = function(object,array) {
-	for(var i=0; i<array.length; i++) {
-		if($tw.utils.hop(object,array[i])) {
-			return true;
-		}
-	}
-	return false;
-};
-
 /*
 Remove entries from an array
 	array: array to modify
@@ -952,44 +878,6 @@ exports.makeDataUri = function(text,type,_canonical_uri) {
 	return parts.join("");
 };
 
-/*
-Useful for finding out the fully escaped CSS selector equivalent to a given tag. For example:
-
-$tw.utils.tagToCssSelector("$:/tags/Stylesheet") --> tc-tagged-\%24\%3A\%2Ftags\%2FStylesheet
-*/
-exports.tagToCssSelector = function(tagName) {
-	return "tc-tagged-" + encodeURIComponent(tagName).replace(/[!"#$%&'()*+,\-./:;<=>?@[\\\]^`{\|}~,]/mg,function(c) {
-		return "\\" + c;
-	});
-};
-
-/*
-IE does not have sign function
-*/
-exports.sign = Math.sign || function(x) {
-	x = +x; // convert to a number
-	if(x === 0 || isNaN(x)) {
-		return x;
-	}
-	return x > 0 ? 1 : -1;
-};
-
-/*
-IE does not have an endsWith function
-*/
-exports.strEndsWith = function(str,ending,position) {
-	if(str.endsWith) {
-		return str.endsWith(ending,position);
-	} else {
-		if(typeof position !== 'number' || !isFinite(position) || Math.floor(position) !== position || position > str.length) {
-			position = str.length;
-		}
-		position -= ending.length;
-		var lastIndex = str.indexOf(ending, position);
-		return lastIndex !== -1 && lastIndex === position;
-	}
-};
-
 /*
 Return system information useful for debugging
 */
@@ -1016,10 +904,6 @@ exports.parseInt = function(str) {
 	return parseInt(str,10) || 0;
 };
 
-exports.stringifyNumber = function(num) {
-	return num + "";
-};
-
 exports.makeCompareFunction = function(type,options) {
 	options = options || {};
 	// set isCaseSensitive to true if not defined in options