ReflectionHelperTest.php

<?php declare(strict_types=1);

namespace DeepCopyTest\Reflection;

use DeepCopy\Exception\PropertyException;
use DeepCopy\Reflection\ReflectionHelper;
use PHPUnit\Framework\TestCase;
use ReflectionClass;
use ReflectionProperty;

/**
 * @covers \DeepCopy\Reflection\ReflectionHelper
 */
class ReflectionHelperTest extends TestCase
{
    public function test_it_retrieves_the_object_properties()
    {
        $child = new ReflectionHelperTestChild();
        $childReflectionClass = new ReflectionClass($child);

        $expectedProps = array(
            'a1',
            'a2',
            'a3',
            'a10',
            'a11',
            'a12',
            'a20',
            'a21',
            'a22',
            'a100',
            'a101',
            'a102',
        );

        $actualProps = ReflectionHelper::getProperties($childReflectionClass);

        $this->assertSame($expectedProps, array_keys($actualProps));
    }

    /**
     * @dataProvider provideProperties
     */
    public function test_it_can_retrieve_an_object_property($name)
    {
        $object = new ReflectionHelperTestChild();

        $property = ReflectionHelper::getProperty($object, $name);

        $this->assertInstanceOf(ReflectionProperty::class, $property);

        $this->assertSame($name, $property->getName());
    }

    public function provideProperties()
    {
        return [
            'public property' => ['a10'],
            'private property' => ['a102'],
            'private property of ancestor' => ['a3']
        ];
    }

    public function test_it_cannot_retrieve_a_non_existent_prperty()
    {
        $object = new ReflectionHelperTestChild();

        $this->expectException(PropertyException::class);
        ReflectionHelper::getProperty($object, 'non existent property');
    }
}

class ReflectionHelperTestParent
{
    public $a1;
    protected $a2;
    private $a3;

    public $a10;
    protected $a11;
    private $a12;

    public static $a20;
    protected static $a21;
    private static $a22;
}

class ReflectionHelperTestChild extends ReflectionHelperTestParent
{
    public $a1;
    protected $a2;
    private $a3;

    public $a100;
    protected $a101;
    private $a102;
}