Permit zero hops to allow messages visible only in the current reques…

…t. Ref: mezzio#7 Signed-off-by: Tim Lieberman <[email protected]>
timdev · Apr 1, 2021 · 144602e · 144602e
1 parent 460b5ad
commit 144602e
Show file tree

Hide file tree

Showing 3 changed files with 19 additions and 2 deletions.
diff --git a/src/Exception/InvalidHopsValueException.php b/src/Exception/InvalidHopsValueException.php
@@ -19,7 +19,7 @@ class InvalidHopsValueException extends InvalidArgumentException implements Exce
     public static function valueTooLow(string $key, int $hops): self
     {
         return new self(sprintf(
-            'Hops value specified for flash message "%s" was too low; must be greater than 0, received %d',
+            'Hops value specified for flash message "%s" was too low; must be non-negative, received %d',
             $key,
             $hops
         ));

diff --git a/src/FlashMessages.php b/src/FlashMessages.php
@@ -73,7 +73,7 @@ public static function createFromSession(
      */
     public function flash(string $key, $value, int $hops = 1): void
     {
-        if ($hops < 1) {
+        if ($hops < 0) {
             throw Exception\InvalidHopsValueException::valueTooLow($key, $hops);
         }
 

diff --git a/test/FlashMessagesTest.php b/test/FlashMessagesTest.php
@@ -365,6 +365,23 @@ public function testCreationAggregatesThrowsExceptionIfInvalidNumberOfHops()
                 $this->anything()
             );
 
+        $flash = FlashMessages::createFromSession($this->session);
+        $flash->flashNow('test', 'value', -1);
+    }
+
+    public function testFlashNowAcceptsZeroHops()
+    {
+        $this->session
+            ->expects($this->once())
+            ->method('has')
+            ->with(FlashMessagesInterface::FLASH_NEXT)
+            ->willReturn(false);
+        $this->session
+            ->expects($this->once())
+            ->method('get')
+            ->with(FlashMessagesInterface::FLASH_NEXT, [])
+            ->willReturn([]);
+
         $flash = FlashMessages::createFromSession($this->session);
         $flash->flashNow('test', 'value', 0);
     }