feat(core utils): regexp_from_wildcard - Create regular expressions from wildcard strings.

This utility can be used for search strings with wildcards like "test-*-xyz".
The wildcard can be at the beginning, somewhere in the middle or at the
end and multiple wildcards can be used.
This method was factored out from removeWildcardClass for broader usage.

Author: thet

src/core/utils.js

@@ -175,6 +175,23 @@ function escapeRegExp(str) {
     return str.replace(/[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g, "\\$&");
 }
 
+/**
+ * Create a RegExp object of a wildcard search string.
+ *
+ * @param {string} wildcard: A search string which can contain wildcards "*".
+ *                           The wildcard "*" can be anywhere in the string and
+ *                           can also be used multiple times. If no wildcard is
+ *                           present the search string is used for an exact match.
+
+ * @returns {RegExp}: A RegExp object which can be used to match strings.
+ */
+function regexp_from_wildcard(wildcard) {
+    let regexp = wildcard.replace(/[\-\[\]{}()+?.,\\\^$|#\s]/g, "\\$&");
+    regexp = regexp.replace(/[*]/g, ".*");
+    regexp = new RegExp(`^${regexp}$`);
+    return regexp;
+}
+
 /**
  * Remove classes from a list of targets if they match a specific pattern.
  *
@@ -193,10 +210,7 @@ function removeWildcardClass(targets, classes) {
             target.classList.remove(classes);
         }
     } else {
-        let matcher = classes.replace(/[\-\[\]{}()+?.,\\\^$|#\s]/g, "\\$&");
-        matcher = matcher.replace(/[*]/g, ".*");
-        matcher = new RegExp("^" + matcher + "$");
-
+        const matcher = regexp_from_wildcard(classes);
         for (const target of targets) {
             const class_list = (target.getAttribute("class") || "").split(/\s+/);
             if (!class_list.length) {
@@ -780,6 +794,7 @@ var utils = {
     isObject: isObject,
     extend: extend,
     findLabel: findLabel,
+    regexp_from_wildcard: regexp_from_wildcard,
     removeWildcardClass: removeWildcardClass,
     hideOrShow: hideOrShow,
     addURLQueryParameter: addURLQueryParameter,
@@ -807,7 +822,7 @@ var utils = {
     date_diff: date_diff,
     threshold_list: threshold_list,
     is_option_truthy: is_option_truthy,
-    getCSSValue: dom.get_css_value, // BBB: moved to dom. TODO: Remove in upcoming version.
+    //getCSSValue: dom.get_css_value, // BBB: moved to dom. TODO: Remove in upcoming version.
     elementInViewport: (el) => {
         // BBB: Remove with next major version.
         console.warn("Deprecated. Use utils.isElementInViewport");

src/core/utils.test.js

@@ -161,6 +161,29 @@ describe("basic tests", function () {
     });
 });
 
+describe("regexp_from_wildcard", function () {
+    it("creates regular expressions from wildcard strings", function () {
+        let regex = utils.regexp_from_wildcard("test-*-tset");
+        expect(regex.test("test-abcd-defg-tset")).toBe(true);
+        expect(regex.test("tset-abcd-defg-test")).toBe(false);
+
+        regex = utils.regexp_from_wildcard("*-test");
+        expect(regex.test("abdc-test")).toBe(true);
+        expect(regex.test("abdc-wxyz")).toBe(false);
+
+        regex = utils.regexp_from_wildcard("test-*");
+        expect(regex.test("test-abcd")).toBe(true);
+        expect(regex.test("abdc-wxyz")).toBe(false);
+
+        regex = utils.regexp_from_wildcard("*-test-*");
+        expect(regex.test("abcd-test-wxyz")).toBe(true);
+        expect(regex.test("abcd-efgh-wxyz")).toBe(false);
+
+        regex = utils.regexp_from_wildcard("*");
+        expect(regex.test("abcd")).toBe(true);
+    });
+});
+
 describe("removeWildcardClass", function () {
     describe("... with single element", function () {
         it("Remove basic class", function () {