stringweaver 1.2.0 → 1.2.2

package/src/genericMethods.js

@@ -29,20 +29,10 @@ function CustomStringConstructor(str, ...args) {
   return Object.freeze(instance);
 }
 
-function clone(instance) {
-  const newInstance = CustomStringConstructor(instance.value);
-  newInstance.history = [...instance.history];
-  return newInstance;
-}
-
 function resolveTemplateString(str, ...args) {
   return str?.raw
-      ? String.raw({ raw: str }, ...args)
-      : getStringValue(str).length ? str : "";
-}
-
-function getStringValue(string) {
-  return string?.value || (string?.constructor === String && string) || ``;
+    ? String.raw({ raw: str }, ...args)
+    : getStringValue(str).length ? str : "";
 }
 
 function checkType(type, item, includeInstances) {
@@ -55,18 +45,44 @@ function isArrayOf(type, value, includeInstances = true) {
   return Array.isArray(value) && value.length > 0 && !value.find(v => checkType(type, v, includeInstances));
 }
 
+function clone(instance) {
+  const newInstance = CustomStringConstructor(instance.value);
+  newInstance.history = [...instance.history];
+  return newInstance;
+}
+
+function getStringValue(string) {
+  return string?.value || (string?.constructor === String && string) || ``;
+}
+
 function isNumber(value) {
   return value?.constructor === Number && !Number.isNaN(value);
 }
 
-function getSWInformation(notChainable) {
-  const firstLines = CustomStringConstructor(decode());
-  const plainValues = {
+function escapeRE(reString, modifiers) {
+  return new RegExp(reString.replace(/\p{S}|\p{P}/gu, a => `\\${a}`), modifiers);
+}
+
+function escape4RE(reString) {
+  return reString.replace(/\p{S}|\p{P}/gu, a => `\\${a}`);
+}
+
+function infoValue(key, infoValue) {
+  return `${key} (${infoValue})`;
+}
+
+function getPlainValues() {
+  return {
     value: `getter/setter`,
     clone: `chainable getter`,
     notEmpty: `chainable getter|undefined`,
     quote: `Object. See [constructor].quoteInfo`,
   };
+}
+
+function getSWInformation(notChainable) {
+  const firstLines = CustomStringConstructor(decode());
+  const plainValues = getPlainValues();
   
   return firstLines.split(/\n/)
     .concat(
@@ -87,18 +103,51 @@ function getSWInformation(notChainable) {
             case isPlainValue: return infoValue(key, plainValues[key]);
             case isNative: return infoValue(key, native);
             case isMethod: return infoValue(key, method);
-            case isGetter: return infoValue(key, getter);
-            default: return infoValue(key, `property`);
-          }
+            case isGetter: return infoValue(key, getter); 
+         }
         }
       )
     );
 }
 
-function infoValue(key, infoValue) {
-  return `${key} (${infoValue})`;
+function decode() {
+  return atob`Rm9yIHRoZSByZWNvcmQ6CltjbV0gY2hhaW5hYmxlIGdldHRlcnMvbWV0aG9kcyBtb2RpZnkgdGhlIGluc3RhbmNlIHN0cmluZwpbY21dIGluZGV4T2Ygb3ZlcnJpZGVzIHJldHVybnMgW3VuZGVmaW5lZF0gaWYgbm90aGluZyB3YXMgZm91bmQgKHNvIG9uZSBjYW4gdXNlIFtsYXN0SV1pbmRleE9mKFtzb21lIHN0cmluZyB2YWx1ZV0pID8/IDAKW2NtXSBpbmNsdWRlcyBpbmZvcm1hdGlvbiBmb3IgY3VzdG9tIG1ldGhvZHMvZ2V0dGVycyBpZiBhcHBsaWNhYmxl`.replace(/\[cm]/g, `\u2714`);
+}
+
+function defineQuotingStyles() {
+  // see https://en.wikipedia.org/wiki/Quotation_mark
+  const quots = {
+    backtick: ["`", "`"],
+    bracket: [`{`, `}`],
+    curlyDoubleInward: [`”`, `“`],
+    curlyDouble: [`“`, `”`],
+    curlyDoubleEqual: [`“`, `“`],
+    curlyLHDouble: [`„`, `”`],
+    curlyLHDoubleInward: [`„`, `“`],
+    curlyLHSingle: [`‚`, `’`],
+    curlyLHSingleInward: [`‚`, `‘`],
+    curlySingle: [`‛`, `’`],
+    curlySingleEqual: [`‛`, `‛`],
+    curlySingleInward: [`’`, `‛`],
+    double: [`"`, `"`],
+    guillemets: [`«`, `»`],
+    guillemetsInward: [`»`, `«`],
+    guillemetsSingle: [`‹`, `›`],
+    guillemetsSingleInward: [`›`, `‹`],
+    single: [`'`, `'`],
+    squareBrackets: [`[`, `]`],
+  };
+  const regExpValues = escape4RE([...new Set(
+    Object.values(quots)
+      .filter(v => Array.isArray(v))
+      .flat())].join(``));
+  quots.re = RegExp(`^[${regExpValues}]|[${regExpValues}]$`, "g");
+
+  return quots;
 }
 
+/* this function is not (directly) tested */
+/* node:coverage disable */
 function createExtendedCTOR(ctor, customMethods) {
   Symbol.toSB = Symbol.for(`toStringBuilder`);
   Object.defineProperty(String.prototype, Symbol.toSB, { 
@@ -123,10 +172,13 @@ function createExtendedCTOR(ctor, customMethods) {
     addCustom: {
       value( { name, method, enumerable = false, isGetter = false } = {} ) {
         if (CustomStringConstructor``[name]) {
-          return console.error(`addCustom: the property "${name}" exists and can not be redefined`);
+          console.error(`addCustom: the property "${name}" exists and can not be redefined`);
+          return `addCustom: the property "${name}" exists and can not be redefined`;
         }
+        
         if (name?.constructor === String && method?.constructor === Function && method.length > 0) {
           customMethods[name] = {method, enumerable, isGetter};
+          return `addCustom: the ${isGetter ? `getter` : `method`} named "${name}" is added`;
         }
       }
     },
@@ -164,52 +216,4 @@ function createExtendedCTOR(ctor, customMethods) {
   
   return ctor;
 }
-
-function escapeRE(reString, modifiers) {
-  return new RegExp(reString.replace(/\p{S}|\p{P}/gu, a => `\\${a}`), modifiers);
-}
-
-function escape4RE(reString) {
-  return reString.replace(/\p{S}|\p{P}/gu, a => `\\${a}`);
-}
-
-function decode() {
-  return atob`Rm9yIHRoZSByZWNvcmQ6CltjbV0gY2hhaW5hYmxlIGdldHRlcnMvbWV0aG9kcyBtb2RpZnkgdGhlIGluc3RhbmNlIHN0cmluZwpbY21dIGluZGV4T2Ygb3ZlcnJpZGVzIHJldHVybnMgW3VuZGVmaW5lZF0gaWYgbm90aGluZyB3YXMgZm91bmQgKHNvIG9uZSBjYW4gdXNlIFtsYXN0SV1pbmRleE9mKFtzb21lIHN0cmluZyB2YWx1ZV0pID8/IDAKW2NtXSBpbmNsdWRlcyBpbmZvcm1hdGlvbiBmb3IgY3VzdG9tIG1ldGhvZHMvZ2V0dGVycyBpZiBhcHBsaWNhYmxl`.replace(/\[cm\]/g, `\u2714`);
-}
-
-function defineQuotingStyles() {
-  // see https://en.wikipedia.org/wiki/Quotation_mark
-  const custom = (start, end) => {
-    start = getStringValue(start);
-    end = getStringValue(end);
-    return [getStringValue(start), end.length ? end  : start]; 
-  } 
-  const quots = {
-    backtick: ["`", "`"],
-    bracket: [`{`, `}`],
-    curlyDoubleInward: [`”`, `“`],
-    curlyDouble: [`“`, `”`],
-    curlyDoubleEqual: [`“`, `“`],
-    curlyLHDouble: [`„`, `”`],
-    curlyLHDoubleInward: [`„`, `“`],
-    curlyLHSingle: [`‚`, `’`],
-    curlyLHSingleInward: [`‚`, `‘`],
-    curlySingle: [`‛`, `’`],
-    curlySingleEqual: [`‛`, `‛`],
-    curlySingleInward: [`’`, `‛`],
-    custom,
-    double: [`"`, `"`],
-    guillemets: [`«`, `»`],
-    guillemetsInward: [`»`, `«`],
-    guillemetsSingle: [`‹`, `›`],
-    guillemetsSingleInward: [`›`, `‹`],
-    single: [`'`, `'`],
-    squareBrackets: [`[`, `]`],
-  };
-  const regExpValues = escape4RE([...new Set(
-    Object.values(quots)
-    .filter(v => Array.isArray(v))
-    .flat())].join(``));
-  quots.re = RegExp(`^[${regExpValues}]|[${regExpValues}]$`, "g");
-  return quots;
-}
+/* node:coverage enable */

package/src/instanceMethods.js

@@ -36,12 +36,12 @@ function checkAndRun(string, fn, or) {
   return string.length > 0 ? fn(string) : or || string;
 }
 
-function format(string, ...tokens) {
-  return checkAndRun(string, () => `${interpolate(string, ...tokens)}`); 
+function ucFirst(string) {
+  return checkAndRun(string, () => `${string[0].toUpperCase()}${string.slice(1)}`);
 }
 
-function ucFirst(string) {
-  return checkAndRun(string, () => `${string[0].toUpperCase()}${string.slice(1)}`); 
+function format(string, ...tokens) {
+  return checkAndRun(string, () => `${interpolate(string, ...tokens)}`);
 }
 
 function surroundWith(string, start, end) {
@@ -53,7 +53,7 @@ function surroundWith(string, start, end) {
 }
 
 function toDashedNotation(string) {
-  return checkAndRun(string, () => 
+  return checkAndRun(string, () =>
     string
       .replace(/\s/g, '')
       .replace(/[A-Z]/g, a => `-${a.toLowerCase()}`)
@@ -82,7 +82,7 @@ function wordsFirstUp(string) {
 }
 
 function toCamelcase(string) {
-  return checkAndRun(string, () => 
+  return checkAndRun(string, () =>
     string.toLowerCase()
       .trim()
       .split(/[- ]/)
@@ -92,29 +92,37 @@ function toCamelcase(string) {
   );
 }
 
+function getBoundary(string) {
+  const match = [...string.matchAll(/\p{Pe}|\p{Z}/gu)].at(-1);
+  return match?.index ?? string.length;
+}
+
 function truncate(string, {at, html = false, wordBoundary = false} = {} ) {
+  html = html?.constructor === Boolean && html || false;
+  wordBoundary = wordBoundary?.constructor === Boolean && wordBoundary || false;
   return checkAndRun(string, () => {
     if (string.length <= at) { return string; }
-    
+
     const subString = string.slice(0, at - 1);
     const endwith = html ? "&hellip;" : `...`;
-    const boundary = wordBoundary 
-      ? [...subString.matchAll(/\p{Pe}|\p{Z}/gu)].at(-1)?.index ?? subString.length 
+    const boundary = wordBoundary
+      ? getBoundary(subString)
       : subString.length;
-    
+
     return (wordBoundary
       ? subString.slice(0, boundary+1).trim()
-      : subString) + endwith; 
+      : subString) + endwith;
     }
   );
 }
 
-function trimAll(string,  keepLines) {
+function trimAll(string,  keepLines = false) {
+  keepLines = keepLines?.constructor === Boolean && keepLines || false;
   return checkAndRun(string, () => {
     const lines = string.replace(/\n/gm, `#LF#`)
       .split(/#LF#/)
       .map(line => line.trim().replace(/\s{2,}/g, a => a[0]) );
-    return keepLines 
+    return keepLines
       ? lines.join(`#LF#`).replace(/#LF#/g, `\n`).trim()
       : lines.filter(l => l.length > 0).join(`\n`);
   });
@@ -125,10 +133,10 @@ function replaceWords(string, { replacements = {}, caseSensitive = false} = {})
   let replacements2Array = Object.entries(replacements).flat();
   const cando = isArrayOf(String, replacements2Array) && caseSensitive?.constructor === Boolean;
   const modifiers = `g${!caseSensitive ? 'i' : ''}`;
-  
+
   if (cando) {
     replacements2Array = replacements2Array.map(v => getStringValue(v)).filter(v => replacements2Array.length > 0);
-    
+
     if (replacements2Array.length) {
       while (replacements2Array.length) {
         const [initial, replacement] = [replacements2Array.shift(), replacements2Array.shift()];
@@ -137,41 +145,41 @@ function replaceWords(string, { replacements = {}, caseSensitive = false} = {})
       }
     }
   }
-  
+
   return string;
 }
 
 // SEE https://youtu.be/99Zacm7SsWQ?t=2101
-function indexOf(string, findMe, fromIndex) {
+function indexOf(string, findMe, fromIndex = 0) {
   string = getStringValue(string);
-  fromIndex = isNumber(fromIndex) ? fromIndex : 0;
+  fromIndex = isNumber(fromIndex) && fromIndex || 0;
   const index = string.indexOf(findMe, fromIndex || 0);
-  return index < 0 ? undefined : index;  
+  return index < 0 ? undefined : index;
 }
 
-function lastIndexOf(string, findMe, beforeIndex) {
+function lastIndexOf(string, findMe, beforeIndex = 0) {
   string = getStringValue(string);
-  beforeIndex = isNumber(beforeIndex) ? beforeIndex : string.length;
+  beforeIndex = isNumber(beforeIndex) && beforeIndex || string.length;
   const index = string.lastIndexOf(findMe, beforeIndex);
   return index < 0 ? undefined : index;
 }
 
 function insert(string, { value, values, at = 0 } = {}) {
   string = getStringValue(string);
-  at = isNumber(at) ? at : 0;
+  at = isNumber(at) && at || 0;
   const valuesMaybeValue = getStringValue(values);
-  values = getStringValue(value).length 
+  values = getStringValue(value).length
     ? value
     : valuesMaybeValue.length
     ? valuesMaybeValue
-    : isArrayOf(String, values) 
-      ? values.map(v => getStringValue(v)).join(``) 
+    : isArrayOf(String, values)
+      ? values.map(v => getStringValue(v)).join(``)
       : [];
-  
+
   return values.length <= 1
     ? string
-    : string.length === 0 
-      ? `${values}${string}` 
+    : string.length === 0
+      ? `${values}${string}`
       : `${string.slice(0, at)}${values}${string.slice(at)}`;
 }
 
@@ -182,16 +190,16 @@ function prefix(string, ...strings) {
 
 function append(string, ...strings2Append) {
   strings2Append = isArrayOf(String, strings2Append) && strings2Append;
-  
+
   if (strings2Append && strings2Append.length > 0) {
     return `${getStringValue(string)}`.concat(strings2Append.join(``))
   }
-  
+
   return getStringValue(string);
 }
 
 function quotGetters(instance, wrap) {
-  return { 
+  return {
     value: {
       get backtick() { return instance.enclose(...quotingStyles.backtick); },
       get bracket() { return instance.enclose(...quotingStyles.bracket); },
@@ -213,7 +221,7 @@ function quotGetters(instance, wrap) {
       get remove() { return wrap(`${instance.value.replace(quotingStyles.re, ``)}`); },
       get single() { return instance.enclose(...quotingStyles.single); },
       get squareBrackets() { return instance.enclose(...quotingStyles.squareBrackets); },
-    }, 
+    },
     enumerable: false,
     configurable: false,
   };