Cleanup analytics docs and test

docs/plugin-analytics.md

@@ -1504,34 +1504,77 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### tune
 
-Take all `Object` and sort them with selected field
+Create and replace the id with a unify id that can be used with [sort](#sort)
 
-```json
-[{
-}]
-```
+Créer et remplacer l'identifiant par un identifiant unifié qui peut être utilisé avec [sort](#sort)
 
-Script:
+#### Example / Exemple
+
+##### Script / Scénario
 
 ```ini
+; Import analytics plugin required to use tune
+; Importation du plugin analytique nécessaire pour utiliser tune
 [use]
 plugin = analytics
 
+; Using "tune" with default settings
+; Utilisation de "tune" avec les paramètres par défaut
 [tune]
 ```
 
-Output:
+##### Input / Entrée
 
 ```json
-[
-]
+ [
+     {
+         "id": 1,
+         "value": 1
+     },
+     {
+         "id": 2,
+         "value": 2
+     }
+ ]
 ```
 
-#### Parameters
+##### Output / Sortie
+
+```json
+ [
+     {
+         "id": "0000000000000000001.00000000000000000000",
+         "value": {
+             "id": 1,
+             "value": 1,
+             "label": "static value"
+         }
+     },
+     {
+         "id": "0000000000000000002.00000000000000000000",
+         "value": {
+             "id": 2,
+             "value": 2,
+             "label": "static value"
+         }
+     }
+ ]
+```
 
--   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to use for the sort key (optional, default `id`)
+#### Parameters
 
-Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+-   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** <ul><li>path of the element used to create the unified identifier</li></ul>
+         <ul><li>chemin de l'élément utilisé pour créer l'identifiant unifié</li></ul> (optional, default `id`)
+-   `method` **(`"natural"` \| `"levenshtein"` \| `"numerical"`)** <ul><li>method used to create the unified identifier</li></ul>
+             <ul><ul><li>natural - Create a normalised identifier that is set to a fixed length</li></ul></ul>
+             <ul><ul><li>levenshtein - Create an identifier based on the Levenshtein algorithm</li></ul></ul>
+             <ul><ul><li>numerical - Create an identifier based on a numeric value</li></ul></ul>
+         <ul><li>méthode utilisée pour créer l'identifiant unifié</li></ul>
+             <ul><ul><li>natural - Crée un identifiant normalisé de longueur fixe</li></ul></ul>
+             <ul><ul><li>levenshtein - Crée un identifiant basé sur l'algorithme de Levenshtein</li></ul></ul>
+             <ul><ul><li>numerical - Crée un identifiant basé sur une valeur numérique</li></ul></ul> (optional, default `natural`)
+
+Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** 
 
 ### value
 

packages/analytics/README.md

@@ -1504,34 +1504,77 @@ Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/G
 
 ### tune
 
-Take all `Object` and sort them with selected field
+Create and replace the id with a unify id that can be used with [sort](#sort)
 
-```json
-[{
-}]
-```
+Créer et remplacer l'identifiant par un identifiant unifié qui peut être utilisé avec [sort](#sort)
 
-Script:
+#### Example / Exemple
+
+##### Script / Scénario
 
 ```ini
+; Import analytics plugin required to use tune
+; Importation du plugin analytique nécessaire pour utiliser tune
 [use]
 plugin = analytics
 
+; Using "tune" with default settings
+; Utilisation de "tune" avec les paramètres par défaut
 [tune]
 ```
 
-Output:
+##### Input / Entrée
 
 ```json
-[
-]
+ [
+     {
+         "id": 1,
+         "value": 1
+     },
+     {
+         "id": 2,
+         "value": 2
+     }
+ ]
 ```
 
-#### Parameters
+##### Output / Sortie
+
+```json
+ [
+     {
+         "id": "0000000000000000001.00000000000000000000",
+         "value": {
+             "id": 1,
+             "value": 1,
+             "label": "static value"
+         }
+     },
+     {
+         "id": "0000000000000000002.00000000000000000000",
+         "value": {
+             "id": 2,
+             "value": 2,
+             "label": "static value"
+         }
+     }
+ ]
+```
 
--   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** path to use for the sort key (optional, default `id`)
+#### Parameters
 
-Returns **[Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)** 
+-   `path` **[String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String)** <ul><li>path of the element used to create the unified identifier</li></ul>
+         <ul><li>chemin de l'élément utilisé pour créer l'identifiant unifié</li></ul> (optional, default `id`)
+-   `method` **(`"natural"` \| `"levenshtein"` \| `"numerical"`)** <ul><li>method used to create the unified identifier</li></ul>
+             <ul><ul><li>natural - Create a normalised identifier that is set to a fixed length</li></ul></ul>
+             <ul><ul><li>levenshtein - Create an identifier based on the Levenshtein algorithm</li></ul></ul>
+             <ul><ul><li>numerical - Create an identifier based on a numeric value</li></ul></ul>
+         <ul><li>méthode utilisée pour créer l'identifiant unifié</li></ul>
+             <ul><ul><li>natural - Crée un identifiant normalisé de longueur fixe</li></ul></ul>
+             <ul><ul><li>levenshtein - Crée un identifiant basé sur l'algorithme de Levenshtein</li></ul></ul>
+             <ul><ul><li>numerical - Crée un identifiant basé sur une valeur numérique</li></ul></ul> (optional, default `natural`)
+
+Returns **{id: [String](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String), value: [Object](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object)}** 
 
 ### value
 

packages/analytics/src/tune.js

@@ -3,6 +3,11 @@ import clone from 'lodash.clone';
 import { levenshteinDistance } from './algorithms';
 import core from './core';
 
+/**
+ * @private
+ * @param s {string | number | unknown}
+ * @returns {string}
+ */
 export const normalize = (s) => {
     if (typeof s === 'string') {
         return String(s).normalize('NFD').replace(/[\u0300-\u036f]/g, '').padEnd(40, '~');
@@ -13,7 +18,20 @@ export const normalize = (s) => {
     return String(s);
 };
 
+/**
+ * @private
+ * @param x {string | number | unknown}
+ * @param y {string | number | unknown}
+ * @returns {*}
+ */
 const levenshtein = (x, y) => levenshteinDistance(normalize(x), normalize(y));
+
+/**
+ * @private
+ * @param x {number}
+ * @param y {number}
+ * @returns {number}
+ */
 const numerical = (x, y) => (x + 1) / (y + 1);
 
 const methods = {
@@ -23,41 +41,20 @@ const methods = {
 const allMethods = Object.keys(methods).join(',');
 
 /**
- * Take all `Object` and sort them with selected field
- *
- * ```json
- * [{
- * }]
- * ```
- *
- * Script:
- *
- * ```ini
- * [use]
- * plugin = analytics
- *
- * [tune]
- *
- * ```
- *
- * Output:
- *
- * ```json
- * [
- * ]
- * ```
- *
- * @name tune
- * @param {String} [path=id] path to use for the sort key
- * @returns {Object}
+ * Tune function see documenation at the end.
+ * This part of the doc is use for jsdoc typing
+ * @private
+ * @param data {unknown}
+ * @param feed
+ * @param ctx
  */
-export default function tune(data, feed) {
-    if (this.isLast()) {
+const tune = (data, feed, ctx) => {
+    if (ctx.isLast()) {
         feed.close();
         return;
     }
-    const path = this.getParam('path', 'id');
-    const method = this.getParam('method', 'natural');
+    const path = ctx.getParam('path', 'id');
+    const method = ctx.getParam('method', 'natural');
     const fields = Array.isArray(path) ? path : [path];
     const currentValue = fields
         .filter((k) => typeof k === 'string')
@@ -73,21 +70,100 @@ export default function tune(data, feed) {
         return;
     }
 
-    if (!this.previousValue) {
-        this.previousValue = currentValue;
-        this.previousDistance = 1;
+    if (!ctx.previousValue) {
+        ctx.previousValue = currentValue;
+        ctx.previousDistance = 1;
         feed.send(core(1, data));
         return;
     }
 
-    const similarity = methods[method](this.previousValue, currentValue);
-    const score = similarity === 0 ? Math.max(this.previousValue.length, currentValue.length) : similarity;
-    const currentDistance = this.previousDistance / score;
+    const similarity = methods[method](ctx.previousValue, currentValue);
+    const score = similarity === 0 ? Math.max(ctx.previousValue.length, currentValue.length) : similarity;
+    const currentDistance = ctx.previousDistance / score;
 
-    this.previousValue = clone(currentValue);
-    this.previousDistance = clone(currentDistance);
+    ctx.previousValue = clone(currentValue);
+    ctx.previousDistance = clone(currentDistance);
     feed.send(core(currentDistance, data));
-}
+};
+
+/**
+ * Create and replace the id with a unify id that can be used with [sort](#sort)
+ *
+ * Créer et remplacer l'identifiant par un identifiant unifié qui peut être utilisé avec [sort](#sort)
+ *
+ * ### Example / Exemple
+ *
+ * #### Script / Scénario
+ *
+ * ```ini
+ * ; Import analytics plugin required to use tune
+ * ; Importation du plugin analytique nécessaire pour utiliser tune
+ * [use]
+ * plugin = analytics
+ *
+ * ; Using "tune" with default settings
+ * ; Utilisation de "tune" avec les paramètres par défaut
+ * [tune]
+ *
+ * ```
+ *
+ * #### Input / Entrée
+ *
+ * ```json
+ *  [
+ *      {
+ *          "id": 1,
+ *          "value": 1
+ *      },
+ *      {
+ *          "id": 2,
+ *          "value": 2
+ *      }
+ *  ]
+ * ```
+ *
+ * #### Output / Sortie
+ *
+ * ```json
+ *  [
+ *      {
+ *          "id": "0000000000000000001.00000000000000000000",
+ *          "value": {
+ *              "id": 1,
+ *              "value": 1,
+ *              "label": "static value"
+ *          }
+ *      },
+ *      {
+ *          "id": "0000000000000000002.00000000000000000000",
+ *          "value": {
+ *              "id": 2,
+ *              "value": 2,
+ *              "label": "static value"
+ *          }
+ *      }
+ *  ]
+ * ```
+ *
+ * @name tune
+ * @param {String} [path=id]
+ *      <ul><li>path of the element used to create the unified identifier</li></ul>
+ *      <ul><li>chemin de l'élément utilisé pour créer l'identifiant unifié</li></ul>
+ * @param {'natural' | 'levenshtein' | 'numerical'} [method=natural]
+ *      <ul><li>method used to create the unified identifier</li></ul>
+ *          <ul><ul><li>natural - Create a normalised identifier that is set to a fixed length</li></ul></ul>
+ *          <ul><ul><li>levenshtein - Create an identifier based on the Levenshtein algorithm</li></ul></ul>
+ *          <ul><ul><li>numerical - Create an identifier based on a numeric value</li></ul></ul>
+ *      <ul><li>méthode utilisée pour créer l'identifiant unifié</li></ul>
+ *          <ul><ul><li>natural - Crée un identifiant normalisé de longueur fixe</li></ul></ul>
+ *          <ul><ul><li>levenshtein - Crée un identifiant basé sur l'algorithme de Levenshtein</li></ul></ul>
+ *          <ul><ul><li>numerical - Crée un identifiant basé sur une valeur numérique</li></ul></ul>
+ * @returns {{
+ *     id: String,
+ *     value: Object
+ * }}
+ */
+export default tune;
 
 /*
 

packages/analytics/test-utils/runEzs.js

@@ -0,0 +1,23 @@
+import from from 'from';
+
+/**
+ * Helper function use to call ezs in each tests
+ * @param ezsRuntime {(name: string, options: any, environment?: unknown) => NodeJS.WritableStream}
+ * @param dataSet {Array<unknown>}
+ * @param functionName {string}
+ * @param [options] {any}
+ * @returns {Promise<Array<unknown>>}
+ */
+const runEzs = (ezsRuntime, dataSet, functionName, options) => new Promise((resolve) => {
+    const result = [];
+    from(dataSet)
+        .pipe(ezsRuntime(functionName, options))
+        .on('data', (chunk) => {
+            result.push(chunk);
+        })
+        .on('end', () => {
+            resolve(result);
+        });
+});
+
+export default runEzs;