chore: fix code to comply with latest PHPStan, Rector and CS (#1268)

* fix cs

* phpstan - ignore all errors related to internal symbols

* phpstan - apply suggestions

* phpstan - update baseline

* rector - update config

* rector - apply suggestions

* cs - fix style by replacing FQCN with import

Author: michalsn

phpstan-baseline.php

@@ -166,15 +166,15 @@
 	'path' => __DIR__ . '/src/Collectors/Auth.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Cannot access property \\$id on array\\<string, string\\>\\|object\\.$#',
+	'message' => '#^Cannot access property \\$expires on array\\<string, string\\>\\|object\\.$#',
 	'identifier' => 'property.nonObject',
-	'count' => 9,
+	'count' => 3,
 	'path' => __DIR__ . '/src/Commands/Hmac.php',
 ];
 $ignoreErrors[] = [
-	'message' => '#^Cannot access property \\$expires on array\\<string, string\\>\\|object\\.$#',
+	'message' => '#^Cannot access property \\$id on array\\<string, string\\>\\|object\\.$#',
 	'identifier' => 'property.nonObject',
-	'count' => 3,
+	'count' => 9,
 	'path' => __DIR__ . '/src/Commands/Hmac.php',
 ];
 $ignoreErrors[] = [
@@ -492,6 +492,13 @@
 	'count' => 6,
 	'path' => __DIR__ . '/tests/Unit/Authentication/JWT/JWTManagerTest.php',
 ];
+$ignoreErrors[] = [
+	'message' => '#^Call to deprecated method __construct\\(\\) of class CodeIgniter\\\\HTTP\\\\Response\\:
+4\\.5\\.0 The param \\$config is no longer used\\.$#',
+	'identifier' => 'method.deprecated',
+	'count' => 3,
+	'path' => __DIR__ . '/tests/Unit/PwnedValidatorTest.php',
+];
 $ignoreErrors[] = [
 	'message' => '#^Call to an undefined method CodeIgniter\\\\Shield\\\\Models\\\\UserModel\\:\\:getLastQuery\\(\\)\\.$#',
 	'identifier' => 'method.notFound',

phpstan.neon.dist

@@ -34,3 +34,7 @@ parameters:
 		disallowedImplicitArrayCreation: true
 		disallowedShortTernary: true
 		matchingInheritedMethodNames: true
+	ignoreErrors:
+		- identifier: function.internal
+		- identifier: return.internalClass
+		- identifier: staticMethod.internal

rector.php

@@ -44,10 +44,8 @@
 use Rector\EarlyReturn\Rector\Return_\PreparedValueToEarlyReturnRector;
 use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
 use Rector\Php73\Rector\FuncCall\StringifyStrNeedlesRector;
-use Rector\Php81\Rector\ClassMethod\NewInInitializerRector;
 use Rector\PHPUnit\AnnotationsToAttributes\Rector\Class_\AnnotationWithValueToAttributeRector;
 use Rector\PHPUnit\CodeQuality\Rector\Class_\YieldDataProviderRector;
-use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertCountWithZeroToAssertEmptyRector;
 use Rector\PHPUnit\CodeQuality\Rector\MethodCall\AssertEmptyNullableObjectToAssertInstanceofRector;
 use Rector\PHPUnit\Set\PHPUnitSetList;
 use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
@@ -135,15 +133,7 @@
             __DIR__ . '/src/Commands/Setup.php',
         ],
 
-        // Ignore for some existing classes to prevent BC break
-        NewInInitializerRector::class => [
-            __DIR__ . '/src/Authentication/JWT/JWSEncoder.php',
-            __DIR__ . '/src/Authentication/JWT/JWSDecoder.php',
-            __DIR__ . '/src/Authentication/JWTManager.php',
-        ],
-
         // Ignore some PHPUnit rules
-        AssertCountWithZeroToAssertEmptyRector::class,
         AssertEmptyNullableObjectToAssertInstanceofRector::class,
     ]);
 

src/Authentication/Authenticators/Session.php

@@ -824,10 +824,9 @@ public function logout(): void
         /** @var \CodeIgniter\Session\Session $session */
         $session     = session();
         $sessionData = $session->get();
-        if (isset($sessionData)) {
-            foreach (array_keys($sessionData) as $key) {
-                $session->remove($key);
-            }
+
+        foreach (array_keys($sessionData) as $key) {
+            $session->remove($key);
         }
 
         // Regenerate the session ID for a touch of added safety.

src/Views/email_2fa_show.php

@@ -1,3 +1,9 @@
+<?php
+
+use CodeIgniter\Shield\Entities\User;
+
+?>
+
 <?= $this->extend(config('Auth')->views['layout']) ?>
 
 <?= $this->section('title') ?><?= lang('Auth.email2FATitle') ?> <?= $this->endSection() ?>
@@ -22,7 +28,7 @@
                 <div class="mb-2">
                     <input type="email" class="form-control" name="email"
                         inputmode="email" autocomplete="email" placeholder="<?= lang('Auth.email') ?>"
-                        <?php /** @var CodeIgniter\Shield\Entities\User $user */ ?>
+                        <?php /** @var User $user */ ?>
                         value="<?= old('email', $user->email) ?>" required>
                 </div>
 

tests/Commands/UserTest.php

@@ -592,6 +592,7 @@ public function testAddgroup(): void
 
         $users = model(UserModel::class);
         $user  = $users->findByCredentials(['email' => 'user10@example.com']);
+        $this->assertInstanceOf(UserEntity::class, $user);
         $this->assertTrue($user->inGroup('admin'));
     }
 
@@ -632,6 +633,7 @@ public function testAddgroupCancel(): void
 
         $users = model(UserModel::class);
         $user  = $users->findByCredentials(['email' => 'user10@example.com']);
+        $this->assertInstanceOf(UserEntity::class, $user);
         $this->assertFalse($user->inGroup('admin'));
     }
 
@@ -644,6 +646,7 @@ public function testRemovegroup(): void
         ]);
         $users = model(UserModel::class);
         $user  = $users->findByCredentials(['email' => 'user11@example.com']);
+        $this->assertInstanceOf(UserEntity::class, $user);
         $user->addGroup('admin');
         $this->assertTrue($user->inGroup('admin'));
 
@@ -658,6 +661,7 @@ public function testRemovegroup(): void
 
         $users = model(UserModel::class);
         $user  = $users->findByCredentials(['email' => 'user11@example.com']);
+        $this->assertInstanceOf(UserEntity::class, $user);
         $this->assertFalse($user->inGroup('admin'));
     }
 
@@ -670,6 +674,7 @@ public function testRemovegroupWithInvalidGroup(): void
         ]);
         $users = model(UserModel::class);
         $user  = $users->findByCredentials(['email' => 'user11@example.com']);
+        $this->assertInstanceOf(UserEntity::class, $user);
         $user->addGroup('admin');
         $this->assertTrue($user->inGroup('admin'));
 
@@ -684,6 +689,7 @@ public function testRemovegroupWithInvalidGroup(): void
 
         $users = model(UserModel::class);
         $user  = $users->findByCredentials(['email' => 'user11@example.com']);
+        $this->assertInstanceOf(UserEntity::class, $user);
         $this->assertTrue($user->inGroup('admin'));
     }
 
@@ -696,6 +702,7 @@ public function testRemovegroupCancel(): void
         ]);
         $users = model(UserModel::class);
         $user  = $users->findByCredentials(['email' => 'user11@example.com']);
+        $this->assertInstanceOf(UserEntity::class, $user);
         $user->addGroup('admin');
         $this->assertTrue($user->inGroup('admin'));
 
@@ -710,6 +717,7 @@ public function testRemovegroupCancel(): void
 
         $users = model(UserModel::class);
         $user  = $users->findByCredentials(['email' => 'user11@example.com']);
+        $this->assertInstanceOf(UserEntity::class, $user);
         $this->assertTrue($user->inGroup('admin'));
     }
 }

tests/Unit/UserModelTest.php

@@ -207,6 +207,8 @@ public function testUpdateUserArrayWithUserDataToUpdate(): void
 
         $user = $users->findByCredentials(['email' => 'foo@bar.com']);
 
+        $this->assertInstanceOf(User::class, $user);
+
         $user->username = 'bar';
         $user->email    = 'bar@bar.com';
         $user->active   = true;