Merge pull request #8 from kennedy-osaze/upgrade-laravel-10

Add support for Laravel 10.x

Author: kennedy-osaze

.github/workflows/main.yml

@@ -20,7 +20,7 @@ jobs:
       - name: Setup PHP
         uses: shivammathur/setup-php@v2
         with:
-          php-version: '8.0'
+          php-version: '8.1'
 
       - name: Cache dependencies
         uses: actions/cache@v3
@@ -44,12 +44,13 @@ jobs:
       fail-fast: true
       matrix:
         os: [ubuntu-latest, windows-latest]
-        php: [8.1, 8.0]
-        laravel: [9.*]
+        php: [8.2, 8.1]
+        laravel: [10.*]
         stability: [prefer-lowest, prefer-stable]
         include:
-          - laravel: 9.*
-            testbench: 7.*
+          - laravel: 10.*
+            testbench: 8.*
+            carbon: ^2.63
 
     name: P${{ matrix.php }} - L${{ matrix.laravel }} - ${{ matrix.stability }} - ${{ matrix.os }}
 
@@ -78,4 +79,4 @@ jobs:
         run: composer check-platform-reqs --verbose
 
       - name: Execute tests
-        run: vendor/bin/phpunit --debug --verbose
+        run: vendor/bin/phpunit

.gitignore

@@ -1,5 +1,6 @@
 .php-cs-fixer.cache
 .phpunit.result.cache
+.phpunit.cache
 composer.lock
 phpunit.xml
 vendor

README.md

@@ -13,9 +13,10 @@ Laravel API Response is a package that helps to provide and render a consistent
 
 ## Version Compatibility
 
- Laravel                    | Laravel API Response
-:---------------------------|:----------------------
- 9.x (Requires PHP >= 8.0)  | 1.x
+ Laravel  | Laravel API Response
+:---------|:----------------------
+ 9.x      | 1.x
+ 10.x     | 2.x
 
 ## Installation
 

composer.json

@@ -17,16 +17,15 @@
         }
     ],
     "require": {
-        "php": "^8.0",
-        "illuminate/contracts": "^9.10",
-        "illuminate/http": "^9.10",
-        "illuminate/translation": "^9.10"
+        "php": "^8.1",
+        "illuminate/contracts": "^10.0",
+        "illuminate/translation": "^10.0"
     },
     "require-dev": {
-        "kennedy-osaze/php-cs-fixer-config": "^2.0",
-        "nunomaduro/collision": "^6.2",
-        "orchestra/testbench": "^7.4",
-        "phpunit/phpunit": "^9.5"
+        "kennedy-osaze/php-cs-fixer-config": "^2.0.1",
+        "nunomaduro/collision": "^7.0",
+        "orchestra/testbench": "^8.0",
+        "phpunit/phpunit": "^10.0"
     },
     "autoload": {
         "psr-4": {

phpunit.xml.dist

@@ -1,23 +1,19 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phpunit
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xsi:noNamespaceSchemaLocation="vendor/phpunit/phpunit/phpunit.xsd"
+    xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.0/phpunit.xsd"
     backupGlobals="false"
-    backupStaticAttributes="false"
+    beStrictAboutTestsThatDoNotTestAnything="false"
     bootstrap="vendor/autoload.php"
     colors="true"
-    convertDeprecationsToExceptions="true"
-    convertErrorsToExceptions="true"
-    convertNoticesToExceptions="true"
-    convertWarningsToExceptions="true"
     processIsolation="false"
     stopOnFailure="false"
-    beStrictAboutOutputDuringTests="true"
-    verbose="true"
+    cacheDirectory=".phpunit.cache"
+    backupStaticProperties="false"
 >
     <testsuites>
         <testsuite name="Laravel API Response Test Suite">
-            <directory suffix=".php">./tests/</directory>
+            <directory suffix="Test.php">./tests/</directory>
         </testsuite>
     </testsuites>
 </phpunit>

tests/ApiResponseTest.php

@@ -15,6 +15,7 @@
 use KennedyOsaze\LaravelApiResponse\Tests\Fakes\DummyModel;
 use KennedyOsaze\LaravelApiResponse\Tests\Fakes\DummyResource;
 use KennedyOsaze\LaravelApiResponse\Tests\Fakes\DummyResourceCollection;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class ApiResponseTest extends TestCase
 {
@@ -161,9 +162,7 @@ public function testCorrectResponseReturnedOnJsonResource()
         DummyModel::migrate();
 
         $model = DummyModel::create(['name' => 'Kennedy']);
-        DummyModel::insert(Collection::times(5, fn ($number) => [
-            'name' => "Kennedy:{$number}", 'created_at' => now(), 'updated_at' => now(),
-        ])->toArray());
+        Collection::times(5)->each(fn ($number) => DummyModel::create(['name' => 'Kennedy:'.$number]));
 
         $resource = new DummyResource($model);
         $collection = DummyResource::collection(DummyModel::all());
@@ -225,17 +224,15 @@ public function testCorrectResponseReturnedOnResourceCollection()
         $this->assertSame($collectionE->collection->map->resolve()->toArray(), $responseDataE['data']['data']['data']);
     }
 
-    /**
-     * @dataProvider getRandomDataTypeProvider
-     */
+    #[DataProvider('getRandomDataTypeProvider')]
     public function testResponseWithRandomDataTypeContent($input, $result)
     {
         $responseData = ApiResponse::create(200, 'A dummy message', $input)->getData(true);
 
         $this->assertSame($result, $responseData['data']);
     }
 
-    public function getRandomDataTypeProvider()
+    public static function getRandomDataTypeProvider()
     {
         return [
             'test object' => [(object) ['type' => 'string'], ['type' => 'string']],

tests/ExceptionsHandlerTest.php

@@ -9,6 +9,7 @@
 use Illuminate\Support\Facades\Validator;
 use Illuminate\Validation\ValidationException;
 use KennedyOsaze\LaravelApiResponse\Tests\Fakes\ExceptionHandler;
+use PHPUnit\Framework\Attributes\DataProvider;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Exception\HttpException;
 use Symfony\Component\HttpKernel\Exception\NotFoundHttpException;
@@ -130,17 +131,15 @@ public function testHttpExceptionWithTranslationMessageReturnsCorrectResponseDat
         $this->assertSame(__('api-response::errors.example_code'), $response->getData(true)['message']);
     }
 
-    /**
-     * @dataProvider getHttpResponseExceptionProvider
-     */
+    #[DataProvider('getHttpResponseExceptionProvider')]
     public function testHttpResponseExceptionReturnsResponseDataCorrectly($exception, $responseData)
     {
         $response = $this->handler->renderApiResponse($exception, $this->app->request);
 
         $this->assertSame($responseData, $response->getData(true));
     }
 
-    public function getHttpResponseExceptionProvider()
+    public static function getHttpResponseExceptionProvider()
     {
         return [
             [

tests/RendersApiResponseTraitTest.php

@@ -66,9 +66,9 @@ public function testResourceCollectionResponse()
     {
         DummyModel::migrate();
 
-        DummyModel::insert(Collection::times(5, fn ($number) => [
+        Collection::times(3)->each(fn ($number) => DummyModel::create([
             'name' => "Kennedy:{$number}", 'created_at' => now(), 'updated_at' => now(),
-        ])->toArray());
+        ]));
 
         $message = 'Dummy message';
 
@@ -80,8 +80,8 @@ public function testResourceCollectionResponse()
         $response2 = $this->controller->resourceCollectionResponse($data2, $message);
         $response3 = $this->controller->resourceCollectionResponse($data3, $message, false);
 
-        collect([$response1, $response2, $response3])->each(fn ($response) => $this->assertSame('Dummy message', $response->getData(true)['message'])
-        );
+        collect([$response1, $response2, $response3])
+            ->each(fn ($response) => $this->assertSame('Dummy message', $response->getData(true)['message']));
 
         $this->assertSame(DummyModel::all(['id', 'name'])->toArray(), $response1->getData(true)['data']);
         $this->assertTrue(Arr::has($response2->getData(true), ['data.data', 'data.links', 'data.meta']));

tests/TestCase.php

@@ -5,9 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Foundation\Testing\RefreshDatabase;
 use KennedyOsaze\LaravelApiResponse\LaravelApiResponseServiceProvider;
-use Orchestra\Testbench\TestCase as OrchestraTestCase;
+use Orchestra\Testbench\TestCase as Orchestra;
 
-abstract class TestCase extends OrchestraTestCase
+class TestCase extends Orchestra
 {
     use RefreshDatabase;
 

tests/TranslatableTraitTest.php

@@ -3,6 +3,7 @@
 namespace KennedyOsaze\LaravelApiResponse\Tests;
 
 use KennedyOsaze\LaravelApiResponse\Tests\Fakes\TranslatableDummyClass;
+use PHPUnit\Framework\Attributes\DataProvider;
 
 class TranslatableTraitTest extends TestCase
 {
@@ -15,17 +16,15 @@ protected function setUp(): void
         $this->class = new TranslatableDummyClass();
     }
 
-    /**
-     * @dataProvider getTranslatableStringProvider
-     */
+    #[DataProvider('getTranslatableStringProvider')]
     public function testStringCanBeParsedAndTranslatableToParameterArray($input, $output)
     {
         $result = $this->class->parseStringToTranslationParameters($input);
 
         $this->assertSame($output, $result);
     }
 
-    public function getTranslatableStringProvider()
+    public static function getTranslatableStringProvider()
     {
         return [
             ['', ['name' => '', 'attributes' => []]],
@@ -40,17 +39,15 @@ public function getTranslatableStringProvider()
         ];
     }
 
-    /**
-     * @dataProvider getTranslatableArrayProvider
-     */
+    #[DataProvider('getTranslatableArrayProvider')]
     public function testTranslatableParameterArrayCanBeConvertedToString($string, $attributes, $output)
     {
         $result = $this->class->transformToTranslatableString($string, $attributes);
 
         $this->assertSame($output, $result);
     }
 
-    public function getTranslatableArrayProvider()
+    public static function getTranslatableArrayProvider()
     {
         return [
             ['', [], ''],
@@ -61,9 +58,7 @@ public function getTranslatableArrayProvider()
         ];
     }
 
-    /**
-     * @dataProvider getTranslationProvider
-     */
+    #[DataProvider('getTranslationProvider')]
     public function testGetTranslatedStringArray($key, $attributes, $prefix, $output)
     {
         $prefix = $prefix ? 'api-response::'.$prefix : $prefix;
@@ -73,7 +68,7 @@ public function testGetTranslatedStringArray($key, $attributes, $prefix, $output
         $this->assertSame($output, $result);
     }
 
-    public function getTranslationProvider()
+    public static function getTranslationProvider()
     {
         return [
             ['', [], null, ['key' => '', 'message' => '']],
@@ -83,17 +78,15 @@ public function getTranslationProvider()
         ];
     }
 
-    /**
-     * @dataProvider getIsTranslationKeyProvider
-     */
+    #[DataProvider('getIsTranslationKeyProvider')]
     public function testIsTranslationKeyReturnsOutputCorrectly($input, $output)
     {
         $result = $this->class->isTranslationKey($input);
 
         $this->assertSame($output, $result);
     }
 
-    public function getIsTranslationKeyProvider()
+    public static function getIsTranslationKeyProvider()
     {
         return [
             ['', false],