Upgrades to Laravel 10 and PHP 8.2, plus fixes from static analysis and code styles

.github/workflows/phpcsfixer.yml

@@ -0,0 +1,26 @@
+name: Format with PHP CS Fixer
+
+on: [pull_request, workflow_dispatch]
+
+jobs:
+  php-cs-fixer:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          extensions: zip
+          coverage: none
+
+      - name: Install Dependencies
+        run: composer install --no-ansi --no-interaction --no-scripts --prefer-dist
+
+      - run: composer run format
+
+      - uses: stefanzweifel/git-auto-commit-action@v4
+        with:
+          commit_message: Apply php-cs-fixer changes

.github/workflows/phpstan.yml

@@ -0,0 +1,22 @@
+name: Perform static analysis with PHPStan
+
+on: [pull_request, workflow_dispatch]
+
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Setup PHP
+        uses: shivammathur/setup-php@v2
+        with:
+          php-version: '8.2'
+          extensions: zip
+          coverage: none
+
+      - name: Install Dependencies
+        run: composer install --no-ansi --no-interaction --no-scripts --prefer-dist
+
+      - run: composer run phpstan

.github/workflows/tests.yml

@@ -4,19 +4,14 @@ on: [pull_request, workflow_dispatch]
 
 jobs:
   test:
-    # not self-hosted, because it's a public repo
     runs-on: ubuntu-latest
 
-    # we want to run it on combination of Laravel 8.12+ and PHP 8+
+    # we want to run it on supported combination of Laravel and PHP versions
     strategy:
       fail-fast: false
       matrix:
-        php: ['8.0', '8.1']
-        laravel: ['^8.12', '^9.0', '^10.0']
-        exclude:
-          # minimum php version for Laravel 10 is PHP 8.1 so we need to exclude (php 8.0 and laravel 10) combination
-          - php: '8.0'
-            laravel: '^10.0'
+        php: ['8.1', '8.2']
+        laravel: ['^9.0', '^10.0']
 
     steps:
       - name: Checkout the repo
@@ -35,4 +30,4 @@ jobs:
         run: composer require laravel/framework $LARAVEL_VERSION --no-interaction --no-scripts --prefer-dist
 
       - name: Execute tests
-        run: vendor/bin/phpunit
+        run: composer run test

.gitignore

@@ -2,4 +2,5 @@
 composer.lock
 .idea
 .phpunit.result.cache
-.phpunit.cache
+.phpunit.cache
+.php-cs-fixer.cache

.php-cs-fixer.php

@@ -0,0 +1,25 @@
+<?php
+
+use PhpCsFixer\Config;
+use PhpCsFixer\Finder;
+
+/** @var Config $config */
+$config = require_once join(DIRECTORY_SEPARATOR, [__DIR__, 'vendor', 'netsells', 'code-standards-laravel', 'phpcsfixer', 'config.php']);
+
+$rules = array_merge_recursive($config->getRules(), [
+    // set project specific rules here
+]);
+
+$finder = Finder::create()
+    ->in([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+    ->name('*.php')
+    ->notName('*.blade.php')
+    ->ignoreDotFiles(true)
+    ->ignoreVCS(true);
+
+return $config
+    ->setFinder($finder)
+    ->setRules($rules);

composer.json

@@ -20,18 +20,25 @@
         }
     ],
     "require": {
-        "php": ">=8.0",
+        "php": "^8.1 || ^8.2",
         "ext-json": "*",
-        "laravel/framework": "^8.12 || ^9.0 || ^10.0"
+        "laravel/framework": "^9.0 || ^10.0"
     },
     "require-dev": {
-        "orchestra/testbench": "^6.0 || ^7.0 || ^8.0",
-        "tmarsteel/mockery-callable-mock": "~2.1"
+        "orchestra/testbench": "^7.0 || ^8.0",
+        "tmarsteel/mockery-callable-mock": "~2.1",
+        "netsells/code-standards-laravel": "^1.1"
     },
     "autoload": {
         "psr-4": {
             "Netsells\\Http\\Resources\\": "src/",
             "Netsells\\Http\\Resources\\Tests\\": "tests/"
         }
+    },
+    "scripts": {
+        "phpstan": "vendor/bin/phpstan",
+        "lint": "vendor/bin/php-cs-fixer fix --dry-run --diff",
+        "format": "vendor/bin/php-cs-fixer fix",
+        "test": "vendor/bin/phpunit"
     }
 }

phpstan.neon

@@ -0,0 +1,15 @@
+includes:
+    - ./vendor/netsells/code-standards-laravel/phpstan/extension.neon
+
+parameters:
+    paths:
+        - src
+        - tests
+
+    # The level 9 is the highest level
+    level: 5
+
+    ignoreErrors:
+    excludePaths:
+
+    checkMissingIterableValueType: false

src/Eloquent/EloquentDeferredValue.php

@@ -2,6 +2,7 @@
 
 namespace Netsells\Http\Resources\Eloquent;
 
+use Illuminate\Support\Collection;
 use Netsells\Http\Resources\DeferredValue;
 use Netsells\Http\Resources\Json\JsonResource;
 use Netsells\Http\Resources\Json\ResourceCollection;
@@ -26,12 +27,12 @@ public static function resolve(array $deferredValues): void
     {
         static::loadEloquentRelations($deferredValues);
 
-        collect($deferredValues)
+        Collection::make($deferredValues)
             ->filter(function (EloquentDeferredValue $deferredValue) {
-                return $deferredValue->resolver;
+                return (bool) $deferredValue->resolver;
             })
             ->each(function (EloquentDeferredValue $deferredValue) {
-                $relations = collect($deferredValue->relations)->map(function ($relation) use ($deferredValue) {
+                $relations = Collection::make($deferredValue->relations)->map(function ($relation) use ($deferredValue) {
                     return data_get($deferredValue->resource, $relation);
                 })->all();
 
@@ -41,6 +42,7 @@ public static function resolve(array $deferredValues): void
 
     /**
      * Begins eager loading eloquent model relations.
+     *
      * @param static[] $deferredValues
      */
     abstract protected static function loadEloquentRelations(array $deferredValues): void;

src/Eloquent/Load.php

@@ -8,11 +8,11 @@
 class Load extends EloquentDeferredValue
 {
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     protected static function loadEloquentRelations(array $deferredValues): void
     {
-        collect($deferredValues)->groupBy('relations')
+        Collection::make($deferredValues)->groupBy('relations')
             ->each(function (Collection $collection, $relation) {
                 EloquentCollection::make($collection->pluck('resource.resource'))
                     ->load($relation);

src/Eloquent/LoadCount.php

@@ -8,11 +8,11 @@
 class LoadCount extends EloquentDeferredValue
 {
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     protected static function loadEloquentRelations(array $deferredValues): void
     {
-        collect($deferredValues)->groupBy('relations')
+        Collection::make($deferredValues)->groupBy('relations')
             ->each(function (Collection $collection, $relation) {
                 EloquentCollection::make($collection->pluck('resource.resource'))
                     ->loadCount($relation);

src/Eloquent/LoadMissing.php

@@ -8,11 +8,11 @@
 class LoadMissing extends EloquentDeferredValue
 {
     /**
-     * @inheritDoc
+     * {@inheritDoc}
      */
     protected static function loadEloquentRelations(array $deferredValues): void
     {
-        collect($deferredValues)->groupBy('relations')
+        Collection::make($deferredValues)->groupBy('relations')
             ->each(function (Collection $collection, $relation) {
                 EloquentCollection::make($collection->pluck('resource.resource'))
                     ->loadMissing($relation);

src/Eloquent/ResolvesEloquentResources.php

@@ -2,20 +2,17 @@
 
 namespace Netsells\Http\Resources\Eloquent;
 
-use Netsells\Http\Resources\DeferredValue;
 use Netsells\Http\Resources\Json\JsonResource;
 
 trait ResolvesEloquentResources
 {
     /**
-     * @var class-string<DeferredValue>
+     * @var class-string<EloquentDeferredValue>
      */
     protected string $defaultDeferredValueClass = LoadMissing::class;
 
     /**
      * @param string|string[] $relations
-     * @param callable|null $fn
-     * @return EloquentDeferredValue
      */
     protected function load(string|array $relations, ?callable $fn = null): EloquentDeferredValue
     {
@@ -24,8 +21,6 @@ protected function load(string|array $relations, ?callable $fn = null): Eloquent
 
     /**
      * @param string|string[] $relations
-     * @param callable|null $fn
-     * @return EloquentDeferredValue
      */
     protected function loadMissing(string|array $relations, ?callable $fn = null): EloquentDeferredValue
     {
@@ -34,8 +29,6 @@ protected function loadMissing(string|array $relations, ?callable $fn = null): E
 
     /**
      * @param string|string[] $relations
-     * @param callable|null $fn
-     * @return EloquentDeferredValue
      */
     protected function loadCount(string|array $relations, ?callable $fn = null): EloquentDeferredValue
     {
@@ -44,27 +37,19 @@ protected function loadCount(string|array $relations, ?callable $fn = null): Elo
 
     /**
      * @param string|string[] $relations
-     * @param callable|null $fn
-     * @return EloquentDeferredValue
      */
     protected function use(string|array $relations, ?callable $fn = null): EloquentDeferredValue
     {
         return new $this->defaultDeferredValueClass($this, (array) $relations, $fn);
     }
 
-    /**
-     * @param string ...$relations
-     * @return EloquentDeferredValue
-     */
     protected function preload(string ...$relations): EloquentDeferredValue
     {
         return new $this->defaultDeferredValueClass($this, $relations);
     }
 
     /**
-     * @param string $relation
      * @param class-string<JsonResource> $resourceClass
-     * @return EloquentDeferredValue
      */
     protected function many(string $relation, string $resourceClass): EloquentDeferredValue
     {
@@ -74,9 +59,7 @@ protected function many(string $relation, string $resourceClass): EloquentDeferr
     }
 
     /**
-     * @param string $relation
      * @param class-string<JsonResource> $resourceClass
-     * @return EloquentDeferredValue
      */
     protected function one(string $relation, string $resourceClass): EloquentDeferredValue
     {

src/Json/AnonymousResourceCollection.php

@@ -4,6 +4,13 @@
 
 class AnonymousResourceCollection extends ResourceCollection
 {
+    /**
+     * Indicates if the collection keys should be preserved.
+     *
+     * @var bool
+     */
+    public $preserveKeys = false;
+
     public function __construct(mixed $resource, string $collects)
     {
         $this->collects = $collects;

src/Json/JsonResource.php

@@ -4,7 +4,6 @@
 
 use Illuminate\Http\Request;
 use Illuminate\Support\Collection;
-use Netsells\Http\Resources\DeferredValue;
 use Netsells\Http\Resources\Eloquent\ResolvesEloquentResources;
 use Netsells\Http\Resources\ResolvesResources;
 
@@ -14,18 +13,13 @@ class JsonResource extends \Illuminate\Http\Resources\Json\JsonResource
     use ResolvesEloquentResources;
 
     /**
-     * @return DeferredValue|DeferredValue[]
+     * @deprecated This method can be removed when dropping support for Laravel 9.
      */
-    public function preloads(/** @param Request $request */)
+    public static function collection($resource)
     {
-        return [];
-    }
-
-    public static function collection(mixed $resource): AnonymousResourceCollection
-    {
-        return tap(new AnonymousResourceCollection($resource, static::class), function ($collection) {
+        return tap(static::newCollection($resource), function ($collection) { // @phpstan-ignore-line
             if (property_exists(static::class, 'preserveKeys')) {
-                $collection->preserveKeys = (new static([]))->preserveKeys === true;
+                $collection->preserveKeys = (new static([]))->preserveKeys === true; // @phpstan-ignore-line
             }
         });
     }
@@ -34,4 +28,9 @@ protected function beforeResolveRoot(Request $request): void
     {
         $this->collectAndResolvePreloads($request, Collection::make([$this]));
     }
+
+    protected static function newCollection(mixed $resource): AnonymousResourceCollection
+    {
+        return new AnonymousResourceCollection($resource, static::class);
+    }
 }