tweak: improve typing

Author: g105b

.github/workflows/ci.yml

@@ -1,19 +1,25 @@
 name: CI
 
-on: [push]
+on:
+  push:
+  pull_request:
+
+permissions:
+  contents: read
+  actions: read
 
 jobs:
   composer:
     runs-on: ubuntu-latest
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3, 8.4 ]
+        php: [ 8.2, 8.3, 8.4, 8.5 ]
 
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v6
 
       - name: Cache Composer dependencies
-        uses: actions/cache@v4
+        uses: actions/cache@v5
         with:
           path: /tmp/composer-cache
           key: ${{ runner.os }}-${{ matrix.php }}-${{ hashFiles('**/composer.lock') }}
@@ -22,22 +28,24 @@ jobs:
         uses: php-actions/composer@v6
         with:
           php_version: ${{ matrix.php }}
+          php_extensions: pcntl
 
       - name: Archive build
-        run: mkdir /tmp/github-actions/ && tar -cvf /tmp/github-actions/build.tar ./
+        run: mkdir /tmp/github-actions/ && tar --exclude=".git" -cvf /tmp/github-actions/build.tar ./
 
       - name: Upload build archive for test runners
         uses: actions/upload-artifact@v4
         with:
           name: build-artifact-${{ matrix.php }}
           path: /tmp/github-actions
+          retention-days: 1
 
   phpunit:
     runs-on: ubuntu-latest
     needs: [ composer ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3, 8.4 ]
+        php: [ 8.2, 8.3, 8.4, 8.5 ]
 
     outputs:
       coverage: ${{ steps.store-coverage.outputs.coverage_text }}
@@ -72,7 +80,7 @@ jobs:
     needs: [ phpunit ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3, 8.4 ]
+        php: [ 8.2, 8.3, 8.4, 8.5 ]
 
     steps:
       - uses: actions/checkout@v4
@@ -87,13 +95,15 @@ jobs:
 
       - name: Upload to Codecov
         uses: codecov/codecov-action@v5
+        with:
+          token: ${{ secrets.CODECOV_TOKEN }}
 
   phpstan:
     runs-on: ubuntu-latest
     needs: [ composer ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3, 8.4 ]
+        php: [ 8.2, 8.3, 8.4, 8.5 ]
 
     steps:
       - uses: actions/download-artifact@v4
@@ -109,13 +119,15 @@ jobs:
         with:
           php_version: ${{ matrix.php }}
           path: src/
+          level: 6
+          memory_limit: 256M
 
   phpmd:
     runs-on: ubuntu-latest
     needs: [ composer ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3, 8.4 ]
+        php: [ 8.2, 8.3, 8.4, 8.5 ]
 
     steps:
       - uses: actions/download-artifact@v4
@@ -139,7 +151,7 @@ jobs:
     needs: [ composer ]
     strategy:
       matrix:
-        php: [ 8.1, 8.2, 8.3, 8.4 ]
+        php: [ 8.2, 8.3, 8.4, 8.5 ]
 
     steps:
       - uses: actions/download-artifact@v4
@@ -156,18 +168,3 @@ jobs:
           php_version: ${{ matrix.php }}
           path: src/
           standard: phpcs.xml
-
-  remove_old_artifacts:
-    runs-on: ubuntu-latest
-
-    steps:
-      - name: Remove old artifacts for prior workflow runs on this repository
-        env:
-          GH_TOKEN: ${{ github.token }}
-        run: |
-          gh api "/repos/${{ github.repository }}/actions/artifacts?name=build-artifact" | jq ".artifacts[] | select(.name | startswith(\"build-artifact\")) | .id" > artifact-id-list.txt
-          while read id
-          do
-            echo -n "Deleting artifact ID $id ... "
-            gh api --method DELETE /repos/${{ github.repository }}/actions/artifacts/$id && echo "Done"
-          done <artifact-id-list.txt

composer.json

@@ -15,6 +15,20 @@
 		"squizlabs/php_codesniffer": "^3.7 || ^4.0"
 	},
 
+	"scripts": {
+		"phpunit": "vendor/bin/phpunit --configuration phpunit.xml",
+		"phpunit:coverage": "XDEBUG_MODE=coverage vendor/bin/phpunit --configuration phpunit.xml --coverage-text",
+		"phpstan": "vendor/bin/phpstan analyse --level 6 src --memory-limit 256M",
+		"phpcs": "vendor/bin/phpcs src --standard=phpcs.xml",
+		"phpmd": "vendor/bin/phpmd src/ text phpmd.xml",
+		"test": [
+			"@phpunit",
+			"@phpstan",
+			"@phpcs",
+			"@phpmd"
+		]
+	},
+
 	"license": "MIT",
 	"authors": [
 		{

example/02-class.php

@@ -0,0 +1,12 @@
+<?php
+require __DIR__ . "/../vendor/autoload.php";
+
+use Gt\FileCache\Cache;
+
+$fileCache = new Cache("/tmp/phpgt-filecache-datetime");
+
+$dateTime = $fileCache->getInstance("current-date", DateTime::class, static function(): DateTime {
+	return new DateTime();
+});
+
+echo $dateTime->format(DateTimeInterface::ATOM) . PHP_EOL;

src/Cache.php

@@ -64,6 +64,7 @@ public function getDateTime(string $name, callable $callback):DateTimeInterface
 		return new DateTimeImmutable($value);
 	}
 
+	/** @return array<mixed> */
 	public function getArray(string $name, callable $callback):array {
 		$value = $this->get($name, $callback);
 		if(!is_array($value)) {
@@ -74,16 +75,17 @@ public function getArray(string $name, callable $callback):array {
 	}
 
 	/**
-	 * @template T
-	 * @param class-string<T> $className
-	 * @return array<T>
+	 * @template TObject of object
+	 * @param class-string<TObject>|"int"|"integer"|"float"|"double"|"string"|"bool"|"boolean" $className
+	 * @phpstan-return ($className is class-string<TObject> ? array<TObject> : ($className is "int"|"integer" ? array<int> : ($className is "float"|"double" ? array<float> : ($className is "string" ? array<string> : array<bool>))))
 	 */
 	public function getTypedArray(string $name, string $className, callable $callback):array {
 		$array = $this->get($name, $callback);
 		if(!is_array($array)) {
 			throw new TypeError("Data '$name' is not an array");
 		}
 
+		/** @var array<int|string, mixed> $array */
 		foreach($array as $key => $value) {
 			$array[$key] = $this->validateAndConvertValue($value, $className, $key);
 		}
@@ -92,11 +94,11 @@ public function getTypedArray(string $name, string $className, callable $callbac
 	}
 
 	/**
-	 * @template T
+	 * @template TObject of object
 	 * @param mixed $value
-	 * @param class-string<T> $className
+	 * @param class-string<TObject>|"int"|"integer"|"float"|"double"|"string"|"bool"|"boolean" $className
 	 * @param string|int $key
-	 * @return T
+	 * @phpstan-return ($className is class-string<TObject> ? TObject : ($className is "int"|"integer" ? int : ($className is "float"|"double" ? float : ($className is "string" ? string : bool))))
 	 */
 	private function validateAndConvertValue(mixed $value, string $className, string|int $key): mixed {
 		return match(strtolower($className)) {
@@ -159,11 +161,11 @@ private function convertToBool(mixed $value): bool {
 	}
 
 	/**
-	 * @template T
+	 * @template TObject of object
 	 * @param mixed $value
-	 * @param class-string<T> $className
+	 * @param class-string<TObject> $className
 	 * @param string|int $key
-	 * @return T
+	 * @return TObject
 	 */
 	private function validateInstance(mixed $value, string $className, string|int $key): object {
 		if($value instanceof $className) {
@@ -174,16 +176,17 @@ private function validateInstance(mixed $value, string $className, string|int $k
 	}
 
 	/**
-	 * @template T
+	 * @template T of object
 	 * @param class-string<T> $className
 	 * @return T
 	 */
 	public function getInstance(string $name, string $className, callable $callback):object {
 		$value = $this->get($name, $callback);
-		if(get_class($value) !== $className) {
+		if(!$value instanceof $className) {
 			throw new TypeError("Value is not an instance of $className");
 		}
 
+		/** @var T $value */
 		return $value;
 	}
 }