Merge branch 'main' into fix/csv-file-loader-line-count

DEFRA · Sep 6, 2024 · a506852 · a506852
2 parents a2ce657 + cf43003
commit a506852
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 28 deletions.
diff --git a/package.json b/package.json
@@ -20,6 +20,7 @@
   ],
   "author": "Charlie Benger-Stevenson",
   "license": "OGL-UK-3.0",
+  "repository": "https://github.com/DEFRA/ffc-pay-etl-framework",
   "description": "A framework for creating ETL pipelines in node",
   "jest": {
     "setupFiles": [

diff --git a/src/transformers/README.md b/src/transformers/README.md
@@ -11,33 +11,46 @@ Currently supported transformers are :
 
 ### Options
 
-| option         | description                                                   |
-| -------------- | ------------------------------------------------------------- |
-| columns        | Array of column transformations                               |
+| option  | description                                                  |
+| ------- | ------------------------------------------------------------ |
+| columns | Array of column transformations                              |
+| locale  | See https://fakerjs.dev/guide/localization for valid locales |
 
 ### Usage
 
 ```js
-FakerTransformer(
-    { 
-        columns: [
-            {
-                name: "column2",
-                faker: "company.name"
-            }
-        ]
-    }
-)
+FakerTransformer({
+  columns: [
+    {
+      name: "column2",
+      faker: "company.name",
+    },
+  ],
+});
 ```
 
 faker is a string value that can be any of the currently supported [apis](https://fakerjs.dev/api/)
 
-e.g. 
+e.g.
 
 - finance.accountName
 - person.firstName
 - randomizer.next
 
+To create UK post code
+
+```js
+FakerTransformer({
+  columns: [
+    {
+      name: "column2",
+      faker: "location.zipCode",
+    },
+  ],
+  locale: "en_GB",
+});
+```
+
 ### Example
 
 src/examples/csv-faker.js
@@ -46,20 +59,18 @@ src/examples/csv-faker.js
 
 ### Options
 
-| option         | description                                                   |
-| -------------- | ------------------------------------------------------------- |
-| column         | source column to be transformed                               |
+| option | description                     |
+| ------ | ------------------------------- |
+| column | source column to be transformed |
 
 ### Usage
 
 ```js
-ToUpperCaseTransformer(
-    { 
-        column: "column2"
-    }
-)
+ToUpperCaseTransformer({
+  column: "column2",
+});
 ```
 
 ### Example
 
-src/examples/csv-to-upper-case.js
+src/examples/csv-to-upper-case.js
diff --git a/src/transformers/fakerTransformer.js b/src/transformers/fakerTransformer.js
@@ -1,5 +1,4 @@
 const { Transform } = require("node:stream")
-const { faker } = require("@faker-js/faker")
 
 /**
  * 
@@ -12,11 +11,19 @@ const { faker } = require("@faker-js/faker")
  *               }
  *           ]
  *       }
+ * @param {String} options.locale
  * @returns StreamReader
  */
 function FakerTransformer(options){
     let self = this
     self.columns = options.columns
+    let faker;
+    if(options.locale){
+        faker = require(`@faker-js/faker/locale/${options.locale}`).faker
+    } else {
+        faker = require('@faker-js/faker').faker
+    }
+
     function getFaker(fakerType) {
         return fakerType.split('.').reduce((a,b) => {
             return Object.keys(a).length === 0 ? faker[b] : a[b]

diff --git a/test/transformers/fakerTransformer.test.js b/test/transformers/fakerTransformer.test.js
@@ -23,9 +23,6 @@ describe('fakerTransformer tests', () => {
                 objectMode: true,
                 transform(chunk,_,callback){
                     expect(chunk.errors.length).toEqual(0)
-<<<<<<< Updated upstream
-                    expect(chunk[1]).not.toEqual("B")
-=======
                     expect(chunk[1]).not.toEqual("b")
                     done()
                     callback(null, chunk)
@@ -57,7 +54,6 @@ describe('fakerTransformer tests', () => {
                     expect(chunk[1]).not.toEqual("b")
                     const regex = /^([A-Za-z]{2}[\d]{1,2}[A-Za-z]?)[\s]+([\d][A-Za-z]{2})$/
                     expect(chunk[1].match(regex)[0]).toEqual(chunk[1])
->>>>>>> Stashed changes
                     done()
                     callback(null, chunk)
                 }