Extracted the Doctine specific parts of the Repository Manager

This commit is contained in:
Richard Miller 2011-12-23 15:29:01 +00:00
parent 8487ab1788
commit ba976e3a41
4 changed files with 219 additions and 104 deletions

View file

@ -0,0 +1,63 @@
<?php
namespace FOQ\ElasticaBundle\Doctrine;
use Doctrine\Common\Annotations\Reader;
use Doctrine\Common\Persistence\ManagerRegistry;
use FOQ\ElasticaBundle\Finder\FinderInterface;
use FOQ\ElasticaBundle\Manager\RepositoryManager as BaseManager;
use FOQ\ElasticaBundle\Repository;
use RuntimeException;
/**
* @author Richard Miller <info@limethinking.co.uk>
*
* Allows retrieval of basic or custom repository for mapped Doctrine
* entities/documents.
*/
class RepositoryManager extends BaseManager
{
protected $entities = array();
protected $repositories = array();
protected $managerRegistry;
protected $reader;
public function __construct(ManagerRegistry $managerRegistry, Reader $reader)
{
$this->managerRegistry = $managerRegistry;
$this->reader = $reader;
}
/**
* Return repository for entity
*
* Returns custom repository if one specified otherwise
* returns a basic respository.
*/
public function getRepository($entityName)
{
$realEntityName = $entityName;
if (strpos($entityName, ':') !== false) {
list($namespaceAlias, $simpleClassName) = explode(':', $entityName);
$realEntityName = $this->managerRegistry->getAliasNamespace($namespaceAlias) . '\\' . $simpleClassName;
}
return parent::getRepository($realEntityName);
}
protected function getCustomRepositoryName($realEntityName)
{
if (isset($this->entities[$realEntityName]['repositoryName'])) {
return $this->entities[$realEntityName]['repositoryName'];
}
$refClass = new \ReflectionClass($realEntityName);
$annotation = $this->reader->getClassAnnotation($refClass, 'FOQ\\ElasticaBundle\\Configuration\\Search');
if ($annotation) {
$this->entities[$realEntityName]['repositoryName']
= $annotation->repositoryClass;
return $annotation->repositoryClass;
}
}
}

View file

@ -2,8 +2,6 @@
namespace FOQ\ElasticaBundle\Manager;
use Doctrine\Common\Annotations\Reader;
use Doctrine\Common\Persistence\ManagerRegistry;
use FOQ\ElasticaBundle\Finder\FinderInterface;
use FOQ\ElasticaBundle\Repository;
use RuntimeException;
@ -17,14 +15,6 @@ class RepositoryManager implements RepositoryManagerInterface
{
protected $entities = array();
protected $repositories = array();
protected $managerRegistry;
protected $reader;
public function __construct(ManagerRegistry $managerRegistry, Reader $reader)
{
$this->managerRegistry = $managerRegistry;
$this->reader = $reader;
}
public function addEntity($entityName, FinderInterface $finder, $repositoryName = null)
{
@ -41,49 +31,34 @@ class RepositoryManager implements RepositoryManagerInterface
*/
public function getRepository($entityName)
{
$realEntityName = $entityName;
if (strpos($entityName, ':') !== false) {
list($namespaceAlias, $simpleClassName) = explode(':', $entityName);
$realEntityName = $this->managerRegistry->getAliasNamespace($namespaceAlias) . '\\' . $simpleClassName;
if (isset($this->repositories[$entityName])) {
return $this->repositories[$entityName];
}
if (isset($this->repositories[$realEntityName])) {
return $this->repositories[$realEntityName];
if (!isset($this->entities[$entityName])) {
throw new RuntimeException(sprintf('No search finder configured for %s', $entityName));
}
if (!isset($this->entities[$realEntityName])) {
throw new RuntimeException(sprintf('No search finder configured for %s', $realEntityName));
}
$repositoryName = $this->getCustomRepositoryName($entityName);
$this->setRepositoryFromAnnotation($realEntityName);
if (isset($this->entities[$realEntityName]['repositoryName'])) {
$repositoryName = $this->entities[$realEntityName]['repositoryName'];
if ($repositoryName) {
if (!class_exists($repositoryName)) {
throw new RuntimeException(sprintf('%s repository for %s does not exist', $repositoryName, $realEntityName));
throw new RuntimeException(sprintf('%s repository for %s does not exist', $repositoryName, $entityName));
}
$repository = new $repositoryName($this->entities[$realEntityName]['finder']);
$this->repositories[$realEntityName] = $repository;
$repository = new $repositoryName($this->entities[$entityName]['finder']);
$this->repositories[$entityName] = $repository;
return $repository;
}
$repository = new Repository($this->entities[$realEntityName]['finder']);
$this->repositories[$realEntityName] = $repository;
$repository = new Repository($this->entities[$entityName]['finder']);
$this->repositories[$entityName] = $repository;
return $repository;
}
private function setRepositoryFromAnnotation($realEntityName)
protected function getCustomRepositoryName($realEntityName)
{
if (isset($this->entities[$realEntityName]['repositoryName'])) {
return;
}
$refClass = new \ReflectionClass($realEntityName);
$annotation = $this->reader->getClassAnnotation($refClass, 'FOQ\\ElasticaBundle\\Configuration\\Search');
if ($annotation) {
$this->entities[$realEntityName]['repositoryName']
= $annotation->repositoryClass;
return $this->entities[$realEntityName]['repositoryName'];
}
}

View file

@ -0,0 +1,139 @@
<?php
namespace FOQ\ElasticaBundle\Tests\Doctrine;
use FOQ\ElasticaBundle\Doctrine\RepositoryManager;
class CustomRepository{}
class Entity{}
/**
* @author Richard Miller <info@limethinking.co.uk>
*/
class RepositoryManagerTest extends \PHPUnit_Framework_TestCase
{
public function testThatGetRepositoryReturnsDefaultRepository()
{
$finderMock = $this->getMockBuilder('FOQ\ElasticaBundle\Finder\TransformedFinder')
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$manager = new RepositoryManager($registryMock, $readerMock);
$manager->addEntity($entityName, $finderMock);
$repository = $manager->getRepository($entityName);
$this->assertInstanceOf('FOQ\ElasticaBundle\Repository', $repository);
}
public function testThatGetRepositoryReturnsCustomRepository()
{
$finderMock = $this->getMockBuilder('FOQ\ElasticaBundle\Finder\TransformedFinder')
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$manager = new RepositoryManager($registryMock, $readerMock);
$manager->addEntity($entityName, $finderMock, 'FOQ\ElasticaBundle\Tests\Manager\CustomRepository');
$repository = $manager->getRepository($entityName);
$this->assertInstanceOf('FOQ\ElasticaBundle\Tests\Manager\CustomRepository', $repository);
}
/**
* @expectedException RuntimeException
*/
public function testThatGetRepositoryThrowsExceptionIfEntityNotConfigured()
{
$finderMock = $this->getMockBuilder('FOQ\ElasticaBundle\Finder\TransformedFinder')
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$manager = new RepositoryManager($registryMock, $readerMock);
$manager->addEntity($entityName, $finderMock);
$manager->getRepository('Missing Entity');
}
/**
* @expectedException RuntimeException
*/
public function testThatGetRepositoryThrowsExceptionIfCustomRepositoryNotFound()
{
$finderMock = $this->getMockBuilder('FOQ\ElasticaBundle\Finder\TransformedFinder')
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$manager = new RepositoryManager($registryMock, $readerMock);
$manager->addEntity($entityName, $finderMock, 'FOQ\ElasticaBundle\Tests\MissingRepository');
$manager->getRepository('Missing Entity');
}
public function testThatGetRepositoryWorksWithShortEntityName()
{
$finderMock = $this->getMockBuilder('FOQ\ElasticaBundle\Finder\TransformedFinder')
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$shortEntityName = 'TestBundle:Entity';
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$shortPath = 'TestBundle';
$fullPath = 'FOQ\ElasticaBundle\Tests\Manager';
$registryMock->expects($this->once())
->method('getAliasNamespace')
->with($this->equalTo($shortPath))
->will($this->returnValue($fullPath));
$manager = new RepositoryManager($registryMock, $readerMock);
$manager->addEntity($entityName, $finderMock);
$repository = $manager->getRepository($shortEntityName);
$this->assertInstanceOf('FOQ\ElasticaBundle\Repository', $repository);
}
}

View file

@ -20,17 +20,9 @@ class RepositoryManagerTest extends \PHPUnit_Framework_TestCase
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$manager = new RepositoryManager($registryMock, $readerMock);
$manager = new RepositoryManager();
$manager->addEntity($entityName, $finderMock);
$repository = $manager->getRepository($entityName);
$this->assertInstanceOf('FOQ\ElasticaBundle\Repository', $repository);
@ -42,17 +34,9 @@ class RepositoryManagerTest extends \PHPUnit_Framework_TestCase
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$manager = new RepositoryManager($registryMock, $readerMock);
$manager = new RepositoryManager();
$manager->addEntity($entityName, $finderMock, 'FOQ\ElasticaBundle\Tests\Manager\CustomRepository');
$repository = $manager->getRepository($entityName);
$this->assertInstanceOf('FOQ\ElasticaBundle\Tests\Manager\CustomRepository', $repository);
@ -67,17 +51,9 @@ class RepositoryManagerTest extends \PHPUnit_Framework_TestCase
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$manager = new RepositoryManager($registryMock, $readerMock);
$manager = new RepositoryManager();
$manager->addEntity($entityName, $finderMock);
$manager->getRepository('Missing Entity');
}
@ -91,49 +67,11 @@ class RepositoryManagerTest extends \PHPUnit_Framework_TestCase
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$manager = new RepositoryManager($registryMock, $readerMock);
$manager = new RepositoryManager();
$manager->addEntity($entityName, $finderMock, 'FOQ\ElasticaBundle\Tests\MissingRepository');
$manager->getRepository('Missing Entity');
}
public function testThatGetRepositoryWorksWithShortEntityName()
{
$finderMock = $this->getMockBuilder('FOQ\ElasticaBundle\Finder\TransformedFinder')
->disableOriginalConstructor()
->getMock();
$registryMock = $this->getMockBuilder('Doctrine\Common\Persistence\ManagerRegistry')
->disableOriginalConstructor()
->getMock();
$readerMock = $this->getMockBuilder('Doctrine\Common\Annotations\Reader')
->disableOriginalConstructor()
->getMock();
$shortEntityName = 'TestBundle:Entity';
$entityName = 'FOQ\ElasticaBundle\Tests\Manager\Entity';
$shortPath = 'TestBundle';
$fullPath = 'FOQ\ElasticaBundle\Tests\Manager';
$registryMock->expects($this->once())
->method('getAliasNamespace')
->with($this->equalTo($shortPath))
->will($this->returnValue($fullPath));
$manager = new RepositoryManager($registryMock, $readerMock);
$manager->addEntity($entityName, $finderMock);
$repository = $manager->getRepository($shortEntityName);
$this->assertInstanceOf('FOQ\ElasticaBundle\Repository', $repository);
}
}