Language: English | 日本語

Accel Record Factory

This is a factory library for Accel Record.

Getting Started

1npm install -D accel-record-factory

Add the configuration for prisma-generator-accel-record to prisma/schema.prisma.

1generator client {
2  provider = "prisma-client-js"
3  output   = "../src/prisma/client"
4}
5
6generator accelRecord {
7  provider    = "prisma-generator-accel-record"
8  output      = "../src/models"
9  factoryPath = "../tests/factories" // Add the output destination for factory files
10}

After modifying prisma/schema.prisma, run the following command:

1npx prisma generate

For example, if you define a User model like this:

1// prisma/schema.prisma
2model User {
3  id        Int    @id @default(autoincrement())
4  firstName String
5  lastName  String
6  age       Int?
7}

The following factory file will be automatically generated:

1// tests/factories/user.ts
2
3import { defineFactory } from "accel-record-factory";
4import { User } from "../../src/models/index.js";
5
6export const UserFactory = defineFactory(User, {
7  // firstName: "MyString",
8  // lastName: "MyString",
9  // age: 1,
10});
11
12export { UserFactory as $User };

You can import and use the factory:

1// tests/user.test.ts
2
3import { $User } from "./factories/user";
4
5const newUser = $User.build();
6
7const user = $User.create({
8  firstName: "John",
9  lastName: "Doe",
10  age: 20,
11});

Usage

Setting Default Values

You can set default values by passing them as the second argument to defineFactory.

1// tests/factories/user.ts
2
3import { defineFactory } from "accel-record-factory";
4import { User } from "../../src/models/index.js";
5
6export const UserFactory = defineFactory(User, {
7  firstName: "John", // Set default value
8  lastName: "Doe",
9  age: 20,
10});
11
12export { UserFactory as $User };

1// tests/user.test.ts
2
3import { $User } from "./factories/user";
4
5const newUser = $User.build();
6newUser.firstName; // => "John"
7newUser.lastName; // => "Doe"
8newUser.age; // => 20

Using Sequential Numbers

When setting default values with defineFactory, you can use a function to utilize sequential numbers.

1// tests/factories/user.ts
2
3import { defineFactory } from "accel-record-factory";
4import { User } from "../../src/models/index.js";
5
6export const UserFactory = defineFactory(User, {
7  firstName: (seq) => `User${seq}`, // Specify a function to use sequential numbers
8});
9
10export { UserFactory as $User };

1// tests/user.test.ts
2
3import { $User } from "./factories/user";
4
5const user1 = $User.build();
6user1.firstName; // => "User1"
7
8const user2 = $User.build();
9user2.firstName; // => "User2"

Generating Associations

By specifying a function for the default value, you can generate models with associations.

1// prisma/schema.prisma
2model User {
3  id        Int    @id @default(autoincrement())
4  firstName String
5  lastName  String
6  age       Int?
7  setting   Setting? // Associated model
8}
9
10model Setting {
11  id     Int    @id @default(autoincrement())
12  userId Int
13  user   User   @relation(fields: [userId], references: [id])
14  notify Boolean
15}

1// tests/factories/user.ts
2
3import { defineFactory } from "accel-record-factory";
4import { User, Setting } from "../../src/models/index.js";
5
6export const UserFactory = defineFactory(User, {
7  setting: () => Setting.build({ notify: true }), // Specify a function to generate the association
8});
9
10export { UserFactory as $User };

1// tests/user.test.ts
2
3import { $User } from "./factories/user";
4
5const user = $User.build();
6user.setting.notify; // => true

Traits

By specifying traits as the third argument to defineFactory, you can set multiple default values.

1// tests/factories/user.ts
2
3import { defineFactory } from "accel-record-factory";
4import { User } from "../../src/models/index.js";
5
6export const UserFactory = defineFactory(
7  User,
8  {
9    firstName: "John",
10    lastName: "Doe",
11  },
12  {
13    traits: {
14      // Specify the trait name
15      foo: {
16        firstName: "Foo",
17        lastName: "Bar",
18      },
19    },
20  }
21);
22
23export { UserFactory as $User };

1// tests/user.test.ts
2
3import { $User } from "./factories/user";
4
5const john = $User.build({});
6john.firstName; // => "John"
7john.lastName; // => "Doe"
8
9const foo = $User.build({}, "foo"); // Use the trait
10foo.firstName; // => "Foo"
11foo.lastName; // => "Bar"