NelsonMartell\Test\Helpers\ImplementsIConvertibleToString

Complexity

Total Complexity

2

Size/Duplication

Total Lines	48
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	testImplementsIConvertibleToString()	0	16	1
A	testPerformsConversionToString()	0	6	1

<?php

/**
 * PHP: Nelson Martell Library file
 *
 * Copyright © 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 2021 Nelson Martell
 * @link      http://nelson6e65.github.io/php_nml/
 * @since     1.0.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 NelsonMartell\Extensions\Text;
use PHPUnit\Framework\TestCase;
use NelsonMartell\IConvertibleToString;

/**
 * Test helper for classes implementing {@see IConvertibleToString} interface.
 *
 * @author Nelson Martell <nelson6e65@gmail.com>
 * @since 1.0.0
 * */
trait ImplementsIConvertibleToString
{
    /**
     * @return string
     */
    abstract public function getTargetClassName(): string;

    /**
     * @return array
     */
    abstract public function toStringProvider(): array;

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

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

        /** @var TestCase $this */
        $this->assertContains(
            IConvertibleToString::class,
            $class->getInterfaceNames(),
            $message
        );
    }

    /**
     * @covers ::toString
     * @covers ::__toString
     * @dataProvider toStringProvider
     *
     * @param string                $expected
     * @param IConvertibleToString  $obj
     *
     * @see IConvertibleToString::toString()
     * @see IConvertibleToString::__toString()
     */
    public function testPerformsConversionToString(string $expected, IConvertibleToString $obj): void
    {
        /** @var TestCase $this */
        $this->assertSame($expected, $obj->toString(), 'Failed explicit conversion to string');

        $this->assertSame($expected, $obj . '', 'Failed implicit conversion to string');
    }
}