Merge branch 'release/2.1.0'

Author: lindyhopchris

CHANGELOG.md

@@ -3,6 +3,16 @@
 All notable changes to this project will be documented in this file. This project adheres to
 [Semantic Versioning](http://semver.org/) and [this changelog format](http://keepachangelog.com/).
 
+## [2.1.0] - 2022-02-20
+
+### Added
+
+- [#110](https://github.com/laravel-json-api/laravel/issues/110) For requests that modify a relationship, it is now
+  possible to get the model or models referenced in the request JSON using the `toOne()` or `toMany()` methods on the
+  resource request class.
+- [#113](https://github.com/laravel-json-api/laravel/issues/113) The Eloquent `Number` field can now be configured to
+  accept numeric strings by calling the `acceptStrings()` method on the field.
+
 ## [2.0.0] - 2022-02-09
 
 ### Added

composer.json

@@ -25,16 +25,15 @@
     "require": {
         "php": "^7.4|^8.0",
         "ext-json": "*",
-        "laravel-json-api/core": "^2.0",
-        "laravel-json-api/eloquent": "^2.0",
+        "laravel-json-api/core": "^2.1",
+        "laravel-json-api/eloquent": "^2.1",
         "laravel-json-api/encoder-neomerx": "^2.0",
         "laravel-json-api/exceptions": "^1.1",
         "laravel-json-api/spec": "^1.1",
         "laravel-json-api/validation": "^2.0",
         "laravel/framework": "^8.76|^9.0"
     },
     "require-dev": {
-        "cloudcreativity/json-api-testing": "^4.0",
         "laravel-json-api/testing": "^1.1",
         "orchestra/testbench": "^6.23|^7.0",
         "phpunit/phpunit": "^9.5.10"

src/Http/Requests/ResourceRequest.php

@@ -23,11 +23,13 @@
 use Illuminate\Contracts\Validation\Validator;
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Http\Response;
+use Illuminate\Support\Collection;
 use LaravelJsonApi\Contracts\Auth\Authorizer;
 use LaravelJsonApi\Contracts\Schema\Relation;
 use LaravelJsonApi\Core\Document\ResourceObject;
 use LaravelJsonApi\Core\Exceptions\JsonApiException;
 use LaravelJsonApi\Core\Query\IncludePaths;
+use LaravelJsonApi\Core\Store\LazyRelation;
 use LaravelJsonApi\Core\Support\Str;
 use LaravelJsonApi\Spec\RelationBuilder;
 use LaravelJsonApi\Spec\ResourceBuilder;
@@ -49,6 +51,11 @@ class ResourceRequest extends FormRequest
      */
     private ?array $validationData = null;
 
+    /**
+     * @var LazyRelation|null
+     */
+    private ?LazyRelation $relation = null;
+
     /**
      * Specify the callback to use to guess the request class for a JSON API resource.
      *
@@ -116,6 +123,38 @@ public function modelOrFail(): object
         throw new LogicException('No model exists for this route.');
     }
 
+    /**
+     * Get the model referenced in a to-one relationship.
+     *
+     * @return Model|object|null
+     */
+    public function toOne(): ?object
+    {
+        if ($this->isModifyingRelationship()) {
+            return $this->relation()->get();
+        }
+
+        throw new LogicException(
+            'Can only retrieve the model for a to-one relationship when the relationship is being modified.'
+        );
+    }
+
+    /**
+     * Get the models referenced in a to-many relationship.
+     *
+     * @return Collection
+     */
+    public function toMany(): Collection
+    {
+        if ($this->isModifyingRelationship()) {
+            return $this->relation()->collect();
+        }
+
+        throw new LogicException(
+            'Can only retrieve the models for a to-many relationship when the relationship is being modified.'
+        );
+    }
+
     /**
      * Perform resource authorization.
      *
@@ -557,4 +596,22 @@ private function validateRelationshipDocument(): void
         }
     }
 
+    /**
+     * @return LazyRelation
+     */
+    private function relation(): LazyRelation
+    {
+        if ($this->relation) {
+            return $this->relation;
+        }
+
+        $jsonApi = $this->jsonApi();
+
+        return $this->relation = new LazyRelation(
+            $jsonApi->server(),
+            $jsonApi->route()->relation(),
+            $this->json()->all(),
+        );
+    }
+
 }

tests/dummy/database/factories/CommentFactory.php

@@ -41,7 +41,7 @@ class CommentFactory extends Factory
     public function definition()
     {
         return [
-            'content' => $this->faker->text,
+            'content' => $this->faker->text(),
             'post_id' => Post::factory(),
             'user_id' => User::factory(),
         ];

tests/dummy/database/factories/ImageFactory.php

@@ -39,7 +39,7 @@ class ImageFactory extends Factory
     public function definition()
     {
         return [
-            'url' => $this->faker->url,
+            'url' => $this->faker->url(),
         ];
     }
 }

tests/dummy/database/factories/PostFactory.php

@@ -41,10 +41,10 @@ public function definition()
     {
         return [
             'author_id' => User::factory(),
-            'content' => $this->faker->text,
-            'published_at' => $this->faker->dateTimeThisMonth,
-            'slug' => $this->faker->unique()->slug,
-            'synopsis' => $this->faker->sentence,
+            'content' => $this->faker->text(),
+            'published_at' => $this->faker->dateTimeThisMonth(),
+            'slug' => $this->faker->unique()->slug(),
+            'synopsis' => $this->faker->sentence(),
             'title' => $this->faker->words(3, true),
         ];
     }

tests/dummy/database/factories/TagFactory.php

@@ -39,7 +39,7 @@ class TagFactory extends Factory
     public function definition()
     {
         return [
-            'name' => $this->faker->colorName,
+            'name' => $this->faker->colorName(),
         ];
     }
 }

tests/dummy/database/factories/UserFactory.php

@@ -40,8 +40,8 @@ class UserFactory extends Factory
     public function definition()
     {
         return [
-            'name' => $this->faker->name,
-            'email' => $this->faker->unique()->safeEmail,
+            'name' => $this->faker->name(),
+            'email' => $this->faker->unique()->safeEmail(),
             'email_verified_at' => now(),
             'password' => '$2y$10$92IXUNpkjO0rOQ5byMi.Ye4oKoEa3Ro9llC/.og/at2.uheWG/igi', // password
             'remember_token' => Str::random(10),

tests/dummy/database/factories/VideoFactory.php

@@ -42,7 +42,7 @@ public function definition()
         return [
             'owner_id' => User::factory(),
             'title' => $this->faker->words(3, true),
-            'url' => $this->faker->url,
+            'url' => $this->faker->url(),
         ];
     }
 }