Merge branch 'release/1.1.2'

Author: lindyhopchris

.github/workflows/tests.yml

@@ -14,15 +14,15 @@ jobs:
     strategy:
       fail-fast: true
       matrix:
-        php: [7.4, '8.0', 8.1]
+        php: [7.4, '8.0', 8.1, 8.2]
         laravel: [8, 9]
         exclude:
           - php: 7.4
             laravel: 9
 
     steps:
     - name: Checkout Code
-      uses: actions/checkout@v2
+      uses: actions/checkout@v3
 
     - name: Setup PHP
       uses: shivammathur/setup-php@v2
@@ -37,7 +37,7 @@ jobs:
       run: composer require "illuminate/testing:^${{ matrix.laravel }}" --no-update
 
     - name: Install dependencies
-      uses: nick-invision/retry@v1
+      uses: nick-fields/retry@v2
       with:
         timeout_minutes: 5
         max_attempts: 5

CHANGELOG.md

@@ -3,6 +3,17 @@
 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/).
 
+## [1.1.2] - 2023-01-15
+
+### Fixed
+
+- The `TestBuilder::withData()` method no longer converts the provided data to a `Collection` if it implements
+  the `JsonSerializable` interface. This change was required because Laravel changed how they converted objects to
+  collections. It is not strictly necessary to convert objects that implement the JSON serializable interface, because
+  they will be converted when the test JSON value is JSON encoded. Technically this is a breaking fix if
+  the `TestBuilder` class has been extended. However, this change is being done as a bug fix because the bug was caused
+  by a minor release of Laravel.
+
 ## [1.1.1] - 2022-02-27
 
 ### Fixed

src/MakesJsonApiRequests.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * Copyright 2023 Cloud Creativity Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/TestBuilder.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * Copyright 2023 Cloud Creativity Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -21,12 +21,12 @@
 use Illuminate\Support\Arr;
 use Illuminate\Support\Collection;
 use Illuminate\Support\Str;
+use JsonSerializable;
 use PHPUnit\Framework\Assert;
 use PHPUnit\Framework\TestCase;
 use function array_walk_recursive;
 use function implode;
 use function is_bool;
-use function is_null;
 use function is_scalar;
 
 final class TestBuilder
@@ -236,16 +236,20 @@ public function page(iterable $page): self
     /**
      * Set the data member of the request JSON API document.
      *
-     * @param iterable|null $data
+     * @param JsonSerializable|iterable|null $data
      * @return $this
      */
-    public function withData(?iterable $data): self
+    public function withData($data): self
     {
-        if (is_null($data)) {
+        if ($data === null) {
             return $this->withJson(['data' => null]);
         }
 
-        return $this->withJson(['data' => Collection::make($data)]);
+        if (is_object($data) && !$data instanceof JsonSerializable) {
+            $data = Collection::make($data);
+        }
+
+        return $this->withJson(['data' => $data]);
     }
 
     /**

src/TestExceptionHandler.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * Copyright 2023 Cloud Creativity Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

src/TestResponse.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * Copyright 2023 Cloud Creativity Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.

tests/Unit/TestBuilderTest.php

@@ -1,6 +1,6 @@
 <?php
 /*
- * Copyright 2022 Cloud Creativity Limited
+ * Copyright 2023 Cloud Creativity Limited
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -31,7 +31,8 @@
 use PHPUnit\Framework\MockObject\MockObject;
 use PHPUnit\Framework\TestCase;
 
-class MockTestCase extends TestCase {
+class MockTestCase extends TestCase
+{
     use MakesHttpRequests;
 }
 
@@ -201,6 +202,103 @@ public function testDelete(): void
         $this->assertEquals(new TestResponse($this->response, 'posts'), $response);
     }
 
+    /**
+     * Test using data that is JSON serializable.
+     *
+     * When the data is JSON serializable, we just pass it through as we expect it to be
+     * JSON encoded by the test request.
+     *
+     * @return void
+     */
+    public function testWithJsonSerializableData(): void
+    {
+        $headers = [
+            'X-Foo' => 'Bar',
+            'Accept' => 'application/vnd.api+json',
+            'CONTENT_TYPE' => 'application/vnd.api+json',
+        ];
+
+        $mock = $this->createMock(\JsonSerializable::class);
+        $mock->method('jsonSerialize')->willReturn([
+            'type' => 'posts',
+            'attributes' => [
+                'content' => '...',
+                'slug' => 'hello-world',
+                'title' => 'Hello World!',
+            ],
+        ]);
+
+        $this->mock
+            ->expects($this->once())
+            ->method('json')
+            ->with('POST', '/api/v1/posts', ['data' => $mock], $headers)
+            ->willReturn(new IlluminateTestResponse($this->response));
+
+        $response = $this->builder
+            ->expects('posts')
+            ->withData($mock)
+            ->post('/api/v1/posts', ['X-Foo' => 'Bar']);
+
+        $this->assertEquals(new TestResponse($this->response, 'posts'), $response);
+    }
+
+    public function testWithIterableThatIsNotJsonSerializable(): void
+    {
+        $headers = [
+            'X-Foo' => 'Bar',
+            'Accept' => 'application/vnd.api+json',
+            'CONTENT_TYPE' => 'application/vnd.api+json',
+        ];
+
+        $object = new class implements \IteratorAggregate {
+            public function getIterator(): \Generator
+            {
+                yield from [
+                    ['type' => 'posts', 'id' => '1'],
+                ];
+            }
+        };
+
+        $expected = Collection::make($object)->toArray();
+
+        $this->mock
+            ->expects($this->once())
+            ->method('json')
+            ->with('POST', '/api/v1/posts', ['data' => $expected], $headers)
+            ->willReturn(new IlluminateTestResponse($this->response));
+
+        $response = $this->builder
+            ->expects('posts')
+            ->withData($object)
+            ->post('/api/v1/posts', ['X-Foo' => 'Bar']);
+
+        $this->assertEquals(new TestResponse($this->response, 'posts'), $response);
+    }
+
+    public function testWithNullData(): void
+    {
+        $headers = [
+            'X-Foo' => 'Bar',
+            'Accept' => 'application/vnd.api+json',
+            'CONTENT_TYPE' => 'application/vnd.api+json',
+        ];
+
+        $data = null;
+
+        $this->mock
+            ->expects($this->once())
+            ->method('json')
+            ->with('POST', '/api/v1/posts', compact('data'), $headers)
+            ->willReturn(new IlluminateTestResponse($this->response));
+
+        $response = $this->builder
+            ->expects('posts')
+            ->withData($data)
+            ->post('/api/v1/posts', ['X-Foo' => 'Bar']);
+
+        $this->assertEquals(new TestResponse($this->response, 'posts'), $response);
+    }
+
     public function testWithHeader(): void
     {
         $headers = [