StubCustomRepository::getClassName() - Code Metrics - Inspection of "Support user defined repositories" - doctrine/DoctrineBundle - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#857)

by Maxime

created 2018-10-12 07:46 UTC

StubCustomRepository::getClassName() A

↳ Parent: StubCustomRepository

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	0

<?php

namespace Doctrine\Bundle\DoctrineBundle\Tests\Repository;

use Doctrine\Bundle\DoctrineBundle\Repository\ContainerRepositoryFactory;
use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepositoryInterface;
use Doctrine\Common\Persistence\ObjectRepository;
use Doctrine\ORM\Configuration;
use Doctrine\ORM\EntityManagerInterface;
use Doctrine\ORM\EntityRepository;
use Doctrine\ORM\Mapping\ClassMetadata;
use PHPUnit\Framework\TestCase;
use Psr\Container\ContainerInterface;

class ContainerRepositoryFactoryTest extends TestCase
{
    public function testGetRepositoryReturnsService()
    {
        if (! interface_exists(ContainerInterface::class)) {
            $this->markTestSkipped('Symfony 3.3 is needed for this feature.');
        }

        $em        = $this->createEntityManager(['Foo\CoolEntity' => 'my_repo']);
        $repo      = new StubRepository($em, new ClassMetadata(''));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $container = $this->createContainer(['my_repo' => $repo]);

        $factory = new ContainerRepositoryFactory($container);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertSame($repo, $factory->getRepository($em, 'Foo\CoolEntity'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function testGetRepositoryReturnsEntityRepository()
    {
        if (! interface_exists(ContainerInterface::class)) {
            $this->markTestSkipped('Symfony 3.3 is needed for this feature.');
        }

        $container = $this->createContainer([]);
        $em        = $this->createEntityManager(['Foo\BoringEntity' => null]);

        $factory    = new ContainerRepositoryFactory($container);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $actualRepo = $factory->getRepository($em, 'Foo\BoringEntity');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertInstanceOf(EntityRepository::class, $actualRepo);
        // test the same instance is returned
        $this->assertSame($actualRepo, $factory->getRepository($em, 'Foo\BoringEntity'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function testCustomRepositoryIsReturned()
    {
        if (! interface_exists(ContainerInterface::class)) {
            $this->markTestSkipped('Symfony 3.3 is needed for this feature.');
        }

        $container = $this->createContainer([]);
        $em        = $this->createEntityManager([
            'Foo\CustomNormalRepoEntity' => StubRepository::class,
        ]);

        $factory    = new ContainerRepositoryFactory($container);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $actualRepo = $factory->getRepository($em, 'Foo\CustomNormalRepoEntity');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertInstanceOf(StubRepository::class, $actualRepo);
        // test the same instance is returned
        $this->assertSame($actualRepo, $factory->getRepository($em, 'Foo\CustomNormalRepoEntity'));
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @expectedException \RuntimeException
     * @expectedExceptionMessage The service "my_repo" must implement ObjectRepository (or extend a base class, like ServiceEntityRepository).
     */
    public function testServiceRepositoriesMustExtendObjectRepository()
    {
        if (! interface_exists(ContainerInterface::class)) {
            $this->markTestSkipped('Symfony 3.3 is needed for this feature.');
        }

        $repo = new \stdClass();

        $container = $this->createContainer(['my_repo' => $repo]);

        $em = $this->createEntityManager(['Foo\CoolEntity' => 'my_repo']);

        $factory = new ContainerRepositoryFactory($container);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $factory->getRepository($em, 'Foo\CoolEntity');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    public function testServiceRepositoriesCanNotExtendsEntityRepository()
    {
        if (! interface_exists(ContainerInterface::class)) {
            $this->markTestSkipped('Symfony 3.3 is needed for this feature.');
        }

        $repo = new StubCustomRepository();

        $container = $this->createContainer(['my_repo' => $repo]);

        $em = $this->createEntityManager(['Foo\CoolEntity' => 'my_repo']);

        $factory = new ContainerRepositoryFactory($container);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $factory->getRepository($em, 'Foo\CoolEntity');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $actualRepo = $factory->getRepository($em, 'Foo\CoolEntity');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $this->assertInstanceOf(StubCustomRepository::class, $actualRepo);
    }


    /**
     * @expectedException \RuntimeException
     * @expectedExceptionMessage The "Doctrine\Bundle\DoctrineBundle\Tests\Repository\StubServiceRepository" entity repository implements "Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepositoryInterface", but its service could not be found. Make sure the service exists and is tagged with "doctrine.repository_service".
     */
    public function testRepositoryMatchesServiceInterfaceButServiceNotFound()
    {
        if (! interface_exists(ContainerInterface::class)) {
            $this->markTestSkipped('Symfony 3.3 is needed for this feature.');
        }

        $container = $this->createContainer([]);

        $em = $this->createEntityManager([
            'Foo\CoolEntity' => StubServiceRepository::class,
        ]);

        $factory = new ContainerRepositoryFactory($container);
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
        $factory->getRepository($em, 'Foo\CoolEntity');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    /**
     * @expectedException \RuntimeException
     * @expectedExceptionMessage The "Foo\CoolEntity" entity has a repositoryClass set to "not_a_real_class", but this is not a valid class. Check your class naming. If this is meant to be a service id, make sure this service exists and is tagged with "doctrine.repository_service".
     */
    public function testCustomRepositoryIsNotAValidClass()
    {
        if (interface_exists(ContainerInterface::class)) {
            $container = $this->createContainer([]);
        } else {
            // Symfony 3.2 and lower support
            $container = null;
        }

        $em = $this->createEntityManager(['Foo\CoolEntity' => 'not_a_real_class']);

        $factory = new ContainerRepositoryFactory($container);
/**
 * @return array|string
 */
function returnsDifferentValues($x) {
    if ($x) {
        return 'foo';
    }

    return array();
}

$x = returnsDifferentValues($y);
if (is_array($x)) {
    // $x is an array.
}
        $factory->getRepository($em, 'Foo\CoolEntity');
function acceptsInteger($int) { }

$x = '123'; // string "123"

// Instead of
acceptsInteger($x);

// we recommend to use
acceptsInteger((integer) $x);
    }

    private function createContainer(array $services)
    {
        $container = $this->getMockBuilder(ContainerInterface::class)->getMock();
        $container->expects($this->any())
            ->method('has')
            ->willReturnCallback(function ($id) use ($services) {
                return isset($services[$id]);
            });
        $container->expects($this->any())
            ->method('get')
            ->willReturnCallback(function ($id) use ($services) {
                return $services[$id];
            });

        return $container;
    }

    private function createEntityManager(array $entityRepositoryClasses)
    {
        $classMetadatas = [];
        foreach ($entityRepositoryClasses as $entityClass => $entityRepositoryClass) {
            $metadata                            = new ClassMetadata($entityClass);
            $metadata->customRepositoryClassName = $entityRepositoryClass;

            $classMetadatas[$entityClass] = $metadata;
        }

        $em = $this->getMockBuilder(EntityManagerInterface::class)->getMock();
        $em->expects($this->any())
            ->method('getClassMetadata')
            ->willReturnCallback(function ($class) use ($classMetadatas) {
                return $classMetadatas[$class];
            });

        $em->expects($this->any())
            ->method('getConfiguration')
            ->willReturn(new Configuration());

        return $em;
    }
}

class StubRepository extends EntityRepository
{
}

class StubServiceRepository extends EntityRepository implements ServiceEntityRepositoryInterface
{
}

class StubCustomRepository implements ObjectRepository
{
    public function find($id) {}
    public function findAll() {}
    public function findBy(array $criteria, ?array $orderBy = null, $limit = null, $offset = null) {}
    public function findOneBy(array $criteria) {}
    public function getClassName() {}
}


1			<?php
2
3			namespace Doctrine\Bundle\DoctrineBundle\Tests\Repository;
4
5			use Doctrine\Bundle\DoctrineBundle\Repository\ContainerRepositoryFactory;
6			use Doctrine\Bundle\DoctrineBundle\Repository\ServiceEntityRepositoryInterface;
7			use Doctrine\Common\Persistence\ObjectRepository;
8			use Doctrine\ORM\Configuration;
9			use Doctrine\ORM\EntityManagerInterface;
10			use Doctrine\ORM\EntityRepository;
11			use Doctrine\ORM\Mapping\ClassMetadata;
12			use PHPUnit\Framework\TestCase;
13			use Psr\Container\ContainerInterface;
14
15			class ContainerRepositoryFactoryTest extends TestCase
16			{
17			public function testGetRepositoryReturnsService()
18			{
19			if (! interface_exists(ContainerInterface::class)) {
20			$this->markTestSkipped('Symfony 3.3 is needed for this feature.');
21			}
22
23			$em = $this->createEntityManager(['Foo\CoolEntity' => 'my_repo']);
24			$repo = new StubRepository($em, new ClassMetadata(''));
			0 ignored issues – show Documentation introduced 2018-01-26 14:06 UTC by Report Bug Copy Issue Report `$em` is of type `object<PHPUnit\Framework\MockObject\MockObject>`, but the function expects a `object<Doctrine\ORM\EntityManagerInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
25			$container = $this->createContainer(['my_repo' => $repo]);
26
27			$factory = new ContainerRepositoryFactory($container);
			0 ignored issues – show Documentation introduced 2017-12-13 10:04 UTC by Report Bug Copy Issue Report `$container` is of type `object<PHPUnit\Framework\MockObject\MockObject>`, but the function expects a `null\|object<Psr\Container\ContainerInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
28			$this->assertSame($repo, $factory->getRepository($em, 'Foo\CoolEntity'));
			0 ignored issues – show Documentation introduced 2017-12-13 10:04 UTC by Report Bug Copy Issue Report `$em` is of type `object<PHPUnit\Framework\MockObject\MockObject>`, but the function expects a `object<Doctrine\ORM\EntityManagerInterface>`. It seems like the type of the argument is not accepted by the function/method which you are calling. In some cases, in particular if PHP’s automatic type-juggling kicks in this might be fine. In other cases, however this might be a bug. We suggest to add an explicit type cast like in the following example: function acceptsInteger($int) { } $x = '123'; // string "123" // Instead of acceptsInteger($x); // we recommend to use acceptsInteger((integer) $x); Loading history...
29			}
30
31			public function testGetRepositoryReturnsEntityRepository()
32			{
33			if (! interface_exists(ContainerInterface::class)) {
34			$this->markTestSkipped('Symfony 3.3 is needed for this feature.');
35			}
36
37			$container = $this->createContainer([]);

doctrine / DoctrineBundle

Pull Request — master (#857)

StubCustomRepository::getClassName() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like