Merge pull request #152 from tomasz-szymanek/faker-locale-support

feat: added faker locale support
RobinCK · Sep 16, 2020 · 4d15352 · 4d15352
2 parents d84fc12 + 2385ab9
commit 4d15352
Show file tree

Hide file tree

Showing 13 changed files with 75 additions and 2 deletions.
diff --git a/src/interface/IFixture.ts b/src/interface/IFixture.ts
@@ -1,6 +1,7 @@
 export interface IFixture {
     parameters: { [key: string]: any };
     processor?: string;
+    locale?: string;
     entity: string;
     name: string;
     dependencies: string[];

diff --git a/src/interface/IFixturesConfig.ts b/src/interface/IFixturesConfig.ts
@@ -1,5 +1,6 @@
 export interface IFixturesConfig {
     entity: string;
+    locale?: string;
     parameters?: { [key: string]: any };
     processor?: string;
     items: { [key: string]: any };

diff --git a/src/parsers/FakerParser.ts b/src/parsers/FakerParser.ts
@@ -1,5 +1,5 @@
 import * as faker from 'faker';
-import { IParser } from '../interface';
+import { IFixture, IParser } from '../interface';
 
 export class FakerParser implements IParser {
     /**
@@ -17,9 +17,14 @@ export class FakerParser implements IParser {
 
     /**
      * @param {string} value
+     * @param {IFixture} fixture
      * @return {any}
      */
-    parse(value: string): any {
+    parse(value: string, fixture?: IFixture): any {
+        if (fixture?.locale) {
+            // @ts-ignore
+            faker.locale = fixture.locale;
+        }
         const result = faker.fake(value);
 
         if ((+result).toString() === result) {

diff --git a/src/schema/jFixturesSchema.ts b/src/schema/jFixturesSchema.ts
@@ -2,6 +2,52 @@ import * as Joi from '@hapi/joi';
 
 export const jFixturesSchema = Joi.object().keys({
     entity: Joi.string().min(1).required(),
+    locale: Joi.string().valid(
+        'az',
+        'ar',
+        'cz',
+        'de',
+        'de_AT',
+        'de_CH',
+        'en',
+        'en_AU',
+        'en_AU_ock',
+        'en_BORK',
+        'en_CA',
+        'en_GB',
+        'en_IE',
+        'en_IND',
+        'en_US',
+        'en_Z',
+        'es',
+        'es_M',
+        'fa',
+        'fi',
+        'fr',
+        'fr_CA',
+        'fr_CH',
+        'ge',
+        'id_I',
+        'it',
+        'ja',
+        'ko',
+        'nb_NO',
+        'nep',
+        'nl',
+        'nl_B',
+        'pl',
+        'pt_BR',
+        'pt_P',
+        'ro',
+        'ru',
+        'sk',
+        'sv',
+        'tr',
+        'uk',
+        'vi',
+        'zh_CN',
+        'zh_TW',
+    ),
     parameters: Joi.object(),
     processor: Joi.string(),
     items: Joi.object().required(),

diff --git a/test/intergation/assets/fixtures/Comment.yml b/test/intergation/assets/fixtures/Comment.yml
@@ -1,4 +1,5 @@
 entity: Comment
+locale: 'pl'
 parameters: {}
 items:
   comment{1..10}:

diff --git a/test/intergation/assets/fixtures/Group.yml b/test/intergation/assets/fixtures/Group.yml
@@ -1,4 +1,5 @@
 entity: Group
+locale: 'pl'
 parameters:
   names:
     admin: Admin

diff --git a/test/intergation/assets/fixtures/Post.yml b/test/intergation/assets/fixtures/Post.yml
@@ -1,4 +1,5 @@
 entity: Post
+locale: 'pl'
 parameters: {}
 items:
   post1:

diff --git a/test/intergation/assets/fixtures/Profile.yml b/test/intergation/assets/fixtures/Profile.yml
@@ -1,4 +1,5 @@
 entity: Profile
+locale: 'pl'
 parameters: {}
 items:
   profile1:

diff --git a/test/intergation/assets/fixtures/User.yml b/test/intergation/assets/fixtures/User.yml
@@ -1,4 +1,5 @@
 entity: User
+locale: 'pl'
 parameters: {}
 processor: ../processor/UserProcessor
 items:

diff --git a/test/unit/Loader.test.ts b/test/unit/Loader.test.ts
@@ -19,6 +19,7 @@ describe('Loader', () => {
         expect(configs).to.deep.equal([
             {
                 entity: 'Post',
+                locale: 'pl',
                 processor: '',
                 items: {
                     post1: {
@@ -30,6 +31,7 @@ describe('Loader', () => {
             },
             {
                 entity: 'User',
+                locale: 'pl',
                 processor: '',
                 items: {
                     user1: {
@@ -58,6 +60,7 @@ describe('Loader', () => {
             {
                 entity: 'Post',
                 processor: '',
+                locale: 'pl',
                 items: {
                     post1: {
                         title: '{{name.title}}',

diff --git a/test/unit/assets/fixtures/Post.yml b/test/unit/assets/fixtures/Post.yml
@@ -1,4 +1,5 @@
 entity: Post
+locale: 'pl'
 processor: '../processor/PostProcessor'
 items:
   post1:

diff --git a/test/unit/assets/fixtures/User.json b/test/unit/assets/fixtures/User.json
@@ -1,5 +1,6 @@
 {
   "entity": "User",
+  "locale": "pl",
   "processor": "/foo/boo",
   "items": {
     "user1": {

diff --git a/test/unit/parsers/FakerParser.test.ts b/test/unit/parsers/FakerParser.test.ts
@@ -1,6 +1,7 @@
 import 'mocha';
 import { expect, assert } from 'chai';
 import { FakerParser } from '../../../src/parsers';
+import { IFixture } from '../../../src/interface';
 
 describe('Faker parser', () => {
     it('should be support', () => {
@@ -35,4 +36,13 @@ describe('Faker parser', () => {
 
         assert.isString(result);
     });
+
+    it('should be translated string', () => {
+        const parser = new FakerParser();
+        const result = parser.parse('{{random.word}}', {
+            locale: 'pl',
+        } as IFixture);
+
+        assert.isString(result);
+    });
 });