refactor: set phpstan level to max

PedroTroller · PedroTroller · commit 993cd9dd52d9 · 2023-05-25T11:15:12.000+02:00
diff --git a/phpstan.neon.dist b/phpstan.neon.dist
@@ -1,5 +1,5 @@
 parameters:
-    level: 8
+    level: max
     paths:
         - src
         - spec/PHPSpec
diff --git a/spec/PHPSpec/OneOfMatcher.php b/spec/PHPSpec/OneOfMatcher.php
@@ -32,12 +32,12 @@ protected function matches($subject, array $arguments): bool
     }
 
     /**
-     * @param mixed   $subject
+     * @param string   $subject
      * @param mixed[] $arguments
      */
     protected function getFailureException(string $name, $subject, array $arguments): FailureException
     {
-        if (1 === \count($arguments) && \is_array(current($arguments))) {
+        if ([] !== \count($arguments) && \is_array(current($arguments))) {
             $arguments = current($arguments);
         }
 
@@ -51,12 +51,12 @@ protected function getFailureException(string $name, $subject, array $arguments)
     }
 
     /**
-     * @param mixed   $subject
+     * @param string   $subject
      * @param mixed[] $arguments
      */
     protected function getNegativeFailureException(string $name, $subject, array $arguments): FailureException
     {
-        if (1 === \count($arguments) && \is_array(current($arguments))) {
+        if ([] !== \count($arguments) && \is_array(current($arguments))) {
             $arguments = current($arguments);
         }
 
diff --git a/src/Knp/DictionaryBundle/Dictionary.php b/src/Knp/DictionaryBundle/Dictionary.php
@@ -9,10 +9,11 @@
 use IteratorAggregate;
 
 /**
- * @template E
+ * @template TKey of (int|string)
+ * @template TValue
  *
- * @extends IteratorAggregate<mixed, E>
- * @extends ArrayAccess<mixed, E>
+ * @extends IteratorAggregate<TKey, TValue>
+ * @extends ArrayAccess<TKey, TValue>
  */
 interface Dictionary extends ArrayAccess, Countable, IteratorAggregate
 {
diff --git a/src/Knp/DictionaryBundle/Dictionary/Collection.php b/src/Knp/DictionaryBundle/Dictionary/Collection.php
@@ -14,18 +14,18 @@
 use Traversable;
 
 /**
- * @implements ArrayAccess<string, Dictionary<mixed>>
- * @implements IteratorAggregate<string, Dictionary<mixed>>
+ * @implements ArrayAccess<string, Dictionary<int|string, mixed>>
+ * @implements IteratorAggregate<string, Dictionary<int|string, mixed>>
  */
 final class Collection implements ArrayAccess, Countable, IteratorAggregate
 {
     /**
-     * @var array<string, Dictionary<mixed>>
+     * @var array<string, Dictionary<int|string, mixed>>
      */
     private array $dictionaries = [];
 
     /**
-     * @param Dictionary<mixed> ...$dictionaries
+     * @param Dictionary<int|string, mixed> ...$dictionaries
      */
     public function __construct(Dictionary ...$dictionaries)
     {
@@ -35,7 +35,7 @@ public function __construct(Dictionary ...$dictionaries)
     }
 
     /**
-     * @param Dictionary<mixed> $dictionary
+     * @param Dictionary<int|string, mixed> $dictionary
      */
     public function add(Dictionary $dictionary): void
     {
@@ -48,8 +48,8 @@ public function offsetExists($offset): bool
     }
 
     /**
-     * @return Dictionary<mixed>
-     *                           {@inheritdoc}
+     * @return Dictionary<int|string, mixed>
+     * {@inheritdoc}
      *
      * @throws DictionaryNotFoundException
      */
diff --git a/src/Knp/DictionaryBundle/Dictionary/Combined.php b/src/Knp/DictionaryBundle/Dictionary/Combined.php
@@ -7,14 +7,15 @@
 use Knp\DictionaryBundle\Dictionary;
 
 /**
- * @template E
+ * @template TKey of (int|string)
+ * @template TValue
  *
- * @extends Wrapper<E>
+ * @extends Wrapper<TKey, TValue>
  */
 final class Combined extends Wrapper
 {
     /**
-     * @param Dictionary<E> ...$dictionaries
+     * @param Dictionary<TKey, TValue> ...$dictionaries
      */
     public function __construct(string $name, Dictionary ...$dictionaries)
     {
@@ -32,10 +33,10 @@ public function __construct(string $name, Dictionary ...$dictionaries)
     }
 
     /**
-     * @param E[] $array1
-     * @param E[] $array2
+     * @param array<TKey, TValue> $array1
+     * @param array<TKey, TValue> $array2
      *
-     * @return E[]
+     * @return array<TKey, TValue>
      */
     private function merge(array $array1, array $array2): array
     {
diff --git a/src/Knp/DictionaryBundle/Dictionary/Factory.php b/src/Knp/DictionaryBundle/Dictionary/Factory.php
@@ -11,7 +11,7 @@ interface Factory
     /**
      * @param mixed[] $config
      *
-     * @return Dictionary<mixed>
+     * @return Dictionary<int|string, mixed>
      */
     public function create(string $name, array $config): Dictionary;
 
diff --git a/src/Knp/DictionaryBundle/Dictionary/Factory/Combined.php b/src/Knp/DictionaryBundle/Dictionary/Factory/Combined.php
@@ -30,7 +30,7 @@ public function create(string $name, array $config): Dictionary
         }
 
         $dictionaries = array_map(
-            fn ($name): Dictionary => $this->dictionaries[$name],
+            fn (string $name): Dictionary => $this->dictionaries[$name],
             $config['dictionaries']
         );
 
diff --git a/src/Knp/DictionaryBundle/Dictionary/Factory/Iterator.php b/src/Knp/DictionaryBundle/Dictionary/Factory/Iterator.php
@@ -19,6 +19,8 @@ public function __construct(private ContainerInterface $container)
     /**
      * {@inheritdoc}
      *
+     * @param array{service?: string} $config
+     *
      * @throw InvalidArgumentException if there is some problem with the config.
      */
     public function create(string $name, array $config): Dictionary
diff --git a/src/Knp/DictionaryBundle/Dictionary/Factory/KeyValue.php b/src/Knp/DictionaryBundle/Dictionary/Factory/KeyValue.php
@@ -18,6 +18,7 @@ public function __construct(private ValueTransformer $transformer)
 
     /**
      * {@inheritdoc}
+     * @param array{content?: array<mixed>} $config
      *
      * @throw InvalidArgumentException if there is some problem with the config.
      */
diff --git a/src/Knp/DictionaryBundle/Dictionary/Factory/Value.php b/src/Knp/DictionaryBundle/Dictionary/Factory/Value.php
@@ -18,6 +18,7 @@ public function __construct(private ValueTransformer $transformer)
 
     /**
      * {@inheritdoc}
+     * @param array{content?: array<mixed>} $config
      *
      * @throw InvalidArgumentException Not able to create a dictionary with the given name
      */
diff --git a/src/Knp/DictionaryBundle/Dictionary/Invokable.php b/src/Knp/DictionaryBundle/Dictionary/Invokable.php
@@ -8,28 +8,31 @@
 use InvalidArgumentException;
 use Knp\DictionaryBundle\Dictionary;
 use ReturnTypeWillChange;
+use Traversable;
 
 /**
- * @template E
+ * @template TKey of (int|string)
+ * @template TValue
  *
- * @implements Dictionary<E>
+ * @implements Dictionary<TKey, TValue>
  */
 final class Invokable implements Dictionary
 {
     private bool $invoked = false;
 
     /**
-     * @var array<mixed, mixed>
+     * @var array<TKey, TValue>
      */
     private array $values = [];
 
     /**
-     * @var callable
+     * @var callable(): array<TKey, TValue>
      */
     private $callable;
 
     /**
      * @param mixed[] $callableArgs
+     * @param callable(): array<TKey, TValue> $callable
      */
     public function __construct(private string $name, callable $callable, private array $callableArgs = [])
     {
@@ -84,14 +87,11 @@ public function offsetUnset($offset): void
         unset($this->values[$offset]);
     }
 
-    /**
-     * @return ArrayIterator<int|string, mixed>
-     */
-    public function getIterator(): ArrayIterator
+    public function getIterator(): Traversable
     {
         $this->invoke();
 
-        return new ArrayIterator($this->values);
+        yield from $this->values;
     }
 
     public function count(): int
diff --git a/src/Knp/DictionaryBundle/Dictionary/Iterator.php b/src/Knp/DictionaryBundle/Dictionary/Iterator.php
@@ -7,14 +7,15 @@
 use Traversable;
 
 /**
- * @template E
+ * @template TKey of (int|string)
+ * @template TValue
  *
- * @extends Wrapper<E>
+ * @extends Wrapper<TKey, TValue>
  */
 final class Iterator extends Wrapper
 {
     /**
-     * @param Traversable<mixed, E> $iterator
+     * @param Traversable<TKey, TValue> $iterator
      */
     public function __construct(string $name, Traversable $iterator)
     {
diff --git a/src/Knp/DictionaryBundle/Dictionary/Simple.php b/src/Knp/DictionaryBundle/Dictionary/Simple.php
@@ -8,14 +8,15 @@
 use Knp\DictionaryBundle\Dictionary;
 
 /**
- * @template E
+ * @template TKey of (int|string)
+ * @template TValue
  *
- * @implements Dictionary<E>
+ * @implements Dictionary<TKey, TValue>
  */
 final class Simple implements Dictionary
 {
     /**
-     * @param array<mixed, E> $values
+     * @param array<TKey, TValue> $values
      */
     public function __construct(private string $name, private array $values)
     {
diff --git a/src/Knp/DictionaryBundle/Dictionary/Traceable.php b/src/Knp/DictionaryBundle/Dictionary/Traceable.php
@@ -6,16 +6,18 @@
 
 use Knp\DictionaryBundle\DataCollector\DictionaryDataCollector;
 use Knp\DictionaryBundle\Dictionary;
+use Traversable;
 
 /**
- * @template E of mixed
+ * @template TKey of (int|string)
+ * @template TValue
  *
- * @implements Dictionary<E>
+ * @implements Dictionary<TKey, TValue>
  */
 final class Traceable implements Dictionary
 {
     /**
-     * @param Dictionary<E> $dictionary
+     * @param Dictionary<TKey, TValue> $dictionary
      */
     public function __construct(private Dictionary $dictionary, private DictionaryDataCollector $collector)
     {
@@ -68,14 +70,11 @@ public function offsetUnset(mixed $offset): void
         $this->markAsUsed();
     }
 
-    /**
-     * @return Dictionary<E>
-     */
-    public function getIterator(): Dictionary
+    public function getIterator(): Traversable
     {
         $this->markAsUsed();
 
-        return $this->dictionary;
+        yield from $this->dictionary;
     }
 
     public function count(): int
diff --git a/src/Knp/DictionaryBundle/Dictionary/Wrapper.php b/src/Knp/DictionaryBundle/Dictionary/Wrapper.php
@@ -5,16 +5,18 @@
 namespace Knp\DictionaryBundle\Dictionary;
 
 use Knp\DictionaryBundle\Dictionary;
+use Traversable;
 
 /**
- * @template E
+ * @template TKey of (int|string)
+ * @template TValue
  *
- * @implements Dictionary<E>
+ * @implements Dictionary<TKey, TValue>
  */
 abstract class Wrapper implements Dictionary
 {
     /**
-     * @param Dictionary<E> $wrapped
+     * @param Dictionary<TKey, TValue> $wrapped
      */
     public function __construct(private Dictionary $wrapped)
     {
@@ -60,11 +62,8 @@ public function count(): int
         return $this->wrapped->count();
     }
 
-    /**
-     * @return Dictionary<E>
-     */
-    public function getIterator(): Dictionary
+    public function getIterator(): Traversable
     {
-        return $this->wrapped;
+        yield from $this->wrapped;
     }
 }
diff --git a/src/Knp/DictionaryBundle/ValueTransformer/Constant.php b/src/Knp/DictionaryBundle/ValueTransformer/Constant.php
@@ -35,6 +35,9 @@ public function supports(mixed $value): bool
         return \array_key_exists($matches['constant'], $constants);
     }
 
+    /**
+     * @param string $value
+     */
     public function transform(mixed $value)
     {
         if (null === $matches = $this->extract($value)) {

Original file line number	Diff line number	Diff line change
`@@ -32,12 +32,12 @@ protected function matches($subject, array $arguments): bool`
`32`	`32`	`}`
`33`	`33`
`34`	`34`	`/**`
`35`		`- * @param mixed $subject`
	`35`	`+ * @param string $subject`
`36`	`36`	`* @param mixed[] $arguments`
`37`	`37`	`*/`
`38`	`38`	`protected function getFailureException(string $name, $subject, array $arguments): FailureException`
`39`	`39`	`{`
`40`		`- if (1 === \count($arguments) && \is_array(current($arguments))) {`
	`40`	`+ if ([] !== \count($arguments) && \is_array(current($arguments))) {`
`41`	`41`	`$arguments = current($arguments);`
`42`	`42`	`}`
`43`	`43`
`@@ -51,12 +51,12 @@ protected function getFailureException(string $name, $subject, array $arguments)`
`51`	`51`	`}`
`52`	`52`
`53`	`53`	`/**`
`54`		`- * @param mixed $subject`
	`54`	`+ * @param string $subject`
`55`	`55`	`* @param mixed[] $arguments`
`56`	`56`	`*/`
`57`	`57`	`protected function getNegativeFailureException(string $name, $subject, array $arguments): FailureException`
`58`	`58`	`{`
`59`		`- if (1 === \count($arguments) && \is_array(current($arguments))) {`
	`59`	`+ if ([] !== \count($arguments) && \is_array(current($arguments))) {`
`60`	`60`	`$arguments = current($arguments);`
`61`	`61`	`}`
`62`	`62`
Original file line number	Diff line number	Diff line change
`@@ -9,10 +9,11 @@`
`9`	`9`	`use IteratorAggregate;`
`10`	`10`
`11`	`11`	`/**`
`12`		`- * @template E`
	`12`	`+ * @template TKey of (int\|string)`
	`13`	`+ * @template TValue`
`13`	`14`	`*`
`14`		`- * @extends IteratorAggregate<mixed, E>`
`15`		`- * @extends ArrayAccess<mixed, E>`
	`15`	`+ * @extends IteratorAggregate<TKey, TValue>`
	`16`	`+ * @extends ArrayAccess<TKey, TValue>`
`16`	`17`	`*/`
`17`	`18`	`interface Dictionary extends ArrayAccess, Countable, IteratorAggregate`
`18`	`19`	`{`
Original file line number	Diff line number	Diff line change
`@@ -7,14 +7,15 @@`
`7`	`7`	`use Knp\DictionaryBundle\Dictionary;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * @template E`
	`10`	`+ * @template TKey of (int\|string)`
	`11`	`+ * @template TValue`
`11`	`12`	`*`
`12`		`- * @extends Wrapper<E>`
	`13`	`+ * @extends Wrapper<TKey, TValue>`
`13`	`14`	`*/`
`14`	`15`	`final class Combined extends Wrapper`
`15`	`16`	`{`
`16`	`17`	`/**`
`17`		`- * @param Dictionary<E> ...$dictionaries`
	`18`	`+ * @param Dictionary<TKey, TValue> ...$dictionaries`
`18`	`19`	`*/`
`19`	`20`	`public function __construct(string $name, Dictionary ...$dictionaries)`
`20`	`21`	`{`
`@@ -32,10 +33,10 @@ public function __construct(string $name, Dictionary ...$dictionaries)`
`32`	`33`	`}`
`33`	`34`
`34`	`35`	`/**`
`35`		`- * @param E[] $array1`
`36`		`- * @param E[] $array2`
	`36`	`+ * @param array<TKey, TValue> $array1`
	`37`	`+ * @param array<TKey, TValue> $array2`
`37`	`38`	`*`
`38`		`- * @return E[]`
	`39`	`+ * @return array<TKey, TValue>`
`39`	`40`	`*/`
`40`	`41`	`private function merge(array $array1, array $array2): array`
`41`	`42`	`{`
Original file line number	Diff line number	Diff line change
`@@ -11,7 +11,7 @@ interface Factory`
`11`	`11`	`/**`
`12`	`12`	`* @param mixed[] $config`
`13`	`13`	`*`
`14`		`- * @return Dictionary<mixed>`
	`14`	`+ * @return Dictionary<int\|string, mixed>`
`15`	`15`	`*/`
`16`	`16`	`public function create(string $name, array $config): Dictionary;`
`17`	`17`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public function create(string $name, array $config): Dictionary`
`30`	`30`	`}`
`31`	`31`
`32`	`32`	`$dictionaries = array_map(`
`33`		`- fn ($name): Dictionary => $this->dictionaries[$name],`
	`33`	`+ fn (string $name): Dictionary => $this->dictionaries[$name],`
`34`	`34`	`$config['dictionaries']`
`35`	`35`	`);`
`36`	`36`
Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,8 @@ public function __construct(private ContainerInterface $container)`
`19`	`19`	`/**`
`20`	`20`	`* {@inheritdoc}`
`21`	`21`	`*`
	`22`	`+ * @param array{service?: string} $config`
	`23`	`+ *`
`22`	`24`	`* @throw InvalidArgumentException if there is some problem with the config.`
`23`	`25`	`*/`
`24`	`26`	`public function create(string $name, array $config): Dictionary`
Original file line number	Diff line number	Diff line change
`@@ -18,6 +18,7 @@ public function __construct(private ValueTransformer $transformer)`
`18`	`18`
`19`	`19`	`/**`
`20`	`20`	`* {@inheritdoc}`
	`21`	`+ * @param array{content?: array<mixed>} $config`
`21`	`22`	`*`
`22`	`23`	`* @throw InvalidArgumentException if there is some problem with the config.`
`23`	`24`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -7,14 +7,15 @@`
`7`	`7`	`use Traversable;`
`8`	`8`
`9`	`9`	`/**`
`10`		`- * @template E`
	`10`	`+ * @template TKey of (int\|string)`
	`11`	`+ * @template TValue`
`11`	`12`	`*`
`12`		`- * @extends Wrapper<E>`
	`13`	`+ * @extends Wrapper<TKey, TValue>`
`13`	`14`	`*/`
`14`	`15`	`final class Iterator extends Wrapper`
`15`	`16`	`{`
`16`	`17`	`/**`
`17`		`- * @param Traversable<mixed, E> $iterator`
	`18`	`+ * @param Traversable<TKey, TValue> $iterator`
`18`	`19`	`*/`
`19`	`20`	`public function __construct(string $name, Traversable $iterator)`
`20`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,15 @@`
`8`	`8`	`use Knp\DictionaryBundle\Dictionary;`
`9`	`9`
`10`	`10`	`/**`
`11`		`- * @template E`
	`11`	`+ * @template TKey of (int\|string)`
	`12`	`+ * @template TValue`
`12`	`13`	`*`
`13`		`- * @implements Dictionary<E>`
	`14`	`+ * @implements Dictionary<TKey, TValue>`
`14`	`15`	`*/`
`15`	`16`	`final class Simple implements Dictionary`
`16`	`17`	`{`
`17`	`18`	`/**`
`18`		`- * @param array<mixed, E> $values`
	`19`	`+ * @param array<TKey, TValue> $values`
`19`	`20`	`*/`
`20`	`21`	`public function __construct(private string $name, private array $values)`
`21`	`22`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,16 +6,18 @@`
`6`	`6`
`7`	`7`	`use Knp\DictionaryBundle\DataCollector\DictionaryDataCollector;`
`8`	`8`	`use Knp\DictionaryBundle\Dictionary;`
	`9`	`+use Traversable;`
`9`	`10`
`10`	`11`	`/**`
`11`		`- * @template E of mixed`
	`12`	`+ * @template TKey of (int\|string)`
	`13`	`+ * @template TValue`
`12`	`14`	`*`
`13`		`- * @implements Dictionary<E>`
	`15`	`+ * @implements Dictionary<TKey, TValue>`
`14`	`16`	`*/`
`15`	`17`	`final class Traceable implements Dictionary`
`16`	`18`	`{`
`17`	`19`	`/**`
`18`		`- * @param Dictionary<E> $dictionary`
	`20`	`+ * @param Dictionary<TKey, TValue> $dictionary`
`19`	`21`	`*/`
`20`	`22`	`public function __construct(private Dictionary $dictionary, private DictionaryDataCollector $collector)`
`21`	`23`	`{`
`@@ -68,14 +70,11 @@ public function offsetUnset(mixed $offset): void`
`68`	`70`	`$this->markAsUsed();`
`69`	`71`	`}`
`70`	`72`
`71`		`- /**`
`72`		`- * @return Dictionary<E>`
`73`		`- */`
`74`		`- public function getIterator(): Dictionary`
	`73`	`+ public function getIterator(): Traversable`
`75`	`74`	`{`
`76`	`75`	`$this->markAsUsed();`
`77`	`76`
`78`		`- return $this->dictionary;`
	`77`	`+ yield from $this->dictionary;`
`79`	`78`	`}`
`80`	`79`
`81`	`80`	`public function count(): int`