【PHPerKaigi2022 後日談】なんちゃって Entity を導入しよう

class User
{
    public function __construct(
        private int $id,
        private string $name,
    ) {
    }

    public function id(): int
    {
        return $this->id;
    }

    public function name(): string
    {
        return $this->name;
    }
}

class User extends Model
{
    public function toEntity(): UserEntity
    {
        return new UserEntity(
            id: $this->id,
            name: $this->name,
        );
    }
}

public function create(string $name): UserEntity
{
    return UserModel::create([
        'name' => $name,
    ])->toEntity();
}

public function retrieveById(int $id): ?UserEntity
{
    return UserModel::query() // find() などでも可能
        ->whereKey($id)
        ->first()
        ?->toEntity()
}

public function update(int $id, string $name): UserEntity
{
    if (! $model = UserModel::find($id)) {
        throw new UserNotFoundException();
    }

    $model->update([
        'name' => $name,
        // 他の値も引数で受け取り列挙
    ]);

    return $model->toEntity();
}

public function updateName(int $id, string $name): UserEntity
{
    if (! $model = UserModel::find($id)) {
        throw new UserNotFoundException();
    }

    $model->update([
        'name' => $name,
    ]);

    return $model->toEntity();
}

public function delete(int $id): void
{
    if (! $model = UserModel::find($id)) {
        throw new UserNotFoundException();
    }

    $model->delete();
}

// twtter の user name を更新したいだけなのに．．．
$user = $this->userRepository
    ->update(
        id: $user->id(),
        name: $user->name(),
        nickName: $user->nickName(),
        birthday: $user->birthday(),
        gender: $user->gender(),
        twitterUserName: $newTwitterUserName,
        // ...
    );

$user = User::find($id);
$user->update([
    'twitter_user_name' => $newTwitterUserName,
]);

$user = User::find($id);
$user->twitter_user_name = $newTwitterUserName;
$user->save();

class User
{
    public function __construct(
-        private int $id,
-        private string $name,
+        private UserModel $model
    ) {
+        assert($model->exists);
    }

    public function id(): int
    {
-        return $this->id;
+        return $this->model->id;
    }

    public function name(): string
    {
-        return $this->name;
+        return $this->model->name;
    }
+
+    public function setName(string $name): static
+    {
+        $this->model->name = $name;
+
+        return $this;
+    }
+
+    public function save(): static
+    {
+        $this->model->save();
+
+        return $this;
+    }
}

- $user = $this->userRepository
-    ->update(
-        id: $user->id(),
-        name: $user->name(),
-        nickName: $user->nickName(),
-        birthday: $user->birthday(),
-        gender: $user->gender(),
-        twitterUserName: $newTwitterUserName,
-        // ...
-    );
+$user->setTwitterUserName($newTwitterUserName);
+$user->save();

<?php

declare(strict_types=1);

namespace App\UseCases\Employee;

use App\Exceptions\Employee\EmployeeNotFoundException;
use App\Exceptions\Employee\OverwiteSameValueException;
use App\Entities\Employee;
use App\Repositories\EmployeeRepository;

class UpdateEmergencyContactNumberAction
{
    public function __construct(
        private EmployeeRepository $repository,
    ) {
    }

    public function __invoke(int $employeeNumber, string $emergencyContactNumber): Employee
    {
        // 社員番号から社員を検索
        $employee = $this->repository
            ->retrieveByEmplpyeeNumber($employeeNumber);

        // 存在チェック
        if (!$employee) {
            throw new EmployeeNotFoundException('該当する社員が見つかりませでした。');
        }

        // 同じ番号での上書きを禁止する
        if ($employee->emergencyContactNumber() === $emergencyContactNumber) {
            throw new OverwiteSameValueException('変更前と同じ番号です。');
        }

        // 緊急連絡先の更新
        $employee->setEmergencyContactNumber($emergencyContactNumber);
        $employee-save();

        return $employee;
    }
}

<?php

declare(strict_types=1);

namespace Tests\Unit\UseCases;

use App\Entities\Employee as EmployeeEntity;
use App\Exceptions\Employee\EmployeeNotFoundException;
use App\Repositories\EmployeeRepository;
use App\UseCases\Employee\UpdateEmergencyContactNumberAction;
use Mockery;
use Mockery\MockInterface;

class UpdateEmergencyContactNumberActionTest
{
    /**
     * @var EmployeeRepository&MockInterface&mixed
     */
    private EmployeeRepository $repository;

    private UpdateEmergencyContactNumberAction $action;

    public function setUp(): void
    {
        parent::setUp();

        $this->repository = Mockery::mock(EmployeeRepository::class);
        $this->action = new UpdateEmergencyContactNumberAction($this->repository);
    }

    /**
     * @test
     */
    public function 緊急連絡先の更新(): void
    {
        // リポジトリの振る舞い
        $this->repository
            ->shouldReceive('retrieveByEmplpyeeNumber')
            ->once()
            ->with('123')
            ->andReturn($employee = Mockery::mock(EmployeeEntity::class));

        // エンティティの振る舞い
        $employee
            ->shouldReceive('emergencyContactNumber')
            ->once()
            ->andReturn('080-1234-5678');
        $employee
            ->shouldReceive('setEmergencyContactNumber')
            ->once()
            ->with('080-9876-5432');
        $employee
            ->shouldReceive('save')
            ->once()

        // 実行
        $result = $this->action(
            employeeNumber: '123',
            emergencyContactNumber: '080-9876-5432',
        );

        // 戻り値の検証
        $this->assertInstanceOf(EmployeeEntity::class, $result);
    }

    /**
     * @test
     */
    public function 緊急連絡先が存在しない(): void
    {
        // リポジトリの振る舞い
        $this->repository
            ->shouldReceive('retrieveByEmplpyeeNumber')
            ->once()
            ->with('123')
            ->andReturnNull();

        // 例外が投げられることを期待
        $this->expectException(EmployeeNotFoundException::class);

        // 実行
        $this->action(
            employeeNumber: '123',
            emergencyContactNumber: '080-9876-5432',
        );
    }
}