E2RPRO-4480 validation 自動生成 -- カスタムメソッド追加 (Code-Hex#8)

wand2016 · web-flow · commit 4c54b58b9ceb · 2023-11-27T07:00:42.000Z
* refactor: split shape Renderer and Factory

* sort

* bump

* rm field arg from sometimes
diff --git a/example/yup/schemas.ts b/example/yup/schemas.ts
@@ -50,7 +50,7 @@ export function EventArgumentInputSchema(): yup.ObjectSchema<EventArgumentInput>
   return yup.object({
     favorites: yup.array(yup.string().maxLength(16).nonNullable().defined()).size(5).nonNullable().defined(),
     name: yup.lazy(() => yup.string().varchar().required_without("nickname").nonNullable().defined()),
-    nickname: yup.lazy(() => yup.string().sometimes("nickname", schema => schema.varchar().max(10).required_without("name")).nullable()),
+    nickname: yup.lazy(() => yup.string().sometimes(schema => schema.varchar().max(10).required_without("name")).nullable()),
     value: yup.string().startsWith("Sir").nonNullable().defined()
   }).strict()
 }
diff --git a/example/yup/yup.d.ts b/example/yup/yup.d.ts
@@ -9,7 +9,7 @@ declare module 'yup' {
   > extends Schema<TType, TContext, TDefault, TFlags> {
     maxLength(size: number): this;
     varchar(): this;
-    sometimes(str: string, callback: (schema: this) => this): this;
+    sometimes(callback: (schema: this) => this): this;
     startsWith(str: string): this;
     required_without(str: string): this;
   }
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "graphql-codegen-lighthouse-yup-schema",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema",
   "respository": {
     "type": "git",
diff --git a/src/yup/Kit.ts b/src/yup/Kit.ts
@@ -13,9 +13,10 @@ import { FieldFactory } from './renderable/field/FieldFactory';
 import { FieldRenderer } from './renderable/field/FieldRenderer';
 import { RuleASTFactory } from './renderable/ruleAST/RuleASTFactory';
 import { RuleASTRenderer } from './renderable/ruleAST/RuleASTRenderer';
+import { ShapeFactory } from './renderable/shape/ShapeFactory';
+import { ShapeRenderer } from './renderable/shape/ShapeRenderer';
 import { TypeASTFactory } from './renderable/typeAST/TypeASTFactory';
 import { TypeASTRenderer } from './renderable/typeAST/TypeASTRenderer';
-import { ShapeRenderer } from './ShapeRenderer';
 import { EnumTypeDefinitionFactory } from './visitFunctionFactories/EnumTypeDefinitionFactory';
 import { InputObjectTypeDefinitionFactory } from './visitFunctionFactories/InputObjectTypeDefinitionFactory';
 import { ObjectTypeDefinitionFactory } from './visitFunctionFactories/ObjectTypeDefinitionFactory';
@@ -61,6 +62,10 @@ export class Kit {
     }
   }
 
+  getShapeRenderer() {
+    return new ShapeRenderer(this.getFieldRenderer());
+  }
+
   getFieldRenderer() {
     return new FieldRenderer(this.getTypeASTRenderer());
   }
@@ -69,24 +74,23 @@ export class Kit {
     return new TypeASTRenderer(this.config, this.getRuleASTRenderer(), this.getExportTypesStrategy());
   }
 
-  getRuleASTFactory() {
-    return new RuleASTFactory(this.config.rules, this.config.ignoreRules, this.config.lazyRules);
-  }
-
   getRuleASTRenderer() {
     return new RuleASTRenderer();
   }
 
-  getShapeRenderer(scalarDirection: keyof NormalizedScalarsMap[string]) {
-    return new ShapeRenderer(this.getFieldRenderer(), this.getFieldFactory(scalarDirection));
+  getShapeFactory(scalarDirection: keyof NormalizedScalarsMap[string]) {
+    return new ShapeFactory(this.getFieldFactory(scalarDirection));
   }
 
+  getFieldFactory(scalarDirection: keyof NormalizedScalarsMap[string]) {
+    return new FieldFactory(this.getTypeASTFactory(scalarDirection), this.getRuleASTFactory());
+  }
   getTypeASTFactory(scalarDirection: keyof NormalizedScalarsMap[string]) {
     return new TypeASTFactory(this.config.lazyTypes, scalarDirection, this.getVisitor());
   }
 
-  getFieldFactory(scalarDirection: keyof NormalizedScalarsMap[string]) {
-    return new FieldFactory(this.getTypeASTFactory(scalarDirection), this.getRuleASTFactory());
+  getRuleASTFactory() {
+    return new RuleASTFactory(this.config.rules, this.config.ignoreRules, this.config.lazyRules);
   }
 
   getImportBuilder() {
@@ -102,7 +106,8 @@ export class Kit {
       registry,
       this.getVisitor(),
       this.getExportTypesStrategy(),
-      this.getShapeRenderer('input')
+      this.getShapeFactory('input'),
+      this.getShapeRenderer()
     );
   }
 
@@ -112,7 +117,8 @@ export class Kit {
       this.getVisitor(),
       this.getWithObjectTypesSpec(),
       this.getExportTypesStrategy(),
-      this.getShapeRenderer('output'),
+      this.getShapeFactory('output'),
+      this.getShapeRenderer(),
       this.config.addUnderscoreToArgsType
     );
   }
diff --git a/src/yup/ShapeRenderer.ts b/src/yup/ShapeRenderer.ts
diff --git a/src/yup/renderable/field/FieldFactory.ts b/src/yup/renderable/field/FieldFactory.ts
@@ -16,13 +16,12 @@ export class FieldFactory {
     const directives = graphQLFieldNode.directives ?? [];
     const rulesDirective = findDirectiveByName(directives, 'rules');
     const rulesForArrayDirective = findDirectiveByName(directives, 'rulesForArray');
-    const fieldName = graphQLFieldNode.name.value;
 
     const metadata = new FieldMetadata({
       name: graphQLFieldNode.name.value,
       isOptional: !isNonNullType(graphQLFieldNode.type),
-      rule: this.ruleASTFactory.createFromDirectiveOrNull(fieldName, rulesDirective ?? null),
-      ruleForArray: this.ruleASTFactory.createFromDirectiveOrNull(fieldName, rulesForArrayDirective ?? null),
+      rule: this.ruleASTFactory.createFromDirectiveOrNull(rulesDirective ?? null),
+      ruleForArray: this.ruleASTFactory.createFromDirectiveOrNull(rulesForArrayDirective ?? null),
     });
 
     return new Field(metadata, this.typeASTFactory.create(graphQLFieldNode.type));
diff --git a/src/yup/renderable/ruleAST/RuleASTFactory.ts b/src/yup/renderable/ruleAST/RuleASTFactory.ts
@@ -13,15 +13,15 @@ export class RuleASTFactory {
     private readonly supportedArgumentName: string = 'apply'
   ) {}
 
-  public createFromDirectiveOrNull(fieldName: string, directive: ConstDirectiveNode | null) {
-    return directive ? this.createFromDirective(fieldName, directive) : this.createNullObject();
+  public createFromDirectiveOrNull(directive: ConstDirectiveNode | null) {
+    return directive ? this.createFromDirective(directive) : this.createNullObject();
   }
 
   public createNullObject() {
     return new RuleASTCompositeNode([]);
   }
 
-  public createFromDirective(fieldName: string, directive: ConstDirectiveNode) {
+  public createFromDirective(directive: ConstDirectiveNode) {
     const ruleStrings = (directive.arguments ?? [])
       .filter(arg => arg.name.value === this.supportedArgumentName)
       .flatMap(({ value }) => {
@@ -32,10 +32,10 @@ export class RuleASTFactory {
         });
       });
 
-    return this.helper(fieldName, ruleStrings);
+    return this.helper(ruleStrings);
   }
 
-  private helper(fieldName: string, ruleStrings: readonly string[]): RuleASTCompositeNode | RuleASTSometimesNode {
+  private helper(ruleStrings: readonly string[]): RuleASTCompositeNode | RuleASTSometimesNode {
     const parsed = ruleStrings.flatMap(ruleString => {
       const validationRule = parse(ruleString);
 
@@ -60,7 +60,7 @@ export class RuleASTFactory {
 
     return sometimesIfExists.length === 0
       ? compositeRule
-      : new RuleASTSometimesNode(fieldName, compositeRule, this.requiresLazy('sometimes'));
+      : new RuleASTSometimesNode(compositeRule, this.requiresLazy('sometimes'));
   }
 
   private mapMethodName(ruleName: string): string {
diff --git a/src/yup/renderable/ruleAST/RuleASTRenderer.ts b/src/yup/renderable/ruleAST/RuleASTRenderer.ts
@@ -16,8 +16,8 @@ export class RuleASTRenderer {
   }
 
   public renderSometimesRule(sometimesRule: RuleASTSometimesNode): string {
-    const { fieldName, continuation } = sometimesRule.getData();
-    return `.sometimes(${JSON.stringify(fieldName)}, schema => schema${continuation.render(this)})`;
+    const { continuation } = sometimesRule.getData();
+    return `.sometimes(schema => schema${continuation.render(this)})`;
   }
 }
 
diff --git a/src/yup/renderable/ruleAST/RuleASTSometimesNode.ts b/src/yup/renderable/ruleAST/RuleASTSometimesNode.ts
@@ -5,14 +5,12 @@ import { RuleASTRenderer } from './RuleASTRenderer';
 // sometimes は特殊で、他の検証ルールを無視する必要があるため、コールバックで他の検証ルールを渡す形にする。
 export class RuleASTSometimesNode implements RuleASTNode {
   public constructor(
-    private readonly fieldName: string, // 消したい
     private readonly continuation: RuleASTCompositeNode,
     private readonly _requiresLazy: boolean
   ) {}
 
   public getData() {
     return {
-      fieldName: this.fieldName,
       continuation: this.continuation,
     };
   }
diff --git a/src/yup/renderable/shape/Shape.ts b/src/yup/renderable/shape/Shape.ts
@@ -0,0 +1,16 @@
+import { Field } from '../field/Field';
+import { ShapeRenderer } from './ShapeRenderer';
+
+export class Shape {
+  constructor(private readonly fields: readonly Field[]) {}
+
+  public getData() {
+    return {
+      fields: this.fields,
+    };
+  }
+
+  public render(shapeRenderer: ShapeRenderer): string {
+    return shapeRenderer.render(this);
+  }
+}
diff --git a/src/yup/renderable/shape/ShapeFactory.ts b/src/yup/renderable/shape/ShapeFactory.ts
@@ -0,0 +1,12 @@
+import { FieldDefinitionNode, InputValueDefinitionNode } from 'graphql';
+
+import { FieldFactory } from '../field/FieldFactory';
+import { Shape } from './Shape';
+
+export class ShapeFactory {
+  constructor(private readonly fieldFactory: FieldFactory) {}
+
+  public create(graphQLFields: readonly (InputValueDefinitionNode | FieldDefinitionNode)[]) {
+    return new Shape(graphQLFields.map(field => this.fieldFactory.create(field)));
+  }
+}
diff --git a/src/yup/renderable/shape/ShapeRenderer.ts b/src/yup/renderable/shape/ShapeRenderer.ts
@@ -0,0 +1,13 @@
+import { FieldRenderer } from '../field/FieldRenderer';
+import { Shape } from './Shape';
+
+export class ShapeRenderer {
+  constructor(private readonly fieldRenderer: FieldRenderer) {}
+
+  public render(shape: Shape): string {
+    return shape
+      .getData()
+      .fields.map(field => field.render(this.fieldRenderer))
+      .join(',\n');
+  }
+}
diff --git a/src/yup/visitFunctionFactories/InputObjectTypeDefinitionFactory.ts b/src/yup/visitFunctionFactories/InputObjectTypeDefinitionFactory.ts
@@ -3,22 +3,25 @@ import { InputObjectTypeDefinitionNode } from 'graphql';
 import { Visitor } from '../../visitor';
 import { ExportTypeStrategy } from '../exportTypeStrategies/ExportTypeStrategy';
 import { Registry } from '../registry';
-import { ShapeRenderer } from '../ShapeRenderer';
+import { ShapeFactory } from '../renderable/shape/ShapeFactory';
+import { ShapeRenderer } from '../renderable/shape/ShapeRenderer';
 import { VisitFunctionFactory } from './types';
 
 export class InputObjectTypeDefinitionFactory implements VisitFunctionFactory<InputObjectTypeDefinitionNode> {
   constructor(
     private readonly registry: Registry,
     private readonly visitor: Visitor,
     private readonly exportTypeStrategy: ExportTypeStrategy,
+    private readonly shapeFactory: ShapeFactory,
     private readonly shapeRenderer: ShapeRenderer
   ) {}
 
   create() {
     return (node: InputObjectTypeDefinitionNode) => {
       const name = this.visitor.convertName(node.name.value);
       this.registry.registerType(name);
-      return this.exportTypeStrategy.inputObjectTypeDefinition(name, this.shapeRenderer.render(node.fields ?? []));
+      const shape = this.shapeFactory.create(node.fields ?? []);
+      return this.exportTypeStrategy.inputObjectTypeDefinition(name, shape.render(this.shapeRenderer));
     };
   }
 }
diff --git a/src/yup/visitFunctionFactories/ObjectTypeDefinitionFactory.ts b/src/yup/visitFunctionFactories/ObjectTypeDefinitionFactory.ts
@@ -3,7 +3,8 @@ import { FieldDefinitionNode, ObjectTypeDefinitionNode } from 'graphql';
 import { Visitor } from '../../visitor';
 import { ExportTypeStrategy } from '../exportTypeStrategies/ExportTypeStrategy';
 import { Registry } from '../registry';
-import { ShapeRenderer } from '../ShapeRenderer';
+import { ShapeFactory } from '../renderable/shape/ShapeFactory';
+import { ShapeRenderer } from '../renderable/shape/ShapeRenderer';
 import { WithObjectTypesSpec } from '../withObjectTypesSpecs/WithObjectTypesSpec';
 import { VisitFunctionFactory } from './types';
 
@@ -13,6 +14,7 @@ export class ObjectTypeDefinitionFactory implements VisitFunctionFactory<ObjectT
     private readonly visitor: Visitor,
     private readonly withObjectTypesSpec: WithObjectTypesSpec,
     private readonly exportTypeStrategy: ExportTypeStrategy,
+    private readonly shapeFactory: ShapeFactory,
     private readonly shapeRenderer: ShapeRenderer,
     private readonly addUnderscoreToArgsType: boolean = false
   ) {}
@@ -27,17 +29,19 @@ export class ObjectTypeDefinitionFactory implements VisitFunctionFactory<ObjectT
       // Building schema for field arguments.
       const argumentBlocks = this.buildArgumentsSchemaBlock(node, (typeName, field) => {
         this.registry.registerType(typeName);
-        return this.exportTypeStrategy.inputObjectTypeDefinition(
-          typeName,
-          this.shapeRenderer.render(field.arguments ?? [])
-        );
+        const shape = this.shapeFactory.create(field.arguments ?? []);
+        return this.exportTypeStrategy.inputObjectTypeDefinition(typeName, shape.render(this.shapeRenderer));
       });
       const appendArguments = argumentBlocks ? '\n' + argumentBlocks : '';
 
       // Building schema for fields.
-      const shapeContent = this.shapeRenderer.render(node.fields ?? []);
-
-      return this.exportTypeStrategy.objectTypeDefinition(name, node.name.value, shapeContent, appendArguments);
+      const shape = this.shapeFactory.create(node.fields ?? []);
+      return this.exportTypeStrategy.objectTypeDefinition(
+        name,
+        node.name.value,
+        shape.render(this.shapeRenderer),
+        appendArguments
+      );
     };
   }
 
diff --git a/tests/yup.spec.ts b/tests/yup.spec.ts
@@ -852,7 +852,7 @@ describe('yup', () => {
       'name: yup.lazy(() => yup.string().startsWith("Sir").required_without("nickname").nonNullable().defined()),',
       'age: yup.number().min(0).max(100).nonNullable().defined()',
       'keyword: yup.string().matches(/^[a-zA-Z0-9]+$/).nonNullable().defined()',
-      'nickname: yup.lazy(() => yup.string().sometimes("nickname", schema => schema.max(10).required_without("name")).nullable())',
+      'nickname: yup.lazy(() => yup.string().sometimes(schema => schema.max(10).required_without("name")).nullable())',
     ];
     for (const wantContain of wantContains) {
       expect(result.content).toContain(wantContain);

Original file line number	Diff line number	Diff line change
`@@ -50,7 +50,7 @@ export function EventArgumentInputSchema(): yup.ObjectSchema<EventArgumentInput>`
`50`	`50`	`return yup.object({`
`51`	`51`	`favorites: yup.array(yup.string().maxLength(16).nonNullable().defined()).size(5).nonNullable().defined(),`
`52`	`52`	`name: yup.lazy(() => yup.string().varchar().required_without("nickname").nonNullable().defined()),`
`53`		`- nickname: yup.lazy(() => yup.string().sometimes("nickname", schema => schema.varchar().max(10).required_without("name")).nullable()),`
	`53`	`+ nickname: yup.lazy(() => yup.string().sometimes(schema => schema.varchar().max(10).required_without("name")).nullable()),`
`54`	`54`	`value: yup.string().startsWith("Sir").nonNullable().defined()`
`55`	`55`	`}).strict()`
`56`	`56`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@ declare module 'yup' {`
`9`	`9`	`> extends Schema<TType, TContext, TDefault, TFlags> {`
`10`	`10`	`maxLength(size: number): this;`
`11`	`11`	`varchar(): this;`
`12`		`- sometimes(str: string, callback: (schema: this) => this): this;`
	`12`	`+ sometimes(callback: (schema: this) => this): this;`
`13`	`13`	`startsWith(str: string): this;`
`14`	`14`	`required_without(str: string): this;`
`15`	`15`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`{`
`2`	`2`	`"name": "graphql-codegen-lighthouse-yup-schema",`
`3`		`- "version": "0.8.2",`
	`3`	`+ "version": "0.9.0",`
`4`	`4`	`"description": "GraphQL Code Generator plugin to generate form validation schema from your GraphQL schema",`
`5`	`5`	`"respository": {`
`6`	`6`	`"type": "git",`
Original file line number	Diff line number	Diff line change
`@@ -16,8 +16,8 @@ export class RuleASTRenderer {`
`16`	`16`	`}`
`17`	`17`
`18`	`18`	`public renderSometimesRule(sometimesRule: RuleASTSometimesNode): string {`
`19`		`- const { fieldName, continuation } = sometimesRule.getData();`
`20`		- return `.sometimes(${JSON.stringify(fieldName)}, schema => schema${continuation.render(this)})`;
	`19`	`+ const { continuation } = sometimesRule.getData();`
	`20`	+ return `.sometimes(schema => schema${continuation.render(this)})`;
`21`	`21`	`}`
`22`	`22`	`}`
`23`	`23`