add PHPStan

Author: LordSimal

.github/workflows/ci.yml

@@ -82,3 +82,6 @@ jobs:
 
     - name: Run PHP CodeSniffer
       run: vendor/bin/phpcs --report=checkstyle | cs2pr
+
+    - name: Run PHPStan
+      run: vendor/bin/phpstan analyse -c phpstan.neon --error-format=checkstyle | cs2pr

composer.json

@@ -17,6 +17,7 @@
         "mobiledetect/mobiledetectlib": "^4.8.03"
     },
     "require-dev": {
+        "cakedc/cakephp-phpstan": "^4.0",
         "cakephp/bake": "^3.0.0",
         "cakephp/cakephp-codesniffer": "^5.0",
         "cakephp/debug_kit": "^5.0.0",
@@ -61,6 +62,8 @@
         "cs-fix": "phpcbf --colors -p",
         "test": "phpunit --colors=always",
         "annotate": "bin/cake annotate all",
-        "illuminate": "bin/cake illuminate code"
+        "illuminate": "bin/cake illuminate code",
+        "phpstan": "phpstan analyse",
+        "phpstan-baseline": "phpstan --generate-baseline"
     }
 }

composer.lock

@@ -36,5 +36,5 @@ export DATABASE_URL="mysql://db:db@db:3306/db"
 # Uncomment these to define logging configuration via environment variables.
 #export LOG_DEBUG_URL="file:///path/to/logs/?levels[]=notice&levels[]=info&levels[]=debug&file=debug"
 #export LOG_ERROR_URL="file:///path/to/logs/?levels[]=warning&levels[]=error&levels[]=critical&levels[]=alert&levels[]=emergency&file=error"
-export DEBUG_KIT_SAFE_TLD="site"
 export APP_FULL_BASE_URL="https://plugins.cakephp.org.ddev.site"
+export DEBUG_KIT_SAFE_TLD="site"

config/.env.ddev

@@ -1,7 +1,9 @@
+includes:
+    - vendor/cakedc/cakephp-phpstan/extension.neon
+
 parameters:
-    level: 8
+    level: 5
     treatPhpDocTypesAsCertain: false
-    checkGenericClassInNonGenericObjectType: false
     bootstrapFiles:
         - config/bootstrap.php
     paths:

phpstan.neon

@@ -127,6 +127,7 @@ public function execute(Arguments $args, ConsoleIo $io)
         }
 
         // Remove packages that were not touched
+        /** @var \Cake\ORM\ResultSet<array-key, \App\Model\Entity\Package> $toDeletePackages */
         $toDeletePackages = $packagesTable->find()->where(['id NOT IN' => $touchedIds])->all();
         foreach ($toDeletePackages as $package) {
             if (!$packagesTable->delete($package)) {
@@ -241,7 +242,7 @@ private function hasExplicitCakePhpDependency(array $tags): bool
      * @param array $meta The meta array to adjust
      * @param string $packageConstraint The meta array which contains the current version strings
      * @param string $tagPrefix The prefix which should be used for the tag
-     * @param array<string, array<int>> $versions The versions to check
+     * @param array<array-key, array<int>> $versions The versions to check
      * @return array
      */
     private function appendVersionTags(

src/Command/SyncPackagesCommand.php

@@ -113,6 +113,7 @@ public function autocomplete(): Response
                 ->withStringBody(json_encode([], JSON_THROW_ON_ERROR));
         }
 
+        /** @var \Cake\ORM\ResultSet<array-key, \App\Model\Entity\Package> $packages */
         $packages = $this->Packages
             ->find('autocomplete', search: $q)
             ->all();
@@ -174,8 +175,9 @@ protected function hasActiveFilterValue(mixed $value): bool
     }
 
     /**
-     * @param array<string, string> $tags
-     * @return array<string, string>
+     * @param array $tags
+     * @param string $prefix
+     * @return array
      */
     protected function sortVersionTags(array $tags, string $prefix): array
     {

src/Controller/PackagesController.php

@@ -36,7 +36,7 @@ public function implementedEvents(): array
      */
     public function afterIdentify(EventInterface $event, User $user): void
     {
-        $token = $user->social_profile->access_token?->getToken();
+        $token = $user->social_profile->access_token->getToken();
         if (!$token) {
             return;
         }

src/Event/AfterGithubIdentify.php

@@ -103,12 +103,12 @@ protected function groupVersionTags(array $tags, string $prefix): array
                 continue;
             }
 
-            $majorVersion = $matches[1];
+            $majorVersion = intval($matches[1]);
             $groups[$majorVersion][] = $tag;
         }
 
-        uksort($groups, static function (string $left, string $right): int {
-            return version_compare($right, $left);
+        uksort($groups, static function (int $left, int $right): int {
+            return version_compare((string)$right, (string)$left);
         });
 
         foreach ($groups as &$groupedTags) {

src/Model/Entity/Package.php

@@ -3,6 +3,7 @@
 
 namespace App\Model\Table;
 
+use ADmad\SocialAuth\Model\Entity\SocialProfile;
 use Cake\Datasource\EntityInterface;
 use Cake\Http\Session;
 use Cake\ORM\RulesChecker;
@@ -102,6 +103,7 @@ public function buildRules(RulesChecker $rules): RulesChecker
      */
     public function getUser(EntityInterface $profile, Session $session): mixed
     {
+        assert($profile instanceof SocialProfile);
         // Make sure here that all the required fields are actually present
         if (!$profile->email) {
             throw new RuntimeException('Could not find email in social profile.');