Skip to content

Commit 5dbb358

Browse files
lindyhopchrislindyhopchris
committed
Merge branch 'release/1.0.0-beta.5' into main
2 parents fbb12bd + b95d1a6 commit 5dbb358

File tree

21 files changed

+762
-33
lines changed

21 files changed

+762
-33
lines changed

Diff for: ‎.github/workflows/tests.yml

+3-3
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,12 @@ jobs:
1010
build:
1111

1212
runs-on: ubuntu-latest
13-
13+
1414
strategy:
1515
fail-fast: true
1616
matrix:
1717
php: ['7.4', '8.0']
18-
laravel: ['^8.0']
18+
laravel: ['^8.30']
1919

2020
steps:
2121
- name: Checkout Code
@@ -38,6 +38,6 @@ jobs:
3838
timeout_minutes: 5
3939
max_attempts: 5
4040
command: composer install --no-suggest --prefer-dist -n -o
41-
41+
4242
- name: Execute tests
4343
run: vendor/bin/phpunit

Diff for: ‎CHANGELOG.md

+39
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,45 @@
33
All notable changes to this project will be documented in this file. This project adheres to
44
[Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
55

6+
## [1.0.0-beta.5] - 2021-07-10
7+
8+
### Added
9+
10+
- The authorizer now has separate `showRelated()` and `showRelationship()` methods. Previously both these controller
11+
actions were authorized via the single `showRelationship()` method. Adding the new `showRelated` method means
12+
developers can now implement separate authorization logic for these two actions if desired. Our default implementation
13+
remains unchanged - both are authorized using the `view<RelationshipName>` method on the relevant policy.
14+
- The request class now has a `isCreatingOrUpdating()` helper method to determine whether the request is to create or
15+
updated a resource.
16+
- Add stop on first failure to all validators in the resource request class.
17+
- [#85](https://github.com/laravel-json-api/laravel/issues/85) When running an application with debug mode turned on,
18+
the default JSON:API error object for an exception will now contain detailed exception information, including the
19+
stack trace, in the object's `meta` member.
20+
- [#103](https://github.com/laravel-json-api/laravel/issues/103) Can now fully customise attribute serialization to JSON
21+
using the `extractUsing()` callback. This receives the model, column name and value. This is useful if the developer
22+
needs to control the serialization of a few fields on their schema. However, the recommendation is to use a resource
23+
class for complete control over the serialization of a model to a JSON:API resource.
24+
25+
### Changed
26+
27+
- Minimum Laravel version is now `8.30`. This change was required to use the `$stopOnFirstFailure` property on Laravel's
28+
`FormRequest` class.
29+
- Schema classes no longer automatically sort their fields by name when iterating over them. This change was made to
30+
give the developer full control over the order of fields (particularly as this order affects the order in which fields
31+
are listed when serialized to a JSON:API resource). Developers can list fields in name order if that is the preferred
32+
order.
33+
- Removed the `LaravelJsonApi\Spec\UnexpectedDocumentException` which was thrown if there was a failure when decoding
34+
request JSON content before parsing it for compliance with the JSON:API specification. A `JsonApiException` will now
35+
be thrown instead.
36+
37+
### Fixed
38+
39+
- [#101](https://github.com/laravel-json-api/laravel/issues/101) Ensure controller create action always returns a
40+
response that will result in a `201 Created` response.
41+
- [#102](https://github.com/laravel-json-api/laravel/issues/102) The attach and detach to-many relationship controller
42+
actions now correctly resolve the collection query class using the relation's inverse resource type. Previously they
43+
were incorrectly using the primary resource type to resolve the query class.
44+
645
## [1.0.0-beta.4] - 2021-06-02
746

847
### Fixed

Diff for: ‎composer.json

+7-7
Original file line numberDiff line numberDiff line change
@@ -25,16 +25,16 @@
2525
"require": {
2626
"php": "^7.4|^8.0",
2727
"ext-json": "*",
28-
"laravel-json-api/core": "^1.0.0-beta.4",
29-
"laravel-json-api/eloquent": "^1.0.0-beta.5",
28+
"laravel-json-api/core": "^1.0.0-beta.5",
29+
"laravel-json-api/eloquent": "^1.0.0-beta.6",
3030
"laravel-json-api/encoder-neomerx": "^1.0.0-beta.1",
31-
"laravel-json-api/exceptions": "^1.0.0-beta.2",
32-
"laravel-json-api/spec": "^1.0.0-beta.1",
31+
"laravel-json-api/exceptions": "^1.0.0-beta.4",
32+
"laravel-json-api/spec": "^1.0.0-beta.2",
3333
"laravel-json-api/validation": "^1.0.0-beta.2",
34-
"laravel/framework": "^8.0"
34+
"laravel/framework": "^8.30"
3535
},
3636
"require-dev": {
37-
"laravel-json-api/hashids": "^1.0.0-beta.2",
37+
"laravel-json-api/hashids": "^1.0.0-beta.3",
3838
"laravel-json-api/testing": "^1.0.0-beta.1",
3939
"orchestra/testbench": "^6.9",
4040
"phpunit/phpunit": "^9.5"
@@ -66,7 +66,7 @@
6666
]
6767
}
6868
},
69-
"minimum-stability": "dev",
69+
"minimum-stability": "stable",
7070
"prefer-stable": true,
7171
"config": {
7272
"sort-packages": true

Diff for: ‎src/Http/Controllers/Actions/AttachRelationship.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public function attachRelationship(Route $route, StoreContract $store)
5252
$resourceType = $route->resourceType()
5353
);
5454

55-
$query = ResourceQuery::queryMany($resourceType);
55+
$query = ResourceQuery::queryMany($relation->inverse());
5656

5757
$model = $route->model();
5858
$response = null;

Diff for: ‎src/Http/Controllers/Actions/DetachRelationship.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ public function detachRelationship(Route $route, StoreContract $store)
5252
$resourceType = $route->resourceType()
5353
);
5454

55-
$query = ResourceQuery::queryMany($resourceType);
55+
$query = ResourceQuery::queryMany($relation->inverse());
5656

5757
$model = $route->model();
5858
$response = null;

Diff for: ‎src/Http/Controllers/Actions/Store.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -71,6 +71,8 @@ public function store(Route $route, StoreContract $store)
7171
$response = $this->saved($model, $request, $query);
7272
}
7373

74-
return $response ?: DataResponse::make($model)->withQueryParameters($query);
74+
return $response ?? DataResponse::make($model)
75+
->withQueryParameters($query)
76+
->didCreate();
7577
}
7678
}

Diff for: ‎src/Http/Requests/FormRequest.php

+33-2
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@
2323
use Illuminate\Contracts\Auth\Guard;
2424
use Illuminate\Database\Eloquent\Model;
2525
use Illuminate\Foundation\Http\FormRequest as BaseFormRequest;
26+
use Illuminate\Support\Str;
2627
use LaravelJsonApi\Contracts\Schema\Schema;
2728
use LaravelJsonApi\Core\JsonApiService;
2829
use LaravelJsonApi\Validation\Factory as ValidationFactory;
@@ -85,13 +86,23 @@ public function isViewingOne(): bool
8586
}
8687

8788
/**
88-
* Is this a request to view resources in a relationship (Read related/relationship actions.)
89+
* Is this a request to view related resources in a relationship? (Show-related action.)
90+
*
91+
* @return bool
92+
*/
93+
public function isViewingRelated(): bool
94+
{
95+
return $this->isMethod('GET') && $this->isRelationship() && !$this->urlHasRelationships();
96+
}
97+
98+
/**
99+
* Is this a request to view resource identifiers in a relationship? (Show-relationship action.)
89100
*
90101
* @return bool
91102
*/
92103
public function isViewingRelationship(): bool
93104
{
94-
return $this->isMethod('GET') && $this->isRelationship();
105+
return $this->isMethod('GET') && $this->isRelationship() && $this->urlHasRelationships();
95106
}
96107

97108
/**
@@ -114,6 +125,16 @@ public function isUpdating(): bool
114125
return $this->isMethod('PATCH') && $this->isNotRelationship();
115126
}
116127

128+
/**
129+
* Is this a request to create or update a resource?
130+
*
131+
* @return bool
132+
*/
133+
public function isCreatingOrUpdating(): bool
134+
{
135+
return $this->isCreating() || $this->isUpdating();
136+
}
137+
117138
/**
118139
* Is this a request to replace a resource relationship?
119140
*
@@ -320,4 +341,14 @@ private function doesntHaveResourceId(): bool
320341
{
321342
return !$this->hasResourceId();
322343
}
344+
345+
/**
346+
* Does the URL contain the keyword "relationships".
347+
*
348+
* @return bool
349+
*/
350+
private function urlHasRelationships(): bool
351+
{
352+
return Str::of($this->url())->contains('relationships');
353+
}
323354
}

Diff for: ‎src/Http/Requests/ResourceQuery.php

+8
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,14 @@ public function authorizeResource(Authorizer $authorizer): bool
126126
return $authorizer->show($this, $this->modelOrFail());
127127
}
128128

129+
if ($this->isViewingRelated()) {
130+
return $authorizer->showRelated(
131+
$this,
132+
$this->modelOrFail(),
133+
$this->jsonApi()->route()->fieldName(),
134+
);
135+
}
136+
129137
if ($this->isViewingRelationship()) {
130138
return $authorizer->showRelationship(
131139
$this,

Diff for: ‎src/Http/Requests/ResourceRequest.php

+4-6
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,6 @@
3131
use LaravelJsonApi\Core\Support\Str;
3232
use LaravelJsonApi\Spec\RelationBuilder;
3333
use LaravelJsonApi\Spec\ResourceBuilder;
34-
use LaravelJsonApi\Spec\UnexpectedDocumentException;
3534
use LogicException;
3635
use Symfony\Component\HttpKernel\Exception\HttpException;
3736
use Symfony\Component\HttpKernel\Exception\HttpExceptionInterface;
@@ -238,7 +237,7 @@ public function validatedForRelation()
238237
*/
239238
protected function prepareForValidation()
240239
{
241-
if ($this->isCreating() || $this->isUpdating()) {
240+
if ($this->isCreatingOrUpdating()) {
242241
$this->assertSupportedMediaType();
243242
$this->validateResourceDocument();
244243
} else if ($this->isModifyingRelationship()) {
@@ -316,7 +315,7 @@ protected function createRelationshipValidator(ValidationFactory $factory): Vali
316315
$this->relationshipRules(),
317316
$this->messages(),
318317
$this->attributes()
319-
);
318+
)->stopOnFirstFailure($this->stopOnFirstFailure);
320319
}
321320

322321
/**
@@ -338,7 +337,7 @@ protected function createDeleteValidator(ValidationFactory $factory): Validator
338337
$this->attributes(),
339338
method_exists($this, 'deleteAttributes') ? $this->deleteAttributes() : []
340339
)
341-
);
340+
)->stopOnFirstFailure($this->stopOnFirstFailure);
342341
}
343342

344343
/**
@@ -487,7 +486,7 @@ private function relationshipRules(): array
487486
* Validate the JSON API document for a resource request.
488487
*
489488
* @return void
490-
* @throws HttpExceptionInterface
489+
* @throws JsonApiException
491490
*/
492491
private function validateResourceDocument(): void
493492
{
@@ -510,7 +509,6 @@ private function validateResourceDocument(): void
510509
* Validate the JSON API document for a modify relationship request.
511510
*
512511
* @return void
513-
* @throws UnexpectedDocumentException
514512
* @throws JsonApiException
515513
*/
516514
private function validateRelationshipDocument(): void

Diff for: ‎tests/dummy/app/Http/Controllers/Api/V1/UserController.php

+42
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<?php
2+
/*
3+
* Copyright 2021 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 App\Http\Controllers\Api\V1;
21+
22+
use App\Http\Controllers\Controller;
23+
use Illuminate\Http\Request;
24+
use LaravelJsonApi\Core\Responses\DataResponse;
25+
use LaravelJsonApi\Laravel\Http\Controllers\Actions;
26+
27+
class UserController extends Controller
28+
{
29+
30+
use Actions\FetchOne;
31+
32+
/**
33+
* Return the current user.
34+
*
35+
* @param Request $request
36+
* @return DataResponse
37+
*/
38+
public function me(Request $request): DataResponse
39+
{
40+
return DataResponse::make($request->user());
41+
}
42+
}

Diff for: ‎tests/dummy/app/JsonApi/V1/Comments/CommentSchema.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class CommentSchema extends Schema
4444
public function fields(): array
4545
{
4646
return [
47-
HashId::make()->alreadyHashed(),
47+
HashId::make()->alreadyHashed()->withLength(10),
4848
Str::make('content'),
4949
DateTime::make('createdAt')->sortable()->readOnly(),
5050
BelongsTo::make('post'),

Diff for: ‎tests/dummy/app/JsonApi/V1/Posts/PostSchema.php

+6-1
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,18 @@ class PostSchema extends Schema
5656
*/
5757
protected int $maxDepth = 3;
5858

59+
/**
60+
* @var string
61+
*/
62+
protected $defaultSort = '-createdAt';
63+
5964
/**
6065
* @inheritDoc
6166
*/
6267
public function fields(): array
6368
{
6469
return [
65-
HashId::make()->alreadyHashed(),
70+
HashId::make()->alreadyHashed()->withLength(10),
6671
BelongsTo::make('author')->type('users')->readOnly(),
6772
HasMany::make('comments')->readOnly(),
6873
Str::make('content'),

Diff for: ‎tests/dummy/app/JsonApi/V1/Tags/TagSchema.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class TagSchema extends Schema
4444
public function fields(): array
4545
{
4646
return [
47-
HashId::make()->alreadyHashed(),
47+
HashId::make()->alreadyHashed()->withLength(10),
4848
DateTime::make('createdAt')->sortable()->readOnly(),
4949
Str::make('name')->sortable(),
5050
BelongsToMany::make('posts')

Diff for: ‎tests/dummy/app/JsonApi/V1/Users/UserSchema.php

+1-1
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ class UserSchema extends Schema
4444
public function fields(): array
4545
{
4646
return [
47-
HashId::make()->alreadyHashed(),
47+
HashId::make()->alreadyHashed()->withLength(10),
4848
DateTime::make('createdAt')->readOnly(),
4949
Str::make('name'),
5050
DateTime::make('updatedAt')->readOnly(),

Diff for: ‎tests/dummy/app/Policies/UserPolicy.php

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
<?php
2+
/*
3+
* Copyright 2021 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 App\Policies;
21+
22+
use App\Models\User;
23+
24+
class UserPolicy
25+
{
26+
27+
/**
28+
* Determine if the user can view the other user.
29+
*
30+
* @param User $user
31+
* @param User $other
32+
* @return bool
33+
*/
34+
public function view(User $user, User $other): bool
35+
{
36+
return true;
37+
}
38+
}

0 commit comments

Comments
 (0)