feat(scalars): add support for custom scalar with arguments (#30)

ardeois · web-flow · commit 7dcc9cf466a7 · 2020-09-24T16:36:48.000-04:00
Some `casual.xxx` generators can accept arguments.
To give more flexibility, the `scalars` config now accepts:
- a string for retrocompatibility
- an object `{generator: string, arguments: any[]}` to pass arguments to the casual function
diff --git a/README.md b/README.md
@@ -31,11 +31,45 @@ Changes the case of the enums. Accepts `upper-case#upperCase`, `pascal-case#pasc
 
 Changes the case of the enums. Accepts `upper-case#upperCase`, `pascal-case#pascalCase` or `keep`
 
-### scalars (`{ [Scalar: string]: keyof Casual.Casual | Casual.functions }`, defaultValue: `undefined`)
+### scalars (`{ [Scalar: string]: ScalarDefinition }`, defaultValue: `undefined`)
 
 Allows you to define mappings for your custom scalars. Allows you to map any GraphQL Scalar to a
 [casual](https://github.com/boo1ean/casual#embedded-generators) embedded generator (string or
-function key)
+function key) with optional arguments
+
+Examples
+**With arguments**
+
+```
+plugins:
+  - typescript-mock-data:
+      scalars:
+        Date: # gets translated to casual.date('YYYY-MM-DD')
+          generator: date
+          arguments: 'YYYY-MM-DD'
+```
+
+**With multiple arguments**
+
+```
+plugins:
+  - typescript-mock-data:
+      scalars:
+        PaginatedAmount: # gets translated to casual.date(-100, 100)
+          generator: integer
+          arguments:
+            - -100
+            - 100
+```
+
+**Shorthand if you don't have arguments**
+
+```
+plugins:
+  - typescript-mock-data:
+      scalars:
+        Date: date # gets translated to casual.date()
+```
 
 ### typesPrefix (`string`, defaultValue: '')
 
@@ -69,7 +103,7 @@ generates:
       - 'typescript'
   src/mocks/generated-mocks.ts:
     plugins:
-      - 'graphql-codegen-typescript-mock-data':
+      - typescript-mock-data:
           typesFile: '../generated-types.ts'
           enumValues: upper-case#upperCase
           typenames: keep
@@ -156,6 +190,18 @@ const user = aUser({ login: 'johndoe' });
 // will create a user object with `login` property overridden to `johndoe`
 ```
 
+### Dealing with Timezone
+
+If some properties use generated dates, the result could different depending on the timezone of your machine.
+
+To force a timezone, you can set environment variable `TZ`:
+
+```bash
+TZ=UTC graphql-codegen
+```
+
+This will force the timezone to `UTC`, whatever the timezone of your machine or CI
+
 ### Contributing
 
 Feel free to open issues and pull requests. We always welcome support from the community.
diff --git a/package.json b/package.json
@@ -59,7 +59,7 @@
     "sideEffects": false,
     "scripts": {
         "build": "tsc -m esnext --outDir dist/esnext && tsc -m commonjs --outDir dist/commonjs",
-        "test": "jest",
+        "test": "TZ=UTC jest",
         "lint": "eslint 'src/**/*.{js,ts,tsx}' --quiet --fix && tsc --noEmit",
         "prettify": "prettier --config ./.prettierrc.js --write",
         "auto:version": "yarn version --`auto version` --message 'Bump version to: %s [skip ci]'",
diff --git a/src/index.ts b/src/index.ts
@@ -58,6 +58,16 @@ const hashedString = (value: string) => {
     return hash;
 };
 
+const getScalarDefinition = (value: ScalarDefinition | ScalarGeneratorName): ScalarDefinition => {
+    if (typeof value === 'string') {
+        return {
+            generator: value,
+            arguments: [],
+        };
+    }
+    return value;
+};
+
 const getNamedType = (
     typeName: string,
     fieldName: string,
@@ -85,8 +95,6 @@ const getNamedType = (
             return casual.boolean;
         case 'Int':
             return casual.integer(0, 9999);
-        case 'Date':
-            return `'${new Date(casual.unix_time).toISOString()}'`;
         default: {
             const foundType = types.find((enumType: TypeItem) => enumType.name === name);
             if (foundType) {
@@ -109,16 +117,26 @@ const getNamedType = (
                             foundType.types && foundType.types[0],
                         );
                     case 'scalar': {
+                        const customScalar = customScalars ? getScalarDefinition(customScalars[foundType.name]) : null;
                         // it's a scalar, let's use a string as a value if there is no custom
                         // mapping for this particular scalar
-                        if (!customScalars || !customScalars[foundType.name]) {
+                        if (!customScalar || !customScalar.generator) {
+                            if (foundType.name === 'Date') {
+                                return `'${new Date(casual.unix_time).toISOString()}'`;
+                            }
                             return `'${casual.word}'`;
                         }
 
                         // If there is a mapping to a `casual` type, then use it and make sure
                         // to call it if it's a function
-                        const embeddedGenerator = casual[customScalars[foundType.name]];
-                        const value = typeof embeddedGenerator === 'function' ? embeddedGenerator() : embeddedGenerator;
+                        const embeddedGenerator = casual[customScalar.generator];
+                        const generatorArgs: unknown[] = Array.isArray(customScalar.arguments)
+                            ? customScalar.arguments
+                            : [customScalar.arguments];
+                        const value =
+                            typeof embeddedGenerator === 'function'
+                                ? embeddedGenerator(...generatorArgs)
+                                : embeddedGenerator;
 
                         if (typeof value === 'string') {
                             return `'${value}'`;
@@ -208,7 +226,15 @@ ${fields}
 };`;
 };
 
-type ScalarMap = { [name: string]: keyof (Casual.Casual | Casual.functions) };
+type ScalarGeneratorName = keyof Casual.Casual | keyof Casual.functions;
+type ScalarDefinition = {
+    generator: ScalarGeneratorName;
+    arguments: unknown;
+};
+
+type ScalarMap = {
+    [name: string]: ScalarGeneratorName | ScalarDefinition;
+};
 
 export interface TypescriptMocksPluginConfig {
     typesFile?: string;
diff --git a/tests/__snapshots__/typescript-mock-data.spec.ts.snap b/tests/__snapshots__/typescript-mock-data.spec.ts.snap
@@ -74,6 +74,80 @@ export const aUser = (overrides?: Partial<Api.User>): Api.User => {
 "
 `;
 
+exports[`should correctly generate the \`casual\` data for a function with arguments scalar mapping 1`] = `
+"
+export const anAbcType = (overrides?: Partial<AbcType>): AbcType => {
+    return {
+        abc: overrides && overrides.hasOwnProperty('abc') ? overrides.abc! : 'sit',
+    };
+};
+
+export const anAvatar = (overrides?: Partial<Avatar>): Avatar => {
+    return {
+        id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : '0550ff93-dd31-49b4-8c38-ff1cb68bdc38',
+        url: overrides && overrides.hasOwnProperty('url') ? overrides.url! : 'aliquid',
+    };
+};
+
+export const anUpdateUserInput = (overrides?: Partial<UpdateUserInput>): UpdateUserInput => {
+    return {
+        id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : '1d6a9360-c92b-4660-8e5f-04155047bddc',
+        login: overrides && overrides.hasOwnProperty('login') ? overrides.login! : 'qui',
+        avatar: overrides && overrides.hasOwnProperty('avatar') ? overrides.avatar! : anAvatar(),
+    };
+};
+
+export const aUser = (overrides?: Partial<User>): User => {
+    return {
+        id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : 'a5756f00-41a6-422a-8a7d-d13ee6a63750',
+        creationDate: overrides && overrides.hasOwnProperty('creationDate') ? overrides.creationDate! : '1970-01-09T16:33:21.532Z',
+        login: overrides && overrides.hasOwnProperty('login') ? overrides.login! : 'libero',
+        avatar: overrides && overrides.hasOwnProperty('avatar') ? overrides.avatar! : anAvatar(),
+        status: overrides && overrides.hasOwnProperty('status') ? overrides.status! : Status.Online,
+        customStatus: overrides && overrides.hasOwnProperty('customStatus') ? overrides.customStatus! : AbcStatus.HasXyzStatus,
+        scalarValue: overrides && overrides.hasOwnProperty('scalarValue') ? overrides.scalarValue! : '1977-06-26',
+    };
+};
+"
+`;
+
+exports[`should correctly generate the \`casual\` data for a function with one argument scalar mapping 1`] = `
+"
+export const anAbcType = (overrides?: Partial<AbcType>): AbcType => {
+    return {
+        abc: overrides && overrides.hasOwnProperty('abc') ? overrides.abc! : 'sit',
+    };
+};
+
+export const anAvatar = (overrides?: Partial<Avatar>): Avatar => {
+    return {
+        id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : '0550ff93-dd31-49b4-8c38-ff1cb68bdc38',
+        url: overrides && overrides.hasOwnProperty('url') ? overrides.url! : 'aliquid',
+    };
+};
+
+export const anUpdateUserInput = (overrides?: Partial<UpdateUserInput>): UpdateUserInput => {
+    return {
+        id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : '1d6a9360-c92b-4660-8e5f-04155047bddc',
+        login: overrides && overrides.hasOwnProperty('login') ? overrides.login! : 'qui',
+        avatar: overrides && overrides.hasOwnProperty('avatar') ? overrides.avatar! : anAvatar(),
+    };
+};
+
+export const aUser = (overrides?: Partial<User>): User => {
+    return {
+        id: overrides && overrides.hasOwnProperty('id') ? overrides.id! : 'a5756f00-41a6-422a-8a7d-d13ee6a63750',
+        creationDate: overrides && overrides.hasOwnProperty('creationDate') ? overrides.creationDate! : '1970-01-09T16:33:21.532Z',
+        login: overrides && overrides.hasOwnProperty('login') ? overrides.login! : 'libero',
+        avatar: overrides && overrides.hasOwnProperty('avatar') ? overrides.avatar! : anAvatar(),
+        status: overrides && overrides.hasOwnProperty('status') ? overrides.status! : Status.Online,
+        customStatus: overrides && overrides.hasOwnProperty('customStatus') ? overrides.customStatus! : AbcStatus.HasXyzStatus,
+        scalarValue: overrides && overrides.hasOwnProperty('scalarValue') ? overrides.scalarValue! : '1977-06-26',
+    };
+};
+"
+`;
+
 exports[`should correctly generate the \`casual\` data for a non-string scalar mapping 1`] = `
 "
 export const anAbcType = (overrides?: Partial<AbcType>): AbcType => {
diff --git a/tests/typescript-mock-data.spec.ts b/tests/typescript-mock-data.spec.ts
@@ -194,6 +194,36 @@ it('should correctly generate the `casual` data for a non-string scalar mapping'
     expect(result).toMatchSnapshot();
 });
 
+it('should correctly generate the `casual` data for a function with arguments scalar mapping', async () => {
+    const result = await plugin(testSchema, [], {
+        scalars: {
+            AnyObject: {
+                generator: 'date',
+                arguments: ['YYYY-MM-DD'],
+            },
+        },
+    });
+
+    expect(result).toBeDefined();
+    expect(result).toContain("'1977-06-26'");
+    expect(result).toMatchSnapshot();
+});
+
+it('should correctly generate the `casual` data for a function with one argument scalar mapping', async () => {
+    const result = await plugin(testSchema, [], {
+        scalars: {
+            AnyObject: {
+                generator: 'date',
+                arguments: 'YYYY-MM-DD',
+            },
+        },
+    });
+
+    expect(result).toBeDefined();
+    expect(result).toContain("'1977-06-26'");
+    expect(result).toMatchSnapshot();
+});
+
 it('should add typesPrefix to all types when option is specified', async () => {
     const result = await plugin(testSchema, [], { typesPrefix: 'Api.' });
 
diff --git a/yarn.lock b/yarn.lock
