Laravel 11.x Compatibility (#49)

* Bump dependencies for Laravel 11 * Update GitHub Actions for Laravel 11 * Allow PHP 8.3 * Bump collections * formatting * formatting * formatting * Fix tests * Update upgrade guide * Linting * Fix build * Fix version constraint * Fix compatibility issue * Fix migrations * Fix conflict * lint --------- Co-authored-by: Tim MacDonald <hello@timacdonald.me>
timacdonald · Mar 13, 2024 · aed50a8 · aed50a8
1 parent 32e7a0c
commit aed50a8
Show file tree

Hide file tree

Showing 12 changed files with 185 additions and 269 deletions.
diff --git a/.github/workflows/main.yml b/.github/workflows/main.yml
@@ -1,128 +1,137 @@
 name: CI
 
 on:
-    push:
-        branches: [ main ]
-    pull_request:
-        branches: [ main ]
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
 
 jobs:
-    lint:
-        runs-on: ubuntu-latest
-        name: 'Lint'
-        steps:
-            - name: Checkout code
-              uses: actions/checkout@v3
-
-            - name: Get composer cache directory
-              id: composer-cache
-              run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
-
-            - name: Cache dependencies
-              uses: actions/cache@v3
-              with:
-                path: ${{ steps.composer-cache.outputs.dir }}
-                key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
-                restore-keys: ${{ runner.os }}-composer-
-
-            - name: Setup PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                  php-version: '8.1'
-                  coverage: pcov
-
-            - name: Install dependencies
-              run: composer update
-
-            - name: Check platform requirements
-              run: composer check-platform-reqs
-
-            - name: PHP-CS-Fixer
-              run: composer fix -- --dry-run
-
-            # - name: composer normalize
-            #   run: composer normalize --dry-run --no-interaction --verbose
-
-            # - name: test coverage
-            #   run: |
-            #       ./vendor/bin/phpunit --coverage-clover=coverage.xml --debug --verbose
-            #       bash <(curl -s https://codecov.io/bash)
-            #   env:
-            #       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
-
-            # - name: Infection
-            #   run: ./vendor/bin/infection --show-mutations --min-covered-msi=100 --no-progress --no-interaction --verbose
-              # env:
-              #     INFECTION_BADGE_API_KEY: ${{ secrets.INFECTION_BADGE_API_KEY }}
-
-            # - name: Psalm
-            #   run: ./vendor/bin/psalm --shepherd --no-progress
-
-            # - name: PHPStan
-            #   run: ./vendor/bin/phpstan --no-interaction --verbose
-            #
-            #   composer-require-checker
-            #   composer-unused
-
-    tests:
-        runs-on: ubuntu-latest
-        name: 'PHP: ${{ matrix.php }}; Laravel: ${{ matrix.laravel }}; Prefer: ${{ matrix.prefer }}'
-        strategy:
-            matrix:
-                php: ['8.1', '8.2']
-                laravel: ['^9.0', '^10.0']
-                prefer: ['prefer-lowest', 'prefer-stable']
-                include:
-                    - testbench: '^7.0'
-                      laravel: '^9.0'
-                    - testbench: '^8.0'
-                      laravel: '^10.0'
-
-        steps:
-            - name: checkout code
-              uses: actions/checkout@v3
-
-            - name: Get composer cache directory
-              id: composer-cache
-              run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
-
-            - name: Cache dependencies
-              uses: actions/cache@v3
-              with:
-                  path: ${{ steps.composer-cache.outputs.dir }}
-                  key: ${{ runner.os }}-php-${{ matrix.php }}-laravel-${{ matrix.laravel }}-prefer-${{ matrix.prefer }}-composer-${{ hashFiles('**/composer.json') }}
-                  restore-keys: ${{ runner.os }}-php-${{ matrix.php }}-laravel-{{ matrix.laravel }}-prefer-${{ matrix.prefer}}-composer-
-
-            - name: Setup PHP
-              uses: shivammathur/setup-php@v2
-              with:
-                  php-version: ${{ matrix.php }}
-                  coverage: none
-
-            - name: Remove dev packages
-              run: |
-                  composer remove --dev --no-update \
-                      friendsofphp/php-cs-fixer \
-                      infection/infection \
-                      nunomaduro/larastan \
-                      phpstan/phpstan-strict-rules
-
-            - name: Require Laravel and Testbench version
-              run: composer require --no-update laravel/framework:"${{ matrix.laravel }}" illuminate/collections:"${{ matrix.laravel }}" illuminate/database:"${{ matrix.laravel }}" illuminate/http:"${{ matrix.laravel }}" illuminate/support:"${{ matrix.laravel }}" orchestra/testbench:"${{ matrix.testbench }}"
-
-            - name: Support prefer-lowest in PHP 8.1
-              if: ${{ matrix.php == 8.1 && matrix.prefer == 'prefer-lowest' }}
-              run: composer require --no-update nesbot/carbon:"^2.62.1"
-
-            - name: Support prefer-lowest in PHP 8.2
-              if: ${{ matrix.php == 8.2 && matrix.prefer == 'prefer-lowest' }}
-              run: composer require --no-update nesbot/carbon:"^2.62.1"
-
-            - name: Install dependencies
-              run: composer update --${{ matrix.prefer }}
-
-            - name: Check platform requirements
-              run: composer check-platform-reqs --verbose
-
-            - name: Run tests
-              run: composer test
+  lint:
+    runs-on: ubuntu-latest
+    name: Lint
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-composer-
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.1'
+          coverage: pcov
+
+      - name: Install dependencies
+        run: composer update
+
+      - name: Check platform requirements
+        run: composer check-platform-reqs
+
+      - name: PHP-CS-Fixer
+        run: composer fix -- --dry-run
+
+      # - name: composer normalize
+      #   run: composer normalize --dry-run --no-interaction --verbose
+
+      # - name: test coverage
+      #   run: "./vendor/bin/phpunit --coverage-clover=coverage.xml --debug --verbose && bash <(curl -s https://codecov.io/bash)"
+      #   env:
+      #       CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}
+
+      # - name: Infection
+      #   run: "./vendor/bin/infection --show-mutations --min-covered-msi=100 --no-progress --no-interaction --verbose"
+      #   env:
+      #       INFECTION_BADGE_API_KEY: ${{ secrets.INFECTION_BADGE_API_KEY }}
+
+      # - name: Psalm
+      #   run: ./vendor/bin/psalm --shepherd --no-progress
+
+      # - name: PHPStan
+      #   run: ./vendor/bin/phpstan --no-interaction --verbose
+
+      #   composer-require-checker
+      #   composer-unused
+
+  tests:
+    runs-on: ubuntu-latest
+    name: "PHP: ${{ matrix.php }}; Laravel: ${{ matrix.laravel }}; Prefer: ${{ matrix.prefer }}"
+    strategy:
+      matrix:
+        php: ['8.1', '8.2', '8.3']
+        laravel: [^9.0, ^10.0, ^11.0]
+        prefer: [prefer-lowest, prefer-stable]
+        include:
+          - testbench: ^7.0
+            laravel: ^9.0
+          - testbench: ^8.0
+            laravel: ^10.0
+          - testbench: ^9.0
+            laravel: ^11.0
+        exclude:
+          - laravel: ^11.0
+            php: '8.1'
+
+    steps:
+      - name: checkout code
+        uses: actions/checkout@v3
+
+      - name: Get composer cache directory
+        id: composer-cache
+        run: echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+
+      - name: Cache dependencies
+        uses: actions/cache@v3
+        with:
+          path: ${{ steps.composer-cache.outputs.dir }}
+          key: ${{ runner.os }}-php-${{ matrix.php }}-laravel-${{ matrix.laravel }}-prefer-${{ matrix.prefer }}-composer-${{ hashFiles('**/composer.json') }}
+          restore-keys: ${{ runner.os }}-php-${{ matrix.php }}-laravel-{{ matrix.laravel }}-prefer-${{ matrix.prefer}}-composer-
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: ${{ matrix.php }}
+          coverage: none
+
+      - name: Remove dev packages
+        run: |
+          composer remove --dev --no-update \
+              friendsofphp/php-cs-fixer \
+              infection/infection \
+              nunomaduro/larastan \
+              phpstan/phpstan-strict-rules
+
+      - name: Require Laravel and Testbench version
+        run: composer require --no-update laravel/framework:"${{ matrix.laravel }}" illuminate/collections:"${{ matrix.laravel }}" illuminate/database:"${{ matrix.laravel }}" illuminate/http:"${{ matrix.laravel }}" illuminate/support:"${{ matrix.laravel }}" orchestra/testbench:"${{ matrix.testbench }}"
+
+      - name: Support prefer-lowest in PHP 8.1
+        if: ${{ matrix.php == 8.1 && matrix.prefer == 'prefer-lowest' }}
+        run: composer require --no-update nesbot/carbon:"^2.62.1"
+
+      - name: Support prefer-lowest in PHP 8.2
+        if: ${{ matrix.php == 8.2 && matrix.prefer == 'prefer-lowest' }}
+        run: composer require --no-update nesbot/carbon:"^2.62.1"
+
+      - name: Support prefer-lowest in PHP 8.3
+        if: ${{ matrix.php == 8.3 && matrix.prefer == 'prefer-lowest' }}
+        run: composer require --no-update nesbot/carbon:"^2.62.1"
+
+      - name: Install dependencies
+        run: composer update --${{ matrix.prefer }}
+
+      - name: Check platform requirements
+        run: composer check-platform-reqs --verbose
+
+      - name: Run tests
+        run: composer test
diff --git a/UPGRADE.md b/UPGRADE.md
@@ -103,3 +103,30 @@ Now collections are formatted correctly. The `posts` value is now an object and
     }
 }
 ```
+
+## Server implementation no longer included by default
+
+Previously, the top level `jsonapi` property was included in every response...
+
+```json5
+{
+    // ...
+    "jsonapi": {
+        "version": "1.0"
+    }
+}
+```
+
+This is no longer the case. If you would like to include a server implementation in your API responses you may call the `JsonApiResource::resolveServerImplementationUsing` method in a service provider or middleware:
+
+```php
+use TiMacDonald\JsonApi\JsonApiResource;
+use TiMacDonald\JsonApi\ServerImplementation;
+
+
+JsonApiResource::resolveServerImplementationUsing(function () {
+    return new ServerImplementation(version: '1.4.3', meta: [
+        'secure' => true,
+    ]);
+});
+```
diff --git a/composer.json b/composer.json
@@ -17,19 +17,19 @@
         }
     ],
     "require": {
-        "php": "~8.1.0 || ~8.2.0",
-        "illuminate/collections": "^9.0 || ^10.0",
-        "illuminate/database": "^9.0 || ^10.0",
-        "illuminate/http": "^9.0 || ^10.0",
-        "illuminate/support": "^9.0 || ^10.0",
-        "symfony/http-kernel": "^6.0"
+        "php": "~8.1.0 || ~8.2.0 || ~8.3.0",
+        "illuminate/collections": "^9.0 || ^10.0 || ^11.0",
+        "illuminate/database": "^9.0 || ^10.0 || ^11.0",
+        "illuminate/http": "^9.0 || ^10.0 || ^11.0",
+        "illuminate/support": "^9.0 || ^10.0 || ^11.0",
+        "symfony/http-kernel": "^6.0 || ^7.0"
     },
     "require-dev": {
         "friendsofphp/php-cs-fixer": "^3.13",
-        "laravel/framework": "^9.0 || ^10.0",
+        "laravel/framework": "^9.0 || ^10.0 || ^11.0",
         "opis/json-schema": "^2.3",
-        "orchestra/testbench": "^7.0 || ^8.0",
-        "phpunit/phpunit": "^9.0"
+        "orchestra/testbench": "^7.0 || ^8.0 || ^9.0",
+        "phpunit/phpunit": "^9.0 || ^10.5"
     },
     "config": {
         "preferred-install": "dist",

diff --git a/src/Concerns/Implementation.php b/src/Concerns/Implementation.php
@@ -13,7 +13,7 @@ trait Implementation
     /**
      * @api
      *
-     * @param (callable(): JsonApiServerImplementation) $callback
+     * @param (callable(): ServerImplementation) $callback
      * @return void
      */
     public static function resolveServerImplementationUsing(callable $callback)
@@ -24,7 +24,7 @@ public static function resolveServerImplementationUsing(callable $callback)
     /**
      * @internal
      *
-     * @return (callable(Request): (JsonApiServerImplementation|null))
+     * @return (callable(Request): (ServerImplementation|null))
      */
     public static function serverImplementationResolver()
     {

diff --git a/src/JsonApiResource.php b/src/JsonApiResource.php
@@ -99,7 +99,7 @@ public function toResourceIdentifier(Request $request)
     }
 
     /**
-     * @return JsonApiServerImplementation|null
+     * @return ServerImplementation|null
      */
     public static function toServerImplementation(Request $request)
     {
@@ -124,9 +124,10 @@ public function toArray($request)
     }
 
     /**
-     * @return array{included?: array<int, JsonApiResource>, jsonapi: JsonApiServerImplementation}
+     * @param  Request  $request
+     * @return array{included?: array<int, JsonApiResource>, jsonapi: ServerImplementation}
      */
-    public function with(Request $request)
+    public function with($request)
     {
         return [
             ...($included = $this->included($request)

diff --git a/src/JsonApiResourceCollection.php b/src/JsonApiResourceCollection.php
@@ -42,9 +42,10 @@ private function resolveResourceIdentifiers(Request $request)
     }
 
     /**
-     * @return array{included?: array<int, JsonApiResource>, jsonapi?: JsonApiServerImplementation}
+     * @param  Request  $request
+     * @return array{included?: array<int, JsonApiResource>, jsonapi?: ServerImplementation}
      */
-    public function with(Request $request)
+    public function with($request)
     {
         return [
             ...($included = $this->collection