[PHPStan] Create PHPStan Extension

composer.json

@@ -4,7 +4,7 @@
     "type": "library",
     "license": "proprietary",
     "config": {
-        "optimize-autoloader": true,
+        "optimize-autoloader": false,
         "preferred-install": "dist",
         "sort-packages": true,
         "allow-plugins": {
@@ -19,6 +19,7 @@
         "ramsey/uuid": "^4.7"
     },
     "require-dev": {
+        "mockery/mockery": "^1.6",
         "pestphp/pest": "^2.34 || ^3.0",
         "phpstan/extension-installer": "^1.3",
         "phpstan/phpstan": "^1.10",
@@ -45,5 +46,11 @@
         ]
     },
     "minimum-stability": "stable",
-    "extra": {}
+    "extra": {
+        "phpstan": {
+            "includes": [
+                "src/Support/PHPStan/extension.neon"
+            ]
+        }
+    }
 }

src/Support/PHPStan/Rules/Functions/NotNull.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace EncoreDigitalGroup\StdLib\Support\PHPStan\Rules\Functions;
+
+use PhpParser\Node;
+use PHPStan\Analyser\Scope;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Type\BooleanType;
+use PHPStan\Type\DynamicFunctionReturnTypeExtension;
+use PHPStan\Type\Type;
+
+class NotNull implements DynamicFunctionReturnTypeExtension
+{
+    public function isFunctionSupported(FunctionReflection $functionReflection): bool
+    {
+        return $functionReflection->getName() === 'not_null';
+    }
+
+    public function getTypeFromFunctionCall(FunctionReflection $functionReflection, Node\Expr\FuncCall $functionCall, Scope $scope): Type
+    {
+        return new BooleanType();
+    }
+}

src/Support/PHPStan/extension.neon

@@ -0,0 +1,5 @@
+services:
+    -
+        class: EncoreDigitalGroup\StdLib\Support\PHPStan\Rules\TypeSpecifiers\Function_NotNull
+        tags:
+            - phpstan.broker.dynamicFunctionReturnTypeExtension

tests/Unit/PHPStan/Rules/Functions/NotNullTest.php

@@ -0,0 +1,34 @@
+<?php
+
+use EncoreDigitalGroup\StdLib\Support\PHPStan\Rules\Functions\NotNull;
+use PHPStan\Reflection\FunctionReflection;
+use PHPStan\Analyser\Scope;
+use PhpParser\Node;
+use PHPStan\Type\BooleanType;
+
+test('NotNull supports the not_null function', function () {
+    $functionReflection = Mockery::mock(FunctionReflection::class);
+    $functionReflection->shouldReceive('getName')->andReturn('not_null');
+
+    $notNull = new NotNull();
+    expect($notNull->isFunctionSupported($functionReflection))->toBeTrue();
+});
+
+test('NotNull does not support other functions', function () {
+    $functionReflection = Mockery::mock(FunctionReflection::class);
+    $functionReflection->shouldReceive('getName')->andReturn('other_function');
+
+    $notNull = new NotNull();
+    expect($notNull->isFunctionSupported($functionReflection))->toBeFalse();
+});
+
+it('returns BooleanType from function call', function () {
+    $functionReflection = Mockery::mock(FunctionReflection::class);
+    $functionCall = Mockery::mock(Node\Expr\FuncCall::class);
+    $scope = Mockery::mock(Scope::class);
+
+    $notNull = new NotNull();
+    $type = $notNull->getTypeFromFunctionCall($functionReflection, $functionCall, $scope);
+
+    expect($type)->toBeInstanceOf(BooleanType::class);
+});