feat(parser): now handles comma and semicolon seperated csv strings

.gitlab-ci.yml

@@ -12,6 +12,9 @@ stages:
 - release
 - metadata
 
+# ====================
+# security stage
+# ====================
 mirror:
   stage: security
   script:
@@ -30,6 +33,9 @@ snyk:
   - docker
   - notpriv
 
+# ====================
+# test stage
+# ====================
 testLEGACY:
   stage: test
   script:
@@ -68,7 +74,6 @@ release:
   stage: release
   script:
   - npmci node install stable
-  - npmci npm prepare
   - npmci npm publish
   only:
   - tags

dist/index.d.ts

@@ -1,6 +1,16 @@
-export declare class Csv {
+export interface ICsvConstructorOptions {
-    static createCsvFromString(csvStringArg: string): Promise<Csv>;
+    headers: boolean;
-    csvString: string;
+}
-    getHeaders(): void;
+export declare class Csv {
-    exportAsJson(): void;
+    static createCsvFromString(csvStringArg: string, options: ICsvConstructorOptions): Promise<Csv>;
+    csvString: string;
+    headers: string[];
+    keyFrame: string;
+    options: ICsvConstructorOptions;
+    determineKeyframe(): void;
+    serializeCsvString(): any[];
+    getRows(): string[];
+    getHeaders(): string[];
+    createDataObject(dataArray: string[]): any;
+    exportAsObject(): Promise<any>;
 }

dist/index.js

@@ -9,20 +9,80 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 class Csv {
-    static createCsvFromString(csvStringArg) {
+    constructor() {
+        this.keyFrame = null;
+        this.options = {
+            headers: true
+        };
+    }
+    static createCsvFromString(csvStringArg, options) {
         return __awaiter(this, void 0, void 0, function* () {
             const csvInstance = new Csv();
             csvInstance.csvString = csvStringArg;
+            csvInstance.determineKeyframe();
             return csvInstance;
         });
     }
-    getHeaders() {
+    determineKeyframe() {
+        let commaLength = 0;
+        let semicolonLength = 0;
+        const commaRegexResult = this.csvString.match(/,/g);
+        const semicolonRegexResult = this.csvString.match(/;/g);
+        if (commaRegexResult) {
+            commaLength = commaRegexResult.length;
+        }
+        if (semicolonRegexResult) {
+            semicolonLength = semicolonRegexResult.length;
+        }
+        // tslint:disable-next-line:prefer-conditional-expression
+        if (commaLength < semicolonLength) {
+            this.keyFrame = ';';
+        }
+        else {
+            this.keyFrame = ',';
+        }
     }
-    exportAsJson() {
+    serializeCsvString() {
-        let json = {
+        const rowArray = this.getRows();
-            [`key`]: 'hi'
+        const resultArray = [];
-        };
+        if (this.options.headers) {
+            this.getHeaders();
+            rowArray.shift();
+        }
+        for (const row of rowArray) {
+            resultArray.push(row.split(this.keyFrame));
+        }
+        return resultArray;
+    }
+    getRows() {
+        return this.csvString.split('\n');
+    }
+    getHeaders() {
+        const rowArray = this.getRows();
+        if (this.options.headers) {
+            let headerRow = rowArray[0];
+            this.headers = headerRow.split(this.keyFrame);
+        }
+        return this.headers;
+    }
+    createDataObject(dataArray) {
+        const neededIterations = dataArray.length;
+        let resultJson = {};
+        for (let i = 0; i < neededIterations; i++) {
+            resultJson[this.headers[i]] = dataArray[i];
+        }
+        return resultJson;
+    }
+    exportAsObject() {
+        return __awaiter(this, void 0, void 0, function* () {
+            const serializedData = this.serializeCsvString();
+            const dataObjects = [];
+            for (const dataArray of serializedData) {
+                dataObjects.push(this.createDataObject(dataArray));
+            }
+            return dataObjects;
+        });
     }
 }
 exports.Csv = Csv;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBRUE7SUFDUyxNQUFNLENBQU8sbUJBQW1CLENBQUUsWUFBb0I7O1lBQzNELE1BQU0sV0FBVyxHQUFHLElBQUksR0FBRyxFQUFFLENBQUM7WUFDOUIsV0FBVyxDQUFDLFNBQVMsR0FBRyxZQUFZLENBQUM7WUFDckMsT0FBTyxXQUFXLENBQUM7UUFDckIsQ0FBQztLQUFBO0lBR00sVUFBVTtJQUVqQixDQUFDO0lBRU0sWUFBWTtRQUNqQixJQUFJLElBQUksR0FBRztZQUNULENBQUMsS0FBSyxDQUFDLEVBQUUsSUFBSTtTQUNkLENBQUM7SUFDSixDQUFDO0NBRUY7QUFsQkQsa0JBa0JDIn0=
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoiaW5kZXguanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi90cy9pbmRleC50cyJdLCJuYW1lcyI6W10sIm1hcHBpbmdzIjoiOzs7Ozs7Ozs7O0FBTUE7SUFBQTtRQVlTLGFBQVEsR0FBVyxJQUFJLENBQUM7UUFFeEIsWUFBTyxHQUEyQjtZQUN2QyxPQUFPLEVBQUUsSUFBSTtTQUNkLENBQUM7SUFnRUosQ0FBQztJQS9FUSxNQUFNLENBQU8sbUJBQW1CLENBQ3JDLFlBQW9CLEVBQ3BCLE9BQStCOztZQUUvQixNQUFNLFdBQVcsR0FBRyxJQUFJLEdBQUcsRUFBRSxDQUFDO1lBQzlCLFdBQVcsQ0FBQyxTQUFTLEdBQUcsWUFBWSxDQUFDO1lBQ3JDLFdBQVcsQ0FBQyxpQkFBaUIsRUFBRSxDQUFDO1lBQ2hDLE9BQU8sV0FBVyxDQUFDO1FBQ3JCLENBQUM7S0FBQTtJQVNNLGlCQUFpQjtRQUN0QixJQUFJLFdBQVcsR0FBRyxDQUFDLENBQUM7UUFDcEIsSUFBSSxlQUFlLEdBQUcsQ0FBQyxDQUFDO1FBQ3hCLE1BQU0sZ0JBQWdCLEdBQUcsSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7UUFDcEQsTUFBTSxvQkFBb0IsR0FBRyxJQUFJLENBQUMsU0FBUyxDQUFDLEtBQUssQ0FBQyxJQUFJLENBQUMsQ0FBQztRQUN4RCxJQUFJLGdCQUFnQixFQUFFO1lBQ3BCLFdBQVcsR0FBRyxnQkFBZ0IsQ0FBQyxNQUFNLENBQUM7U0FDdkM7UUFDRCxJQUFJLG9CQUFvQixFQUFFO1lBQ3hCLGVBQWUsR0FBRyxvQkFBb0IsQ0FBQyxNQUFNLENBQUM7U0FDL0M7UUFDRCx5REFBeUQ7UUFDekQsSUFBSSxXQUFXLEdBQUcsZUFBZSxFQUFFO1lBQ2pDLElBQUksQ0FBQyxRQUFRLEdBQUcsR0FBRyxDQUFDO1NBQ3JCO2FBQU07WUFDTCxJQUFJLENBQUMsUUFBUSxHQUFHLEdBQUcsQ0FBQztTQUNyQjtJQUNILENBQUM7SUFFTSxrQkFBa0I7UUFDdkIsTUFBTSxRQUFRLEdBQUcsSUFBSSxDQUFDLE9BQU8sRUFBRSxDQUFDO1FBQ2hDLE1BQU0sV0FBVyxHQUFHLEVBQUUsQ0FBQztRQUN2QixJQUFJLElBQUksQ0FBQyxPQUFPLENBQUMsT0FBTyxFQUFFO1lBQ3hCLElBQUksQ0FBQyxVQUFVLEVBQUUsQ0FBQztZQUNsQixRQUFRLENBQUMsS0FBSyxFQUFFLENBQUM7U0FDbEI7UUFDRCxLQUFLLE1BQU0sR0FBRyxJQUFJLFFBQVEsRUFBRTtZQUMxQixXQUFXLENBQUMsSUFBSSxDQUFDLEdBQUcsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLFFBQVEsQ0FBQyxDQUFDLENBQUM7U0FDNUM7UUFDRCxPQUFPLFdBQVcsQ0FBQztJQUNyQixDQUFDO0lBRU0sT0FBTztRQUNaLE9BQU8sSUFBSSxDQUFDLFNBQVMsQ0FBQyxLQUFLLENBQUMsSUFBSSxDQUFDLENBQUM7SUFDcEMsQ0FBQztJQUVNLFVBQVU7UUFDZixNQUFNLFFBQVEsR0FBRyxJQUFJLENBQUMsT0FBTyxFQUFFLENBQUM7UUFDaEMsSUFBSSxJQUFJLENBQUMsT0FBTyxDQUFDLE9BQU8sRUFBRTtZQUN4QixJQUFJLFNBQVMsR0FBRyxRQUFRLENBQUMsQ0FBQyxDQUFDLENBQUM7WUFDNUIsSUFBSSxDQUFDLE9BQU8sR0FBRyxTQUFTLENBQUMsS0FBSyxDQUFDLElBQUksQ0FBQyxRQUFRLENBQUMsQ0FBQztTQUMvQztRQUNELE9BQU8sSUFBSSxDQUFDLE9BQU8sQ0FBQztJQUN0QixDQUFDO0lBRU0sZ0JBQWdCLENBQUMsU0FBbUI7UUFDekMsTUFBTSxnQkFBZ0IsR0FBRyxTQUFTLENBQUMsTUFBTSxDQUFDO1FBQzFDLElBQUksVUFBVSxHQUFRLEVBQUUsQ0FBQztRQUN6QixLQUFLLElBQUksQ0FBQyxHQUFHLENBQUMsRUFBRSxDQUFDLEdBQUcsZ0JBQWdCLEVBQUUsQ0FBQyxFQUFFLEVBQUU7WUFDekMsVUFBVSxDQUFDLElBQUksQ0FBQyxPQUFPLENBQUMsQ0FBQyxDQUFDLENBQUMsR0FBRyxTQUFTLENBQUMsQ0FBQyxDQUFDLENBQUM7U0FDNUM7UUFDRCxPQUFPLFVBQVUsQ0FBQztJQUNwQixDQUFDO0lBRVksY0FBYzs7WUFDekIsTUFBTSxjQUFjLEdBQUcsSUFBSSxDQUFDLGtCQUFrQixFQUFFLENBQUM7WUFDakQsTUFBTSxXQUFXLEdBQUcsRUFBRSxDQUFDO1lBQ3ZCLEtBQUssTUFBTSxTQUFTLElBQUksY0FBYyxFQUFFO2dCQUN0QyxXQUFXLENBQUMsSUFBSSxDQUFDLElBQUksQ0FBQyxnQkFBZ0IsQ0FBQyxTQUFTLENBQUMsQ0FBQyxDQUFDO2FBQ3BEO1lBQ0QsT0FBTyxXQUFXLENBQUM7UUFDckIsQ0FBQztLQUFBO0NBQ0Y7QUFoRkQsa0JBZ0ZDIn0=

dist/smartcsv.plugins.d.ts

@@ -1,2 +1,2 @@
-import * as csv from 'csv';
+import * as smartq from 'smartq';
-export { csv };
+export { smartq };

dist/smartcsv.plugins.js

@@ -1,5 +1,5 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-const csv = require("csv");
+const smartq = require("smartq");
-exports.csv = csv;
+exports.smartq = smartq;
-//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjc3YucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y3N2LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSwyQkFBMkI7QUFHekIsa0JBQUcifQ==
+//# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoic21hcnRjc3YucGx1Z2lucy5qcyIsInNvdXJjZVJvb3QiOiIiLCJzb3VyY2VzIjpbIi4uL3RzL3NtYXJ0Y3N2LnBsdWdpbnMudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7QUFBQSxpQ0FBaUM7QUFFeEIsd0JBQU0ifQ==

test/test.ts

@@ -8,12 +8,12 @@ import * as smartfile from 'smartfile';
 let fileString: string;
 let testCsv: smartcsv.Csv;
 
-tap.test('should read a file',  async (tools) => {
+tap.test('should read a file', async tools => {
   fileString = smartfile.fs.toStringSync('./test/sample.csv');
 });
 
 tap.test('should create a valid csv', async () => {
-  testCsv = await smartcsv.Csv.createCsvFromString(fileString, {headers: true});
+  testCsv = await smartcsv.Csv.createCsvFromString(fileString, { headers: true });
   const result = await testCsv.exportAsObject();
   console.log(result);
 });

ts/index.ts

@@ -5,19 +5,43 @@ export interface ICsvConstructorOptions {
 }
 
 export class Csv {
-  public static async createCsvFromString (csvStringArg: string, options: ICsvConstructorOptions): Promise<Csv> {
+  public static async createCsvFromString(
+    csvStringArg: string,
+    options: ICsvConstructorOptions
+  ): Promise<Csv> {
     const csvInstance = new Csv();
     csvInstance.csvString = csvStringArg;
+    csvInstance.determineKeyframe();
     return csvInstance;
   }
   public csvString: string;
   public headers: string[];
+  public keyFrame: string = null;
 
   public options: ICsvConstructorOptions = {
     headers: true
   };
 
-  public serializeCsvString () {
+  public determineKeyframe() {
+    let commaLength = 0;
+    let semicolonLength = 0;
+    const commaRegexResult = this.csvString.match(/,/g);
+    const semicolonRegexResult = this.csvString.match(/;/g);
+    if (commaRegexResult) {
+      commaLength = commaRegexResult.length;
+    }
+    if (semicolonRegexResult) {
+      semicolonLength = semicolonRegexResult.length;
+    }
+    // tslint:disable-next-line:prefer-conditional-expression
+    if (commaLength < semicolonLength) {
+      this.keyFrame = ';';
+    } else {
+      this.keyFrame = ',';
+    }
+  }
+
+  public serializeCsvString() {
     const rowArray = this.getRows();
     const resultArray = [];
     if (this.options.headers) {
@@ -25,34 +49,34 @@ export class Csv {
       rowArray.shift();
     }
     for (const row of rowArray) {
-      resultArray.push(row.split(';'));
+      resultArray.push(row.split(this.keyFrame));
     }
     return resultArray;
   }
 
-  public getRows () {
+  public getRows() {
     return this.csvString.split('\n');
   }
 
-  public getHeaders () {
+  public getHeaders() {
     const rowArray = this.getRows();
     if (this.options.headers) {
-      let headerRow = rowArray[ 0 ];
+      let headerRow = rowArray[0];
-      this.headers = headerRow.split(';');
+      this.headers = headerRow.split(this.keyFrame);
     }
     return this.headers;
   }
 
-  public createDataObject (dataArray: string[]) {
+  public createDataObject(dataArray: string[]) {
     const neededIterations = dataArray.length;
     let resultJson: any = {};
-    for(let i = 0; i < neededIterations; i++) {
+    for (let i = 0; i < neededIterations; i++) {
       resultJson[this.headers[i]] = dataArray[i];
     }
     return resultJson;
   }
 
-  public async exportAsObject (): Promise<any> {
+  public async exportAsObject(): Promise<any> {
     const serializedData = this.serializeCsvString();
     const dataObjects = [];
     for (const dataArray of serializedData) {
@@ -60,5 +84,4 @@ export class Csv {
     }
     return dataObjects;
   }
-
 }

ts/smartcsv.plugins.ts

@@ -1,5 +1,3 @@
 import * as smartq from 'smartq';
 
-export {
+export { smartq };
-  smartq
-};