|
| 1 | +<?php |
| 2 | +/* |
| 3 | + * Copyright 2022 Cloud Creativity Limited |
| 4 | + * |
| 5 | + * Licensed under the Apache License, Version 2.0 (the "License"); |
| 6 | + * you may not use this file except in compliance with the License. |
| 7 | + * You may obtain a copy of the License at |
| 8 | + * |
| 9 | + * http://www.apache.org/licenses/LICENSE-2.0 |
| 10 | + * |
| 11 | + * Unless required by applicable law or agreed to in writing, software |
| 12 | + * distributed under the License is distributed on an "AS IS" BASIS, |
| 13 | + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 14 | + * See the License for the specific language governing permissions and |
| 15 | + * limitations under the License. |
| 16 | + */ |
| 17 | + |
| 18 | +declare(strict_types=1); |
| 19 | + |
| 20 | +namespace LaravelJsonApi\Laravel\Tests\Acceptance\Relationships; |
| 21 | + |
| 22 | +use App\JsonApi\V1\Posts\PostSchema; |
| 23 | +use App\Models\Post; |
| 24 | +use App\Models\Tag; |
| 25 | +use Closure; |
| 26 | +use LaravelJsonApi\Core\Facades\JsonApi; |
| 27 | +use LaravelJsonApi\Laravel\Facades\JsonApiRoute; |
| 28 | +use LaravelJsonApi\Laravel\Http\Controllers\JsonApiController; |
| 29 | +use LaravelJsonApi\Laravel\Tests\Acceptance\TestCase; |
| 30 | +use function url; |
| 31 | + |
| 32 | +class ToManyLinksTest extends TestCase |
| 33 | +{ |
| 34 | + |
| 35 | + /** |
| 36 | + * @var PostSchema |
| 37 | + */ |
| 38 | + private PostSchema $schema; |
| 39 | + |
| 40 | + /** |
| 41 | + * @var Post |
| 42 | + */ |
| 43 | + private Post $post; |
| 44 | + |
| 45 | + /** |
| 46 | + * @var Tag |
| 47 | + */ |
| 48 | + private Tag $tag; |
| 49 | + |
| 50 | + /** |
| 51 | + * @return void |
| 52 | + */ |
| 53 | + protected function setUp(): void |
| 54 | + { |
| 55 | + parent::setUp(); |
| 56 | + |
| 57 | + JsonApiRoute::server('v1')->prefix('api/v1')->resources(function ($server) { |
| 58 | + $server->resource('posts', JsonApiController::class)->relationships(function ($relationships) { |
| 59 | + $relationships->hasMany('tags'); |
| 60 | + }); |
| 61 | + }); |
| 62 | + |
| 63 | + $this->schema = JsonApi::server('v1')->schemas()->schemaFor('posts'); |
| 64 | + $this->post = Post::factory()->create(); |
| 65 | + $this->post->tags()->attach($this->tag = Tag::factory()->create()); |
| 66 | + } |
| 67 | + |
| 68 | + /** |
| 69 | + * @return array[] |
| 70 | + */ |
| 71 | + public function scenarioProvider(): array |
| 72 | + { |
| 73 | + return [ |
| 74 | + 'hidden' => [ |
| 75 | + static function (PostSchema $schema) { |
| 76 | + $schema->relationship('tags')->hidden(); |
| 77 | + return null; |
| 78 | + }, |
| 79 | + ], |
| 80 | + 'no links' => [ |
| 81 | + static function (PostSchema $schema) { |
| 82 | + $schema->relationship('tags')->serializeUsing( |
| 83 | + static fn($relation) => $relation->withoutLinks() |
| 84 | + ); |
| 85 | + return null; |
| 86 | + }, |
| 87 | + ], |
| 88 | + 'no self link' => [ |
| 89 | + static function (PostSchema $schema, Post $post) { |
| 90 | + $schema->relationship('tags')->serializeUsing( |
| 91 | + static fn($relation) => $relation->withoutSelfLink() |
| 92 | + ); |
| 93 | + return ['related' => url('/api/v1/posts', [$post, 'tags'])]; |
| 94 | + }, |
| 95 | + ], |
| 96 | + 'no related link' => [ |
| 97 | + static function (PostSchema $schema, Post $post) { |
| 98 | + $schema->relationship('tags')->serializeUsing( |
| 99 | + static fn($relation) => $relation->withoutRelatedLink() |
| 100 | + ); |
| 101 | + return ['self' => url('/api/v1/posts', [$post, 'relationships', 'tags'])]; |
| 102 | + }, |
| 103 | + ], |
| 104 | + ]; |
| 105 | + } |
| 106 | + |
| 107 | + /** |
| 108 | + * @param Closure $scenario |
| 109 | + * @return void |
| 110 | + * @dataProvider scenarioProvider |
| 111 | + */ |
| 112 | + public function testRelated(Closure $scenario): void |
| 113 | + { |
| 114 | + $expected = $scenario($this->schema, $this->post); |
| 115 | + |
| 116 | + $response = $this |
| 117 | + ->withoutExceptionHandling() |
| 118 | + ->jsonApi('tags') |
| 119 | + ->get(url('/api/v1/posts', [$this->post, 'tags'])); |
| 120 | + |
| 121 | + $response->assertFetchedMany([$this->tag]); |
| 122 | + |
| 123 | + if (is_array($expected)) { |
| 124 | + $response->assertLinks($expected); |
| 125 | + } |
| 126 | + } |
| 127 | + |
| 128 | + /** |
| 129 | + * @param Closure $scenario |
| 130 | + * @return void |
| 131 | + * @dataProvider scenarioProvider |
| 132 | + */ |
| 133 | + public function testSelf(Closure $scenario): void |
| 134 | + { |
| 135 | + $expected = $scenario($this->schema, $this->post); |
| 136 | + |
| 137 | + $response = $this |
| 138 | + ->withoutExceptionHandling() |
| 139 | + ->jsonApi('tags') |
| 140 | + ->get(url('/api/v1/posts', [$this->post, 'relationships', 'tags'])); |
| 141 | + |
| 142 | + $response->assertFetchedToMany([$this->tag]); |
| 143 | + |
| 144 | + if (is_array($expected)) { |
| 145 | + $response->assertLinks($expected); |
| 146 | + } |
| 147 | + } |
| 148 | + |
| 149 | +} |
0 commit comments