[feat-21] Rename afterCreate to afterBuild (#25)

Author: davidtkramer

README.md

@@ -235,7 +235,7 @@ userFactory.build().fullName; // 'Alice Smith'
 
 ### Transient Params
 
-Transient params are arguments that can be passed to the build method that are not merged into the returned object. They can be used to provide options to attribute builders and afterCreate hooks.
+Transient params are arguments that can be passed to the build method that are not merged into the returned object. They can be used to provide options to attribute builders and afterBuild hooks.
 
 The `transient` method defines the default values for transient params. The types for transient params are inferred by the compiler and will be type-safe in the build method, just like regular attributes.
 
@@ -251,7 +251,7 @@ const contactFactory = createFactory(factory =>
       }
       name: 'Alice',
     })
-    .afterCreate(({ entity, transientParams }) => {
+    .afterBuild(({ entity, transientParams }) => {
       if (transientParams.downcaseName) {
         entity.name = entity.name.toLowerCase();
       }
@@ -303,7 +303,7 @@ user.isAdmin; // true
 user.isActive; // false
 ```
 
-Traits can define their own transient params and after create hooks using the alternative builder syntax.
+Traits can define their own transient params and after build hooks using the alternative builder syntax.
 
 ```typescript
 import { postFactory } from './post-factory';
@@ -323,7 +323,7 @@ const userFactory = createFactory((factory) =>
         .attributes({
           type: 'author'
         })
-        .afterCreate(({ entity, transientParams }) => {
+        .afterBuild(({ entity, transientParams }) => {
           const { postCount } = transientParams;
           for (let i = 0; i < postCount; i++) {
             entity.posts.push(...postFactory.buildList(postCount))
@@ -350,7 +350,7 @@ const contactFactory = createFactory((factory) =>
       phone: '(555) 123,4567',
       name: 'Alice',
     })
-    .afterCreate(({ entity, transientParams }) => {
+    .afterBuild(({ entity, transientParams }) => {
       if (transientParams.upcaseName) {
         entity.name = entity.name.toUpperCase();
       }
@@ -368,7 +368,7 @@ contact.name; // 'ALICE'
 
 ### Extending Factories
 
-Factories can extend from one or more parent factories. This is helpful for sharing logic between factories and modeling inheritance. Transient params, attributes, traits, and after create hooks defined on the parent will be inherited.
+Factories can extend from one or more parent factories. This is helpful for sharing logic between factories and modeling inheritance. Transient params, attributes, traits, and after build hooks defined on the parent will be inherited.
 
 #### Sharing logic
 

src/__tests__/factory.test.ts

@@ -31,7 +31,7 @@ describe('build', () => {
           .attributes({
             role: 'owner',
           })
-          .afterCreate(({ entity, transientParams }) => {
+          .afterBuild(({ entity, transientParams }) => {
             if (transientParams.skipOwnerHook) return;
             entity.hooks.push('owner');
           })
@@ -42,20 +42,20 @@ describe('build', () => {
           .attributes({
             type: 'bot',
           })
-          .afterCreate(({ entity, transientParams }) => {
+          .afterBuild(({ entity, transientParams }) => {
             if (transientParams.skipBotHook) return;
             entity.hooks.push('bot1');
           })
-          .afterCreate(({ entity, transientParams }) => {
+          .afterBuild(({ entity, transientParams }) => {
             if (transientParams.skipBotHook) return;
             entity.hooks.push('bot2');
           })
       )
-      .afterCreate(({ entity, transientParams }) => {
+      .afterBuild(({ entity, transientParams }) => {
         if (transientParams.skipGlobalHook) return;
         entity.hooks.push('global1');
       })
-      .afterCreate(({ entity, transientParams }) => {
+      .afterBuild(({ entity, transientParams }) => {
         if (transientParams.skipGlobalHook) return;
         entity.hooks.push('global2');
       })
@@ -151,12 +151,12 @@ describe('build', () => {
     expect(ownerUser.role).toBe('owner');
   });
 
-  it('runs global afterCreate hooks after trait afterCreate hooks', () => {
+  it('runs global afterBuild hooks after trait afterBuild hooks', () => {
     const user = factory.build('owner', 'bot');
     expect(user.hooks).toEqual(['owner', 'bot1', 'bot2', 'global1', 'global2']);
   });
 
-  it('runs trait afterCreate hooks in same order as provided traits', () => {
+  it('runs trait afterBuild hooks in same order as provided traits', () => {
     const user1 = factory.build('owner', 'bot', { skipGlobalHook: true });
     expect(user1.hooks).toEqual(['owner', 'bot1', 'bot2']);
 
@@ -251,7 +251,7 @@ describe('buildList', () => {
 
 describe('DSL', () => {
   describe('extends', () => {
-    it('can inherit attributes, transientParams, traits, and afterCreate hooks', () => {
+    it('can inherit attributes, transientParams, traits, and afterBuild hooks', () => {
       interface BaseContact {
         id: number;
         phone: string;
@@ -268,11 +268,11 @@ describe('DSL', () => {
           })
           .trait('invalidPhone', { phone: 'asdf' })
           .trait('withCountryCode', (trait) =>
-            trait.transient({ countryCode: 1 }).afterCreate(({ entity }) => {
+            trait.transient({ countryCode: 1 }).afterBuild(({ entity }) => {
               entity.phone = `+1 ${entity.phone}`;
             })
           )
-          .afterCreate(({ entity }) => {
+          .afterBuild(({ entity }) => {
             entity.phone = entity.phone + ' x123';
           })
       );
@@ -288,14 +288,14 @@ describe('DSL', () => {
             businessName: 'Mega Lo Mart',
           })
           .trait('invalidName', { businessName: '' })
-          .afterCreate(({ entity, transientParams }) => {
+          .afterBuild(({ entity, transientParams }) => {
             if (transientParams.upcaseName) {
               entity.businessName = entity.businessName.toUpperCase();
             }
           })
       );
 
-      // inherits attributes, transientParam defaults, and afterCreate hooks
+      // inherits attributes, transientParam defaults, and afterBuild hooks
       const business1 = businessFactory.build();
       expect(business1.id).toBe(1);
       expect(business1.phone).toBe('(555) 123-4567 x123');
@@ -397,11 +397,11 @@ describe('DSL', () => {
           .trait('parentTrait', (trait) =>
             trait
               .transient({ parentTraitTransientParam: 1 })
-              .afterCreate(({ entity }) => {
+              .afterBuild(({ entity }) => {
                 entity.hooks.push('parentTraitHook');
               })
           )
-          .afterCreate(({ entity }) => {
+          .afterBuild(({ entity }) => {
             entity.hooks.push('parentHook');
           })
       );
@@ -413,11 +413,11 @@ describe('DSL', () => {
           .trait('parentTrait', (trait) =>
             trait
               .attributes({ childOneAttribute: 2 })
-              .afterCreate(({ entity }) => {
+              .afterBuild(({ entity }) => {
                 entity.hooks.push('childOneTraitHook');
               })
           )
-          .afterCreate(({ entity }) => {
+          .afterBuild(({ entity }) => {
             entity.hooks.push('childOneHook');
           })
       );
@@ -429,11 +429,11 @@ describe('DSL', () => {
           .trait('parentTrait', (trait) =>
             trait
               .attributes({ childTwoAttribute: 1 })
-              .afterCreate(({ entity }) => {
+              .afterBuild(({ entity }) => {
                 entity.hooks.push('childTwoTraitHook');
               })
           )
-          .afterCreate(({ entity }) => {
+          .afterBuild(({ entity }) => {
             entity.hooks.push('childTwoHook');
           })
       );
@@ -632,15 +632,15 @@ describe('DSL', () => {
       expect(user2.name).toBe('odd');
     });
 
-    it('can use transientParams in afterCreate', () => {
+    it('can use transientParams in afterBuild', () => {
       const factory = createFactory((factory) =>
         factory
           .transient({ globalTransientId: 10 })
           .attributes<{ id: number; name: string }>({ id: 1, name: 'name' })
           .trait('transient', (trait) =>
             trait
               .transient({ traitTransientName: 'transientNameDefault' })
-              .afterCreate(({ entity, transientParams }) => {
+              .afterBuild(({ entity, transientParams }) => {
                 entity.id = transientParams.globalTransientId;
                 entity.name = transientParams.traitTransientName;
               })
@@ -662,13 +662,13 @@ describe('DSL', () => {
     });
   });
 
-  describe('afterCreate', () => {
+  describe('afterBuild', () => {
     it('can use transientParams', () => {
       const factory = createFactory((factory) =>
         factory
           .transient({ globalTransientId: 10 })
           .attributes<{ id: number }>({ id: 1 })
-          .afterCreate(({ entity, transientParams }) => {
+          .afterBuild(({ entity, transientParams }) => {
             entity.id = transientParams.globalTransientId;
           })
       );

src/factory.ts

@@ -85,8 +85,8 @@ interface TraitBuilder<
     >
   ): FinalBuilder<TraitBuilder<Entity, GlobalTransientParams, TransientParams>>;
 
-  afterCreate(
-    afterCreateCallback: (params: {
+  afterBuild(
+    afterBuildCallback: (params: {
       entity: Entity;
       transientParams: GlobalTransientParams & TransientParams;
     }) => void
@@ -153,8 +153,8 @@ interface FactoryBuilder<
     >
   >;
 
-  afterCreate(
-    afterCreateCallback: (params: {
+  afterBuild(
+    afterBuildCallback: (params: {
       entity: OuterEntity;
       transientParams: OuterGlobalTransientParams;
     }) => void
@@ -214,10 +214,10 @@ interface FactoryDefinition {
     {
       attributeDefaults: Record<string, any>;
       transientParamDefaults: Record<string, any>;
-      afterCreateHooks: Array<(...args: Array<any>) => void>;
+      afterBuildHooks: Array<(...args: Array<any>) => void>;
     }
   >;
-  afterCreateHooks: Array<(...args: Array<any>) => void>;
+  afterBuildHooks: Array<(...args: Array<any>) => void>;
   sequence: { count: number };
 }
 
@@ -230,7 +230,7 @@ export function createFactory<Entity, GlobalTransientParams, Traits>(
     attributeDefaults: {},
     transientParamDefaults: {},
     traits: {},
-    afterCreateHooks: [],
+    afterBuildHooks: [],
     sequence: { count: -1 },
   };
 
@@ -296,11 +296,11 @@ export function createFactory<Entity, GlobalTransientParams, Traits>(
         }
       }
 
-      // after create hooks
+      // after build hooks
       for (let traitName of traitNames.reverse()) {
         const trait = definition.traits[traitName];
-        for (let afterCreate of trait.afterCreateHooks) {
-          afterCreate({
+        for (let afterBuild of trait.afterBuildHooks) {
+          afterBuild({
             entity,
             transientParams: {
               ...trait.transientParamDefaults,
@@ -310,8 +310,8 @@ export function createFactory<Entity, GlobalTransientParams, Traits>(
         }
       }
 
-      for (let afterCreate of definition.afterCreateHooks) {
-        afterCreate({ entity, transientParams });
+      for (let afterBuild of definition.afterBuildHooks) {
+        afterBuild({ entity, transientParams });
       }
 
       return entity as Entity;
@@ -354,7 +354,7 @@ export function createFactory<Entity, GlobalTransientParams, Traits>(
           const trait = parentDefinition.traits[traitName];
           definition.traits[traitName] = { ...trait };
         }
-        definition.afterCreateHooks.push(...parentDefinition.afterCreateHooks);
+        definition.afterBuildHooks.push(...parentDefinition.afterBuildHooks);
       }
       return factoryBuilder;
     },
@@ -370,7 +370,7 @@ export function createFactory<Entity, GlobalTransientParams, Traits>(
       definition.traits[name] = {
         attributeDefaults: {},
         transientParamDefaults: {},
-        afterCreateHooks: [],
+        afterBuildHooks: [],
       };
       if (typeof traitBuilderArg === 'function') {
         const traitBuilder: TraitBuilder<any, any, any> = {
@@ -382,8 +382,8 @@ export function createFactory<Entity, GlobalTransientParams, Traits>(
             definition.traits[name].transientParamDefaults = params;
             return traitBuilder;
           },
-          afterCreate(afterCreateCallback) {
-            definition.traits[name].afterCreateHooks.push(afterCreateCallback);
+          afterBuild(afterBuildCallback) {
+            definition.traits[name].afterBuildHooks.push(afterBuildCallback);
             return traitBuilder;
           },
         };
@@ -393,8 +393,8 @@ export function createFactory<Entity, GlobalTransientParams, Traits>(
       }
       return factoryBuilder;
     },
-    afterCreate(afterCreateCallback) {
-      definition.afterCreateHooks.push(afterCreateCallback);
+    afterBuild(afterBuildCallback) {
+      definition.afterBuildHooks.push(afterBuildCallback);
       return factoryBuilder;
     },
   };