Merge pull request #2 from PhpGt/1-typesafegetter

Type safety

Author: Greg Bowler

composer.json

@@ -4,7 +4,8 @@
 	"type": "library",
 
 	"require": {
-		"php": ">=8.1"
+		"php": ">=8.1",
+		"phpgt/typesafegetter": "^v1.2.4"
 	},
 
 	"require-dev": {

composer.lock

@@ -1,7 +1,13 @@
 <?php
 namespace Gt\FileCache;
 
-class Cache {
+use DateTimeImmutable;
+use DateTimeInterface;
+use Gt\TypeSafeGetter\CallbackTypeSafeGetter;
+use TypeError;
+
+class Cache implements CallbackTypeSafeGetter {
+	const DEFAULT_SECONDS_VALID = 60 * 60; // 1 hour of validity.
 	private FileAccess $fileAccess;
 
 	public function __construct(
@@ -17,7 +23,7 @@ public function __construct(
 	public function get(
 		string $name,
 		callable $callback,
-		int $secondsValid = 60 * 60 // 1 hour of validity
+		int $secondsValid = self::DEFAULT_SECONDS_VALID
 	):mixed {
 		try {
 			$this->fileAccess->checkValidity($name, $secondsValid);
@@ -29,4 +35,48 @@ public function get(
 			return $value;
 		}
 	}
+
+	public function getString(string $name, callable $callback, int $secondsValid = self::DEFAULT_SECONDS_VALID):string {
+		return (string)$this->get($name, $callback, $secondsValid);
+	}
+
+	public function getInt(string $name, callable $callback, int $secondsValid = self::DEFAULT_SECONDS_VALID):int {
+		return (int)$this->get($name, $callback, $secondsValid);
+	}
+
+	public function getFloat(string $name, callable $callback, int $secondsValid = self::DEFAULT_SECONDS_VALID):float {
+		return (float)$this->get($name, $callback, $secondsValid);
+	}
+
+	public function getBool(string $name, callable $callback, int $secondsValid = self::DEFAULT_SECONDS_VALID):bool {
+		return (bool)$this->get($name, $callback, $secondsValid);
+	}
+
+	public function getDateTime(string $name, callable $callback, int $secondsValid = self::DEFAULT_SECONDS_VALID):DateTimeInterface {
+		$value = $this->get($name, $callback, $secondsValid);
+		if($value instanceof DateTimeInterface) {
+			return $value;
+		}
+		elseif(is_int($value)) {
+			$dt = new DateTimeImmutable();
+			return $dt->setTimestamp($value);
+		}
+
+		return new DateTimeImmutable($value);
+	}
+
+	/**
+	 * @template T
+	 * @param class-string<T> $className
+	 * @return T
+	 */
+	public function getClass(string $className, string $name, callable $callback, int $secondsValid = self::DEFAULT_SECONDS_VALID):object {
+		$serialized = $this->get($name, $callback, $secondsValid);
+		$value = unserialize($serialized);
+		if(get_class($value) !== $className) {
+			throw new TypeError("Value is not of type $className");
+		}
+
+		return $value;
+	}
 }

src/Cache.php

@@ -2,18 +2,24 @@
 namespace Gt\FileCache\Test;
 
 use Gt\FileCache\Cache;
+use Gt\FileCache\FileAccess;
 use PHPUnit\Framework\TestCase;
+use stdClass;
 
 class CacheTest extends TestCase {
+	public function tearDown():void {
+		exec("rm -rf " . sys_get_temp_dir() . "/phpgt-filecache");
+	}
+
 	public function testGet_expectedValueReturned():void {
-		$sut = new Cache(sys_get_temp_dir() . "/phpgt-filecache");
+		$sut = $this->getSut();
 		$value = "test-value";
 		$result = $sut->get("test", fn() => $value);
 		self::assertSame($value, $result);
 	}
 
 	public function testGet_expectedValueReturnedOnMultipleCalls():void {
-		$sut = new Cache(sys_get_temp_dir() . "/phpgt-filecache");
+		$sut = $this->getSut();
 		$value = "test-value";
 		$result = $sut->get("test", fn() => $value);
 		self::assertSame($value, $result);
@@ -22,7 +28,7 @@ public function testGet_expectedValueReturnedOnMultipleCalls():void {
 	}
 
 	public function testGet_multipleCallsDoesNotCallbackMultipleTimes():void {
-		$sut = new Cache(sys_get_temp_dir() . "/phpgt/filecache");
+		$sut = $this->getSut();
 		$name = uniqid("test-");
 		$value = "test-value-123";
 		$count = 0;
@@ -39,4 +45,69 @@ public function testGet_multipleCallsDoesNotCallbackMultipleTimes():void {
 		self::assertSame($value, $result);
 		self::assertSame(1, $count);
 	}
+
+	public function testGetString():void {
+		$value = uniqid();
+		$sut = $this->getSut([
+			"test" => $value,
+		]);
+		self::assertSame($value, $sut->getString("test", fn() => "new"));
+	}
+
+	public function testGetInt():void {
+		$value = (string)rand(100,999);
+		$sut = $this->getSut([
+			"test" => $value,
+		]);
+		self::assertSame((int)$value, $sut->getInt("test", fn() => 2));
+	}
+
+	public function testGetFoat():void {
+		$value = (string)(rand(100,999) * 3.14159);
+		$sut = $this->getSut([
+			"test" => $value,
+		]);
+		self::assertSame((float)$value, $sut->getFloat("test", fn() => 3.141));
+	}
+
+	public function testGetBool():void {
+		$value = "yes";
+		$sut = $this->getSut([
+			"test" => $value,
+		]);
+		self::assertTrue($sut->getBool("test", fn() => false));
+	}
+
+	public function testGetDateTime():void {
+		$value = "1988-04-05";
+		$sut = $this->getSut([
+			"test" => $value,
+		]);
+		self::assertSame($value, $sut->getDateTime("test", fn() => 123)->format("Y-m-d"));
+	}
+
+	public function testGetClass():void {
+		$value = new StdClass();
+		$value->name = uniqid();
+		$sut = $this->getSut([
+			"test" => serialize($value),
+		]);
+		$class = $sut->getClass(StdClass::class, "test", fn() => false);
+		self::assertSame($value->name, $class->name);
+	}
+
+	private function getSut(array $mockFiles = []):Cache {
+		$mockFileAccess = null;
+		if(!empty($mockFiles)) {
+			$mockFileAccess = self::createMock(FileAccess::class);
+			foreach($mockFiles as $key => $value) {
+				$mockFileAccess->method("getData")
+					->with($key)->willReturn($value);
+			}
+		}
+		return new Cache(
+			sys_get_temp_dir() . "/phpgt-filecache",
+			$mockFileAccess,
+		);
+	}
 }