Doctrine\Tests\Persistence\Mapping\ClassMetadataFactoryTest

Complexity

Total Complexity

15

Size/Duplication

Total Lines	167
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

15 Methods

Rating	Name	Duplication	Size	Complexity
A	testGetCachedMetadata()	0	9	1
A	testClassIsTransient()	0	3	1
A	testCacheGetMetadataFor()	0	8	1
A	testGetAliasedMetadata()	0	6	1
A	setUp()	0	5	1
A	testWillFallbackOnNotLoadedMetadata()	0	12	1
A	testGetCacheDriver()	0	12	1
A	testCacheGetMetadataForLegacy()	0	8	1
A	testWillIgnoreCacheEntriesThatAreNotMetadataInstances()	0	20	1
A	testGetInvalidAliasedMetadata()	0	8	1
A	testGetParentMetadata()	0	6	1
A	testGetMetadataForAbsentClass()	0	4	1
A	testWillFailOnFallbackFailureWithNotLoadedMetadata()	0	10	1
A	testGetMetadataFor()	0	5	1
A	testGetCachedMetadataLegacy()	0	9	1

<?php

declare(strict_types=1);

namespace Doctrine\Tests\Persistence\Mapping;

use Cache\Adapter\PHPArray\ArrayCachePool;
use Doctrine\Common\Cache\ArrayCache;
use Doctrine\Common\Cache\Cache;
use Doctrine\Persistence\Mapping\ClassMetadata;
use Doctrine\Persistence\Mapping\Driver\MappingDriver;
use Doctrine\Persistence\Mapping\MappingException;
use Doctrine\Tests\DoctrineTestCase;
use PHPUnit\Framework\MockObject\MockObject;
use stdClass;
use function str_replace;

/**
 * @covers \Doctrine\Persistence\Mapping\AbstractClassMetadataFactory
 */
class ClassMetadataFactoryTest extends DoctrineTestCase
{
    /** @var TestClassMetadataFactory */
    private $cmf;

    protected function setUp() : void
    {
        $driver    = $this->createMock(MappingDriver::class);
        $metadata  = $this->createMock(ClassMetadata::class);
        $this->cmf = new TestClassMetadataFactory($driver, $metadata);
    }

    public function testGetCacheDriver() : void
    {
        self::assertNull($this->cmf->getCacheDriver());

The function Doctrine\Persistence\Mapping\AbstractClassMetadataFactory::getCacheDriver() has been deprecated.

        $cache = new ArrayCache();

        $this->cmf->setCacheDriver($cache);

The function Doctrine\Persistence\Mapping\AbstractClassMetadataFactory::setCacheDriver() has been deprecated.

        /** @var ArrayCache $cacheDriver */
        $cacheDriver = $this->cmf->getCacheDriver();

The function Doctrine\Persistence\Mapping\AbstractClassMetadataFactory::getCacheDriver() has been deprecated.

        self::assertSame($cache, $cacheDriver);
    }

    public function testGetMetadataFor() : void
    {
        $metadata = $this->cmf->getMetadataFor('stdClass');

The assignment to $metadata is dead and can be removed.

        self::assertTrue($this->cmf->hasMetadataFor('stdClass'));
    }

    public function testGetMetadataForAbsentClass() : void
    {
        $this->expectException(MappingException::class);
        $this->cmf->getMetadataFor(__NAMESPACE__ . '\AbsentClass');
    }

    public function testGetParentMetadata() : void
    {
        $metadata = $this->cmf->getMetadataFor(ChildEntity::class);

The assignment to $metadata is dead and can be removed.

        self::assertTrue($this->cmf->hasMetadataFor(ChildEntity::class));
        self::assertTrue($this->cmf->hasMetadataFor(RootEntity::class));
    }

    public function testGetCachedMetadataLegacy() : void
    {
        $metadata = $this->createMock(ClassMetadata::class);
        $cache    = new ArrayCache();
        $cache->save(str_replace('\\', '.', ChildEntity::class) . '$CLASSMETADATA', $metadata);

        $this->cmf->setCacheDriver($cache);

The function Doctrine\Persistence\Mapping\AbstractClassMetadataFactory::setCacheDriver() has been deprecated.

        self::assertEquals($metadata, $this->cmf->getMetadataFor(ChildEntity::class));
    }

    public function testGetCachedMetadata() : void
    {
        $metadata = $this->createMock(ClassMetadata::class);
        $cache    = new ArrayCachePool();
        $cache->set(str_replace('\\', '.', ChildEntity::class) . '$CLASSMETADATA', $metadata);

        $this->cmf->setCache($cache);

        self::assertEquals($metadata, $this->cmf->getMetadataFor(ChildEntity::class));
    }

    public function testCacheGetMetadataForLegacy() : void
    {
        $cache = new ArrayCache();
        $this->cmf->setCacheDriver($cache);

The function Doctrine\Persistence\Mapping\AbstractClassMetadataFactory::setCacheDriver() has been deprecated.

        $loadedMetadata = $this->cmf->getMetadataFor(ChildEntity::class);

        self::assertEquals($loadedMetadata, $cache->fetch(str_replace('\\', '.', ChildEntity::class) . '$CLASSMETADATA'));
    }

    public function testCacheGetMetadataFor() : void
    {
        $cache = new ArrayCachePool();
        $this->cmf->setCache($cache);

        $loadedMetadata = $this->cmf->getMetadataFor(ChildEntity::class);

        self::assertEquals($loadedMetadata, $cache->get(str_replace('\\', '.', ChildEntity::class) . '$CLASSMETADATA'));
    }

    public function testGetAliasedMetadata() : void
    {
        $this->cmf->getMetadataFor('prefix:ChildEntity');

        self::assertTrue($this->cmf->hasMetadataFor(__NAMESPACE__ . '\ChildEntity'));
        self::assertTrue($this->cmf->hasMetadataFor('prefix:ChildEntity'));
    }

    /**
     * @group DCOM-270
     */
    public function testGetInvalidAliasedMetadata() : void
    {
        $this->expectException(MappingException::class);
        $this->expectExceptionMessage(
            'Class \'Doctrine\Tests\Persistence\Mapping\ChildEntity:Foo\' does not exist'
        );

        $this->cmf->getMetadataFor('prefix:ChildEntity:Foo');
    }

    /**
     * @group DCOM-270
     */
    public function testClassIsTransient() : void
    {
        self::assertTrue($this->cmf->isTransient('prefix:ChildEntity:Foo'));
    }

    public function testWillFallbackOnNotLoadedMetadata() : void
    {
        $classMetadata = $this->createMock(ClassMetadata::class);

        $this->cmf->fallbackCallback = static function () use ($classMetadata) {
            return $classMetadata;
        };

        /** @var ClassMetadata $fooClassMetadata */
        $fooClassMetadata = $this->cmf->getMetadataFor('Foo');

        self::assertSame($classMetadata, $fooClassMetadata);
    }

    public function testWillFailOnFallbackFailureWithNotLoadedMetadata() : void
    {
        $this->cmf->fallbackCallback = static function () {
            return null;
        };

        $this->expectException(MappingException::class);
        $this->expectExceptionMessage("Class 'Foo' does not exist");

        $this->cmf->getMetadataFor('Foo');
    }

    /**
     * @group 717
     */
    public function testWillIgnoreCacheEntriesThatAreNotMetadataInstances() : void
    {
        /** @var Cache|MockObject $cacheDriver */
        $cacheDriver = $this->createMock(Cache::class);

        $this->cmf->setCacheDriver($cacheDriver);

The function Doctrine\Persistence\Mapping\AbstractClassMetadataFactory::setCacheDriver() has been deprecated.

        $cacheDriver->expects(self::once())->method('fetch')->with('Foo$CLASSMETADATA')->willReturn(new stdClass());

        /** @var ClassMetadata $metadata */
        $metadata = $this->createMock(ClassMetadata::class);

        /** @var MockObject|stdClass|callable $fallbackCallback */
        $fallbackCallback = $this->getMockBuilder(stdClass::class)->setMethods(['__invoke'])->getMock();

        $fallbackCallback->expects(self::any())->method('__invoke')->willReturn($metadata);

        $this->cmf->fallbackCallback = $fallbackCallback;

        self::assertSame($metadata, $this->cmf->getMetadataFor('Foo'));
    }
}

class RootEntity
{
}

class ChildEntity extends RootEntity
{
}