animethemes-server/tests/Feature/Http/Api/Wiki/Video/Script/ScriptIndexTest.php

<?php

declare(strict_types=1);

namespace Tests\Feature\Http\Api\Wiki\Video\Script;

use App\Concerns\Actions\Http\Api\SortsModels;
use App\Contracts\Http\Api\Field\SortableField;
use App\Enums\Http\Api\Filter\TrashedStatus;
use App\Enums\Http\Api\Sort\Direction;
use App\Enums\Models\Wiki\VideoOverlap;
use App\Enums\Models\Wiki\VideoSource;
use App\Http\Api\Criteria\Filter\TrashedCriteria;
use App\Http\Api\Criteria\Paging\Criteria;
use App\Http\Api\Criteria\Paging\OffsetCriteria;
use App\Http\Api\Field\Field;
use App\Http\Api\Include\AllowedInclude;
use App\Http\Api\Parser\FieldParser;
use App\Http\Api\Parser\FilterParser;
use App\Http\Api\Parser\IncludeParser;
use App\Http\Api\Parser\PagingParser;
use App\Http\Api\Parser\SortParser;
use App\Http\Api\Query\Query;
use App\Http\Api\Schema\Wiki\Video\ScriptSchema;
use App\Http\Api\Sort\Sort;
use App\Http\Resources\Wiki\Video\Collection\ScriptCollection;
use App\Http\Resources\Wiki\Video\Resource\ScriptResource;
use App\Models\BaseModel;
use App\Models\Wiki\Video;
use App\Models\Wiki\Video\VideoScript;
use Carbon\Carbon;
use Illuminate\Database\Eloquent\Relations\BelongsTo;
use Illuminate\Foundation\Testing\WithFaker;
use Illuminate\Foundation\Testing\WithoutEvents;
use Tests\TestCase;

/**
 * Class ScriptIndexTest.
 */
class ScriptIndexTest extends TestCase
{
    use SortsModels;
    use WithFaker;
    use WithoutEvents;

    /**
     * By default, the Script Index Endpoint shall return a collection of Script Resources.
     *
     * @return void
     */
    public function testDefault(): void
    {
        $scripts = VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->create();

        $response = $this->get(route('api.videoscript.index'));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query()))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall be paginated.
     *
     * @return void
     */
    public function testPaginated(): void
    {
        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->create();

        $response = $this->get(route('api.videoscript.index'));

        $response->assertJsonStructure([
            ScriptCollection::$wrap,
            'links',
            'meta',
        ]);
    }

    /**
     * The Script Index Endpoint shall allow inclusion of related resources.
     *
     * @return void
     */
    public function testAllowedIncludePaths(): void
    {
        $schema = new ScriptSchema();

        $allowedIncludes = collect($schema->allowedIncludes());

        $selectedIncludes = $allowedIncludes->random($this->faker->numberBetween(1, $allowedIncludes->count()));

        $includedPaths = $selectedIncludes->map(fn (AllowedInclude $include) => $include->path());

        $parameters = [
            IncludeParser::param() => $includedPaths->join(','),
        ];

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->for(Video::factory())
            ->create();

        $scripts = VideoScript::with($includedPaths->all())->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall implement sparse fieldsets.
     *
     * @return void
     */
    public function testSparseFieldsets(): void
    {
        $schema = new ScriptSchema();

        $fields = collect($schema->fields());

        $includedFields = $fields->random($this->faker->numberBetween(1, $fields->count()));

        $parameters = [
            FieldParser::param() => [
                ScriptResource::$wrap => $includedFields->map(fn (Field $field) => $field->getKey())->join(','),
            ],
        ];

        $scripts = VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->create();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Synonym Index Endpoint shall support sorting resources.
     *
     * @return void
     */
    public function testSorts(): void
    {
        $schema = new ScriptSchema();

        /** @var Sort $sort */
        $sort = collect($schema->fields())
            ->filter(fn (Field $field) => $field instanceof SortableField)
            ->map(fn (SortableField $field) => $field->getSort())
            ->random();

        $parameters = [
            SortParser::param() => $sort->format(Direction::getRandomInstance()),
        ];

        $query = new Query($parameters);

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->create();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $scripts = $this->sort(VideoScript::query(), $query, $schema)->get();

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, $query))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support filtering by created_at.
     *
     * @return void
     */
    public function testCreatedAtFilter(): void
    {
        $createdFilter = $this->faker->date();
        $excludedDate = $this->faker->date();

        $parameters = [
            FilterParser::param() => [
                BaseModel::ATTRIBUTE_CREATED_AT => $createdFilter,
            ],
            PagingParser::param() => [
                OffsetCriteria::SIZE_PARAM => Criteria::MAX_RESULTS,
            ],
        ];

        Carbon::withTestNow($createdFilter, function () {
            VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
        });

        Carbon::withTestNow($excludedDate, function () {
            VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
        });

        $script = VideoScript::query()->where(BaseModel::ATTRIBUTE_CREATED_AT, $createdFilter)->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($script, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support filtering by updated_at.
     *
     * @return void
     */
    public function testUpdatedAtFilter(): void
    {
        $updatedFilter = $this->faker->date();
        $excludedDate = $this->faker->date();

        $parameters = [
            FilterParser::param() => [
                BaseModel::ATTRIBUTE_UPDATED_AT => $updatedFilter,
            ],
            PagingParser::param() => [
                OffsetCriteria::SIZE_PARAM => Criteria::MAX_RESULTS,
            ],
        ];

        Carbon::withTestNow($updatedFilter, function () {
            VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
        });

        Carbon::withTestNow($excludedDate, function () {
            VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
        });

        $script = VideoScript::query()->where(BaseModel::ATTRIBUTE_UPDATED_AT, $updatedFilter)->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($script, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support filtering by trashed.
     *
     * @return void
     */
    public function testWithoutTrashedFilter(): void
    {
        $parameters = [
            FilterParser::param() => [
                TrashedCriteria::PARAM_VALUE => TrashedStatus::WITHOUT,
            ],
            PagingParser::param() => [
                OffsetCriteria::SIZE_PARAM => Criteria::MAX_RESULTS,
            ],
        ];

        VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();

        $deleteVideo = VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
        $deleteVideo->each(function (VideoScript $script) {
            $script->delete();
        });

        $script = VideoScript::withoutTrashed()->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($script, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support filtering by trashed.
     *
     * @return void
     */
    public function testWithTrashedFilter(): void
    {
        $parameters = [
            FilterParser::param() => [
                TrashedCriteria::PARAM_VALUE => TrashedStatus::WITH,
            ],
            PagingParser::param() => [
                OffsetCriteria::SIZE_PARAM => Criteria::MAX_RESULTS,
            ],
        ];

        VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();

        $deleteVideo = VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
        $deleteVideo->each(function (VideoScript $script) {
            $script->delete();
        });

        $script = VideoScript::withTrashed()->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($script, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support filtering by trashed.
     *
     * @return void
     */
    public function testOnlyTrashedFilter(): void
    {
        $parameters = [
            FilterParser::param() => [
                TrashedCriteria::PARAM_VALUE => TrashedStatus::ONLY,
            ],
            PagingParser::param() => [
                OffsetCriteria::SIZE_PARAM => Criteria::MAX_RESULTS,
            ],
        ];

        VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();

        $deleteVideo = VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
        $deleteVideo->each(function (VideoScript $script) {
            $script->delete();
        });

        $script = VideoScript::onlyTrashed()->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($script, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support filtering by deleted_at.
     *
     * @return void
     */
    public function testDeletedAtFilter(): void
    {
        $deletedFilter = $this->faker->date();
        $excludedDate = $this->faker->date();

        $parameters = [
            FilterParser::param() => [
                BaseModel::ATTRIBUTE_DELETED_AT => $deletedFilter,
                TrashedCriteria::PARAM_VALUE => TrashedStatus::WITH,
            ],
            PagingParser::param() => [
                OffsetCriteria::SIZE_PARAM => Criteria::MAX_RESULTS,
            ],
        ];

        Carbon::withTestNow($deletedFilter, function () {
            $scripts = VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
            $scripts->each(function (VideoScript $script) {
                $script->delete();
            });
        });

        Carbon::withTestNow($excludedDate, function () {
            $scripts = VideoScript::factory()->count($this->faker->randomDigitNotNull())->create();
            $scripts->each(function (VideoScript $script) {
                $script->delete();
            });
        });

        $script = VideoScript::withTrashed()->where(BaseModel::ATTRIBUTE_DELETED_AT, $deletedFilter)->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($script, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support constrained eager loading of videos by lyrics.
     *
     * @return void
     */
    public function testVideosByLyrics(): void
    {
        $lyricsFilter = $this->faker->boolean();

        $parameters = [
            FilterParser::param() => [
                Video::ATTRIBUTE_LYRICS => $lyricsFilter,
            ],
            IncludeParser::param() => VideoScript::RELATION_VIDEO,
        ];

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->for(Video::factory())
            ->create();

        $scripts = VideoScript::with([
            VideoScript::RELATION_VIDEO => function (BelongsTo $query) use ($lyricsFilter) {
                $query->where(Video::ATTRIBUTE_LYRICS, $lyricsFilter);
            },
        ])
        ->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support constrained eager loading of videos by nc.
     *
     * @return void
     */
    public function testVideosByNc(): void
    {
        $ncFilter = $this->faker->boolean();

        $parameters = [
            FilterParser::param() => [
                Video::ATTRIBUTE_NC => $ncFilter,
            ],
            IncludeParser::param() => VideoScript::RELATION_VIDEO,
        ];

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->for(Video::factory())
            ->create();

        $scripts = VideoScript::with([
            VideoScript::RELATION_VIDEO => function (BelongsTo $query) use ($ncFilter) {
                $query->where(Video::ATTRIBUTE_NC, $ncFilter);
            },
        ])
        ->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support constrained eager loading of videos by overlap.
     *
     * @return void
     */
    public function testVideosByOverlap(): void
    {
        $overlapFilter = VideoOverlap::getRandomInstance();

        $parameters = [
            FilterParser::param() => [
                Video::ATTRIBUTE_OVERLAP => $overlapFilter->description,
            ],
            IncludeParser::param() => VideoScript::RELATION_VIDEO,
        ];

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->for(Video::factory())
            ->create();

        $scripts = VideoScript::with([
            VideoScript::RELATION_VIDEO => function (BelongsTo $query) use ($overlapFilter) {
                $query->where(Video::ATTRIBUTE_OVERLAP, $overlapFilter->value);
            },
        ])
        ->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support constrained eager loading of videos by resolution.
     *
     * @return void
     */
    public function testVideosByResolution(): void
    {
        $resolutionFilter = $this->faker->randomNumber();
        $excludedResolution = $resolutionFilter + 1;

        $parameters = [
            FilterParser::param() => [
                Video::ATTRIBUTE_RESOLUTION => $resolutionFilter,
            ],
            IncludeParser::param() => VideoScript::RELATION_VIDEO,
        ];

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->for(
                Video::factory()->state([
                    Video::ATTRIBUTE_RESOLUTION => $this->faker->boolean() ? $resolutionFilter : $excludedResolution,
                ])
            )
            ->create();

        $scripts = VideoScript::with([
            VideoScript::RELATION_VIDEO => function (BelongsTo $query) use ($resolutionFilter) {
                $query->where(Video::ATTRIBUTE_RESOLUTION, $resolutionFilter);
            },
        ])
        ->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support constrained eager loading of videos by source.
     *
     * @return void
     */
    public function testVideosBySource(): void
    {
        $sourceFilter = VideoSource::getRandomInstance();

        $parameters = [
            FilterParser::param() => [
                Video::ATTRIBUTE_SOURCE => $sourceFilter->description,
            ],
            IncludeParser::param() => VideoScript::RELATION_VIDEO,
        ];

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->for(Video::factory())
            ->create();

        $scripts = VideoScript::with([
            VideoScript::RELATION_VIDEO => function (BelongsTo $query) use ($sourceFilter) {
                $query->where(Video::ATTRIBUTE_SOURCE, $sourceFilter->value);
            },
        ])
        ->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support constrained eager loading of videos by subbed.
     *
     * @return void
     */
    public function testVideosBySubbed(): void
    {
        $subbedFilter = $this->faker->boolean();

        $parameters = [
            FilterParser::param() => [
                Video::ATTRIBUTE_SUBBED => $subbedFilter,
            ],
            IncludeParser::param() => VideoScript::RELATION_VIDEO,
        ];

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->for(Video::factory())
            ->create();

        $scripts = VideoScript::with([
            VideoScript::RELATION_VIDEO => function (BelongsTo $query) use ($subbedFilter) {
                $query->where(Video::ATTRIBUTE_SUBBED, $subbedFilter);
            },
        ])
        ->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }

    /**
     * The Script Index Endpoint shall support constrained eager loading of videos by uncen.
     *
     * @return void
     */
    public function testVideosByUncen(): void
    {
        $uncenFilter = $this->faker->boolean();

        $parameters = [
            FilterParser::param() => [
                Video::ATTRIBUTE_UNCEN => $uncenFilter,
            ],
            IncludeParser::param() => VideoScript::RELATION_VIDEO,
        ];

        VideoScript::factory()
            ->count($this->faker->randomDigitNotNull())
            ->for(Video::factory())
            ->create();

        $scripts = VideoScript::with([
            VideoScript::RELATION_VIDEO => function (BelongsTo $query) use ($uncenFilter) {
                $query->where(Video::ATTRIBUTE_UNCEN, $uncenFilter);
            },
        ])
            ->get();

        $response = $this->get(route('api.videoscript.index', $parameters));

        $response->assertJson(
            json_decode(
                json_encode(
                    (new ScriptCollection($scripts, new Query($parameters)))
                        ->response()
                        ->getData()
                ),
                true
            )
        );
    }
}