ISSUE-337: fix phpstan

phpList · Dec 9, 2024 · 9658c6c · 9658c6c
1 parent 707b0a1
commit 9658c6c
Show file tree

Hide file tree

Showing 12 changed files with 99 additions and 101 deletions.
diff --git a/composer.json b/composer.json
@@ -55,7 +55,7 @@
         "phpunit/phpunit": "^9.5",
         "guzzlehttp/guzzle": "^6.3.0",
         "squizlabs/php_codesniffer": "^3.2.0",
-        "phpstan/phpstan": "^0.12.57",
+        "phpstan/phpstan": "^1.10",
         "nette/caching": "^3.0.0",
         "nikic/php-parser": "^4.19.1",
         "phpmd/phpmd": "^2.6.0",

diff --git a/phpstan.neon b/phpstan.neon
@@ -5,6 +5,3 @@ parameters:
         - src
         - tests
         - public
-    ignoreErrors:
-        - '#Cannot call method (?:willReturn|shouldBeCalledOnce|shouldNotBeCalled|shouldBeCalled|shouldNotHaveBeenCalled)\(\) on .*\.#'
-        - '#Call to an undefined method [a-zA-Z0-9\\_]+::willReturn\(\)#'
diff --git a/src/Composer/ScriptHandler.php b/src/Composer/ScriptHandler.php
@@ -1,11 +1,14 @@
 <?php
+
 declare(strict_types=1);
 
 namespace PhpList\Core\Composer;
 
 use Composer\Package\PackageInterface;
 use Composer\Script\Event;
+use DomainException;
 use PhpList\Core\Core\ApplicationStructure;
+use RuntimeException;
 use Symfony\Component\Filesystem\Filesystem;
 
 /**
@@ -48,7 +51,7 @@ class ScriptHandler
     /**
      * @return string absolute application root directory without the trailing slash
      *
-     * @throws \RuntimeException if there is no composer.json in the application root
+     * @throws RuntimeException if there is no composer.json in the application root
      */
     private static function getApplicationRoot(): string
     {
@@ -61,7 +64,7 @@ private static function getApplicationRoot(): string
      */
     private static function getCoreDirectory(): string
     {
-        return static::getApplicationRoot() . '/vendor/' . static::CORE_PACKAGE_NAME;
+        return self::getApplicationRoot() . '/vendor/' . static::CORE_PACKAGE_NAME;
     }
 
     /**
@@ -73,12 +76,12 @@ private static function getCoreDirectory(): string
      *
      * @return void
      *
-     * @throws \DomainException if this method is called for the core package
+     * @throws DomainException if this method is called for the core package
      */
-    public static function createBinaries(Event $event)
+    public static function createBinaries(Event $event): void
     {
-        static::preventScriptFromCorePackage($event);
-        static::mirrorDirectoryFromCore('bin');
+        self::preventScriptFromCorePackage($event);
+        self::mirrorDirectoryFromCore('bin');
     }
 
     /**
@@ -90,27 +93,27 @@ public static function createBinaries(Event $event)
      *
      * @return void
      *
-     * @throws \DomainException if this method is called for the core package
+     * @throws DomainException if this method is called for the core package
      */
-    public static function createPublicWebDirectory(Event $event)
+    public static function createPublicWebDirectory(Event $event): void
     {
-        static::preventScriptFromCorePackage($event);
-        static::mirrorDirectoryFromCore('public');
+        self::preventScriptFromCorePackage($event);
+        self::mirrorDirectoryFromCore('public');
     }
 
     /**
      * @param Event $event
      *
      * @return void
      *
-     * @throws \DomainException if this method is called for the core package
+     * @throws DomainException if this method is called for the core package
      */
-    private static function preventScriptFromCorePackage(Event $event)
+    private static function preventScriptFromCorePackage(Event $event): void
     {
         $composer = $event->getComposer();
         $packageName = $composer->getPackage()->getName();
-        if ($packageName === static::CORE_PACKAGE_NAME) {
-            throw new \DomainException(
+        if ($packageName === self::CORE_PACKAGE_NAME) {
+            throw new DomainException(
                 'This Composer script must not be called for the core package itself.',
                 1501240572
             );
@@ -128,14 +131,14 @@ private static function preventScriptFromCorePackage(Event $event)
      *
      * @return void
      */
-    private static function mirrorDirectoryFromCore(string $directoryWithoutSlashes)
+    private static function mirrorDirectoryFromCore(string $directoryWithoutSlashes): void
     {
         $directoryWithSlashes = '/' . $directoryWithoutSlashes . '/';
 
         $fileSystem = new Filesystem();
         $fileSystem->mirror(
-            static::getCoreDirectory() . $directoryWithSlashes,
-            static::getApplicationRoot() . $directoryWithSlashes,
+            self::getCoreDirectory() . $directoryWithSlashes,
+            self::getApplicationRoot() . $directoryWithSlashes,
             null,
             ['override' => true, 'delete' => false]
         );
@@ -148,13 +151,13 @@ private static function mirrorDirectoryFromCore(string $directoryWithoutSlashes)
      *
      * @return void
      */
-    public static function listModules(Event $event)
+    public static function listModules(Event $event): void
     {
         $packageRepository = new PackageRepository();
         $packageRepository->injectComposer($event->getComposer());
 
         $modules = $packageRepository->findModules();
-        $maximumPackageNameLength = static::calculateMaximumPackageNameLength($modules);
+        $maximumPackageNameLength = self::calculateMaximumPackageNameLength($modules);
 
         foreach ($modules as $module) {
             $paddedName = str_pad($module->getName(), $maximumPackageNameLength + 1);
@@ -185,11 +188,11 @@ private static function calculateMaximumPackageNameLength(array $modules): int
      *
      * @return void
      */
-    public static function createBundleConfiguration(Event $event)
+    public static function createBundleConfiguration(Event $event): void
     {
-        static::createAndWriteFile(
-            static::getApplicationRoot() . static::BUNDLE_CONFIGURATION_FILE,
-            static::createAndInitializeModuleFinder($event)->createBundleConfigurationYaml()
+        self::createAndWriteFile(
+            self::getApplicationRoot() . self::BUNDLE_CONFIGURATION_FILE,
+            self::createAndInitializeModuleFinder($event)->createBundleConfigurationYaml()
         );
     }
 
@@ -205,13 +208,13 @@ public static function createBundleConfiguration(Event $event)
      *
      * @return void
      *
-     * @throws \RuntimeException
+     * @throws RuntimeException
      */
-    private static function createAndWriteFile(string $path, string $contents)
+    private static function createAndWriteFile(string $path, string $contents): void
     {
         $fileHandle = fopen($path, 'wb');
         if ($fileHandle === false) {
-            throw new \RuntimeException('The file "' . $path . '" could not be opened for writing.', 1519851153);
+            throw new RuntimeException('The file "' . $path . '" could not be opened for writing.', 1519851153);
         }
 
         fwrite($fileHandle, $contents);
@@ -226,11 +229,11 @@ private static function createAndWriteFile(string $path, string $contents)
      *
      * @return void
      */
-    public static function createRoutesConfiguration(Event $event)
+    public static function createRoutesConfiguration(Event $event): void
     {
-        static::createAndWriteFile(
-            static::getApplicationRoot() . static::ROUTES_CONFIGURATION_FILE,
-            static::createAndInitializeModuleFinder($event)->createRouteConfigurationYaml()
+        self::createAndWriteFile(
+            self::getApplicationRoot() . self::ROUTES_CONFIGURATION_FILE,
+            self::createAndInitializeModuleFinder($event)->createRouteConfigurationYaml()
         );
     }
 
@@ -255,20 +258,20 @@ private static function createAndInitializeModuleFinder(Event $event): ModuleFin
      *
      * @return void
      */
-    public static function clearAllCaches()
+    public static function clearAllCaches():void
     {
         $fileSystem = new Filesystem();
-        $fileSystem->remove(static::getApplicationRoot() . '/var/cache');
+        $fileSystem->remove(self::getApplicationRoot() . '/var/cache');
     }
 
     /**
      * Creates config/parameters.yml (the parameters configuration file).
      *
      * @return void
      */
-    public static function createParametersConfiguration()
+    public static function createParametersConfiguration(): void
     {
-        $configurationFilePath = static::getApplicationRoot() . static::PARAMETERS_CONFIGURATION_FILE;
+        $configurationFilePath = self::getApplicationRoot() . self::PARAMETERS_CONFIGURATION_FILE;
         if (file_exists($configurationFilePath)) {
             return;
         }
@@ -279,7 +282,7 @@ public static function createParametersConfiguration()
         $secret = bin2hex(random_bytes(20));
         $configuration = sprintf($template, $secret);
 
-        static::createAndWriteFile($configurationFilePath, $configuration);
+        self::createAndWriteFile($configurationFilePath, $configuration);
     }
 
     /**
@@ -289,11 +292,11 @@ public static function createParametersConfiguration()
      *
      * @return void
      */
-    public static function createGeneralConfiguration(Event $event)
+    public static function createGeneralConfiguration(Event $event): void
     {
-        static::createAndWriteFile(
-            static::getApplicationRoot() . static::GENERAL_CONFIGURATION_FILE,
-            static::createAndInitializeModuleFinder($event)->createGeneralConfigurationYaml()
+        self::createAndWriteFile(
+            self::getApplicationRoot() . self::GENERAL_CONFIGURATION_FILE,
+            self::createAndInitializeModuleFinder($event)->createGeneralConfigurationYaml()
         );
     }
 }
diff --git a/src/Core/ApplicationKernel.php b/src/Core/ApplicationKernel.php
@@ -123,14 +123,6 @@ public function registerContainerConfiguration(LoaderInterface $loader): void
         $loader->load($this->getApplicationDir() . '/config/config_modules.yml');
     }
 
-    /**
-     * @return bool
-     */
-    private function shouldHaveDevelopmentBundles(): bool
-    {
-        return $this->environment !== Environment::PRODUCTION;
-    }
-
     /**
      * Reads the bundles from the bundle configuration file and instantiates them.
      *

diff --git a/src/Core/Bootstrap.php b/src/Core/Bootstrap.php
@@ -146,7 +146,7 @@ private function isDebugEnabled(): bool
      *
      * @return Bootstrap fluent interface
      */
-    public function ensureDevelopmentOrTestingEnvironment(): static
+    public function ensureDevelopmentOrTestingEnvironment(): self
     {
         if (isset($_ENV['APP_ENV']) && $_ENV['APP_ENV'] === Environment::TESTING) {
             return $this;

diff --git a/src/Domain/Model/Identity/Administrator.php b/src/Domain/Model/Identity/Administrator.php
@@ -127,12 +127,4 @@ public function setSuperUser(bool $superUser): void
     {
         $this->superUser = $superUser;
     }
-
-    #[ORM\PrePersist]
-    public function setCreationDate(): void
-    {
-        if ($this->creationDate === null) {
-            $this->creationDate = new DateTime();
-        }
-    }
 }
diff --git a/src/TestingSupport/Traits/SymfonyServerTrait.php b/src/TestingSupport/Traits/SymfonyServerTrait.php
@@ -73,7 +73,7 @@ protected function getBaseUrl(): string
     private function waitForServerLockFileToAppear(): void
     {
         $currentWaitTime = 0;
-        while (!$this->lockFileExists() && $currentWaitTime < static::$maximumWaitTimeForServerLockFile) {
+        while (!$this->lockFileExists() && $currentWaitTime < self::$maximumWaitTimeForServerLockFile) {
             $process = new Process(['symfony', 'server:status', '--no-ansi']);
             $process->run();
 
@@ -84,13 +84,13 @@ private function waitForServerLockFileToAppear(): void
                     file_put_contents(self::$lockFileName, trim($port));
                 }
             }
-            usleep(static::$waitTimeBetweenServerCommands);
-            $currentWaitTime += static::$waitTimeBetweenServerCommands;
+            usleep(self::$waitTimeBetweenServerCommands);
+            $currentWaitTime += self::$waitTimeBetweenServerCommands;
         }
 
         if (!$this->lockFileExists()) {
             throw new RuntimeException(
-                'There is no symfony server lock file "' . static::$lockFileName . '".',
+                'There is no symfony server lock file "' . self::$lockFileName . '".',
                 1516625236
             );
         }

diff --git a/tests/Integration/Domain/Repository/Fixtures/AdministratorFixture.php b/tests/Integration/Domain/Repository/Fixtures/AdministratorFixture.php
@@ -36,13 +36,13 @@ public function load(ObjectManager $manager): void
             $this->setSubjectId($admin, (int)$row['id']);
             $admin->setLoginName($row['loginname']);
             $admin->setEmailAddress($row['email']);
-            $this->setSubjectProperty($admin,'creationDate', new DateTime($row['created']));
             $admin->setPasswordHash($row['password']);
-            $this->setSubjectProperty($admin,'passwordChangeDate', new DateTime($row['passwordchanged']));
             $admin->setDisabled((bool) $row['disabled']);
             $admin->setSuperUser((bool) $row['superuser']);
 
             $manager->persist($admin);
+            $this->setSubjectProperty($admin,'creationDate', new DateTime($row['created']));
+            $this->setSubjectProperty($admin,'passwordChangeDate', new DateTime($row['passwordchanged']));
         }
 
         fclose($handle);

diff --git a/tests/Integration/Domain/Repository/Identity/AdministratorRepositoryTest.php b/tests/Integration/Domain/Repository/Identity/AdministratorRepositoryTest.php
@@ -42,7 +42,7 @@ protected function tearDown(): void
 
     public function testFindReadsModelFromDatabase(): void
     {
-        /** @var $actual Administrator */
+        /** @var Administrator $actual */
         $actual = $this->repository->find(1);
 
         $this->assertNotNull($actual);

diff --git a/tests/Integration/Domain/Repository/Messaging/SubscriberListRepositoryTest.php b/tests/Integration/Domain/Repository/Messaging/SubscriberListRepositoryTest.php
@@ -166,11 +166,11 @@ public function testFindsAssociatedSubscriptions()
         $this->loadFixtures([SubscriberListFixture::class, SubscriberFixture::class, SubscriptionFixture::class]);
 
         $id = 2;
-        /** @var Subscription[] $model */
-        $subscriptions = $this->subscriptionRepository->findBySubscriberList($id);
+        $subscriber = $this->subscriberRepository->find($id);
+        /** @var Subscription[] $subscriptions */
+        $subscriptions = $this->subscriptionRepository->findBySubscriberList($subscriber);
 
         self::assertNotEmpty($subscriptions);
-        /** @var Subscription $firstSubscription */
         $firstSubscription = $subscriptions[0];
         self::assertInstanceOf(Subscription::class, $firstSubscription);
         $expectedSubscriberId = 1;
@@ -182,7 +182,7 @@ public function testFindsAssociatedSubscribers()
         $this->loadFixtures([SubscriberListFixture::class, SubscriberFixture::class, SubscriptionFixture::class]);
 
         $id = 2;
-        /** @var Subscriber[] $model */
+        /** @var Subscriber[] $subscribers */
         $subscribers = $this->subscriberRepository->getSubscribersBySubscribedListId($id);
 
         $expectedSubscriber = $this->subscriberRepository->find(1);
@@ -198,7 +198,7 @@ public function testRemoveAlsoRemovesAssociatedSubscriptions()
         $initialNumberOfSubscriptions = count($this->subscriptionRepository->findAll());
 
         $id = 2;
-        /** @var SubscriberList $model */
+        /** @var SubscriberList $subscriberList */
         $subscriberList = $this->subscriberListRepository->findWithSubscription($id);
 
         $numberOfAssociatedSubscriptions = count($subscriberList->getSubscriptions());