Adds support for PHPStan (#24)

Author: JasonTheAdams

.github/workflows/phpstan.yml

@@ -0,0 +1,35 @@
+name: 'PHPStan'
+on:
+  push:
+jobs:
+  phpstan:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 1
+      # ------------------------------------------------------------------------------
+      # Prepare our composer cache directory
+      # ------------------------------------------------------------------------------
+      - name: Get Composer Cache Directory
+        id: get-composer-cache-dir
+        run: |
+          echo "dir=$(composer config cache-files-dir)" >> $GITHUB_OUTPUT
+      - uses: actions/cache@v4
+        id: composer-cache
+        with:
+          path: ${{ steps.get-composer-cache-dir.outputs.dir }}
+          key: ${{ runner.os }}-composer-${{ hashFiles('**/composer.lock') }}
+          restore-keys: |
+            ${{ runner.os }}-composer-
+      # ------------------------------------------------------------------------------
+      # Install dependencies
+      # ------------------------------------------------------------------------------
+      - name: Install dependencies
+        run: composer install --ignore-platform-reqs --no-interaction
+      # ------------------------------------------------------------------------------
+      # Run PHPStan
+      # ------------------------------------------------------------------------------
+      - name: Run PHPStan
+        run: composer phpstan

composer.json

@@ -33,7 +33,8 @@
     "codeception/module-webdriver": "^1.0",
     "codeception/util-universalframework": "^1.0",
     "lucatume/wp-browser": "^3.0.14",
-    "phpunit/phpunit": "~6.0"
+    "phpunit/phpunit": "~6.0",
+    "phpstan/phpstan": "^2.1"
   },
   "autoload": {
     "psr-4": {
@@ -44,5 +45,8 @@
     "psr-4": {
       "StellarWP\\Models\\Tests\\": "tests/_support/Helper/"
     }
+  },
+  "scripts": {
+    "phpstan": "phpstan analyze --memory-limit=512M"
   }
 }

composer.lock

@@ -0,0 +1,7 @@
+parameters:
+	level: max
+	paths:
+		- src
+	excludePaths:
+		- tests
+	treatPhpDocTypesAsCertain: false

phpstan.neon

@@ -3,6 +3,7 @@
 namespace StellarWP\Models;
 
 use InvalidArgumentException;
+use Throwable;
 
 class Config {
 	/**
@@ -11,7 +12,7 @@ class Config {
 	protected static $hookPrefix;
 
 	/**
-	 * @var string
+	 * @var class-string<Throwable>
 	 */
 	protected static $invalidArgumentException = InvalidArgumentException::class;
 
@@ -40,7 +41,7 @@ public static function getHookPrefix(): string {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @return string
+	 * @return class-string<Throwable>
 	 */
 	public static function getInvalidArgumentException(): string {
 		return static::$invalidArgumentException;
@@ -111,9 +112,12 @@ public static function setInvalidArgumentException( string $class ) {
 	 *
 	 * @param string $message
 	 *
-	 * @return void
+	 * @return never
+	 * @throws Throwable
 	 */
 	public static function throwInvalidArgumentException( string $message ): void {
-		throw new static::$invalidArgumentException( $message );
+		/** @var class-string<Throwable> $exceptionClass */
+		$exceptionClass = static::$invalidArgumentException;
+		throw new $exceptionClass( $message );
 	}
 }

src/Models/Config.php

@@ -11,7 +11,7 @@ interface Arrayable {
 	 *
 	 * @since 1.0.0
 	 *
-	 * @return array
+	 * @return array<string,mixed>
 	 */
 	public function toArray() : array;
 }

src/Models/Contracts/Arrayable.php

@@ -44,7 +44,7 @@ public function getAttribute( string $key );
 	 *
 	 * @since 1.0.0
 	 *
-	 * @return array
+	 * @return array<string,mixed>
 	 */
 	public function getDirty() : array;
 
@@ -131,7 +131,7 @@ public static function isPropertyTypeValid( string $key, $value ) : bool;
 	 * @since 2.0.0 changed to static
 	 * @since 1.0.0
 	 *
-	 * @return int[]|string[]
+	 * @return list<string>
 	 */
 	public static function propertyKeys() : array;
 

src/Models/Contracts/Model.php

@@ -11,7 +11,7 @@ interface ModelBuildsFromData {
 	/**
 	 * @since 2.0.0
 	 *
-	 * @param array|object $data
+	 * @param array<string,mixed>|object $data
 	 *
 	 * @return Model
 	 */

src/Models/Contracts/ModelBuildsFromData.php

@@ -7,7 +7,7 @@
 /**
  * @since 1.0.0
  */
-interface ModelCrud {
+interface ModelCrud extends ModelBuildsFromData {
 	/**
 	 * @since 1.0.0
 	 *
@@ -20,7 +20,7 @@ public static function find( $id );
 	/**
 	 * @since 1.0.0
 	 *
-	 * @param array $attributes
+	 * @param array<string,mixed> $attributes
 	 *
 	 * @return Model
 	 */
@@ -43,7 +43,7 @@ public function delete() : bool;
 	/**
 	 * @since 1.0.0
 	 *
-	 * @return ModelQueryBuilder
+	 * @return ModelQueryBuilder<static>
 	 */
 	public static function query();
 }

src/Models/Contracts/ModelCrud.php

@@ -3,15 +3,16 @@
 namespace StellarWP\Models\Contracts;
 
 use StellarWP\Models\ModelFactory;
+use StellarWP\Models\Contracts\ModelCrud;
 
 /**
  * @since 1.0.0
  */
-interface ModelHasFactory {
+interface ModelHasFactory extends ModelCrud {
 	/**
 	 * @since 1.0.0
 	 *
-	 * @return ModelFactory
+	 * @return ModelFactory<static>
 	 */
 	public static function factory();
 }