@cepharum/concrete-db 0.1.1 → 0.2.1

package/lib/term-functions.mjs

@@ -1,31 +1,3 @@
-/**
- * (c) 2021 cepharum GmbH, Berlin, http://cepharum.de
- *
- * The MIT License (MIT)
- *
- * Copyright (c) 2021 cepharum GmbH
- *
- * Permission is hereby granted, free of charge, to any person obtaining a copy
- * of this software and associated documentation files (the "Software"), to deal
- * in the Software without restriction, including without limitation the rights
- * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
- * copies of the Software, and to permit persons to whom the Software is
- * furnished to do so, subject to the following conditions:
- *
- * The above copyright notice and this permission notice shall be included in all
- * copies or substantial portions of the Software.
- *
- * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
- * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
- * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
- * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
- * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
- * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
- * SOFTWARE.
- *
- * @author: cepharum
- */
-
 import { ForeignKey } from "./helper.mjs";
 
 /**
@@ -82,3 +54,89 @@ export function icompare( left, right ) {
 export function compare( left, right ) {
 	return String( left ).localeCompare( String( right ) );
 }
+
+/**
+ * Extracts list of words from provided scalar or non-scalar value.
+ *
+ * A word is a consecutive sequence of letters, digits, underscores and dashes
+ * though dashes are rejected in a leading position. On setting custom option
+ * for ignoring case, all letters of collected words are converted to lowercase
+ * in resulting map.
+ *
+ * @param {any} value value to extract words from
+ * @param {number} minSize minimum number of characters in a string to be considered for extracting words
+ * @param {number} minWordSize minimum number of characters in extracted words
+ * @param {number} maxWordSize maximum number of characters in extracted words
+ * @param {boolean} ignoreCase set true to drop case of extracted words
+ * @param {boolean} strict set false to have any non-string value converted to string instead of being ignored
+ * @param {string} wordPattern provides source of global unicode regexp matching a word to generate
+ * @returns {Object<string,number>} map of extracted words into either words's number of occurrences
+ */
+export function spread( value, minSize = 10, minWordSize = 3, maxWordSize = Infinity, ignoreCase = true, strict = true, wordPattern = undefined ) {
+	const result = {};
+
+	for ( const word of generateWords( value, minSize, ignoreCase, strict, wordPattern ) ) {
+		if ( word.length >= minWordSize && word.length <= maxWordSize ) {
+			result[word] = ( result[word] || 0 ) + 1;
+		}
+	}
+
+	return result;
+}
+
+/**
+ * Generates error with provided message for failing curing process.
+ *
+ * @param {string} message description of error
+ * @returns {Error} generated error
+ */
+export function fail( message ) {
+	return new Error( message );
+}
+
+
+/**
+ * Recursively iterates over provided source converting all scalar data into
+ * string prior to yielding consecutive sequences of letters and digits.
+ *
+ * @param {any} source data to extract terms from
+ * @param {number} minSize minimum number of characters in a string to be considered for extracting terms
+ * @param {boolean} ignoreCase set true to drop case of extracted terms
+ * @param {boolean} strict set false to have any non-string value converted to string instead of being ignored
+ * @param {string} wordPattern provides source of global unicode regexp matching a word to generate
+ * @returns {Generator<string|*, void, *>} iterator over flat sequence of terms
+ */
+function *generateWords( source, minSize, ignoreCase, strict, wordPattern = undefined ) {
+	let stream;
+
+	if ( Array.isArray( source ) ) {
+		stream = source;
+	} else if ( source instanceof Set || source instanceof Map ) {
+		stream = source.values();
+	} else if ( source && typeof source === "object" ) {
+		stream = Object.values( source );
+	} else {
+		if ( strict && typeof source !== "string" ) {
+			return;
+		}
+
+		const string = String( source ).trim();
+
+		if ( string.length < minSize ) {
+			return;
+		}
+
+		const ptn = wordPattern ? new RegExp( wordPattern, "gu" ) : /[\p{L}\p{N}_][\p{L}\p{N}_-]*/gu;
+		let match;
+
+		while ( ( match = ptn.exec( string ) ) ) {
+			yield ignoreCase ? ( match[1] ?? match[0] ).toLocaleLowerCase() : match[1] ?? match[0];
+		}
+
+		return;
+	}
+
+	for ( const sub of stream ) {
+		yield* generateWords( sub, minSize, ignoreCase, strict, wordPattern );
+	}
+}

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@cepharum/concrete-db",
-	"version": "0.1.1",
+	"version": "0.2.1",
 	"description": "a read-only web database generator",
 	"main": "lib/collector.mjs",
 	"types": "concrete-db.d.ts",
@@ -10,7 +10,8 @@
 	"scripts": {
 		"cure": "node ./cure.mjs",
 		"lint": "eslint lib/**/*.{js,mjs,cjs} test/**/*.{js,mjs,cjs} cure.mjs",
-		"test": "nyc mocha --ui=tdd --recursive test/**/*.spec.*",
+		"lint:fix": "eslint --fix lib/**/*.{js,mjs,cjs} test/**/*.{js,mjs,cjs} cure.mjs",
+		"test": "c8 mocha --ui=tdd --recursive test/**/*.spec.*",
 		"test:getting-started": "node ./test/curing.shell.mjs",
 		"docs:dev": "vuepress dev docs",
 		"docs:build": "vuepress build docs"
@@ -19,23 +20,26 @@
 	"author": "cepharum GmbH",
 	"license": "MIT",
 	"dependencies": {
-		"ajv": "^6.12.6",
+		"ajv": "^8.11.0",
 		"file-essentials": "^0.1.2",
 		"lodash.merge": "^4.6.2",
-		"minimist": "^1.2.5",
+		"minimist": "^1.2.6",
 		"promise-essentials": "^0.2.0",
-		"simple-terms": "^0.3.0",
-		"yaml": "^1.10.2"
+		"simple-terms": "^0.4.0",
+		"yaml": "^2.1.0"
 	},
 	"devDependencies": {
-		"eslint": "^7.24.0",
+		"c8": "^7.11.3",
+		"eslint": "^8.16.0",
 		"eslint-config-cepharum": "^1.0.12",
-		"eslint-plugin-promise": "^5.1.0",
-		"mocha": "^8.3.2",
-		"nyc": "^15.1.0",
+		"eslint-plugin-promise": "^6.0.0",
+		"mocha": "^10.0.0",
 		"should": "^13.2.3",
-		"vuepress": "^1.8.2",
-		"vuepress-plugin-mermaidjs": "^1.8.1"
+		"vuepress": "^1.9.7",
+		"vuepress-plugin-mermaidjs": "^1.9.1"
+	},
+	"engines": {
+		"node": ">=10"
 	},
 	"files": [
 		"lib",