Merge pull request #1085 from veewee/psalm-issues

Resolve psalm errors

grumphp.yml.dist

@@ -35,14 +35,13 @@ grumphp:
       verbose: true
       functional: true
     psalm:
-      show_info: true
       no_cache: true
   testsuites:
     git_pre_commit:
       tasks: [phpcs, phpspec, phpunit, composer, composer_normalize, yamllint, phplint, phpparser, psalm]
     # On CI, we run paratest separately. For some reason this currently fails in GitHub actions.
     ci:
-      tasks: [phpcs, phpspec, phpunit, composer, composer_normalize, yamllint, phplint, phpparser]
+      tasks: [phpcs, phpspec, phpunit, composer, composer_normalize, yamllint, phplint, phpparser, psalm]
     # Don't run psalm on Windows for now. There is a known issue with the Windows phar:
     # https://github.com/vimeo/psalm/issues/2858
     windows:

phive.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <phive xmlns="https://phar.io/phive">
-  <phar name="psalm" version="^4.13.1" installed="4.22.0" location="./tools/psalm" copy="true"/>
+  <phar name="psalm" version="^5.9.0" installed="5.9.0" location="./tools/psalm" copy="true"/>
   <phar name="phpcs" version="^3.6.1" installed="3.6.2" location="./tools/phpcs" copy="true"/>
   <phar name="phpcbf" version="^3.6.1" installed="3.6.2" location="./tools/phpcbf" copy="true"/>
   <phar name="composer-normalize" version="^2.16.0" installed="2.24.1" location="./tools/composer-normalize" copy="true"/>

psalm.xml

@@ -5,6 +5,8 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
     xsi:schemaLocation="https://getpsalm.org/schema/config vendor/vimeo/psalm/config.xsd"
+    findUnusedBaselineEntry="false"
+    findUnusedCode="false"
 >
     <projectFiles>
         <directory name="src" />

src/Collection/FilesCollection.php

@@ -18,6 +18,14 @@
  */
 class FilesCollection extends ArrayCollection
 {
+    /**
+     * @param \Traversable<array-key, \SplFileInfo> $iterator
+     */
+    public static function fromTraversable(\Traversable $iterator): FilesCollection
+    {
+        return new self(array_values(iterator_to_array($iterator)));
+    }
+
     /**
      * Adds a rule that files must match.
      *
@@ -47,7 +55,7 @@ public function names(array $patterns): self
     {
         $filter = new Iterator\FilenameFilterIterator($this->getIterator(), $patterns, []);
 
-        return new self([...$filter]);
+        return self::fromTraversable($filter);
     }
 
     /**
@@ -63,7 +71,7 @@ public function notName(string $pattern): self
     {
         $filter = new Iterator\FilenameFilterIterator($this->getIterator(), [], [$pattern]);
 
-        return new self([...$filter]);
+        return self::fromTraversable($filter);
     }
 
     /**
@@ -80,12 +88,14 @@ public function path(string $pattern): self
      * Filter by paths.
      *
      * $collection->paths(['/^spec\/','/^src\/'])
+     *
+     * @psalm-suppress ArgumentTypeCoercion - Works on int, \SplFileInfo as well
      */
     public function paths(array $patterns): self
     {
         $filter = new Iterator\PathFilterIterator($this->getIterator(), $patterns, []);
 
-        return new self([...$filter]);
+        return self::fromTraversable($filter);
     }
 
     /**
@@ -106,12 +116,14 @@ public function notPath(string $pattern): self
      * You can use patterns (delimited with / sign) or simple strings.
      *
      * $collection->notPaths(['/^spec\/','/^src\/'])
+     *
+     * @psalm-suppress ArgumentTypeCoercion - Works on int, \SplFileInfo as well
      */
     public function notPaths(array $pattern): self
     {
         $filter = new Iterator\PathFilterIterator($this->getIterator(), [], $pattern);
 
-        return new self([...$filter]);
+        return self::fromTraversable($filter);
     }
 
     public function extensions(array $extensions): self
@@ -139,7 +151,7 @@ public function size(string $size): self
         $comparator = new Comparator\NumberComparator($size);
         $filter = new Iterator\SizeRangeFilterIterator($this->getIterator(), [$comparator]);
 
-        return new self([...$filter]);
+        return self::fromTraversable($filter);
     }
 
     /**
@@ -161,7 +173,7 @@ public function date(string $date): self
         $comparator = new Comparator\DateComparator($date);
         $filter = new Iterator\DateRangeFilterIterator($this->getIterator(), [$comparator]);
 
-        return new self([...$filter]);
+        return self::fromTraversable($filter);
     }
 
     /**
@@ -182,14 +194,17 @@ public function filter(Closure $p): self
     {
         $filter = new Iterator\CustomFilterIterator($this->getIterator(), [$p]);
 
-        return new self([...$filter]);
+        return self::fromTraversable($filter);
     }
 
+    /**
+     * @param Traversable<array-key, SplFileInfo> $fileList
+     */
     public function filterByFileList(Traversable $fileList): FilesCollection
     {
         $allowedFiles = array_map(function (SplFileInfo $file) {
             return $file->getPathname();
-        }, [...$fileList]);
+        }, iterator_to_array($fileList));
 
         return $this->filter(function (SplFileInfo $file) use ($allowedFiles) {
             return \in_array($file->getPathname(), $allowedFiles, true);

src/Composer/GrumPHPPlugin.php

@@ -260,7 +260,7 @@ function (string $argument): string {
         // Loop on process until it exits normally.
         do {
             $status = proc_get_status($process);
-        } while ($status && $status['running']);
+        } while ($status['running']);
 
         $exitCode = $status['exitcode'] ?? -1;
         proc_close($process);

src/Configuration/Compiler/ExtensionCompilerPass.php

@@ -9,6 +9,9 @@
 use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 
+/**
+ * @psalm-suppress UndefinedDocblockClass - PHP 8.0 Doesnt know enums
+ */
 class ExtensionCompilerPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container): void

src/Configuration/Environment/PathsRegistrar.php

@@ -38,6 +38,8 @@ private static function prependOne(string $path): void
 
     /**
      * Detect which path variable name is being used
+     *
+     * @return non-empty-string
      */
     private static function pathVarName(): string
     {
@@ -54,6 +56,9 @@ private static function pathVarName(): string
         return $pathStr;
     }
 
+    /**
+     * @psalm-suppress PossiblyInvalidCast - Not sure what's going on, should be always OK.
+     */
     private static function pathContainsDir(string $dir): bool
     {
         return (bool) preg_match(

src/Configuration/Model/EnvConfig.php

@@ -40,7 +40,8 @@ public function __construct(
     }
 
     /**
-     * @param array{max_workers: int, enabled: bool} $config
+     * @psalm-suppress RedundantCastGivenDocblockType - The types are not validated here.
+     * @param array{files ?: list<string>, variables ?: array<string, string>, paths ?: list<string>} $config
      */
     public static function fromArray(array $config): self
     {

src/Event/Subscriber/StashUnstagedChangesSubscriber.php

@@ -109,6 +109,7 @@ private function doSaveStash(): void
                 $this->io->write(['<fg=yellow>Detected unstaged changes... Stashing them!</fg=yellow>']);
             }
 
+            /** @psalm-suppress RedundantCondition - it's the most clear this way.. */
             if (!$hasPending && $hasUntracked) {
                 $this->io->write(['<fg=yellow>Detected untracked files... Stashing them!</fg=yellow>']);
             }

src/Event/Subscriber/VerboseLoggerSubscriber.php

@@ -44,6 +44,7 @@ public function onCommand(ConsoleCommandEvent $event): void
             return;
         }
 
+        /** @psalm-suppress DeprecatedConstant - Only possible to use enums from PHP 8.2*/
         $this->logger->pushHandler(new StreamHandler('php://stdout', Logger::DEBUG));
         $this->logGuessedPaths($output);
     }

src/Formatter/PhpcsFormatter.php

@@ -14,7 +14,7 @@ class PhpcsFormatter implements ProcessFormatterInterface
     protected $output = '';
 
     /**
-     * @var string[]
+     * @var list<string>
      */
     protected $suggestedFiles = [];
 
@@ -41,6 +41,9 @@ public function format(Process $process): string
         return $this->output;
     }
 
+    /**
+     * @return list<string>
+     */
     private function getSuggestedFilesFromJson(array $json): array
     {
         $suggestedFiles = [];
@@ -53,7 +56,7 @@ private function getSuggestedFilesFromJson(array $json): array
             }
             foreach ($data['messages'] as $message) {
                 if (\is_array($message) && $message['fixable']) {
-                    $suggestedFiles[] = $absolutePath;
+                    $suggestedFiles[] = (string) $absolutePath;
                     break;
                 }
             }

src/Linter/Xml/XmlLinter.php

@@ -148,6 +148,7 @@ private function validateDTD(DOMDocument $document): bool
         }
 
         // Do not validate external DTDs if the loadFromNet option is disabled:
+        /** @psalm-suppress UndefinedPropertyFetch - Should bet here on PHP 8.0 as well. */
         $systemId = $document->doctype->systemId;
         if (filter_var($systemId, FILTER_VALIDATE_URL) && !$this->loadFromNet) {
             return true;

src/Locator/EnrichedGuessedPathsFromDotEnvLocator.php

@@ -7,6 +7,9 @@
 use GrumPHP\Configuration\GuessedPaths;
 use GrumPHP\Util\Filesystem;
 
+/**
+ * @psalm-suppress RedundantCast - We don't want to blindly assume variables in $_SERVER are from the string type.
+ */
 class EnrichedGuessedPathsFromDotEnvLocator
 {
     /**

src/Locator/GuessedPathsLocator.php

@@ -9,6 +9,9 @@
 use GrumPHP\Util\ComposerFile;
 use GrumPHP\Util\Filesystem;
 
+/**
+ * @psalm-suppress RedundantCast - We don't want to blindly assume variables in $_SERVER are from the string type.
+ */
 class GuessedPathsLocator
 {
     /**

src/Task/Ant.php

@@ -4,13 +4,17 @@
 
 namespace GrumPHP\Task;
 
+use GrumPHP\Formatter\ProcessFormatterInterface;
 use GrumPHP\Runner\TaskResult;
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Context\ContextInterface;
 use GrumPHP\Task\Context\GitPreCommitContext;
 use GrumPHP\Task\Context\RunContext;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
+/**
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
+ */
 class Ant extends AbstractExternalTask
 {
     public static function getConfigurableOptions(): OptionsResolver

src/Task/Atoum.php

@@ -4,6 +4,7 @@
 
 namespace GrumPHP\Task;
 
+use GrumPHP\Formatter\ProcessFormatterInterface;
 use GrumPHP\Runner\TaskResult;
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Context\ContextInterface;
@@ -12,7 +13,7 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
- * Atoum task.
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
  */
 class Atoum extends AbstractExternalTask
 {

src/Task/Behat.php

@@ -4,6 +4,7 @@
 
 namespace GrumPHP\Task;
 
+use GrumPHP\Formatter\ProcessFormatterInterface;
 use GrumPHP\Runner\TaskResult;
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Context\ContextInterface;
@@ -12,7 +13,7 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
- * Behat task.
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
  */
 class Behat extends AbstractExternalTask
 {

src/Task/Brunch.php

@@ -4,6 +4,7 @@
 
 namespace GrumPHP\Task;
 
+use GrumPHP\Formatter\ProcessFormatterInterface;
 use GrumPHP\Runner\TaskResult;
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Context\ContextInterface;
@@ -12,7 +13,7 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
- * Brunch task.
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
  */
 class Brunch extends AbstractExternalTask
 {

src/Task/CloverCoverage.php

@@ -16,9 +16,6 @@
 use SplFileInfo;
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
-/**
- * Clover unit test coverage task.
- */
 class CloverCoverage implements TaskInterface
 {
     /**

src/Task/Codeception.php

@@ -4,6 +4,7 @@
 
 namespace GrumPHP\Task;
 
+use GrumPHP\Formatter\ProcessFormatterInterface;
 use GrumPHP\Runner\TaskResult;
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Context\ContextInterface;
@@ -12,7 +13,7 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
- * Codeception task.
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
  */
 class Codeception extends AbstractExternalTask
 {

src/Task/Composer.php

@@ -15,6 +15,9 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use SplFileInfo;
 
+/**
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
+ */
 class Composer extends AbstractExternalTask
 {
     /**

src/Task/ComposerNormalize.php

@@ -3,6 +3,7 @@
 namespace GrumPHP\Task;
 
 use GrumPHP\Fixer\Provider\FixableProcessResultProvider;
+use GrumPHP\Formatter\ProcessFormatterInterface;
 use GrumPHP\Runner\TaskResult;
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Context\ContextInterface;
@@ -11,6 +12,9 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 use Symfony\Component\Process\Process;
 
+/**
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
+ */
 class ComposerNormalize extends AbstractExternalTask
 {
     public function canRunInContext(ContextInterface $context): bool

src/Task/ComposerRequireChecker.php

@@ -4,6 +4,7 @@
 
 namespace GrumPHP\Task;
 
+use GrumPHP\Formatter\ProcessFormatterInterface;
 use GrumPHP\Runner\TaskResult;
 use GrumPHP\Runner\TaskResultInterface;
 use GrumPHP\Task\Context\ContextInterface;
@@ -12,7 +13,7 @@
 use Symfony\Component\OptionsResolver\OptionsResolver;
 
 /**
- * ComposerRequireChecker task.
+ * @extends AbstractExternalTask<ProcessFormatterInterface>
  */
 class ComposerRequireChecker extends AbstractExternalTask
 {