バリデーション

Accel Recordのモデルに、バリデーションを追加することができます。

バリデーションのサンプル

モデルに対するバリデーションのサンプルを記載します。

src/models/user.ts

import { validates } from "accel-record/validations";
import { ApplicationRecord } from "./applicationRecord.js";

export class UserModel extends ApplicationRecord {
  static validations = validates(this, [["firstName", { presence: true }]]);
}

import { User } from "./models/index.js";

const user = User.build({ firstName: "" });
user.isValid(); // => false
user.errors.fullMessages(); // => ["FirstName can't be blank"]

user.firstName = "John";
user.isValid(); // => true

バリデーションの実行タイミング

save, update, craeteメソッドを利用する場合、バリデーションが自動的に実行され、エラーが無い場合のみ保存処理が行われます。

import { User } from "./models/index.js";

// バリデーションエラーが発生した場合、saveやupdateはfalseを返します。
const newUser = User.build({ firstName: "" });
newUser.save(); // => false
newUser.errors.fullMessages(); // => ["FirstName can't be blank"]

const user = User.first()!;
user.update({ firstName: "" }); // => false
newUser.errors.fullMessages(); // => ["FirstName can't be blank"]

// バリデーションエラーが発生した場合、createでは例外がスローされます。
User.create({ firstName: "" }); // => Error: Failed to create

バリデーションの定義

validates()関数を利用しモデルクラスにvalidationsプロパティを用意することで、バリデーションを定義することができます。 または、BaseModelのvalidateAttributes()メソッドをオーバーライドする方法もあります。

prisma/schema.prisma

model ValidateSample {
  id       Int     @id @default(autoincrement())
  accepted Boolean
  pattern  String
  key      String
  count    Int
  size     String
}

./models/validateSample.ts

import { Validator } from "accel-record";
import { validates } from "accel-record/validations";
import { ApplicationRecord } from "./applicationRecord.js";

export class ValidateSampleModel extends ApplicationRecord {
  static validations = validates(this, [
    // よく使われるバリデーションは、バリデーションヘルパーを利用して簡単に記述ができます。
    ["accepted", { acceptance: true }],
    [
      "pattern",
      {
        length: { minimum: 2, maximum: 5 },
        format: { with: /^[a-z]+$/, message: "only allows lowercase letters" },
      },
    ],
    ["size", { inclusion: { in: ["small", "medium", "large"] } }],
    [["key", "size"], { presence: true }],

    // カスタムバリデータの利用例
    MyValidator,
  ]);

  // validateAttributesメソッドをオーバーライドして、バリデーションを定義することもできます。
  override validateAttributes() {
    this.validates("key", { uniqueness: true });

    // 独自のロジックでバリデーションを行う場合は、 errros.add メソッドを利用してエラーメッセージを追加します。
    if (this.key && !/^[a-z]$/.test(this.key[0])) {
      this.errors.add("key", "should start with a lowercase letter");
    }
  }
}

// カスタムバリデータは、Validatorを継承してvalidateメソッドを実装します。
class MyValidator extends Validator<{ key: string | undefined }> {
  validate() {
    if (this.record.key === "xs") {
      this.errors.add("key", "should not be xs");
    }
  }
}