Upgrade PHPMD CI

.github/workflows/ci.yml

@@ -132,7 +132,7 @@ jobs:
         run: tar -xvf /tmp/github-actions/build.tar ./
 
       - name: PHP Mess Detector
-        uses: php-actions/phpmd@v1
+        uses: php-actions/phpmd@v2
         with:
           php_version: ${{ matrix.php }}
           path: src/

src/Flash.php

@@ -0,0 +1,32 @@
+<?php
+namespace Gt\Session;
+
+use RuntimeException;
+use SplQueue;
+
+class Flash {
+	public function __construct(private readonly SessionStore $session) {}
+
+	public function put(string $name, string $message):void {
+		$queue = $this->session->get("queue.$name");
+		if(!$queue) {
+			$queue = new SplQueue();
+			$this->session->set("queue.$name", $queue);
+		}
+
+		$queue->enqueue(new FlashMessage($name, $message));
+	}
+
+	public function consume(string $name):?FlashMessage {
+		/** @var null|SplQueue $queue */
+		$queue = $this->session->get("queue.$name");
+		try {
+			return $queue->dequeue();
+		}
+		catch(RuntimeException $e) {
+			$this->session->remove("queue.$name");
+			return null;
+		}
+	}
+
+}

src/FlashMessage.php

@@ -0,0 +1,9 @@
+<?php
+namespace Gt\Session;
+
+class FlashMessage {
+	public function __construct(
+		public readonly string $name,
+		public readonly string $message,
+	) {}
+}

src/SessionStore.php

@@ -38,7 +38,11 @@ public function setData(string $key, mixed $value):void {
 	}
 
 	public function getData(string $key):mixed {
-		return $this->offsetGet($key) ?? null;
+		if(!$this->offsetExists($key)) {
+			return null;
+		}
+
+		return $this->offsetGet($key);
 	}
 
 	public function containsData(string $key):bool {

test/FlashTest.php

@@ -0,0 +1,69 @@
+<?php
+
+use Gt\Session\Flash;
+use Gt\Session\FlashMessage;
+use Gt\Session\SessionStore;
+use PHPUnit\Framework\TestCase;
+
+class FlashTest extends TestCase {
+	public function testPut():void {
+		$sessionStore = self::createMock(SessionStore::class);
+		$sessionStore->expects(self::once())
+			->method("get")
+			->with("queue.test")
+			->willReturn(null);
+		$sessionStore->expects(self::once())
+			->method("set")
+			->with(
+				self::equalTo("queue.test"),
+				self::isInstanceOf(SplQueue::class)
+			);
+
+		$sut = new Flash($sessionStore);
+		$sut->put("test", "Test message");
+	}
+
+	public function testConsume_none():void {
+		$queue = self::createMock(SplQueue::class);
+		$queue->expects(self::once())
+			->method("dequeue")
+			->willThrowException(new RuntimeException("Can't shift from an empty datastructure"));
+		$sessionStore = self::createMock(SessionStore::class);
+		$sessionStore->expects(self::once())
+			->method("get")
+			->with("queue.test")
+			->willReturn($queue);
+		$sut = new Flash($sessionStore);
+		$flashMessage = $sut->consume("test");
+		self::assertNull($flashMessage);
+	}
+
+	public function testConsume():void {
+		$fm1 = new FlashMessage("test", "First");
+		$fm2 = new FlashMessage("test", "Second");
+
+		$queue = self::createMock(SplQueue::class);
+		$queue->expects(self::exactly(3))
+			->method("dequeue")
+			->willReturnOnConsecutiveCalls($fm1, $fm2);
+
+		$sessionStore = self::createMock(SessionStore::class);
+		$sessionStore->expects(self::exactly(3))
+			->method("get")
+			->with("queue.test")
+			->willReturn($queue);
+		$sessionStore->expects(self::once())
+			->method("remove")
+			->with("queue.test");
+		$sut = new Flash($sessionStore);
+
+		$flashMessage = $sut->consume("test");
+		self::assertInstanceOf(FlashMessage::class, $flashMessage);
+		self::assertSame("First", $flashMessage->message);
+		$flashMessage = $sut->consume("test");
+		self::assertInstanceOf(FlashMessage::class, $flashMessage);
+		self::assertSame("Second", $flashMessage->message);
+		$flashMessage = $sut->consume("test");
+		self::assertNull($flashMessage);
+	}
+}