feat(core utils): Add is_option_truthy to check Pattern options for a truthy value.

A values "undefined", "null", "false", "none" or "" are considered falsy
and can be used to disable some functionality. Other values including
"0" are considered to be true.

Author: thet

src/core/utils.js

@@ -756,6 +756,36 @@ const threshold_list = (num_steps = 0) => {
     return thresholds.sort();
 };
 
+/**
+ * is_option_truthy - Check if an Pattern option is set.
+ *
+ * An option is set if it is not one of:
+ * - undefined
+ * - null
+ * - "none"
+ * - ""
+ *
+ * @param {String} option - The option to check.
+ *
+ * @returns {Boolean} - Returns true if the option is set, false otherwise.
+ *
+ * @example
+ *
+ * is_option_truthy() // false
+ * is_option_truthy(undefined) // false
+ * is_option_truthy(null) // false
+ * is_option_truthy("") // false
+ * is_option_truthy("none") // false
+ * is_option_truthy("false") // false
+ * is_option_truthy("foo") // true
+ * is_option_truthy(true) // true
+ * is_option_truthy(0) // true
+ *
+ */
+const is_option_truthy = (option) => {
+    return ![undefined, null, "none", false, "false", ""].includes(option);
+};
+
 var utils = {
     jqueryPlugin: jqueryPlugin,
     escapeRegExp: escapeRegExp,
@@ -789,6 +819,7 @@ var utils = {
     is_iso_date: is_iso_date,
     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.
 };
 

src/core/utils.test.js

@@ -899,3 +899,24 @@ describe("threshold_list ...", function () {
         ]);
     });
 });
+
+describe("is_option_truthy ...", function () {
+    it("checks if an option is set", () => {
+        // These options are considered truthy
+        expect(utils.is_option_truthy("a")).toBe(true);
+        expect(utils.is_option_truthy(true)).toBe(true);
+        expect(utils.is_option_truthy("true")).toBe(true);
+        expect(utils.is_option_truthy(1)).toBe(true);
+        // Also "0" is considered truthy because it can be a valid option for
+        // length, time and so forth.
+        expect(utils.is_option_truthy(0)).toBe(true);
+
+        // These options are considered falsy
+        expect(utils.is_option_truthy(undefined)).toBe(false);
+        expect(utils.is_option_truthy(null)).toBe(false);
+        expect(utils.is_option_truthy(false)).toBe(false);
+        expect(utils.is_option_truthy("false")).toBe(false);
+        expect(utils.is_option_truthy("none")).toBe(false);
+        expect(utils.is_option_truthy("")).toBe(false);
+    });
+});