ApiClients\Tools\ResourceTestUtilities\AbstractResourceTest

Complexity

Total Complexity

16

Size/Duplication

Total Lines	132
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	6

Test Coverage

Coverage

0%

Importance

Changes

0

10 Methods

Rating	Name	Duplication	Size	Complexity
	getClass()	0	1	?
	getNamespace()	0	1	?
A	provideProperties()	0	4	1
A	providePropertiesIncompatible()	0	4	1
B	providePropertiesGenerator()	0	31	6
A	generateTypeValues()	0	23	3
A	getDocBlock()	0	8	2
A	testProperties()	0	15	1
A	testPropertiesIncompatible()	0	14	1
A	testInterface()	0	9	1

<?php
declare(strict_types=1);

namespace ApiClients\Tools\ResourceTestUtilities;

use ApiClients\Foundation\Resource\ResourceInterface;
use Doctrine\Common\Inflector\Inflector;
use Generator;
use phpDocumentor\Reflection\DocBlock;
use phpDocumentor\Reflection\DocBlockFactory;
use ReflectionClass;
use ReflectionProperty;
use TypeError;

abstract class AbstractResourceTest extends TestCase
{
    abstract function getClass(): string;

It is generally recommended to explicitly declare the visibility for methods.

    abstract function getNamespace(): string;

It is generally recommended to explicitly declare the visibility for methods.

    public function provideProperties(): Generator
    {
        yield from $this->providePropertiesGenerator('compatible');
    }

    public function providePropertiesIncompatible(): Generator
    {
        yield from $this->providePropertiesGenerator('incompatible');
    }

    public function providePropertiesGenerator(string $typeMethod): Generator
    {
        $class = new ReflectionClass($this->getClass());

        $jsonTemplate = [];
        foreach ($class->getProperties() as $property) {
            $jsonTemplate[$property->getName()] = '';
        }

        foreach ($class->getProperties() as $property) {
            $method = Inflector::camelize($property->getName());
            $docBlock = $this->getDocBlock($property->getDocComment());

            $varTag = $docBlock->getTagsByName('var');
            if (count($varTag) !== 1) {
                continue;
            }

            $varTag = $varTag[0];
            if ($varTag->getType() === '') {
                continue;
            }

            if (!Types::has($varTag->getType())) {
                continue;
            }

            $type = Types::get($varTag->getType());
            yield from $this->generateTypeValues($type, $property, $method, $typeMethod, $jsonTemplate);
        }
    }

    protected function generateTypeValues(
        Type $type,
        ReflectionProperty $property,
        string $method,
        string $typeMethod,
        array $jsonTemplate
    ): Generator
    {
        $json = $jsonTemplate;
        foreach ($type->$typeMethod() as $typeClass) {
            $methodType = Types::get(constant($typeClass . '::SCALAR'));
            foreach ($methodType->generate(2500) as $value) {
                $json[$property->getName()] = $value;
                yield [
                    $property->getName(), // Name of the property to assign data to
                    $method,              // Method to call verifying that data
                    $type,                // The different types of data assiciated with this field
                    $json,                // JSON to use during testing
                    $value,               // Value to check against
                ];
            }
        }
    }

    /**
     * @param $docBlockContents
     * @return DocBlock
     */
    protected function getDocBlock(string $docBlockContents): DocBlock
    {
        if (class_exists('phpDocumentor\Reflection\DocBlockFactory')) {
            return DocBlockFactory::createInstance()->create($docBlockContents);
        }

        return new DocBlock($docBlockContents);
    }

    /**
     * @dataProvider provideProperties
     */
    public function testProperties(string $property, string $method, Type $type, array $json, $value)

The parameter $property is not used and could be removed.

    {
        $class = $this->getClass();
        $resource = $this->hydrate(
            str_replace(
                $this->getNamespace(),
                $this->getNamespace() . '\\Async',
                $class
            ),
            $json,
            'Async'
        );
        $this->assertSame($value, $resource->{$method}());
        $this->assertInternalType($type->scalar(), $resource->{$method}());
    }

    /**
     * @dataProvider providePropertiesIncompatible
     * @expectedException TypeError
     */
    public function testPropertiesIncompatible(string $property, string $method, Type $type, array $json, $value)

The parameter $property is not used and could be removed.

The parameter $type is not used and could be removed.

    {
        $class = $this->getClass();
        $resource = $this->hydrate(
            str_replace(
                $this->getNamespace(),
                $this->getNamespace() . '\\Async',
                $class
            ),
            $json,
            'Async'
        );
        $this->assertSame($value, $resource->{$method}());
    }

    public function testInterface()
    {
        $this->assertTrue(
            is_subclass_of(

Due to PHP Bug #53727, is_subclass_of might return inconsistent results on some PHP versions if \ApiClients\Foundation\Resource\ResourceInterface::class can be an interface. If so, you could instead use ReflectionClass::implementsInterface.

                $this->getClass(),
                ResourceInterface::class
            )
        );
    }
}