Merge pull request #165 from conedevelopment/prepare-phpstan

.gitattributes

@@ -12,7 +12,7 @@
 /js-tests export-ignore
 /phpstan.neon.dist export-ignore
 /phpunit.xml.dist export-ignore
-/public/build/assets/ linguist-generated
+/public/build/assets/** linguist-generated
 /tests export-ignore
 /yarn.lock export-ignore linguist-generated
 /vite.config.js export-ignore

.github/workflows/back-end.yml

@@ -135,9 +135,12 @@ jobs:
             name: "Search for $this->$this typo 🐌"
             run: |
                 ! git grep --line-number -e '\$this\s*->\s*\$this' -- ':!:*/back-end\.yml'
+        -
+            name: "Install orchestra/testbench"
+            run: "composer require --dev orchestra/testbench"
         -
             name: "Perform static analysis"
-            run: "true TODO || composer exec -- phpstan analyze --level=5 src/"
+            run: "composer exec -- phpstan || true 'Annotate only'"
 
     coding_standards:
         name: "4️⃣ Coding Standards"

.github/workflows/reusable-integrity.yml

@@ -119,7 +119,7 @@ jobs:
                 wget --secure-protocol=TLSv1_3 --max-redirect=1 --retry-on-host-error --retry-connrefused --tries=3 \
                     --no-verbose --output-document="${{ runner.temp }}/cloc/cloc" "${RELEASE_ASSET_URL}"
                 {
-                    git ls-files -- ':!:LICENSE' ':!:package-lock.json' >"${{ runner.temp }}/cloc/include-list"
+                    git ls-files -- ':!:LICENSE' ':!:yarn.lock' >"${{ runner.temp }}/cloc/include-list"
                     echo '```'
                     perl "${{ runner.temp }}/cloc/cloc" --hide-rate \
                         --list-file="${{ runner.temp }}/cloc/include-list" \

database/factories/MediumFactory.php

@@ -12,7 +12,7 @@ class MediumFactory extends Factory
     /**
      * The name of the factory's corresponding model.
      *
-     * @var string
+     * @var class-string<\Cone\Root\Models\Medium>
      */
     protected $model = Medium::class;
 

database/factories/MetaFactory.php

@@ -11,7 +11,7 @@ class MetaFactory extends Factory
     /**
      * The name of the factory's corresponding model.
      *
-     * @var string
+     * @var class-string<\Cone\Root\Models\Meta>
      */
     protected $model = Meta::class;
 

database/factories/NotificationFactory.php

@@ -11,7 +11,7 @@ class NotificationFactory extends Factory
     /**
      * The name of the factory's corresponding model.
      *
-     * @var string
+     * @var class-string<\Cone\Root\Models\Notification>
      */
     protected $model = Notification::class;
 

phpstan.neon.dist

@@ -4,11 +4,29 @@ parameters:
     databaseMigrationsPath:
         - database/migrations/
         - vendor/orchestra/testbench-core/laravel/migrations/
+    scanFiles:
+        - tests/phpstan/FieldWithRoute.php
+        - tests/phpstan/MetaDataModel.php
     paths:
         - src/
         - config/
         - database/
         - routes/
     level: 5
+    checkAlwaysTrueCheckTypeFunctionCall: true
+    checkAlwaysTrueInstanceof: true
+    checkAlwaysTrueStrictComparison: true
+    checkAlwaysTrueLooseComparison: true
+    checkClassCaseSensitivity: false
+    checkDynamicProperties: true
+    checkExplicitMixed: false
+    checkImplicitMixed: false
+    checkExplicitMixedMissingReturn: true
+    checkFunctionNameCase: true
+    checkInternalClassCaseSensitivity: true
     ignoreErrors:
         - '#^Unsafe usage of new static#'
+        # Illuminate\View\View vs. Illuminate\Contracts\View\View
+        - '#^Method Cone\\\S+::render\(\) should return Illuminate\\View\\View but returns Illuminate\\Contracts\\View\\View\.$#'
+        # SoftDeletes
+        - '#(\$forceDeleting|::withTrashed|::onlyTrashed|::trashed|::restore)#'

src/Fields/BelongsTo.php

@@ -7,6 +7,11 @@
 use Illuminate\Http\Request;
 use Illuminate\Routing\Router;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\BelongsTo
+ *
+ * @extends \Cone\Root\Fields\Relation<TRelation>
+ */
 class BelongsTo extends Relation
 {
     /**

src/Fields/BelongsToMany.php

@@ -13,6 +13,11 @@
 use Illuminate\Routing\Router;
 use Illuminate\Support\Arr;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\BelongsToMany
+ *
+ * @extends \Cone\Root\Fields\Relation<TRelation>
+ */
 class BelongsToMany extends Relation
 {
     /**

src/Fields/Fields.php

@@ -123,6 +123,7 @@ public function registerRoutes(Request $request, Router $router): void
         $router->prefix('fields')->group(function (Router $router) use ($request): void {
             $this->each(static function (Field $field) use ($request, $router): void {
                 if (in_array(RegistersRoutes::class, class_uses_recursive($field))) {
+                    /** @var \Tests\FieldWithRoute $field */
                     $field->registerRoutes($request, $router);
                 }
             });

src/Fields/File.php

@@ -168,7 +168,9 @@ protected function stored(Request $request, Model $model, string $path): array
             call_user_func_array($this->storageResolver, [$request, $medium, $path]);
         }
 
-        $request->user()->uploads()->save($medium);
+        /** @var \Illuminate\Foundation\Auth\User&\Cone\Root\Interfaces\Models\User $user */
+        $user = $request->user();
+        $user->uploads()->save($medium);
 
         MoveFile::withChain($medium->convertible() ? [new PerformConversions($medium)] : [])
             ->dispatch($medium, $path, false);
@@ -234,6 +236,7 @@ public function prune(Request $request, Model $model, array $keys): int
      */
     public function toOption(Request $request, Model $model, Model $related): array
     {
+        /** @var \Cone\Root\Models\Medium $related */
         $option = parent::toOption($request, $model, $related);
 
         $name = sprintf(
@@ -245,6 +248,8 @@ public function toOption(Request $request, Model $model, Model $related): array
 
         $option['attrs']->merge(['name' => $name]);
 
+        /** @var \Cone\Root\Models\Medium $related */
+
         return array_merge($option, [
             'fileName' => $related->file_name,
             'isImage' => $related->isImage,

src/Fields/HasMany.php

@@ -6,6 +6,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasMany as EloquentRelation;
 
+/**
+ * @extends \Cone\Root\Fields\HasOneOrMany<\Illuminate\Database\Eloquent\Relations\HasMany>
+ */
 class HasMany extends HasOneOrMany
 {
     /**

src/Fields/HasOne.php

@@ -5,6 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\HasOne as EloquentRelation;
 
+/**
+ * @extends \Cone\Root\Fields\HasOneOrMany<\Illuminate\Database\Eloquent\Relations\HasOne>
+ */
 class HasOne extends HasOneOrMany
 {
     /**

src/Fields/HasOneOrMany.php

@@ -8,6 +8,11 @@
 use Illuminate\Http\Request;
 use Illuminate\Support\Arr;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\HasOneOrMany
+ *
+ * @extends \Cone\Root\Fields\Relation<TRelation>
+ */
 abstract class HasOneOrMany extends Relation
 {
     /**

src/Fields/Meta.php

@@ -8,6 +8,9 @@
 use Illuminate\Database\Eloquent\Relations\MorphOne as EloquentRelation;
 use Illuminate\Http\Request;
 
+/**
+ * @extends \Cone\Root\Fields\MorphOne<\Illuminate\Database\Eloquent\Relations\MorphOne>
+ */
 class Meta extends MorphOne
 {
     /**
@@ -21,6 +24,7 @@ class Meta extends MorphOne
     public function __construct(string $label, Closure|string|null $modelAttribute = null, Closure|string|null $relation = null)
     {
         $relation ??= function (Model $model): EloquentRelation {
+            /** @phpstan-var \Tests\MetaDataModel $model */
             $related = $model->metaData()->make();
 
             return $model->metaData()

src/Fields/MorphMany.php

@@ -5,6 +5,9 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphMany as EloquentRelation;
 
+/**
+ * @extends \Cone\Root\Fields\MorphOneOrMany<\Illuminate\Database\Eloquent\Relations\MorphMany>
+ */
 class MorphMany extends MorphOneOrMany
 {
     /**

src/Fields/MorphOne.php

@@ -5,6 +5,11 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphOne as EloquentRelation;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\MorphOne
+ *
+ * @extends \Cone\Root\Fields\MorphOneOrMany<TRelation>
+ */
 class MorphOne extends MorphOneOrMany
 {
     /**

src/Fields/MorphOneOrMany.php

@@ -5,6 +5,11 @@
 use Illuminate\Database\Eloquent\Model;
 use Illuminate\Database\Eloquent\Relations\MorphOneOrMany as EloquentRelation;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\MorphOneOrMany
+ *
+ * @extends \Cone\Root\Fields\HasOneOrMany<TRelation>
+ */
 abstract class MorphOneOrMany extends HasOneOrMany
 {
     /**

src/Fields/MorphTo.php

@@ -10,6 +10,9 @@
 use Illuminate\Routing\Router;
 use Illuminate\Support\Str;
 
+/**
+ * @extends \Cone\Root\Fields\BelongsTo<\Illuminate\Database\Eloquent\Relations\MorphTo>
+ */
 class MorphTo extends BelongsTo
 {
     /**

src/Fields/MorphToMany.php

@@ -9,6 +9,9 @@
 use Illuminate\Database\Eloquent\Relations\MorphToMany as EloquentRelation;
 use Illuminate\Http\Request;
 
+/**
+ * @extends \Cone\Root\Fields\BelongsToMany<\Illuminate\Database\Eloquent\Relations\MorphToMany>
+ */
 class MorphToMany extends BelongsToMany
 {
     /**

src/Fields/Relation.php

@@ -27,6 +27,9 @@
 use Illuminate\Support\MessageBag;
 use Illuminate\Support\Str;
 
+/**
+ * @template TRelation of \Illuminate\Database\Eloquent\Relations\Relation
+ */
 abstract class Relation extends Field implements Form
 {
     use AsForm;
@@ -118,6 +121,8 @@ public static function scopeQuery(Closure $callback): void
 
     /**
      * Get the relation instance.
+     *
+     * @phpstan-return TRelation
      */
     public function getRelation(Model $model): EloquentRelation
     {

src/Http/Controllers/ActionController.php

@@ -13,6 +13,7 @@ class ActionController extends Controller
      */
     public function __invoke(Request $request): Response
     {
+        /** @var \Cone\Root\Actions\Action $action */
         $action = $request->route('action');
 
         Gate::allowIf($action->authorized($request));

src/Http/Controllers/MediaController.php

@@ -13,8 +13,10 @@ class MediaController extends Controller
      */
     public function __invoke(Request $request): JsonResponse
     {
+        /** @var \Cone\Root\Resources\Resource $resource */
         $resource = $request->route('_resource');
 
+        /** @var \Cone\Root\Fields\Media $field */
         $field = $request->route('field');
 
         $model = $request->filled('model')

src/Http/Controllers/RepeaterController.php

@@ -12,8 +12,10 @@ class RepeaterController extends Controller
      */
     public function __invoke(Request $request): JsonResponse
     {
+        /** @var \Cone\Root\Resources\Resource $resource */
         $resource = $request->route('_resource');
 
+        /** @var \Cone\Root\Fields\Repeater $field */
         $field = $request->route('field');
 
         $model = $request->filled('model')

src/Http/Controllers/WidgetController.php

@@ -13,6 +13,7 @@ class WidgetController extends Controller
      */
     public function __invoke(Request $request): Response
     {
+        /** @var \Cone\Root\Widgets\Widget $widget */
         $widget = $request->route('widget');
 
         $data = $widget->data($request);

src/Models/Medium.php

@@ -160,6 +160,8 @@ public function user(): BelongsTo
 
     /**
      * Determine if the file is image.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<bool, never>
      */
     protected function isImage(): Attribute
     {
@@ -172,6 +174,8 @@ protected function isImage(): Attribute
 
     /**
      * Get the conversion URLs.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<array<string, string>, never>
      */
     protected function urls(): Attribute
     {
@@ -190,6 +194,8 @@ function (array $urls, string $conversion): array {
 
     /**
      * Get the formatted size attribute.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<string, never>
      */
     protected function formattedSize(): Attribute
     {
@@ -210,6 +216,8 @@ protected function formattedSize(): Attribute
 
     /**
      * Get the dimensions attribute.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<string|null, never>
      */
     protected function dimensions(): Attribute
     {

src/Models/Notification.php

@@ -62,6 +62,8 @@ public function getMorphClass(): string
 
     /**
      * Get the subject attribute.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<string|null, never>
      */
     protected function subject(): Attribute
     {
@@ -72,6 +74,8 @@ protected function subject(): Attribute
 
     /**
      * Get the formatted created at attribute.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<string|null, never>
      */
     protected function formattedCreatedAt(): Attribute
     {
@@ -82,6 +86,8 @@ protected function formattedCreatedAt(): Attribute
 
     /**
      * Get the formatted created at attribute.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<bool, never>
      */
     protected function isRead(): Attribute
     {
@@ -92,6 +98,8 @@ protected function isRead(): Attribute
 
     /**
      * Get the URL attribute.
+     *
+     * @return \Illuminate\Database\Eloquent\Casts\Attribute<string|null, never>
      */
     protected function url(): Attribute
     {

src/Navigation/Item.php

@@ -6,6 +6,12 @@
 use Cone\Root\Traits\Makeable;
 use Illuminate\Support\Facades\URL;
 
+/**
+ * @property string $url
+ * @property string $label
+ * @property string $icon
+ * @property string $group
+ */
 class Item
 {
     use HasAttributes;