Update PHPstan and fix new issues

.phpmd.dist.xml

@@ -11,12 +11,18 @@
     </description>
 
     <rule ref="rulesets/cleancode.xml">
+        <!--
+            We want boolean flags for optional features of some methods.
+        -->
+        <exclude name="BooleanArgumentFlag" />
         <!--
             We sometimes want to use else expressions for better readability.
         -->
         <exclude name="ElseExpression" />
+        <!--
+            We need to statically access third-party helpers from Symfony.
+        -->
         <exclude name="StaticAccess" />
-        <exclude name="BooleanArgumentFlag" />
     </rule>
     <rule ref="rulesets/codesize.xml" />
     <rule ref="rulesets/controversial.xml" />

composer.json

@@ -50,13 +50,15 @@
     "require-dev": {
         "phpdocumentor/shim": "^3.7",
         "phpmd/phpmd": "^2.15",
-        "phpstan/phpstan": "^1.12",
+        "phpstan/phpstan": "^2.1",
-        "phpstan/phpstan-doctrine": "^1.5",
+        "phpstan/phpstan-doctrine": "^2.0",
-        "phpstan/phpstan-strict-rules": "^1.6",
+        "phpstan/phpstan-strict-rules": "^2.0",
-        "phpstan/phpstan-symfony": "^1.4",
+        "phpstan/phpstan-symfony": "^2.0",
-        "friendsofphp/php-cs-fixer": "^3.71",
+        "friendsofphp/php-cs-fixer": "^3.73",
-        "squizlabs/php_codesniffer": "^3.11",
+        "squizlabs/php_codesniffer": "^3.12",
-        "vimeo/psalm": "^5.26"
+        "vimeo/psalm": "^6.9",
+        "psalm/plugin-symfony": "^5.2",
+        "weirdan/doctrine-psalm-plugin": "^2.10"
     },
     "autoload": {
         "psr-4": {

psalm.xml.dist

@@ -8,6 +8,7 @@
     findUnusedBaselineEntry="true"
     findUnusedCode="true"
     findUnusedVariablesAndParams="true"
+    memoizeMethodCallResults="true"
     reportMixedIssues="false"
 >
     <issueHandlers>
@@ -61,4 +62,8 @@
             <directory name="vendor"/>
         </ignoreFiles>
     </projectFiles>
+    <plugins>
+        <pluginClass class="Psalm\SymfonyPsalmPlugin\Plugin"/>
+        <pluginClass class="Weirdan\DoctrinePsalmPlugin\Plugin"/>
+    </plugins>
 </psalm>

src/Configuration.php

@@ -38,7 +38,7 @@ use Symfony\Component\Yaml\Yaml;
  * @property-read string $repositoryName Common name of this repository
  * @property-read string $adminEmail Repository contact's e-mail address
  * @property-read string $database Database's data source name (DSN)
- * @property-read array $metadataPrefix Array of served metadata prefixes
+ * @property-read array<string, array<string, string>> $metadataPrefix Array of served metadata prefixes
  * @property-read string $deletedRecords Repository's deleted records policy
  * @property-read int $maxRecords Maximum number of records served per request
  * @property-read int $tokenValid Number of seconds resumption tokens are valid

src/Console/CsvImportCommand.php

@@ -139,30 +139,36 @@ class CsvImportCommand extends Console
         $progressIndicator = new ProgressIndicator($output, null, 100, ['⠏', '⠛', '⠹', '⢸', '⣰', '⣤', '⣆', '⡇']);
         $progressIndicator->start('Importing...');
 
-        while ($row = fgetcsv($file)) {
+        while ($row = fgetcsv($file, null, ",", "\"", "\\")) {
-            /** @var Format */
+            if (!is_null($row[0])) {
-            $format = $this->em->getMetadataFormat($this->arguments['format']);
+                /** @var Format */
-            $record = new Record($row[$columnMapping['idColumn']], $format);
+                $format = $this->em->getMetadataFormat($this->arguments['format']);
-            if (strlen(trim($row[$columnMapping['contentColumn']])) > 0) {
+                /** @phpstan-ignore-next-line - see https://github.com/phpstan/phpstan/issues/12195 */
-                $record->setContent($row[$columnMapping['contentColumn']], !$this->arguments['noValidation']);
+                $record = new Record($row[$columnMapping['idColumn']], $format);
-            }
+                /** @phpstan-ignore-next-line - see https://github.com/phpstan/phpstan/issues/12195 */
-            if (isset($columnMapping['dateColumn'])) {
+                if (strlen(trim($row[$columnMapping['contentColumn']])) > 0) {
-                $record->setLastChanged(new DateTime($row[$columnMapping['dateColumn']]));
+                    $record->setContent($row[$columnMapping['contentColumn']], !$this->arguments['noValidation']);
-            }
-            if (isset($columnMapping['setColumn'])) {
-                $sets = $row[$columnMapping['setColumn']];
-                foreach (explode(',', $sets) as $set) {
-                    /** @var Set */
-                    $setSpec = $this->em->getSet(trim($set));
-                    $record->addSet($setSpec);
                 }
-            }
+                if (isset($columnMapping['dateColumn'])) {
-            $this->em->addOrUpdate($record, true);
+                    /** @phpstan-ignore-next-line - see https://github.com/phpstan/phpstan/issues/12195 */
+                    $record->setLastChanged(new DateTime($row[$columnMapping['dateColumn']]));
+                }
+                if (isset($columnMapping['setColumn'])) {
+                    $sets = $row[$columnMapping['setColumn']];
+                    /** @phpstan-ignore-next-line - see https://github.com/phpstan/phpstan/issues/12195 */
+                    foreach (explode(',', $sets) as $set) {
+                        /** @var Set */
+                        $setSpec = $this->em->getSet(trim($set));
+                        $record->addSet($setSpec);
+                    }
+                }
+                $this->em->addOrUpdate($record, true);
 
-            ++$count;
+                ++$count;
-            $progressIndicator->advance();
+                $progressIndicator->advance();
-            $progressIndicator->setMessage('Importing... ' . (string) $count . ' records processed.');
+                $progressIndicator->setMessage('Importing... ' . (string) $count . ' records processed.');
-            $this->checkMemoryUsage();
+                $this->checkMemoryUsage();
+            }
         }
         $this->em->flush();
         $this->em->pruneOrphanedSets();
@@ -204,20 +210,19 @@ class CsvImportCommand extends Console
             'setColumn' => $input->getOption('setColumn')
         ];
 
-        $headers = fgetcsv($file);
+        $headers = fgetcsv($file, null, ",", "\"", "\\");
-        if (!is_array($headers) || !isset($headers[0])) {
+        if (!is_array($headers) || is_null($headers[0])) {
             $output->writeln([
                 '',
                 sprintf(
                     ' [ERROR] File "%s" does not contain valid CSV. ',
-                    /** @phpstan-ignore-next-line - URI is always set for fopen() resources. */
+                    stream_get_meta_data($file)['uri'] ?? 'unknown'
-                    stream_get_meta_data($file)['uri'] ?: 'unknown'
                 ),
                 ''
             ]);
             return null;
         }
-        /** @var array<string, int> */
+        /** @phpstan-ignore-next-line - see https://github.com/phpstan/phpstan/issues/12195 */
         $headers = array_flip($headers);
 
         $callback = function (string $column) use ($headers): ?int {
@@ -231,8 +236,7 @@ class CsvImportCommand extends Console
                 '',
                 sprintf(
                     ' [ERROR] File "%s" does not contain mandatory columns. ',
-                    /** @phpstan-ignore-next-line - URI is always set for fopen() resources. */
+                    stream_get_meta_data($file)['uri'] ?? 'unknown'
-                    stream_get_meta_data($file)['uri'] ?: 'unknown'
                 ),
                 ''
             ]);

src/Console/UpdateFormatsCommand.php

@@ -53,17 +53,16 @@ class UpdateFormatsCommand extends Console
      */
     protected function execute(InputInterface $input, OutputInterface $output): int
     {
-        /** @var array<string, array<string, string>> */
         $formats = Configuration::getInstance()->metadataPrefix;
         $this->clearResultCache();
         $inDatabase = $this->em->getMetadataFormats();
         $failure = false;
         foreach ($formats as $prefix => $format) {
             if (
-                $inDatabase->containsKey(key: $prefix)
+                $inDatabase->containsKey($prefix)
-                /** @phpstan-ignore-next-line - $inDatabase[$prefix] is always of type Format. */
+                /** @phpstan-ignore-next-line - see line 62 */
                 and $format['namespace'] === $inDatabase[$prefix]->getNamespace()
-                /** @phpstan-ignore-next-line - $inDatabase[$prefix] is always of type Format. */
+                /** @phpstan-ignore-next-line - see line 62 */
                 and $format['schema'] === $inDatabase[$prefix]->getSchema()
             ) {
                 continue;

src/Entity/Record.php

@@ -179,8 +179,7 @@ class Record extends Entity
      *
      * @return bool TRUE if content exists, FALSE otherwise
      *
-     * @psalm-assert-if-true string $this->content
+     * @phpstan-assert-if-true !null $this->getContent()
-     * @psalm-assert-if-true string $this->getContent()
      */
     public function hasContent(): bool
     {

src/Entity/Set.php

@@ -131,8 +131,7 @@ class Set extends Entity
      *
      * @return bool TRUE if description exists, FALSE otherwise
      *
-     * @psalm-assert-if-true string $this->description
+     * @phpstan-assert-if-true !null $this->getDescription()
-     * @psalm-assert-if-true string $this->getDescription()
      */
     public function hasDescription(): bool
     {

src/EntityManager.php

@@ -51,7 +51,7 @@ use Symfony\Component\Filesystem\Path;
  * @mixin DoctrineEntityManager
  *
  * @psalm-import-type Params from DriverManager
- * @SuppressWarnings(PHPMD.CouplingBetweenObjects)
+ * @SuppressWarnings("PHPMD.CouplingBetweenObjects")
  */
 final class EntityManager extends EntityManagerDecorator
 {
@@ -431,8 +431,6 @@ final class EntityManager extends EntityManagerDecorator
             'sqlite' => 'pdo_sqlite'
         ]);
         $conn = DriverManager::getConnection(
-            // Generic return type of DsnParser::parse() is not correctly recognized.
-            // phpcs:ignore
             $parser->parse($dsn),
             $config
         );