nelson6e65 / php_nml

tests/Helpers/ImplementsIStrictPropertiesContainer.php

<?php

/**
 * PHP: Nelson Martell Library file
 *
 * Copyright © 2016-2021 Nelson Martell (http://nelson6e65.github.io)
 *
 * Licensed under The MIT License (MIT)
 * For full copyright and license information, please see the LICENSE
 * Redistributions of files must retain the above copyright notice.
 *
 * @copyright 2016-2021 Nelson Martell
 * @link      http://nelson6e65.github.io/php_nml/
 * @since     v0.6.0, v0.7.0
 * @license   http://www.opensource.org/licenses/mit-license.php The MIT License (MIT)
 * */

declare(strict_types=1);

namespace NelsonMartell\Test\Helpers;

use ReflectionClass;
use BadMethodCallException;
use NelsonMartell\Extensions\Text;
use NelsonMartell\IStrictPropertiesContainer;
use PHPUnit\Framework\TestCase;

/**
 * Test helper for classes implementing ``NelsonMartell\IStrictPropertiesContainer`` interface and
 * ``NelsonMartell\PropertiesHandler`` trait.
 *
 *
 * @author Nelson Martell <nelson6e65@gmail.com>
 *
 * @see HasReadOnlyProperties
 * @see HasReadWriteProperties
 * @see HasUnaccesibleProperties
 * @see HasWriteOnlyProperties
 * */
trait ImplementsIStrictPropertiesContainer
{
    /**
     * @return string
     */
    abstract public function getTargetClassName(): string;

    abstract public function objectInstanceProvider(): array;

    public function testImplementsIStrictPropertiesContainerInterface(): void
    {
        $className = $this->getTargetClassName();
        $class     = new ReflectionClass($className);

        /** @var TestCase $this */
        if ($class->isTrait()) {
            $this->assertTrue(true);
            return;
        }

        $message = Text::format(
            '"{0}" do not implements "{1}" interface.',
            $className,
            IStrictPropertiesContainer::class
        );

        $this->assertContains(
            IStrictPropertiesContainer::class,
            $class->getInterfaceNames(),
            $message
        );
    }

    /**
     * @depends testImplementsIStrictPropertiesContainerInterface
     * @dataProvider objectInstanceProvider
     *
     * @param IStrictPropertiesContainer $obj
     */
    public function testIsUnableToCreateDirectAttributesOutsideOfClassDefinition(IStrictPropertiesContainer $obj)
    {
        /** @var TestCase $this */
        $this->expectException(BadMethodCallException::class);

        /** @phpstan-ignore-next-line */
        $obj->thisPropertyNameIsMaybeImposibleThatExistsInClassToBeUsedAsNameOfPropertyOfAnyClassGiven = 'No way';

The property thisPropertyNameIsMaybeImposibleThatExistsInClassToBeUsedAsNameOfPropertyOfAnyClassGiven does not exist on NelsonMartell\IStrictPropertiesContainer. Since you implemented __set, consider adding a @property annotation.

    }
}