第一章６『Labelモデルに関わるサービスとリポジトリの実装』

2022/03/18 Laravel

前回のあらすじ

リポジトリクラスとサービスクラスをいい感じに作ってくれるテンプレートとコマンドを設定してTodoモデルとLabelモデル用のリポジトリクラスとサービスクラスを作ってTodoモデル用のリポジトリクラスとサービスクラスの中身を修正してテストした。

今回はLabelモデル用のリポジトリクラスとサービスクラスのコードを書いていく。やる事は前回とほぼ同じ。

app/Repositories/LabelRepository.phpを以下のように編集する。

<?php

declare(strict_types=1);

namespace App\Repositories;

use App\Models\Label;
use Illuminate\Database\Eloquent\Collection;
use Illuminate\Database\Eloquent\ModelNotFoundException;

class LabelRepository {
    public function all(): ?Collection {
        $labels = Label::all();
        if ($labels->count() === 0) {
            return null;
        }
        return $labels;
    }

    public function create(string $title): Label {
        $label = new Label();
        $label->title = $title;
        $label->save();
        return $label;
    }

    public function update(int $id, string $title): Label {
        $label = $this->findById($id);
        $label->title = $title;
        $label->save();
        return $label;
    }

    public function delete(int $id): bool {
        $label = $this->findById($id);
        return $label->delete();
    }

    public function findById(int $id): ?Label {
        $label = Label::find($id);
        if ($label === null) {
            throw new ModelNotFoundException();
        }
        return $label;
    }
}

<?php

declare(strict_types=1);

namespace App\Repositories;

use App\Models\Label;

use Illuminate\Database\Eloquent\Collection;

use Illuminate\Database\Eloquent\ModelNotFoundException;

class LabelRepository {

public function all(): ?Collection {

$labels = Label::all();

if ($labels->count() === 0) {

return null;

}

return $labels;

}

public function create(string $title): Label {

$label = new Label();

$label->title = $title;

$label->save();

return $label;

}

public function update(int $id, string $title): Label {

$label = $this->findById($id);

$label->title = $title;

$label->save();

return $label;

}

public function delete(int $id): bool {

$label = $this->findById($id);

return $label->delete();

}

public function findById(int $id): ?Label {

$label = Label::find($id);

if ($label === null) {

throw new ModelNotFoundException();

}

return $label;

}

次はサービスクラス。

app/Services/Label/CreateLabelService.phpを以下のように編集する。

<?php

declare(strict_types=1);

namespace App\Services\Label;

use App\Models\Label;
use App\Repositories\LabelRepository;

class CreateLabelService {
    private LabelRepository $labelRepository;

    /**
     * CreateLabelService constructor.
     * @param LabelRepository $labelRepository
     */
    public function __construct(LabelRepository $labelRepository) {
        $this->labelRepository = $labelRepository;
    }

    /**
     * @param string $title
     * @return Label
     */
    public function __invoke(string $title): Label {
        return $this->labelRepository->create($title);
    }
}

<?php

declare(strict_types=1);

namespace App\Services\Label;

use App\Models\Label;

use App\Repositories\LabelRepository;

class CreateLabelService {

private LabelRepository $labelRepository;

/**

* CreateLabelService constructor.

* @param LabelRepository $labelRepository

public function __construct(LabelRepository $labelRepository) {

$this->labelRepository = $labelRepository;

}

/**

* @param string $title

* @return Label

public function __invoke(string $title): Label {

return $this->labelRepository->create($title);

}

app/Services/Label/DeleteLabelService.phpを以下のように編集。

<?php

declare(strict_types=1);

namespace App\Services\Label;

use App\Repositories\LabelRepository;

class DeleteLabelService {
    private LabelRepository $labelRepository;

    /**
     * DeleteLabelService constructor.
     * @param LabelRepository $labelRepository
     */
    public function __construct(LabelRepository $labelRepository) {
        $this->labelRepository = $labelRepository;
    }

    /**
     * @param int $id
     * @return bool
     */
    public function __invoke(int $id): bool {
        return $this->labelRepository->delete($id);
    }
}

<?php

declare(strict_types=1);

namespace App\Services\Label;

use App\Repositories\LabelRepository;

class DeleteLabelService {

private LabelRepository $labelRepository;

/**

* DeleteLabelService constructor.

* @param LabelRepository $labelRepository

public function __construct(LabelRepository $labelRepository) {

$this->labelRepository = $labelRepository;

}

/**

* @param int $id

* @return bool

public function __invoke(int $id): bool {

return $this->labelRepository->delete($id);

}

app/Services/Label/GetLabelsService.phpを以下のように編集。

<?php

declare(strict_types=1);

namespace App\Services\Label;

use App\Repositories\LabelRepository;
use Illuminate\Database\Eloquent\Collection;

class GetLabelsService {
    private LabelRepository $labelRepository;

    /**
     * GetLabelsService constructor.
     * @param LabelRepository $labelRepository
     */
    public function __construct(LabelRepository $labelRepository) {
        $this->labelRepository = $labelRepository;
    }

    /**
     * @return ?Collection
     */
    public function __invoke(): ?Collection {
        return $this->labelRepository->all();
    }
}

<?php

declare(strict_types=1);

namespace App\Services\Label;

use App\Repositories\LabelRepository;

use Illuminate\Database\Eloquent\Collection;

class GetLabelsService {

private LabelRepository $labelRepository;

/**

* GetLabelsService constructor.

* @param LabelRepository $labelRepository

public function __construct(LabelRepository $labelRepository) {

$this->labelRepository = $labelRepository;

}

/**

* @return ?Collection

public function __invoke(): ?Collection {

return $this->labelRepository->all();

}

app/Services/Label/UpdateLabelService.phpを以下のように編集。

<?php

declare(strict_types=1);

namespace App\Services\Label;

use App\Models\Label;
use App\Repositories\LabelRepository;

class UpdateLabelService {
    private LabelRepository $labelRepository;

    /**
     * UpdateLabelsService constructor.
     * @param LabelRepository $labelRepository
     */
    public function __construct(LabelRepository $labelRepository) {
        $this->labelRepository = $labelRepository;
    }

    /**
     * @param int $id
     * @param string $title
     * @return Label
     */
    public function __invoke(int $id, string $title): Label {
        return $this->labelRepository->update($id, $title);
    }
}

<?php

declare(strict_types=1);

namespace App\Services\Label;

use App\Models\Label;

use App\Repositories\LabelRepository;

class UpdateLabelService {

private LabelRepository $labelRepository;

/**

* UpdateLabelsService constructor.

* @param LabelRepository $labelRepository

public function __construct(LabelRepository $labelRepository) {

$this->labelRepository = $labelRepository;

}

/**

* @param int $id

* @param string $title

* @return Label

public function __invoke(int $id, string $title): Label {

return $this->labelRepository->update($id, $title);

}

リポジトリクラスとサービスクラスができたのでテストを書いていく。

テストを作成。

todo-list % sail artisan make:test Repositories/LabelRepositoryTest --unit

1	todo-list % sail artisan make:test Repositories/LabelRepositoryTest --unit

tests/Unit/Repositories/LabelRepositoryTest.phpを以下のように編集。

<?php

declare(strict_types=1);

namespace Tests\Unit\Repositories;

use App\Repositories\LabelRepository;
use Illuminate\Database\Eloquent\ModelNotFoundException;
use Illuminate\Foundation\Testing\RefreshDatabase;
use Tests\TestCase;

class LabelRepositoryTest extends TestCase {
    use RefreshDatabase;

    public function testSuccessAllReturnedTwoLabels() {
        $labelRepository = new LabelRepository();
        $labelRepository->create('Test1');
        $labelRepository->create('Test2');

        $labels = $labelRepository->all();
        $this->assertCount(2, $labels);
    }

    public function testSuccessAllReturnedNull() {
        $labelRepository = new LabelRepository();
        $labels = $labelRepository->all();
        $this->assertSame(null, $labels);
    }

    public function testSuccessCreate() {
        $labelRepository = new LabelRepository();
        $label = $labelRepository->create('Test');
        $this->assertSame('Test', $label->title);
    }

    public function testSuccessUpdate() {
        $labelRepository = new LabelRepository();
        $label = $labelRepository->create('Test');
        $updatedLabel = $labelRepository->update($label->id, 'Updated');
        $this->assertSame('Updated', $updatedLabel->title);
    }

    public function testFailUpdateBecauseModelNotFound() {
        $this->expectException(ModelNotFoundException::class);
        $labelRepository = new LabelRepository();
        $labelRepository->update(1, 'Update');
    }

    public function testSuccessDelete() {
        $labelRepository = new LabelRepository();
        $label = $labelRepository->create('Test');
        $this->assertDatabaseCount('labels', 1);
        $labelRepository->delete($label->id);
        $this->assertDatabaseCount('labels', 0);
    }

    public function testFailDeleteBecauseModelNotFound() {
        $this->expectException(ModelNotFoundException::class);
        $labelRepository = new LabelRepository();
        $labelRepository->delete(1);
    }

    public function testSuccessFindById() {
        $labelRepository = new LabelRepository();
        $label = $labelRepository->create('Test');
        $returnedLabel = $labelRepository->findById($label->id);
        $this->assertSame($label->id, $returnedLabel->id);
    }

    public function testFailFindByIdBecauseModelNotFound() {
        $this->expectException(ModelNotFoundException::class);
        $labelRepository = new LabelRepository();
        $labelRepository->findById(1);
    }
}

<?php

declare(strict_types=1);

namespace Tests\Unit\Repositories;

use App\Repositories\LabelRepository;

use Illuminate\Database\Eloquent\ModelNotFoundException;

use Illuminate\Foundation\Testing\RefreshDatabase;

use Tests\TestCase;

class LabelRepositoryTest extends TestCase {

use RefreshDatabase;

public function testSuccessAllReturnedTwoLabels() {

$labelRepository = new LabelRepository();

$labelRepository->create('Test1');

$labelRepository->create('Test2');

$labels = $labelRepository->all();

$this->assertCount(2, $labels);

}

public function testSuccessAllReturnedNull() {

$labelRepository = new LabelRepository();

$labels = $labelRepository->all();

$this->assertSame(null, $labels);

}

public function testSuccessCreate() {

$labelRepository = new LabelRepository();

$label = $labelRepository->create('Test');

$this->assertSame('Test', $label->title);

}

public function testSuccessUpdate() {

$labelRepository = new LabelRepository();

$label = $labelRepository->create('Test');

$updatedLabel = $labelRepository->update($label->id, 'Updated');

$this->assertSame('Updated', $updatedLabel->title);

}

public function testFailUpdateBecauseModelNotFound() {

$this->expectException(ModelNotFoundException::class);

$labelRepository = new LabelRepository();

$labelRepository->update(1, 'Update');

}

public function testSuccessDelete() {

$labelRepository = new LabelRepository();

$label = $labelRepository->create('Test');

$this->assertDatabaseCount('labels', 1);

$labelRepository->delete($label->id);

$this->assertDatabaseCount('labels', 0);

}

public function testFailDeleteBecauseModelNotFound() {

$this->expectException(ModelNotFoundException::class);

$labelRepository = new LabelRepository();

$labelRepository->delete(1);

}

public function testSuccessFindById() {

$labelRepository = new LabelRepository();

$label = $labelRepository->create('Test');

$returnedLabel = $labelRepository->findById($label->id);

$this->assertSame($label->id, $returnedLabel->id);

}

public function testFailFindByIdBecauseModelNotFound() {

$this->expectException(ModelNotFoundException::class);

$labelRepository = new LabelRepository();

$labelRepository->findById(1);

}

テストを実行。

todo-list % sail artisan test

1	todo-list % sail artisan test

こんな感じのが表示されれば成功。

tests/Unit/Servicesの下にTodoモデルのサービステストを書いてしまっていたのでtests/Unit/Services/Todoの下に移動させた。

次はサービスクラスのテストを書いていく。

todo-list % sail artisan make:test Services/Label/CreateLabelServiceTest --unit
todo-list % sail artisan make:test Services/Label/DeleteLabelServiceTest --unit
todo-list % sail artisan make:test Services/Label/GetLabelsServiceTest --unit
todo-list % sail artisan make:test Services/Label/UpdateLabelServiceTest --unit

todo-list % sail artisan make:test Services/Label/CreateLabelServiceTest --unit

todo-list % sail artisan make:test Services/Label/DeleteLabelServiceTest --unit

todo-list % sail artisan make:test Services/Label/GetLabelsServiceTest --unit

todo-list % sail artisan make:test Services/Label/UpdateLabelServiceTest --unit

tests/Unit/Services/Label/CreateLabelServiceTest.phpを以下のように編集する。

<?php

declare(strict_types=1);

namespace Tests\Unit\Services\Label;

use App\Repositories\LabelRepository;
use App\Services\Label\CreateLabelService;
use Mockery\MockInterface;
use Tests\TestCase;

class CreateLabelServiceTest extends TestCase {
    public function testSuccess() {
        $label = 'Test';

        $this->mock(LabelRepository::class, function (MockInterface $mock) use ($label) {
            $mock->shouldReceive('create')
                ->with($label)
                ->once();
        });

        $createLabelService = app(CreateLabelService::class);
        $createLabelService->__invoke($label);
    }
}

<?php

declare(strict_types=1);

namespace Tests\Unit\Services\Label;

use App\Repositories\LabelRepository;

use App\Services\Label\CreateLabelService;

use Mockery\MockInterface;

use Tests\TestCase;

class CreateLabelServiceTest extends TestCase {

public function testSuccess() {

$label = 'Test';

$this->mock(LabelRepository::class, function (MockInterface $mock) use ($label) {

$mock->shouldReceive('create')

->with($label)

->once();

});

$createLabelService = app(CreateLabelService::class);

$createLabelService->__invoke($label);

}

tests/Unit/Services/Label/DeleteLabelServiceTest.phpを以下のように編集する。

<?php

declare(strict_types=1);

namespace Tests\Unit\Services\Label;

use App\Repositories\LabelRepository;
use App\Services\Label\DeleteLabelService;
use Mockery\MockInterface;
use Tests\TestCase;

class DeleteLabelServiceTest extends TestCase {
    public function testSuccess() {
        $id = 1;

        $this->mock(LabelRepository::class, function (MockInterface $mock) use ($id) {
            $mock->shouldReceive('delete')
                ->with($id)
                ->once();
        });

        $deleteLabelService = app(DeleteLabelService::class);
        $deleteLabelService->__invoke($id);
    }
}

<?php

declare(strict_types=1);

namespace Tests\Unit\Services\Label;

use App\Repositories\LabelRepository;

use App\Services\Label\DeleteLabelService;

use Mockery\MockInterface;

use Tests\TestCase;

class DeleteLabelServiceTest extends TestCase {

public function testSuccess() {

$id = 1;

$this->mock(LabelRepository::class, function (MockInterface $mock) use ($id) {

$mock->shouldReceive('delete')

->with($id)

->once();

});

$deleteLabelService = app(DeleteLabelService::class);

$deleteLabelService->__invoke($id);

}

tests/Unit/Services/Label/GetLabelsServiceTest.phpを以下のように編集する。

<?php

declare(strict_types=1);

namespace Tests\Unit\Services\Label;

use App\Repositories\LabelRepository;
use App\Services\Label\GetLabelsService;
use Mockery\MockInterface;
use Tests\TestCase;

class GetLabelsServiceTest extends TestCase {
    public function testSuccess() {
        $this->mock(LabelRepository::class, function (MockInterface $mock) {
            $mock->shouldReceive('all')
                ->once();
        });

        $createLabelService = app(GetLabelsService::class);
        $createLabelService->__invoke();
    }
}

<?php

declare(strict_types=1);

namespace Tests\Unit\Services\Label;

use App\Repositories\LabelRepository;

use App\Services\Label\GetLabelsService;

use Mockery\MockInterface;

use Tests\TestCase;

class GetLabelsServiceTest extends TestCase {

public function testSuccess() {

$this->mock(LabelRepository::class, function (MockInterface $mock) {

$mock->shouldReceive('all')

->once();

});

$createLabelService = app(GetLabelsService::class);

$createLabelService->__invoke();

}

tests/Unit/Services/Label/UpdateLabelServiceTest.phpを以下のように編集する。

<?php

declare(strict_types=1);

namespace Tests\Unit\Services\Label;

use App\Repositories\LabelRepository;
use App\Services\Label\UpdateLabelService;
use Mockery\MockInterface;
use Tests\TestCase;

class UpdateLabelServiceTest extends TestCase {
    public function testSuccess() {
        $id = 1;
        $label = 'Test';

        $this->mock(LabelRepository::class, function (MockInterface $mock) use ($id, $label) {
            $mock->shouldReceive('update')
                ->with($id, $label)
                ->once();
        });

        $createLabelService = app(UpdateLabelService::class);
        $createLabelService->__invoke($id, $label);
    }
}

<?php

declare(strict_types=1);

namespace Tests\Unit\Services\Label;

use App\Repositories\LabelRepository;

use App\Services\Label\UpdateLabelService;

use Mockery\MockInterface;

use Tests\TestCase;

class UpdateLabelServiceTest extends TestCase {

public function testSuccess() {

$id = 1;

$label = 'Test';

$this->mock(LabelRepository::class, function (MockInterface $mock) use ($id, $label) {

$mock->shouldReceive('update')

->with($id, $label)

->once();

});

$createLabelService = app(UpdateLabelService::class);

$createLabelService->__invoke($id, $label);

}

テストを実行。

todo-list % sail artisan test

1	todo-list % sail artisan test

こんな感じのが表示されれば成功。

RELATION ENTRY

れっちり

第一章８『Labelモデルに関わるコン...

2022/04/4 Laravel

前回Todoに関わるコントローラーを作ったので今回はLabelに関わるコントローラーを作っていく。 routes/api.phpにLabel用のルーティングを追加。 [crayon-62b8cab134f1a762190647/] app/Http/Contro...

れっちり

第一章７『Todoモデルに関わるコント...

2022/03/26 Laravel

todoの追加と同時にラベルとの紐付けを行うためにサービスクラスを追加したり編集したりした。期限をCarbonじゃなくstringで登録するようにもした。 app/Repositories/TodoRepository.phpのcreateとupdateを以下のように編集した。 [crayon-...

れっちり

第一章５『サービスクラスとリポジトリク...

2022/03/11 Laravel

コントローラー周りの事は１記事で終わると思ったけど思ったより長くなってしまったので何回かに分割する。 app/Http/Controllersの下にController.phpとLabelController.phpとTodoController.phpがあるけど（LabelCon...

れっちり

第一章4 『bladeファイルとVueコ...

2022/03/4 Laravel

ターミナルで以下を実行してbladeファイルとVueのファイルを作成。 [crayon-62b8cab13739d298365404/] bladeファイルからVueコンポーネントを呼び出せるようにする。 resources/js/app.jsを以下のように編集する。 [cra...

第一章６ 『Labelモデルに関わるサービスとリポジトリの実装』

前回のあらすじ

第一章６『Labelモデルに関わるサービスとリポジトリの実装』