Merge pull request #5 from olivernybroe/types

Add type checking via phpstan

.gitattributes

@@ -13,3 +13,4 @@
 /art                     export-ignore
 /docs                    export-ignore
 /UPGRADING.md            export-ignore
+/types                   export-ignore

composer.json

@@ -19,6 +19,7 @@
     },
     "require-dev": {
         "pestphp/pest": "^1.20",
+        "phpstan/phpstan": "^1.4",
         "spatie/ray": "^1.28"
     },
     "autoload": {

src/Invader.php

@@ -4,11 +4,19 @@
 
 use ReflectionClass;
 
+/**
+ * @template T of object
+ * @mixin T
+ */
 class Invader
 {
+    /** @var T */
     public object $obj;
     public ReflectionClass $reflected;
 
+    /**
+     * @param T $obj
+     */
     public function __construct(object $obj)
     {
         $this->obj = $obj;

src/functions.php

@@ -3,7 +3,13 @@
 use Spatie\Invade\Invader;
 
 if (! function_exists('invade')) {
-    function invade(object $object)
+    /**
+     * @template T of object
+     *
+     * @param T $object
+     * @return Invader<T>
+     */
+    function invade(object $object): Invader
     {
         return new Invader($object);
     }

types/Example.php

@@ -0,0 +1,16 @@
+<?php
+
+class Example
+{
+    public function __construct(
+        private string $mySecret,
+        protected int $myShared,
+        public string $myExposed,
+    ) {
+    }
+
+    public function getMySecret(): string
+    {
+        return $this->mySecret;
+    }
+}

types/phpstan.neon.dist

@@ -0,0 +1,4 @@
+parameters:
+  paths:
+    - .
+  level: max

types/src/Invader.php

@@ -0,0 +1,12 @@
+<?php
+
+use Spatie\Invade\Invader;
+use function PHPStan\Testing\assertType;
+
+$example = new Example("password", 42, "Pestival");
+$invaded = new Invader($example);
+
+assertType(Invader::class . '<' . Example::class . '>', $invaded);
+assertType('string', $invaded->myExposed);
+assertType('int', $invaded->myShared);
+assertType('string', $invaded->mySecret);

types/src/functions.php

@@ -0,0 +1,8 @@
+<?php
+
+use Spatie\Invade\Invader;
+use function PHPStan\Testing\assertType;
+
+$example = new Example("password", 42, "Pestival");
+
+assertType(Invader::class . '<' . Example::class . '>', invade($example));