Updates locked deps and solves psalm errors introduced by better type…

…s upstream Signed-off-by: George Steel <george@net-glue.co.uk>
laminas · Jan 10, 2022 · c70b388 · c70b388
1 parent d7f7ee4
commit c70b388
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 56 deletions.
diff --git a/composer.lock b/composer.lock
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<files psalm-version="4.18.0.0">
+<files psalm-version="4.18.1@dda05fa913f4dc6eb3386f2f7ce5a45d37a71bcb">
   <file src="bin/templatemap_generator.php">
     <MissingParamType occurrences="1">
       <code>$templatePath</code>
@@ -2208,35 +2208,24 @@
     </RedundantConditionGivenDocblockType>
   </file>
   <file src="src/Resolver/TemplatePathStack.php">
-    <DocblockTypeContradiction occurrences="2">
-      <code>gettype($options)</code>
+    <DocblockTypeContradiction occurrences="1">
       <code>is_string($path)</code>
     </DocblockTypeContradiction>
     <FalsableReturnStatement occurrences="2">
       <code>false</code>
       <code>false</code>
     </FalsableReturnStatement>
-    <MixedArgument occurrences="7">
-      <code>$key</code>
-      <code>$path</code>
-      <code>$path</code>
+    <MixedArgument occurrences="4">
       <code>$value</code>
       <code>$value</code>
       <code>$value</code>
       <code>$value</code>
     </MixedArgument>
-    <MixedAssignment occurrences="6">
-      <code>$key</code>
-      <code>$path</code>
-      <code>$path</code>
+    <MixedAssignment occurrences="3">
       <code>$this-&gt;lastLookupFailure</code>
       <code>$this-&gt;lastLookupFailure</code>
       <code>$value</code>
     </MixedAssignment>
-    <MixedOperand occurrences="2">
-      <code>$path</code>
-      <code>$path</code>
-    </MixedOperand>
     <NullArgument occurrences="1">
       <code>$this-&gt;paths</code>
     </NullArgument>
@@ -2245,10 +2234,6 @@
       <code>(bool) $flag</code>
       <code>(string) $defaultSuffix</code>
     </RedundantCastGivenDocblockType>
-    <RedundantConditionGivenDocblockType occurrences="2">
-      <code>is_array($paths)</code>
-      <code>is_object($options)</code>
-    </RedundantConditionGivenDocblockType>
   </file>
   <file src="src/Strategy/FeedStrategy.php">
     <MixedAssignment occurrences="1">

diff --git a/src/Resolver/TemplatePathStack.php b/src/Resolver/TemplatePathStack.php
@@ -35,6 +35,8 @@
 
 /**
  * Resolves view scripts based on a stack of paths
+ *
+ * @psalm-type PathStack = SplStack<string>
  */
 class TemplatePathStack implements ResolverInterface
 {
@@ -50,7 +52,7 @@ class TemplatePathStack implements ResolverInterface
      */
     protected $defaultSuffix = 'phtml';
 
-    /** @var SplStack */
+    /** @var PathStack */
     protected $paths;
 
     /**
@@ -81,7 +83,7 @@ class TemplatePathStack implements ResolverInterface
     /**
      * Constructor
      *
-     * @param  null|array|Traversable $options
+     * @param  null|array<string, mixed>|Traversable<string, mixed> $options
      */
     public function __construct($options = null)
     {
@@ -93,7 +95,9 @@ public function __construct($options = null)
             }
         }
 
-        $this->paths = new SplStack();
+        /** @psalm-var PathStack $paths */
+        $paths       = new SplStack();
+        $this->paths = $paths;
         if (null !== $options) {
             $this->setOptions($options);
         }
@@ -102,12 +106,13 @@ public function __construct($options = null)
     /**
      * Configure object
      *
-     * @param  array|Traversable $options
+     * @param  array<string, mixed>|Traversable<string, mixed> $options
      * @return void
      * @throws Exception\InvalidArgumentException
      */
     public function setOptions($options)
     {
+        /** @psalm-suppress DocblockTypeContradiction */
         if (! is_array($options) && ! $options instanceof Traversable) {
             throw new Exception\InvalidArgumentException(sprintf(
                 'Expected array or Traversable object; received "%s"',
@@ -162,7 +167,7 @@ public function getDefaultSuffix()
     /**
      * Add many paths to the stack at once
      *
-     * @param  array $paths
+     * @param  list<string> $paths
      * @return TemplatePathStack
      */
     public function addPaths(array $paths)
@@ -176,24 +181,29 @@ public function addPaths(array $paths)
     /**
      * Rest the path stack to the paths provided
      *
-     * @param  SplStack|array $paths
+     * @param  PathStack|list<string> $paths
      * @return TemplatePathStack
      * @throws Exception\InvalidArgumentException
      */
     public function setPaths($paths)
     {
         if ($paths instanceof SplStack) {
             $this->paths = $paths;
-        } elseif (is_array($paths)) {
+
+            return $this;
+        }
+
+        /** @psalm-suppress RedundantConditionGivenDocblockType */
+        if (is_array($paths)) {
             $this->clearPaths();
             $this->addPaths($paths);
-        } else {
-            throw new Exception\InvalidArgumentException(
-                "Invalid argument provided for \$paths, expecting either an array or SplStack object"
-            );
+
+            return $this;
         }
 
-        return $this;
+        throw new Exception\InvalidArgumentException(
+            "Invalid argument provided for \$paths, expecting either an array or SplStack object"
+        );
     }
 
     /**
@@ -236,13 +246,15 @@ public function addPath($path)
      */
     public function clearPaths()
     {
-        $this->paths = new SplStack();
+        /** @psalm-var PathStack $paths */
+        $paths       = new SplStack();
+        $this->paths = $paths;
     }
 
     /**
      * Returns stack of paths
      *
-     * @return SplStack
+     * @return PathStack
      */
     public function getPaths()
     {

diff --git a/test/Resolver/TemplatePathStackTest.php b/test/Resolver/TemplatePathStackTest.php
@@ -204,7 +204,7 @@ public function testSettingOptionsWithInvalidArgumentRaisesException($options):
     }
 
     /**
-     * @return array<array-key, array{0: mixed[]|ArrayObject}>
+     * @return array<array-key, array{0: array<string, mixed>|ArrayObject<string, mixed>}>
      */
     public function validOptions(): array
     {
@@ -220,7 +220,7 @@ public function validOptions(): array
     }
 
     /**
-     * @param array|ArrayObject $options
+     * @param array<string, mixed>|ArrayObject<string, mixed> $options
      * @dataProvider validOptions
      */
     public function testAllowsSettingOptions($options): void
@@ -239,7 +239,7 @@ public function testAllowsSettingOptions($options): void
     }
 
     /**
-     * @param array|ArrayObject $options
+     * @param array<string, mixed>|ArrayObject<string, mixed> $options
      * @dataProvider validOptions
      */
     public function testAllowsPassingOptionsToConstructor($options): void