Merge pull request #238 from cleverage/143

#143 - Remove all PHPStan ignores at level 6

Author: njoubert-cleverage

CHANGELOG.md

@@ -3,6 +3,10 @@ Latest
 
 ## Changes
 * [#197](https://github.com/cleverage/process-bundle/issues/197) Add missing tests: every Task and Transformer is now covered by unit tests. Remove the obsolete `tests.old` directory.
+* [#143](https://github.com/cleverage/process-bundle/issues/143) Improve PHPStan configuration: remove all `ignoreErrors` and `@phpstan-ignore` comments (report unmatched ignored errors again), add missing iterable value types and generic types in PHPDoc, remove unreachable code in AbstractIterableOutputTask and InputAggregatorTask.
+
+## Fixes
+* [#143](https://github.com/cleverage/process-bundle/issues/143) Fix InputIteratorTask: an `\IteratorAggregate` input whose `getIterator()` does not return an `\Iterator` (e.g. another `\IteratorAggregate`) is iterated instead of failing with a `TypeError`. Update documentation, add tests.
 
 v5.1
 -----

docs/reference/tasks/input_iterator_task.md

@@ -12,7 +12,7 @@ Task reference
 Accepted inputs
 ---------------
 
-`array`, `\Iterator` or `\IteratorAggregate`: any other type throws an `\UnexpectedValueException`
+`array`, `\Iterator` or `\IteratorAggregate` (whatever `\Traversable` its `getIterator()` returns): any other type throws an `\UnexpectedValueException`
 
 Possible outputs
 ----------------

phpstan.neon

@@ -5,16 +5,5 @@ parameters:
         - tests
     excludePaths:
         - src/Resources/tests/*
-    ignoreErrors:
-        - '#type has no value type specified in iterable type#'
-        - '#has parameter .* with no value type specified in iterable type#'
-        - '#has no value type specified in iterable type array#'
-        - '#configureOptions\(\) has no return type specified.#'
-        - '#configure\(\) has no return type specified#'
-        - '#process\(\) has no return type specified#'
-        - '#should return Iterator but returns Traversable#'
-        - '#Negated boolean expression is always false#'
-        - identifier: missingType.generics
-    reportUnmatchedIgnoredErrors: false
     inferPrivatePropertyTypeFromConstructor: true
     treatPhpDocTypesAsCertain: false

src/Command/ListProcessCommand.php

@@ -48,6 +48,9 @@ public function processSorter(ProcessConfiguration $a, ProcessConfiguration $b):
         return $a->getCode() <=> $b->getCode();
     }
 
+    /**
+     * @param array{output: string} $message
+     */
     public function maxMessageLengthFilter(int $max, array $message): int
     {
         return max($max, \strlen($this->filterOutTags($message['output'])));

src/Command/ProcessHelpCommand.php

@@ -126,6 +126,9 @@ protected function execute(InputInterface $input, OutputInterface $output): int
 
     /**
      * Try to find a best candidate for next display.
+     *
+     * @param array<string|null> $branches
+     * @param list<string>       $taskList
      */
     protected function findBestNextTask(
         array $branches,
@@ -223,6 +226,8 @@ protected function getTaskChildrenCount(TaskConfiguration $task): int
 
     /**
      * Merge needed branches, display a task node, split following needed branches.
+     *
+     * @param array<string|null> $branches
      */
     protected function resolveBranchOutput(
         array &$branches,
@@ -442,6 +447,10 @@ static function ($branchTask, $i) use ($origin, $branches, $gapBranches, $final)
         $this->writeBranches($output, $branches);
     }
 
+    /**
+     * @param array<string|null>      $branches
+     * @param string|iterable<string> $comment
+     */
     protected function writeBranches(
         OutputInterface $output,
         array $branches,

src/Configuration/ProcessConfiguration.php

@@ -21,10 +21,20 @@
  */
 class ProcessConfiguration
 {
+    /**
+     * @var list<list<string>>|null
+     */
     protected ?array $dependencyGroups = null;
 
+    /**
+     * @var list<string>|null
+     */
     protected ?array $mainTaskGroup = null;
 
+    /**
+     * @param array<string, TaskConfiguration> $taskConfigurations
+     * @param array<string, mixed>             $options
+     */
     public function __construct(
         protected string $code,
         protected array $taskConfigurations,
@@ -42,6 +52,9 @@ public function getCode(): string
         return $this->code;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getOptions(): array
     {
         return $this->options;
@@ -106,6 +119,8 @@ public function getTaskConfiguration(string $taskCode): TaskConfiguration
      * Group all task by dependencies.
      *
      * If one task depend from another, it should come after
+     *
+     * @return list<list<string>>
      */
     public function getDependencyGroups(): array
     {
@@ -130,6 +145,8 @@ public function getDependencyGroups(): array
      * It may be defined by the entry_point, or the end_point or simply the first task.
      *
      * If one task depend from another, it should come after
+     *
+     * @return list<string>
      */
     public function getMainTaskGroup(): array
     {
@@ -195,6 +212,10 @@ public function checkCircularDependencies(): void
 
     /**
      * Cross all relations of a task to find all dependencies, and append them to the given array.
+     *
+     * @param list<string> $dependencies
+     *
+     * @return list<string>
      */
     protected function buildDependencies(TaskConfiguration $taskConfig, array &$dependencies = []): array
     {
@@ -222,6 +243,10 @@ protected function buildDependencies(TaskConfiguration $taskConfig, array &$depe
 
     /**
      * Sort the tasks by dependencies.
+     *
+     * @param list<string> $dependencies
+     *
+     * @return list<string>
      */
     protected function sortDependencies(array $dependencies): array
     {

src/Configuration/TaskConfiguration.php

@@ -49,6 +49,11 @@ class TaskConfiguration
 
     protected bool $logErrors;
 
+    /**
+     * @param array<string, mixed> $options
+     * @param list<string>         $outputs
+     * @param list<string>         $errorOutputs
+     */
     public function __construct(
         protected string $code,
         protected string $serviceReference,
@@ -93,6 +98,9 @@ public function getHelp(): string
         return $this->help;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getOptions(): array
     {
         return $this->options;
@@ -107,11 +115,17 @@ public function getOption(string $code, mixed $default = null): mixed
         return $default;
     }
 
+    /**
+     * @return list<string>
+     */
     public function getOutputs(): array
     {
         return $this->outputs;
     }
 
+    /**
+     * @return list<string>
+     */
     #[\Deprecated(message: 'Use getErrorOutputs method instead')]
     public function getErrors(): array
     {
@@ -120,6 +134,9 @@ public function getErrors(): array
         return $this->getErrorOutputs();
     }
 
+    /**
+     * @return list<string>
+     */
     public function getErrorOutputs(): array
     {
         return $this->errorOutputs;

src/Context/ContextualOptionResolver.php

@@ -18,6 +18,8 @@ class ContextualOptionResolver
     /**
      * Basic value inference
      * Replaces "{{ key }}" by context[key].
+     *
+     * @param array<string, mixed> $context
      */
     public function contextualizeOption(mixed $value, array $context): mixed
     {
@@ -46,6 +48,11 @@ public function contextualizeOption(mixed $value, array $context): mixed
 
     /**
      * Replace all contextualized values from options.
+     *
+     * @param array<string, mixed> $options
+     * @param array<string, mixed> $context
+     *
+     * @return array<string, mixed>
      */
     public function contextualizeOptions(array $options, array $context): array
     {

src/Event/ConsoleProcessEvent.php

@@ -22,6 +22,9 @@
  */
 class ConsoleProcessEvent extends Event
 {
+    /**
+     * @param array<string, mixed> $processContext
+     */
     public function __construct(
         private readonly InputInterface $consoleInput,
         private readonly OutputInterface $consoleOutput,
@@ -45,6 +48,9 @@ public function getProcessInput(): mixed
         return $this->processInput;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getProcessContext(): array
     {
         return $this->processContext;

src/Event/ProcessEvent.php

@@ -26,6 +26,9 @@ class ProcessEvent extends Event
 
     final public const EVENT_PROCESS_FAILED = 'cleverage_process.fail';
 
+    /**
+     * @param array<string, mixed> $processContext
+     */
     public function __construct(
         protected string $processCode,
         protected mixed $processInput = null,
@@ -50,6 +53,9 @@ public function getProcessOutput(): mixed
         return $this->processOutput;
     }
 
+    /**
+     * @return array<string, mixed>
+     */
     public function getProcessContext(): array
     {
         return $this->processContext;