1.0.22

.gitlab-ci.yml

@@ -1,10 +1,10 @@
-# gitzone standard
+# gitzone ci_default
-image: hosttoday/ht-docker-node:npmci
+image: registry.gitlab.com/hosttoday/ht-docker-node:npmci
 
 cache:
   paths:
     - .npmci_cache/
-  key: "$CI_BUILD_STAGE"
+  key: '$CI_BUILD_STAGE'
 
 stages:
   - security
@@ -20,17 +20,19 @@ mirror:
   script:
     - npmci git mirror
   tags:
+    - lossless
     - docker
     - notpriv
 
 snyk:
+  image: registry.gitlab.com/hosttoday/ht-docker-node:snyk
   stage: security
   script:
     - npmci npm prepare
-    - npmci command npm install -g snyk
     - npmci command npm install --ignore-scripts
     - npmci command snyk test
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -38,19 +40,7 @@ snyk:
 # test stage
 # ====================
 
-testLTS:
+testStable:
-  stage: test
-  script:
-  - npmci npm prepare
-  - npmci node install lts
-  - npmci npm install
-  - npmci npm test
-  coverage: /\d+.?\d+?\%\s*coverage/
-  tags:
-  - docker
-  - notpriv
-    
-testSTABLE:
   stage: test
   script:
     - npmci npm prepare
@@ -59,6 +49,20 @@ testSTABLE:
     - npmci npm test
   coverage: /\d+.?\d+?\%\s*coverage/
   tags:
+    - lossless
+    - docker
+    - priv
+
+testBuild:
+  stage: test
+  script:
+    - npmci npm prepare
+    - npmci node install stable
+    - npmci npm install
+    - npmci command npm run build
+  coverage: /\d+.?\d+?\%\s*coverage/
+  tags:
+    - lossless
     - docker
     - notpriv
 
@@ -70,6 +74,7 @@ release:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
@@ -78,20 +83,14 @@ release:
 # ====================
 codequality:
   stage: metadata
-  image: docker:stable
   allow_failure: true
-  services:
-    - docker:stable-dind
   script:
-    - export SP_VERSION=$(echo "$CI_SERVER_VERSION" | sed 's/^\([0-9]*\)\.\([0-9]*\).*/\1-\2-stable/')
+    - npmci command npm install -g tslint typescript
-    - docker run
+    - npmci npm prepare
-        --env SOURCE_CODE="$PWD"
+    - npmci npm install
-        --volume "$PWD":/code
+    - npmci command "tslint -c tslint.json ./ts/**/*.ts"
-        --volume /var/run/docker.sock:/var/run/docker.sock
-        "registry.gitlab.com/gitlab-org/security-products/codequality:$SP_VERSION" /code
-  artifacts:
-    paths: [codeclimate.json]
   tags:
+    - lossless
     - docker
     - priv
 
@@ -102,18 +101,20 @@ trigger:
   only:
     - tags
   tags:
+    - lossless
     - docker
     - notpriv
 
 pages:
-  image: hosttoday/ht-docker-node:npmci
   stage: metadata
   script:
+    - npmci node install lts
     - npmci command npm install -g @gitzone/tsdoc
     - npmci npm prepare
     - npmci npm install
     - npmci command tsdoc
   tags:
+    - lossless
     - docker
     - notpriv
   only:

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@pushrocks/smartcsv",
-  "version": "1.0.16",
+  "version": "1.0.22",
   "private": false,
   "description": "handle csv data | gitzone standard compliant",
   "main": "dist/index.js",
@@ -13,14 +13,28 @@
     "format": "(gitzone format)"
   },
   "devDependencies": {
-    "@gitzone/tsbuild": "^2.1.11",
+    "@gitzone/tsbuild": "^2.1.17",
-    "@gitzone/tsrun": "^1.2.6",
+    "@gitzone/tsrun": "^1.2.8",
-    "@gitzone/tstest": "^1.0.21",
+    "@gitzone/tstest": "^1.0.28",
-    "@pushrocks/smartfile": "^7.0.2",
+    "@pushrocks/smartfile": "^7.0.6",
-    "@pushrocks/tapbundle": "^3.0.9",
+    "@pushrocks/tapbundle": "^3.2.0",
-    "@types/node": "^12.0.2"
+    "@types/node": "^12.12.17",
+    "tslint": "^6.0.0-beta0",
+    "tslint-config-prettier": "^1.18.0"
   },
   "dependencies": {
-    "@pushrocks/smartpromise": "^3.0.2"
+    "@pushrocks/smartpromise": "^3.0.6",
-  }
+    "@pushrocks/smartstring": "^3.0.17"
+  },
+  "files": [
+    "ts/**/*",
+    "ts_web/**/*",
+    "dist/**/*",
+    "dist_web/**/*",
+    "dist_ts_web/**/*",
+    "assets/**/*",
+    "cli.js",
+    "npmextra.json",
+    "readme.md"
+  ]
 }

readme.md

@@ -18,9 +18,14 @@ handle csv data | gitzone standard compliant
 
 ## Usage
 
+
+## Contribution
+
+We are always happy for code contributions. If you are not the code contributing type that is ok. Still, maintaining Open Source repositories takes considerable time and thought. If you like the quality of what we do and our modules are useful to you we would appreciate a little monthly contribution: You can [contribute one time](https://lossless.link/contribute-onetime) or [contribute monthly](https://lossless.link/contribute). :)
+
 For further information read the linked docs at the top of this readme.
 
 > MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
-| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
+| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy)
 
-[![repo-footer](https://pushrocks.gitlab.io/assets/repo-footer.svg)](https://maintainedby.lossless.com)
+[![repo-footer](https://lossless.gitlab.io/publicrelations/repofooter.svg)](https://maintainedby.lossless.com)

test/sample.csv

@@ -1,3 +1,3 @@
-Header 1;Header 2; Header3
+Header 1;Header 2;"Header 3"
-row1data1; row1data2; row1data3
+"row1data1";"row1data2";"row1data3"
-row2data1; row2data2; row2data3
+"row2data1";row2data2;"row2data3"

test/test.ts

@@ -13,7 +13,7 @@ tap.test('should read a file', async tools => {
 });
 
 tap.test('should create a valid csv', async () => {
-  testCsv = await smartcsv.Csv.createCsvFromString(fileString, { headers: true });
+  testCsv = await smartcsv.Csv.createCsvFromString(fileString, { headers: true, unquote: true });
   const result = await testCsv.exportAsObject();
   console.log(result);
 });

ts/index.ts

@@ -2,6 +2,7 @@ import * as plugins from './smartcsv.plugins';
 
 export interface ICsvConstructorOptions {
   headers: boolean;
+  unquote?: boolean;
 }
 
 export class Csv {
@@ -17,6 +18,7 @@ export class Csv {
     optionsArg: ICsvConstructorOptions
   ): Promise<Csv> {
     const csvInstance = new Csv(csvStringArg, optionsArg);
+    await csvInstance.exportAsObject();
     return csvInstance;
   }
 
@@ -51,21 +53,40 @@ export class Csv {
   public csvString: string;
   public headers: string[];
   public keyFrame: string = null;
+  public data: any[];
+
+  private base64RecognitionPrefix = '####12345####';
 
   public options: ICsvConstructorOptions = {
-    headers: true
+    headers: true,
+    unquote: true
   };
 
   constructor(csvStringArg: string, optionsArg: ICsvConstructorOptions) {
-    this.csvString = csvStringArg;
+    this.options = {
-    this.options = optionsArg;
+      ...this.options,
+      ...optionsArg
+    };
+
+    let csvStringToParse = csvStringArg;
+    if (this.options.unquote) {
+      csvStringToParse = csvStringToParse.replace(
+        /"(.*?)"/gi,
+        (match, p1, offset, originalString) => {
+          return this.base64RecognitionPrefix + plugins.smartstring.base64.encode(match);
+        }
+      );
+    }
+
+    this.csvString = csvStringToParse;
+
     this.determineKeyframe();
   }
 
   /**
    * determines the keyframe of the csv string
    */
-  public determineKeyframe() {
+  private determineKeyframe() {
     let commaLength = 0;
     let semicolonLength = 0;
     const commaRegexResult = this.csvString.match(/,/g);
@@ -87,7 +108,7 @@ export class Csv {
   /**
    * serializes the csv string
    */
-  public serializeCsvString() {
+  private serializeCsvString() {
     const rowArray = this.getRows();
     const resultArray = [];
     if (this.options.headers) {
@@ -100,7 +121,10 @@ export class Csv {
     return resultArray;
   }
 
-  public getRows(): string[] {
+  /**
+   * gets the rows of the csv
+   */
+  private getRows(): string[] {
     const rowsArray = this.csvString.split('\n');
     if (rowsArray[rowsArray.length - 1] === '') {
       rowsArray.pop();
@@ -108,20 +132,40 @@ export class Csv {
     return rowsArray;
   }
 
-  public getHeaders() {
+  private getHeaders() {
     const rowArray = this.getRows();
     if (this.options.headers) {
       let headerRow = rowArray[0];
       this.headers = headerRow.split(this.keyFrame);
+      if (this.options.unquote) {
+        const unquotedHeaders: string[] = [];
+        for (let header of this.headers) {
+          if (header.startsWith(this.base64RecognitionPrefix)) {
+            header = header.replace(this.base64RecognitionPrefix, '');
+            unquotedHeaders.push(plugins.smartstring.base64.decode(header).replace(/['"]+/g, ''));
+          } else {
+            unquotedHeaders.push(header);
+          }
+        }
+        this.headers = unquotedHeaders;
+      }
     }
     return this.headers;
   }
 
-  public createDataObject(dataArray: string[]) {
+  private createDataObject(dataArray: string[]) {
     const neededIterations = dataArray.length;
     let resultJson: any = {};
     for (let i = 0; i < neededIterations; i++) {
-      resultJson[this.headers[i]] = dataArray[i];
+      let value = dataArray[i];
+      if (this.options.unquote && value.startsWith(this.base64RecognitionPrefix)) {
+        value = value.replace(this.base64RecognitionPrefix, '');
+        value = plugins.smartstring.base64
+          .decode(value)
+          .replace(/['"]+/g, '')
+          .replace(/['"]+/g, '');
+      }
+      resultJson[this.headers[i]] = value;
     }
     return resultJson;
   }
@@ -132,6 +176,7 @@ export class Csv {
     for (const dataArray of serializedData) {
       dataObjects.push(this.createDataObject(dataArray));
     }
+    this.data = dataObjects;
     return dataObjects;
   }
 }

ts/smartcsv.plugins.ts

@@ -1,3 +1,4 @@
-import * as smartq from '@pushrocks/smartpromise';
+import * as smartpromise from '@pushrocks/smartpromise';
+import * as smartstring from '@pushrocks/smartstring';
 
-export { smartq };
+export { smartpromise, smartstring };