Lower ErrorLevel for Psalm, fix issues (#73)

Fantom409 · web-flow · commit ab102cc54985 · 2020-12-09T02:46:35.000+03:00
diff --git a/composer.json b/composer.json
@@ -28,7 +28,7 @@
         "phpunit/phpunit": "^9.4",
         "roave/infection-static-analysis-plugin": "^1.5",
         "spatie/phpunit-watcher": "^1.23",
-        "vimeo/psalm": "^4.2"
+        "vimeo/psalm": "^4.3"
     },
     "suggest": {
         "yiisoft/cache-wincache": "To store cache using WinCache PECL extension",
diff --git a/psalm.xml b/psalm.xml
@@ -1,6 +1,6 @@
 <?xml version="1.0"?>
 <psalm
-    errorLevel="6"
+    errorLevel="2"
     resolveFromConfigFile="true"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns="https://getpsalm.org/schema/config"
diff --git a/src/ArrayCache.php b/src/ArrayCache.php
@@ -21,10 +21,17 @@ final class ArrayCache implements CacheInterface
 
     private array $cache = [];
 
+    /**
+     * @param string $key
+     * @param mixed $default
+     *
+     * @return mixed|null
+     */
     public function get($key, $default = null)
     {
         $this->validateKey($key);
         if (isset($this->cache[$key]) && !$this->isExpired($key)) {
+            /** @var mixed */
             $value = $this->cache[$key][0];
             if (is_object($value)) {
                 $value = clone $value;
@@ -145,7 +152,6 @@ private function ttlToExpiration($ttl): int
      * @param DateInterval|int|string|null $ttl raw TTL.
      *
      * @return int|null TTL value as UNIX timestamp or null meaning infinity
-     * @suppress PhanPossiblyFalseTypeReturn
      */
     private function normalizeTtl($ttl): ?int
     {
@@ -163,21 +169,23 @@ private function normalizeTtl($ttl): ?int
     /**
      * Converts iterable to array. If provided value is not iterable it throws an InvalidArgumentException
      *
-     * @param $iterable
+     * @param iterable $iterable
      *
      * @return array
      */
     private function iterableToArray($iterable): array
     {
+        /** @psalm-suppress DocblockTypeContradiction */
         if (!is_iterable($iterable)) {
             throw new InvalidArgumentException('Iterable is expected, got ' . gettype($iterable));
         }
 
+        /** @psalm-suppress RedundantCast */
         return $iterable instanceof \Traversable ? iterator_to_array($iterable) : (array)$iterable;
     }
 
     /**
-     * @param $key
+     * @param mixed $key
      */
     private function validateKey($key): void
     {
diff --git a/src/Cache.php b/src/Cache.php
@@ -143,7 +143,7 @@ public function set($key, $value, $ttl = null, Dependency $dependency = null): b
      * If the cache already contains such a key, the existing value and
      * expiration time will be replaced with the new ones, respectively.
      *
-     * @param array $values the values to be cached, as key-value pairs.
+     * @param iterable $values the values to be cached, as key-value pairs.
      * @param \DateInterval|int|null $ttl the TTL value of this value. If not set, default value is used.
      * @param Dependency|null $dependency dependency of the cached values. If the dependency changes,
      * the corresponding values in the cache will be invalidated when it is fetched via {@see CacheInterface::get()}.
@@ -362,6 +362,7 @@ protected function normalizeTtl($ttl): ?int
      */
     private function iterableToArray(iterable $iterable): array
     {
+        /** @psalm-suppress RedundantCast */
         return $iterable instanceof \Traversable ? iterator_to_array($iterable) : (array)$iterable;
     }
 
diff --git a/src/Dependency/AllDependencies.php b/src/Dependency/AllDependencies.php
@@ -16,7 +16,7 @@ class AllDependencies extends Dependency
     /**
      * @var Dependency[]
      */
-    private $dependencies;
+    private array $dependencies;
 
     /**
      * @param Dependency[] $dependencies list of dependencies that this dependency is composed of.
@@ -38,7 +38,6 @@ public function evaluateDependency(CacheInterface $cache): void
      * @codeCoverageIgnore method is not used
      *
      * @param CacheInterface $cache
-     * @suppress PhanUnusedProtectedMethodParameter
      */
     protected function generateDependencyData(CacheInterface $cache)
     {
diff --git a/src/Dependency/AnyDependency.php b/src/Dependency/AnyDependency.php
@@ -16,7 +16,7 @@ class AnyDependency extends Dependency
     /**
      * @var Dependency[]
      */
-    private $dependencies;
+    private array $dependencies;
 
     /**
      * @param Dependency[] $dependencies list of dependencies that this dependency is composed of.
@@ -38,7 +38,6 @@ public function evaluateDependency(CacheInterface $cache): void
      * @codeCoverageIgnore method is not used
      *
      * @param CacheInterface $cache
-     * @suppress PhanUnusedProtectedMethodParameter
      */
     protected function generateDependencyData(CacheInterface $cache)
     {
diff --git a/src/Dependency/CallbackDependency.php b/src/Dependency/CallbackDependency.php
@@ -25,7 +25,6 @@ public function __construct(callable $callback)
      * @param CacheInterface $cache
      *
      * @return mixed
-     * @suppress PhanUnusedProtectedMethodParameter
      */
     protected function generateDependencyData(CacheInterface $cache)
     {
diff --git a/src/Dependency/Dependency.php b/src/Dependency/Dependency.php
@@ -26,12 +26,12 @@ abstract class Dependency
      * to use the same cache dependency for multiple separate cache calls while generating the same
      * page without an overhead of re-evaluating dependency data each time. Defaults to false.
      */
-    protected $isReusable = false;
+    protected bool $isReusable = false;
 
     /**
      * @var array static storage of cached data for reusable dependencies.
      */
-    private static $reusableData = [];
+    private static array $reusableData = [];
 
     /**
      * Changes dependency behavior so dependent data for this cache dependency will be generated only once per request.
@@ -117,6 +117,7 @@ protected function generateReusableHash(): string
      */
     protected function iterableToArray(iterable $iterable): array
     {
+        /** @psalm-suppress RedundantCast */
         return $iterable instanceof \Traversable ? iterator_to_array($iterable) : (array)$iterable;
     }
 
diff --git a/src/Dependency/FileDependency.php b/src/Dependency/FileDependency.php
@@ -14,7 +14,7 @@
  */
 final class FileDependency extends Dependency
 {
-    private $fileName;
+    private string $fileName;
 
     /**
      * @param string $fileName the file path whose last modification time is used to
@@ -29,8 +29,6 @@ public function __construct(string $fileName)
      * @param CacheInterface $cache
      *
      * @return false|int|mixed
-     * @suppress PhanUnusedProtectedMethodParameter
-     * @suppress PhanUnusedProtectedFinalMethodParameter
      */
     protected function generateDependencyData(CacheInterface $cache)
     {
diff --git a/src/Dependency/TagDependency.php b/src/Dependency/TagDependency.php
@@ -26,7 +26,7 @@ final class TagDependency extends Dependency
     /**
      * @var array a list of tag names for this dependency
      */
-    private $tags;
+    private array $tags;
 
     /**
      * @param array|string $tags a list of tag names for this dependency. For a single tag, you may specify it as a string
diff --git a/src/Exception/SetCacheException.php b/src/Exception/SetCacheException.php
@@ -8,23 +8,25 @@
 
 final class SetCacheException extends CacheException
 {
-    /**
-     * @var string
-     */
-    private $key;
+    /** @var string $key */
+    private string $key;
+    /** @var mixed $value */
     private $value;
 
     /**
      * @var CacheInterface
      */
-    private $cache;
+    private CacheInterface $cache;
 
+    /**
+     * @param mixed $value
+     */
     public function __construct(
         string $key,
         $value,
         CacheInterface $cache,
-        $message = 'Could not store the value in the cache',
-        $code = 0,
+        string $message = 'Could not store the value in the cache',
+        int $code = 0,
         \Throwable $previous = null
     ) {
         $this->key = $key;
diff --git a/src/NullCache.php b/src/NullCache.php
@@ -12,12 +12,10 @@
  *
  * By replacing it with some other cache component, one can quickly switch from
  * non-caching mode to caching mode.
- *
- * @phan-file-suppress PhanUnusedPublicFinalMethodParameter
  */
 final class NullCache implements CacheInterface
 {
-    public function add($key, $value, $ttl = 0, Dependency $dependency = null): bool
+    public function add(string $key, $value, $ttl = 0, Dependency $dependency = null): bool
     {
         $this->validateKey($key);
         return true;
@@ -63,7 +61,7 @@ public function addMultiple(array $values, $ttl = null, Dependency $dependency =
         return true;
     }
 
-    public function getOrSet($key, callable $callable, $ttl = null, Dependency $dependency = null)
+    public function getOrSet(string $key, callable $callable, $ttl = null, Dependency $dependency = null)
     {
         $this->validateKey($key);
         return $callable($this);
@@ -103,6 +101,7 @@ public function setKeyPrefix(string $keyPrefix): void
 
     private function iterableToArray(iterable $iterable): array
     {
+        /** @psalm-suppress RedundantCast */
         return $iterable instanceof \Traversable ? iterator_to_array($iterable) : (array)$iterable;
     }
 

Original file line number	Diff line number	Diff line change
`@@ -21,10 +21,17 @@ final class ArrayCache implements CacheInterface`
`21`	`21`
`22`	`22`	`private array $cache = [];`
`23`	`23`
	`24`	`+ /**`
	`25`	`+ * @param string $key`
	`26`	`+ * @param mixed $default`
	`27`	`+ *`
	`28`	`+ * @return mixed\|null`
	`29`	`+ */`
`24`	`30`	`public function get($key, $default = null)`
`25`	`31`	`{`
`26`	`32`	`$this->validateKey($key);`
`27`	`33`	`if (isset($this->cache[$key]) && !$this->isExpired($key)) {`
	`34`	`+ /** @var mixed */`
`28`	`35`	`$value = $this->cache[$key][0];`
`29`	`36`	`if (is_object($value)) {`
`30`	`37`	`$value = clone $value;`
`@@ -145,7 +152,6 @@ private function ttlToExpiration($ttl): int`
`145`	`152`	`* @param DateInterval\|int\|string\|null $ttl raw TTL.`
`146`	`153`	`*`
`147`	`154`	`* @return int\|null TTL value as UNIX timestamp or null meaning infinity`
`148`		`- * @suppress PhanPossiblyFalseTypeReturn`
`149`	`155`	`*/`
`150`	`156`	`private function normalizeTtl($ttl): ?int`
`151`	`157`	`{`
`@@ -163,21 +169,23 @@ private function normalizeTtl($ttl): ?int`
`163`	`169`	`/**`
`164`	`170`	`* Converts iterable to array. If provided value is not iterable it throws an InvalidArgumentException`
`165`	`171`	`*`
`166`		`- * @param $iterable`
	`172`	`+ * @param iterable $iterable`
`167`	`173`	`*`
`168`	`174`	`* @return array`
`169`	`175`	`*/`
`170`	`176`	`private function iterableToArray($iterable): array`
`171`	`177`	`{`
	`178`	`+ /** @psalm-suppress DocblockTypeContradiction */`
`172`	`179`	`if (!is_iterable($iterable)) {`
`173`	`180`	`throw new InvalidArgumentException('Iterable is expected, got ' . gettype($iterable));`
`174`	`181`	`}`
`175`	`182`
	`183`	`+ /** @psalm-suppress RedundantCast */`
`176`	`184`	`return $iterable instanceof \Traversable ? iterator_to_array($iterable) : (array)$iterable;`
`177`	`185`	`}`
`178`	`186`
`179`	`187`	`/**`
`180`		`- * @param $key`
	`188`	`+ * @param mixed $key`
`181`	`189`	`*/`
`182`	`190`	`private function validateKey($key): void`
`183`	`191`	`{`
Original file line number	Diff line number	Diff line change
`@@ -143,7 +143,7 @@ public function set($key, $value, $ttl = null, Dependency $dependency = null): b`
`143`	`143`	`* If the cache already contains such a key, the existing value and`
`144`	`144`	`* expiration time will be replaced with the new ones, respectively.`
`145`	`145`	`*`
`146`		`- * @param array $values the values to be cached, as key-value pairs.`
	`146`	`+ * @param iterable $values the values to be cached, as key-value pairs.`
`147`	`147`	`* @param \DateInterval\|int\|null $ttl the TTL value of this value. If not set, default value is used.`
`148`	`148`	`* @param Dependency\|null $dependency dependency of the cached values. If the dependency changes,`
`149`	`149`	`* the corresponding values in the cache will be invalidated when it is fetched via {@see CacheInterface::get()}.`
`@@ -362,6 +362,7 @@ protected function normalizeTtl($ttl): ?int`
`362`	`362`	`*/`
`363`	`363`	`private function iterableToArray(iterable $iterable): array`
`364`	`364`	`{`
	`365`	`+ /** @psalm-suppress RedundantCast */`
`365`	`366`	`return $iterable instanceof \Traversable ? iterator_to_array($iterable) : (array)$iterable;`
`366`	`367`	`}`
`367`	`368`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,6 @@ public function __construct(callable $callback)`
`25`	`25`	`* @param CacheInterface $cache`
`26`	`26`	`*`
`27`	`27`	`* @return mixed`
`28`		`- * @suppress PhanUnusedProtectedMethodParameter`
`29`	`28`	`*/`
`30`	`29`	`protected function generateDependencyData(CacheInterface $cache)`
`31`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`*/`
`15`	`15`	`final class FileDependency extends Dependency`
`16`	`16`	`{`
`17`		`- private $fileName;`
	`17`	`+ private string $fileName;`
`18`	`18`
`19`	`19`	`/**`
`20`	`20`	`* @param string $fileName the file path whose last modification time is used to`
`@@ -29,8 +29,6 @@ public function __construct(string $fileName)`
`29`	`29`	`* @param CacheInterface $cache`
`30`	`30`	`*`
`31`	`31`	`* @return false\|int\|mixed`
`32`		`- * @suppress PhanUnusedProtectedMethodParameter`
`33`		`- * @suppress PhanUnusedProtectedFinalMethodParameter`
`34`	`32`	`*/`
`35`	`33`	`protected function generateDependencyData(CacheInterface $cache)`
`36`	`34`	`{`