feat: add ReflectionHelper

Author: kenjis

src/ReflectionHelper.php

@@ -0,0 +1,85 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kenjis\PhpUnitHelper;
+
+use Closure;
+use ReflectionClass;
+use ReflectionException;
+use ReflectionMethod;
+use ReflectionObject;
+use ReflectionProperty;
+
+use function func_get_args;
+use function gettype;
+use function is_object;
+
+trait ReflectionHelper
+{
+    /**
+     * @param object|string $obj    object or class name
+     * @param string        $method method name
+     *
+     * @throws ReflectionException
+     */
+    public static function getPrivateMethodInvoker($obj, string $method): Closure
+    {
+        $refMethod = new ReflectionMethod($obj, $method);
+        $refMethod->setAccessible(true);
+        $obj = gettype($obj) === 'object' ? $obj : null;
+
+        return static function () use ($obj, $refMethod) {
+            $args = func_get_args();
+
+            return $refMethod->invokeArgs($obj, $args);
+        };
+    }
+
+    /**
+     * @param object|string $obj
+     *
+     * @throws ReflectionException
+     */
+    protected static function getAccessibleRefProperty($obj, string $property): ReflectionProperty
+    {
+        if (is_object($obj)) {
+            $refClass = new ReflectionObject($obj);
+        } else {
+            $refClass = new ReflectionClass($obj);
+        }
+
+        $refProperty = $refClass->getProperty($property);
+        $refProperty->setAccessible(true);
+
+        return $refProperty;
+    }
+
+    /**
+     * @param object|string $obj      object or class name
+     * @param string        $property property name
+     * @param mixed         $value    value
+     *
+     * @throws ReflectionException
+     */
+    public static function setPrivateProperty($obj, string $property, $value): void
+    {
+        $refProperty = self::getAccessibleRefProperty($obj, $property);
+        $refProperty->setValue($obj, $value);
+    }
+
+    /**
+     * @param object|string $obj      object or class name
+     * @param string        $property property name
+     *
+     * @return mixed value
+     *
+     * @throws ReflectionException
+     */
+    public static function getPrivateProperty($obj, string $property)
+    {
+        $refProperty = self::getAccessibleRefProperty($obj, $property);
+
+        return $refProperty->getValue($obj);
+    }
+}

tests/Fake/ForReflectionHelper.php

@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kenjis\PhpUnitHelper;
+
+class ForReflectionHelper
+{
+    /**
+     * @var string
+     */
+    private $private = 'secret';
+
+    /**
+     * @var string
+     */
+    private static $staticPrivate = 'xyz';
+
+    public function getPrivate(): string
+    {
+        return $this->private;
+    }
+
+    public static function getStaticPrivate(): string
+    {
+        return self::$staticPrivate;
+    }
+
+    private function privateMethod(string $param1, string $param2): string
+    {
+        return 'private ' . $param1 . $param2;
+    }
+
+    private static function privateStaticMethod(string $param1, string$param2): string
+    {
+        return 'private_static ' . $param1 . $param2;
+    }
+}

tests/ReflectionHelperTest.php

@@ -0,0 +1,77 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Kenjis\PhpUnitHelper;
+
+use PHPUnit\Framework\TestCase;
+
+class ReflectionHelperTest extends TestCase
+{
+    use ReflectionHelper;
+
+    public function test_getPrivateProperty_object(): void
+    {
+        $obj = new ForReflectionHelper();
+        $actual = $this->getPrivateProperty($obj, 'private');
+        $this->assertEquals('secret', $actual);
+    }
+
+    public function test_getPrivateProperty_static(): void
+    {
+        $actual = $this->getPrivateProperty(
+            ForReflectionHelper::class,
+            'staticPrivate'
+        );
+        $this->assertEquals('xyz', $actual);
+    }
+
+    public function test_setPrivateProperty_object(): void
+    {
+        $obj = new ForReflectionHelper();
+        $this->setPrivateProperty(
+            $obj,
+            'private',
+            'open'
+        );
+        $this->assertEquals('open', $obj->getPrivate());
+    }
+
+    public function test_setPrivateProperty_static(): void
+    {
+        $this->setPrivateProperty(
+            ForReflectionHelper::class,
+            'staticPrivate',
+            'abc'
+        );
+        $this->assertEquals(
+            'abc',
+            ForReflectionHelper::getStaticPrivate()
+        );
+    }
+
+    public function test_getPrivateMethodInvoker_object(): void
+    {
+        $obj = new ForReflectionHelper();
+        $method = $this->getPrivateMethodInvoker(
+            $obj,
+            'privateMethod'
+        );
+        $this->assertEquals(
+            'private param1param2',
+            $method('param1', 'param2')
+        );
+    }
+
+    public function test_getPrivateMethodInvoker_static(): void
+    {
+        $method = $this->getPrivateMethodInvoker(
+            ForReflectionHelper::class,
+            'privateStaticMethod'
+        );
+        $this->assertEquals(
+            'private_static param1param2',
+            $method('param1', 'param2')
+        );
+    }
+}