chore: enable phpstan (#81)

* chore: enable phpstan

* fix: phpstan error

* chore: bump js deps

.github/workflows/backend.yml

@@ -0,0 +1,12 @@
+name: FoF Masquerade PHP
+
+on: [workflow_dispatch, push, pull_request]
+
+jobs:
+  run:
+    uses: flarum/framework/.github/workflows/REUSABLE_backend.yml@main
+    with:
+      enable_backend_testing: false
+      enable_phpstan: true
+
+      backend_directory: .

.github/workflows/build.yml → .github/workflows/frontend.yml

@@ -1,4 +1,4 @@
-name: Javascript
+name: FoF Masquerade JS
 
 on: [workflow_dispatch, push, pull_request]
 
@@ -8,11 +8,12 @@ jobs:
     with:
       enable_bundlewatch: false
       enable_prettier: true
-      enable_typescript: false
+      enable_typescript: true
 
       frontend_directory: ./js
       backend_directory: .
       js_package_manager: npm
       main_git_branch: master
+
     secrets:
       bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

composer.json

@@ -47,11 +47,26 @@
         },
         "flagrow": {
             "discuss": "https://discuss.flarum.org/d/5791"
+        },
+        "flarum-cli": {
+            "modules": {
+                "githubActions": true
+            }
         }
     },
     "autoload": {
         "psr-4": {
             "FoF\\Masquerade\\": "src/"
         }
+    },
+    "require-dev": {
+        "flarum/phpstan": "*"
+    },
+    "scripts": {
+        "analyse:phpstan": "phpstan analyse",
+        "clear-cache:phpstan": "phpstan clear-result-cache"
+    },
+    "scripts-descriptions": {
+        "analyse:phpstan": "Run static analysis"
     }
 }

js/package.json

@@ -5,8 +5,8 @@
     "dependencies": {
         "flarum-webpack-config": "^2.0.0",
         "html5sortable": "^0.9.18",
-        "webpack": "^5.76.0",
-        "webpack-cli": "^4.10.0"
+        "webpack": "^5.89.0",
+        "webpack-cli": "^5.1.4"
     },
     "scripts": {
         "dev": "webpack --mode development --watch",
@@ -16,6 +16,6 @@
     "devDependencies": {
         "@flarum/prettier-config": "^1.0.0",
         "flarum-tsconfig": "^1.0.2",
-        "prettier": "^2.6.2"
+        "prettier": "^3.0.3"
     }
 }

phpstan.neon

@@ -0,0 +1,14 @@
+includes:
+  - vendor/flarum/phpstan/extension.neon
+
+parameters:
+  # The level will be increased in Flarum 2.0
+  level: 5
+  paths:
+    - extend.php
+    - src
+  excludePaths:
+    - *.blade.php
+  checkMissingIterableValueType: false
+  databaseMigrationsPath: ['migrations']
+

src/Api/Serializers/FieldSerializer.php

@@ -3,11 +3,16 @@
 namespace FoF\Masquerade\Api\Serializers;
 
 use Flarum\Api\Serializer\AbstractSerializer;
+use FoF\Masquerade\Field;
 use Tobscure\JsonApi\Relationship;
 use Tobscure\JsonApi\Resource;
 
 class FieldSerializer extends AbstractSerializer
 {
+    /**
+     * @param Field $model
+     * @return array
+     */
     protected function getDefaultAttributes($model): array
     {
         return $model->toArray();
@@ -20,7 +25,7 @@ public function getType($model): string
 
     public function answer($model): ?Relationship
     {
-        if (!$this->getActor()) {
+        if ($this->getActor()->isGuest()) {
             return null;
         }
 

src/Repositories/FieldRepository.php

@@ -100,15 +100,11 @@ public function delete($id)
     {
         $field = $this->field->findOrFail($id);
 
-        if ($field) {
-            $field->delete();
+        $field->delete();
 
-            $this->cache->forget(static::CACHE_KEY_ALL_FIELDS);
-
-            return $field;
-        }
+        $this->cache->forget(static::CACHE_KEY_ALL_FIELDS);
 
-        return false;
+        return $field;
     }
 
     /**
@@ -120,18 +116,18 @@ public function delete($id)
      */
     public function completed($userId)
     {
-//      return $this->cache->rememberForever(sprintf(
-//          static::CACHE_KEY_UNCOMPLETED,
-//          $userId
-//      ), function () use ($userId) {
+        //      return $this->cache->rememberForever(sprintf(
+        //          static::CACHE_KEY_UNCOMPLETED,
+        //          $userId
+        //      ), function () use ($userId) {
         return $this->field
-                ->where('required', true)
-                ->whereDoesntHave('answers', function ($q) use ($userId) {
-                    $q->where('user_id', $userId);
-                })
-                ->count() == 0;
+            ->where('required', true)
+            ->whereDoesntHave('answers', function ($q) use ($userId) {
+                $q->where('user_id', $userId);
+            })
+            ->count() == 0;
 
-//      });
+        //      });
     }
 
     /**
@@ -167,9 +163,10 @@ protected function query()
 
     protected function highestSort(): int
     {
-        /** @var $max Field */
-        $max = Field::orderBy('sort', 'desc')->first();
+        /** @var Field $max */
+        $max = Field::query()->orderBy('sort', 'desc')->first();
 
+        /** @phpstan-ignore-next-line */
         return $max ? $max->sort + 1 : 0;
     }
 }