count($this->faker->randomDigitNotNull())->create(); $response = $this->get(route('api.page.index')); $response->assertJson( json_decode( json_encode( (new PageCollection($pages, new Query())) ->response() ->getData() ), true ) ); } /** * The Page Index Endpoint shall be paginated. * * @return void */ public function testPaginated(): void { Page::factory()->count($this->faker->randomDigitNotNull())->create(); $response = $this->get(route('api.page.index')); $response->assertJsonStructure([ PageCollection::$wrap, 'links', 'meta', ]); } /** * The Page Index Endpoint shall implement sparse fieldsets. * * @return void */ public function testSparseFieldsets(): void { $schema = new PageSchema(); $fields = collect($schema->fields()); $includedFields = $fields->random($this->faker->numberBetween(1, $fields->count())); $parameters = [ FieldParser::param() => [ PageResource::$wrap => $includedFields->map(fn (Field $field) => $field->getKey())->join(','), ], ]; $pages = Page::factory()->count($this->faker->randomDigitNotNull())->create(); $response = $this->get(route('api.page.index', $parameters)); $response->assertJson( json_decode( json_encode( (new PageCollection($pages, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Page Index Endpoint shall support sorting resources. * * @return void */ public function testSorts(): void { $schema = new PageSchema(); /** @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); Page::factory()->count($this->faker->randomDigitNotNull())->create(); $response = $this->get(route('api.page.index', $parameters)); $pages = $this->sort(Page::query(), $query, $schema)->get(); $response->assertJson( json_decode( json_encode( (new PageCollection($pages, $query)) ->response() ->getData() ), true ) ); } /** * The Page 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 () { Page::factory()->count($this->faker->randomDigitNotNull())->create(); }); Carbon::withTestNow($excludedDate, function () { Page::factory()->count($this->faker->randomDigitNotNull())->create(); }); $page = Page::query()->where(BaseModel::ATTRIBUTE_CREATED_AT, $createdFilter)->get(); $response = $this->get(route('api.page.index', $parameters)); $response->assertJson( json_decode( json_encode( (new PageCollection($page, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Page 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 () { Page::factory()->count($this->faker->randomDigitNotNull())->create(); }); Carbon::withTestNow($excludedDate, function () { Page::factory()->count($this->faker->randomDigitNotNull())->create(); }); $page = Page::query()->where(BaseModel::ATTRIBUTE_UPDATED_AT, $updatedFilter)->get(); $response = $this->get(route('api.page.index', $parameters)); $response->assertJson( json_decode( json_encode( (new PageCollection($page, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Page 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, ], ]; Page::factory()->count($this->faker->randomDigitNotNull())->create(); $deletePage = Page::factory()->count($this->faker->randomDigitNotNull())->create(); $deletePage->each(function (Page $page) { $page->delete(); }); $page = Page::withoutTrashed()->get(); $response = $this->get(route('api.page.index', $parameters)); $response->assertJson( json_decode( json_encode( (new PageCollection($page, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Page 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, ], ]; Page::factory()->count($this->faker->randomDigitNotNull())->create(); $deletePage = Page::factory()->count($this->faker->randomDigitNotNull())->create(); $deletePage->each(function (Page $page) { $page->delete(); }); $page = Page::withTrashed()->get(); $response = $this->get(route('api.page.index', $parameters)); $response->assertJson( json_decode( json_encode( (new PageCollection($page, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Page 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, ], ]; Page::factory()->count($this->faker->randomDigitNotNull())->create(); $deletePage = Page::factory()->count($this->faker->randomDigitNotNull())->create(); $deletePage->each(function (Page $page) { $page->delete(); }); $page = Page::onlyTrashed()->get(); $response = $this->get(route('api.page.index', $parameters)); $response->assertJson( json_decode( json_encode( (new PageCollection($page, new Query($parameters))) ->response() ->getData() ), true ) ); } /** * The Page 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 () { $pages = Page::factory()->count($this->faker->randomDigitNotNull())->create(); $pages->each(function (Page $page) { $page->delete(); }); }); Carbon::withTestNow($excludedDate, function () { $pages = Page::factory()->count($this->faker->randomDigitNotNull())->create(); $pages->each(function (Page $page) { $page->delete(); }); }); $page = Page::withTrashed()->where(BaseModel::ATTRIBUTE_DELETED_AT, $deletedFilter)->get(); $response = $this->get(route('api.page.index', $parameters)); $response->assertJson( json_decode( json_encode( (new PageCollection($page, new Query($parameters))) ->response() ->getData() ), true ) ); } }