@oino-ts/common 0.16.2 → 0.17.1

package/src/OINOFormatter.ts

@@ -1,165 +1,165 @@
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-
-import { OINO_ERROR_PREFIX, OINOLog } from "./index.js"
-
-
-
-/**
- * Class for formatting strings and values.
- *
- */
-export class OINOFormatter {
-    static OINO_FORMATTER_REGEXP = /\s?(trim(\(\))?|trimLeft(\(\))?|trimRight(\(\))?|toUpper(\(\))?|toLower(\(\))?|cropLeft\((\d+)\)|cropRight\((\d+)\)|cropToDelimiter\(([^\(\),]+),(\d+)\)|cropFromDelimiter\(([^\(\),]+),(\d+)\)|substring\((\d+),(\d+)\)|replace\(([^\(\),]+),([^\(\),]+)\))\s?$/i
-    _types: string[]
-    _params: any[][]
-
-    /**
-     * Constructor of `OINOFormatter`
-     * @param types array of formatter types
-     * @param params array of formatter parameters according to type
-     */
-    constructor(types: string[], params: any[][]) {
-        this._types = types
-        this._params = params
-    }
-
-    /**
-     * Constructor for `OINOFormatter` as parser of http parameter.
-     *
-     * @param formatters string or array of strings of serialized representation of formatters with following functions
-     * - trim()
-     * - trimLeft()
-     * - trimRight()
-     * - toUpper()
-     * - toLower()
-     * - cropLeft(charsToCrop)
-     * - cropRight(charsToCrop)
-     * - cropToDelimiter(delimiter,offsetChars)
-     * - cropFromDelimiter(delimiter,offsetChars)
-     * - substring(start,end)
-     * - replace(search,replace)
-     */
-    static parse(formatters: string|string[]): OINOFormatter {
-        if (typeof formatters === "string") {
-            formatters = [formatters]
-        }
-        if (!formatters || formatters.length === 0) {
-            return OINO_EMPTY_FORMATTER
-
-        } else {
-            const types:string[] = []
-            const params:any[][] = []
-            for (let i=0; i<formatters.length; i++) {
-                let match = formatters[i]?.match(this.OINO_FORMATTER_REGEXP)
-                if (!match) {
-                    OINOLog.error("@oino-ts/common", "OINOFormatter", "parse", "Invalid formatter string", {formatter:formatters[i]})
-                    throw new Error(OINO_ERROR_PREFIX + "Invalid formatter: " + formatters[i])
-                } else {
-                    const formatter_type = match[1].toLowerCase().substring(0, match[1].indexOf('('))
-                    const formatter_params: any[] = []
-                    if ((formatter_type === "trim") || (formatter_type === "trimleft") || (formatter_type === "trimright") || (formatter_type === "toupper") || (formatter_type === "tolower")) {
-                        // no parameters
-
-                    } else if (formatter_type=== "cropleft") {
-                        formatter_params.push(parseInt(match[7]))
-
-                    } else if (formatter_type === "cropright") {
-                        formatter_params.push(parseInt(match[8]))
-
-                    } else if (formatter_type === "croptodelimiter") {
-                        formatter_params.push(decodeURIComponent(match[9]), parseInt(match[10]))
-
-                    } else if (formatter_type === "cropfromdelimiter") {
-                        formatter_params.push(decodeURIComponent(match[11]), parseInt(match[12]))
-
-                    } else if (formatter_type === "substring") {
-                        formatter_params.push(parseInt(match[13]), parseInt(match[14]))
-
-                    } else if (formatter_type === "replace") {
-                        formatter_params.push(decodeURIComponent(match[15]), decodeURIComponent(match[16]))
-                    } else {
-                        OINOLog.error("@oino-ts/common", "OINOFormatter", "parse", "Unknown formatter type", {formatter:formatters[i]})
-                        throw new Error(OINO_ERROR_PREFIX + "Unsupported formatter: " + formatters[i])
-                    }
-                    types.push(formatter_type)
-                    params.push(formatter_params)
-                }
-            }
-            return new OINOFormatter(types, params)
-        }
-    }
-
-    /**
-     * Does formatter include any operations.
-     * @return true if formatter is empty
-     */
-    isEmpty():boolean {
-        return this._types.length === 0
-    }
-
-    /**
-     * Applies all formatters in order to given value.
-     *
-     * @param value string value to be formatted
-     * @returns formatted string value
-     */
-    format(value: string): string {
-        let formatted = value
-        for (let i = 0; i < this._types.length; i++) {
-            const formatter_type = this._types[i]
-            const formatter_params = this._params[i]
-            if (formatter_type === "trim") {
-                formatted = formatted.trim()
-
-            } else if (formatter_type === "trimleft") {
-                formatted = formatted.trimStart()
-
-            } else if (formatter_type === "trimright") {
-                formatted = formatted.trimEnd()
-
-            } else if (formatter_type === "toupper") {
-                formatted = formatted.toUpperCase()
-
-            } else if (formatter_type === "tolower") {
-                formatted = formatted.toLowerCase()
-
-            } else if (formatter_type === "cropleft") {
-                formatted = formatted.slice(formatter_params[0])
-
-            } else if (formatter_type === "cropright") {
-                formatted = formatted.slice(0, formatted.length-formatter_params[0])
-
-            } else if (formatter_type === "croptodelimiter") {
-                const to_demilimiter_idx = formatted.indexOf(formatter_params[0])
-                if (to_demilimiter_idx >= 0) {
-                    formatted = formatted.slice(Math.max(to_demilimiter_idx + formatter_params[0].length + formatter_params[1], 0))
-                }
-                
-            } else if (formatter_type === "cropfromdelimiter") {
-                const from_demilimiter_idx = formatted.indexOf(formatter_params[0])
-                if (from_demilimiter_idx >= 0) {
-                    formatted = formatted.slice(0, Math.max(from_demilimiter_idx + formatter_params[1], 0))
-                }
-
-            } else if (formatter_type === "substring") {
-                const start = formatter_params[0] ? parseInt(formatter_params[0]) : 0
-                const end = formatter_params[1] ? parseInt(formatter_params[1]) : formatted.length
-                formatted = formatted.substring(start, end)
-
-            } else if (formatter_type === "replace") {
-                const search = formatter_params[0]
-                const replacement = formatter_params[1]
-                formatted = formatted.replaceAll(search, replacement)
-            }
-            // console.log("formatter:", formatter_type, "params:", formatter_params, "formatted:", formatted)
-        }
-        return formatted
-    }
-
-}
-
-export const OINO_EMPTY_FORMATTER = new OINOFormatter([], [])
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import { OINO_ERROR_PREFIX, OINOLog } from "./index.js"
+
+
+
+/**
+ * Class for formatting strings and values.
+ *
+ */
+export class OINOFormatter {
+    static OINO_FORMATTER_REGEXP = /\s?(trim(\(\))?|trimLeft(\(\))?|trimRight(\(\))?|toUpper(\(\))?|toLower(\(\))?|cropLeft\((\d+)\)|cropRight\((\d+)\)|cropToDelimiter\(([^\(\),]+),(\d+)\)|cropFromDelimiter\(([^\(\),]+),(\d+)\)|substring\((\d+),(\d+)\)|replace\(([^\(\),]+),([^\(\),]+)\))\s?$/i
+    _types: string[]
+    _params: any[][]
+
+    /**
+     * Constructor of `OINOFormatter`
+     * @param types array of formatter types
+     * @param params array of formatter parameters according to type
+     */
+    constructor(types: string[], params: any[][]) {
+        this._types = types
+        this._params = params
+    }
+
+    /**
+     * Constructor for `OINOFormatter` as parser of http parameter.
+     *
+     * @param formatters string or array of strings of serialized representation of formatters with following functions
+     * - trim()
+     * - trimLeft()
+     * - trimRight()
+     * - toUpper()
+     * - toLower()
+     * - cropLeft(charsToCrop)
+     * - cropRight(charsToCrop)
+     * - cropToDelimiter(delimiter,offsetChars)
+     * - cropFromDelimiter(delimiter,offsetChars)
+     * - substring(start,end)
+     * - replace(search,replace)
+     */
+    static parse(formatters: string|string[]): OINOFormatter {
+        if (typeof formatters === "string") {
+            formatters = [formatters]
+        }
+        if (!formatters || formatters.length === 0) {
+            return OINO_EMPTY_FORMATTER
+
+        } else {
+            const types:string[] = []
+            const params:any[][] = []
+            for (let i=0; i<formatters.length; i++) {
+                let match = formatters[i]?.match(this.OINO_FORMATTER_REGEXP)
+                if (!match) {
+                    OINOLog.error("@oino-ts/common", "OINOFormatter", "parse", "Invalid formatter string", {formatter:formatters[i]})
+                    throw new Error(OINO_ERROR_PREFIX + "Invalid formatter: " + formatters[i])
+                } else {
+                    const formatter_type = match[1].toLowerCase().substring(0, match[1].indexOf('('))
+                    const formatter_params: any[] = []
+                    if ((formatter_type === "trim") || (formatter_type === "trimleft") || (formatter_type === "trimright") || (formatter_type === "toupper") || (formatter_type === "tolower")) {
+                        // no parameters
+
+                    } else if (formatter_type=== "cropleft") {
+                        formatter_params.push(parseInt(match[7]))
+
+                    } else if (formatter_type === "cropright") {
+                        formatter_params.push(parseInt(match[8]))
+
+                    } else if (formatter_type === "croptodelimiter") {
+                        formatter_params.push(decodeURIComponent(match[9]), parseInt(match[10]))
+
+                    } else if (formatter_type === "cropfromdelimiter") {
+                        formatter_params.push(decodeURIComponent(match[11]), parseInt(match[12]))
+
+                    } else if (formatter_type === "substring") {
+                        formatter_params.push(parseInt(match[13]), parseInt(match[14]))
+
+                    } else if (formatter_type === "replace") {
+                        formatter_params.push(decodeURIComponent(match[15]), decodeURIComponent(match[16]))
+                    } else {
+                        OINOLog.error("@oino-ts/common", "OINOFormatter", "parse", "Unknown formatter type", {formatter:formatters[i]})
+                        throw new Error(OINO_ERROR_PREFIX + "Unsupported formatter: " + formatters[i])
+                    }
+                    types.push(formatter_type)
+                    params.push(formatter_params)
+                }
+            }
+            return new OINOFormatter(types, params)
+        }
+    }
+
+    /**
+     * Does formatter include any operations.
+     * @return true if formatter is empty
+     */
+    isEmpty():boolean {
+        return this._types.length === 0
+    }
+
+    /**
+     * Applies all formatters in order to given value.
+     *
+     * @param value string value to be formatted
+     * @returns formatted string value
+     */
+    format(value: string): string {
+        let formatted = value
+        for (let i = 0; i < this._types.length; i++) {
+            const formatter_type = this._types[i]
+            const formatter_params = this._params[i]
+            if (formatter_type === "trim") {
+                formatted = formatted.trim()
+
+            } else if (formatter_type === "trimleft") {
+                formatted = formatted.trimStart()
+
+            } else if (formatter_type === "trimright") {
+                formatted = formatted.trimEnd()
+
+            } else if (formatter_type === "toupper") {
+                formatted = formatted.toUpperCase()
+
+            } else if (formatter_type === "tolower") {
+                formatted = formatted.toLowerCase()
+
+            } else if (formatter_type === "cropleft") {
+                formatted = formatted.slice(formatter_params[0])
+
+            } else if (formatter_type === "cropright") {
+                formatted = formatted.slice(0, formatted.length-formatter_params[0])
+
+            } else if (formatter_type === "croptodelimiter") {
+                const to_demilimiter_idx = formatted.indexOf(formatter_params[0])
+                if (to_demilimiter_idx >= 0) {
+                    formatted = formatted.slice(Math.max(to_demilimiter_idx + formatter_params[0].length + formatter_params[1], 0))
+                }
+                
+            } else if (formatter_type === "cropfromdelimiter") {
+                const from_demilimiter_idx = formatted.indexOf(formatter_params[0])
+                if (from_demilimiter_idx >= 0) {
+                    formatted = formatted.slice(0, Math.max(from_demilimiter_idx + formatter_params[1], 0))
+                }
+
+            } else if (formatter_type === "substring") {
+                const start = formatter_params[0] ? parseInt(formatter_params[0]) : 0
+                const end = formatter_params[1] ? parseInt(formatter_params[1]) : formatted.length
+                formatted = formatted.substring(start, end)
+
+            } else if (formatter_type === "replace") {
+                const search = formatter_params[0]
+                const replacement = formatter_params[1]
+                formatted = formatted.replaceAll(search, replacement)
+            }
+            // console.log("formatter:", formatter_type, "params:", formatter_params, "formatted:", formatted)
+        }
+        return formatted
+    }
+
+}
+
+export const OINO_EMPTY_FORMATTER = new OINOFormatter([], [])

package/src/OINOHtmlTemplate.test.ts

@@ -1,114 +1,114 @@
-/*
- * This Source Code Form is subject to the terms of the Mozilla Public
- * License, v. 2.0. If a copy of the MPL was not distributed with this
- * file, You can obtain one at https://mozilla.org/MPL/2.0/.
- */
-
-import { expect, test } from "bun:test";
-
-import { OINOHtmlTemplate } from "./OINOHtmlTemplate"
-import { OINOFormatter } from "./OINOFormatter";
-import { OINOLog, OINOConsoleLog, OINOLogLevel } from "./OINOLog"
-
-Math.random()
-
-OINOLog.setInstance(new OINOConsoleLog(OINOLogLevel.error))
-
-const VARIABLE_OPTIONS = [
-    "{{{var{i}}}}", // 0 nothing
-    "{{{var{i}|trim()}}}", // 1 trim
-    "{{{var{i}|trimLeft()}}}", // 2 trimLeft
-    "{{{var{i}|trimRight()}}}", // 3 trimRight
-    "{{{var{i}|toLower()}}}", // 4 toLower
-    "{{{var{i}|cropLeft(1)}}}", // 5 cropLeft
-    "{{{var{i}|cropRight(1)}}}", // 6 cropRight
-    "{{{var{i}|cropToDelimiter(¤,1)}}}", // 7 cropToDelimiter
-    "{{{var{i}|cropFromDelimiter(¤,0)}}}", // 8 cropFromDelimiter
-    "{{{var{i}|substring(2,10)}}}", // 9 substring
-    "{{{var{i}|replace(¤,a)}}}" // 10 replace
-]
-const VARIABLE_VALUES = [
-    "value{i}",   // 0 nothing
-    "  value{i}  ", // 1 trim
-    "  value{i}", // 2 trimLeft
-    "value{i}  ", // 3 trimRight
-    "VALUE{i}", // 4 toLower
-    "¤value{i}", // 5 cropLeft
-    "value{i}¤", // 6 cropRight
-    "¤¤value{i}", // 7 cropToDelimiter
-    "value{i}¤!", // 8 cropFromDelimiter
-    "!¤value{i}",   // 9 substring
-    "v¤lue{i}"    // 10 replace
-]
-
-
-function _generateTemplateVariable(i:number): string {
-    return VARIABLE_OPTIONS[i % VARIABLE_OPTIONS.length].replace(/\{i\}/g, i.toString())
-}
-
-function _generateTemplateHtml(variableCount: number): string {
-    let template = "{{{header}}}\n<div>\n" // edge case: tag at the start of the template
-    for (let i = 1; i <= variableCount; i++) {
-        template += `<p>${_generateTemplateVariable(i)}</p>\n`
-    }
-    template += "</div>\n{{{footer}}}" // edge case: tag at the end of the template
-    return template
-}
-
-function _generateResultHtml(variableCount: number): string {
-    let template = "header\n<div>\n"
-    for (let i = 1; i <= variableCount; i++) {
-        template += `<p>value${i}</p>\n`
-    }
-    template += "</div>\nfooter"
-    return template
-}
-
-
-function _generateValue(i: number): string {
-    return VARIABLE_VALUES[i % VARIABLE_VALUES.length].replace(/\{i\}/g, i.toString())
-}
-
-function _generateValues(variableCount: number): any {
-    const values: any = { header: "header", footer: "footer" }
-    for (let i = 1; i <= variableCount; i++) {
-        values[`var${i}`] = _generateValue(i)
-    }
-    return values
-}
-
-function benchmarkOINOHtmlTemplate(variables:number, replacements: number = 1000): number {
-    const template = new OINOHtmlTemplate(_generateTemplateHtml(variables))
-    const values = _generateValues(variables)
-    const result = _generateResultHtml(variables)
-
-    const start = performance.now();
-
-    for (let i = 0; i < replacements; i+=variables) {
-        template.setVariableFromProperties(values)
-        const res = template.render()
-        expect(res.body).toBe(result)
-    }
-
-    const end = performance.now()
-    const duration = end - start
-    return Math.round(replacements / duration)
-}   
-
-await test("OINOHtmlTemplate render and performance", async () => {
-
-    let hps_min = Number.MAX_VALUE
-    let hps_max = 0
-    
-    for (let j=10; j<=100; j+=10) {
-        const rps = benchmarkOINOHtmlTemplate(j, 100000)
-        // console.log(`Template variable renders per second with ${j} variables: ${rps}krps`)
-        hps_min = Math.min(rps, hps_min)
-        hps_max = Math.max(rps, hps_max)
-        expect(hps_min).toBeGreaterThanOrEqual(2500)
-        expect(hps_max).toBeLessThanOrEqual(5000)
-    }
-    console.log("OINOHtmlTemplate performance: " + hps_min + "k - " + hps_max + "k renders per second")
-})
-    
-
+/*
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at https://mozilla.org/MPL/2.0/.
+ */
+
+import { expect, test } from "bun:test";
+
+import { OINOHtmlTemplate } from "./OINOHtmlTemplate"
+import { OINOFormatter } from "./OINOFormatter";
+import { OINOLog, OINOConsoleLog, OINOLogLevel } from "./OINOLog"
+
+Math.random()
+
+OINOLog.setInstance(new OINOConsoleLog(OINOLogLevel.error))
+
+const VARIABLE_OPTIONS = [
+    "{{{var{i}}}}", // 0 nothing
+    "{{{var{i}|trim()}}}", // 1 trim
+    "{{{var{i}|trimLeft()}}}", // 2 trimLeft
+    "{{{var{i}|trimRight()}}}", // 3 trimRight
+    "{{{var{i}|toLower()}}}", // 4 toLower
+    "{{{var{i}|cropLeft(1)}}}", // 5 cropLeft
+    "{{{var{i}|cropRight(1)}}}", // 6 cropRight
+    "{{{var{i}|cropToDelimiter(¤,1)}}}", // 7 cropToDelimiter
+    "{{{var{i}|cropFromDelimiter(¤,0)}}}", // 8 cropFromDelimiter
+    "{{{var{i}|substring(2,10)}}}", // 9 substring
+    "{{{var{i}|replace(¤,a)}}}" // 10 replace
+]
+const VARIABLE_VALUES = [
+    "value{i}",   // 0 nothing
+    "  value{i}  ", // 1 trim
+    "  value{i}", // 2 trimLeft
+    "value{i}  ", // 3 trimRight
+    "VALUE{i}", // 4 toLower
+    "¤value{i}", // 5 cropLeft
+    "value{i}¤", // 6 cropRight
+    "¤¤value{i}", // 7 cropToDelimiter
+    "value{i}¤!", // 8 cropFromDelimiter
+    "!¤value{i}",   // 9 substring
+    "v¤lue{i}"    // 10 replace
+]
+
+
+function _generateTemplateVariable(i:number): string {
+    return VARIABLE_OPTIONS[i % VARIABLE_OPTIONS.length].replace(/\{i\}/g, i.toString())
+}
+
+function _generateTemplateHtml(variableCount: number): string {
+    let template = "{{{header}}}\n<div>\n" // edge case: tag at the start of the template
+    for (let i = 1; i <= variableCount; i++) {
+        template += `<p>${_generateTemplateVariable(i)}</p>\n`
+    }
+    template += "</div>\n{{{footer}}}" // edge case: tag at the end of the template
+    return template
+}
+
+function _generateResultHtml(variableCount: number): string {
+    let template = "header\n<div>\n"
+    for (let i = 1; i <= variableCount; i++) {
+        template += `<p>value${i}</p>\n`
+    }
+    template += "</div>\nfooter"
+    return template
+}
+
+
+function _generateValue(i: number): string {
+    return VARIABLE_VALUES[i % VARIABLE_VALUES.length].replace(/\{i\}/g, i.toString())
+}
+
+function _generateValues(variableCount: number): any {
+    const values: any = { header: "header", footer: "footer" }
+    for (let i = 1; i <= variableCount; i++) {
+        values[`var${i}`] = _generateValue(i)
+    }
+    return values
+}
+
+function benchmarkOINOHtmlTemplate(variables:number, replacements: number = 1000): number {
+    const template = new OINOHtmlTemplate(_generateTemplateHtml(variables))
+    const values = _generateValues(variables)
+    const result = _generateResultHtml(variables)
+
+    const start = performance.now();
+
+    for (let i = 0; i < replacements; i+=variables) {
+        template.setVariableFromProperties(values)
+        const res = template.render()
+        expect(res.body).toBe(result)
+    }
+
+    const end = performance.now()
+    const duration = end - start
+    return Math.round(replacements / duration)
+}   
+
+await test("OINOHtmlTemplate render and performance", async () => {
+
+    let hps_min = Number.MAX_VALUE
+    let hps_max = 0
+    
+    for (let j=10; j<=100; j+=10) {
+        const rps = benchmarkOINOHtmlTemplate(j, 100000)
+        // console.log(`Template variable renders per second with ${j} variables: ${rps}krps`)
+        hps_min = Math.min(rps, hps_min)
+        hps_max = Math.max(rps, hps_max)
+        expect(hps_min).toBeGreaterThanOrEqual(2500)
+        expect(hps_max).toBeLessThanOrEqual(5000)
+    }
+    console.log("OINOHtmlTemplate performance: " + hps_min + "k - " + hps_max + "k renders per second")
+})
+    
+