Merge pull request #111 from AthennaIO/develop

feat(parser): add csv parser

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@athenna/common",
-  "version": "4.30.0",
+  "version": "4.31.0",
   "description": "The Athenna common helpers to use in any Node.js ESM project.",
   "license": "MIT",
   "author": "João Lenon <[email protected]>",
@@ -60,6 +60,7 @@
     "chalk": "^5.3.0",
     "change-case": "^4.1.2",
     "collect.js": "^4.36.1",
+    "csv-parser": "^3.0.0",
     "execa": "^8.0.1",
     "fastify": "^4.25.2",
     "got": "^12.6.1",

src/helpers/Parser.ts

@@ -10,6 +10,7 @@
 import ms from 'ms'
 import bytes from 'bytes'
 import yaml from 'js-yaml'
+import csvParser from 'csv-parser'
 
 import { Is } from '#src/helpers/Is'
 import { String } from '#src/helpers/String'
@@ -20,6 +21,21 @@ import { getReasonPhrase, getStatusCode } from 'http-status-codes'
 import { InvalidNumberException } from '#src/exceptions/InvalidNumberException'
 
 export class Parser {
+  /**
+   * Parse using Node.js streams, useful for
+   * parsing multiple values in files.
+   */
+  public static stream() {
+    return {
+      /**
+       * Parse a csv chunk to json object.
+       */
+      csvToJson: (options?: csvParser.Options | string[]) => {
+        return csvParser(options)
+      }
+    }
+  }
+
   /**
    * Parse a string to array.
    */
@@ -50,14 +66,14 @@ export class Parser {
       return `${values[0]}${options?.pairSeparator || ' and '}${values[1]}`
     }
 
-    const normalized = Options.create(options, {
+    options = Options.create(options, {
       separator: ', ',
       lastSeparator: ' and '
     })
 
     return (
-      values.slice(0, -1).join(normalized.separator) +
-      normalized.lastSeparator +
+      values.slice(0, -1).join(options.separator) +
+      options.lastSeparator +
       values[values.length - 1]
     )
   }
@@ -162,6 +178,47 @@ export class Parser {
     return ms(value, { long })
   }
 
+  /**
+   * Parses a json to a csv string.
+   */
+  public static jsonToCsv(
+    value: Record<string, any>,
+    options: { headers?: string[] } = {}
+  ) {
+    options = Options.create(options, {
+      headers: Object.keys(value)
+    })
+
+    let csv = ''
+
+    if (!Is.Empty(options.headers)) {
+      csv +=
+        Parser.arrayToString(options.headers, {
+          separator: ',',
+          pairSeparator: ',',
+          lastSeparator: ','
+        }) + '\n'
+    }
+
+    const values = []
+
+    Object.keys(value).forEach(key => {
+      if (!Is.Empty(options.headers) && !options.headers.includes(key)) {
+        return
+      }
+
+      values.push(value[key])
+    })
+
+    csv += Parser.arrayToString(values, {
+      separator: ',',
+      pairSeparator: ',',
+      lastSeparator: ','
+    })
+
+    return csv
+  }
+
   /**
    * Parses the status code number to it reason in string.
    */

tests/fixtures/resources/data.csv

@@ -0,0 +1,3 @@
+id,name
+1,lenon
+2,victor

tests/unit/ParserTest.ts

@@ -7,7 +7,7 @@
  * file that was distributed with this source code.
  */
 
-import { Parser } from '#src'
+import { File, Parser } from '#src'
 import { Test, type Context } from '@athenna/test'
 import { InvalidNumberException } from '#src/exceptions/InvalidNumberException'
 
@@ -279,4 +279,47 @@ export default class ParserTest {
 
     assert.deepEqual(object, { version: 3 })
   }
+
+  @Test()
+  public async shouldBeAbleToParseObjectToCsv({ assert }: Context) {
+    const csv = Parser.jsonToCsv({ id: 1, name: 'lenon' })
+
+    assert.deepEqual(csv, 'id,name\n1,lenon')
+  }
+
+  @Test()
+  public async shouldBeAbleToParseObjectToCsvWithoutHeaders({ assert }: Context) {
+    const csv = Parser.jsonToCsv({ id: 1, name: 'lenon' }, { headers: [] })
+
+    assert.deepEqual(csv, '1,lenon')
+  }
+
+  @Test()
+  public async shouldBeAbleToParseObjectToCsvOnlyWithDefinedHeaders({ assert }: Context) {
+    const csv = Parser.jsonToCsv({ id: 1, name: 'lenon' }, { headers: ['id'] })
+
+    assert.deepEqual(csv, 'id\n1')
+  }
+
+  @Test()
+  public async shouldBeAbleToParseACsvFileToJson({ assert }: Context) {
+    const getCsvData = async () => {
+      return new Promise(resolve => {
+        const data = []
+
+        new File(Path.fixtures('resources/data.csv'))
+          .createReadStream()
+          .pipe(Parser.stream().csvToJson())
+          .on('data', user => data.push(user))
+          .on('end', () => resolve(data))
+      })
+    }
+
+    const data = await getCsvData()
+
+    assert.deepEqual(data, [
+      { id: '1', name: 'lenon' },
+      { id: '2', name: 'victor' }
+    ])
+  }
 }