Enhancement: Throw exception when entity definition for name is unavailable

src/Provider/Doctrine/EntityDefinitionUnavailable.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactoryGirl\Provider\Doctrine;
+
+final class EntityDefinitionUnavailable extends \OutOfRangeException implements Exception
+{
+    public static function for(string $name): self
+    {
+        return new self(sprintf(
+            'An entity definition for name "%s" is not available.',
+            $name
+        ));
+    }
+}

src/Provider/Doctrine/FixtureFactory.php

@@ -17,22 +17,22 @@ class FixtureFactory
      * @var EntityManager
      */
     protected $em;
-    
+
     /**
      * @var string
      */
     protected $entityNamespace;
-    
+
     /**
      * @var array<EntityDef>
      */
     protected $entityDefs;
-    
+
     /**
      * @var array
      */
     protected $singletons;
-    
+
     /**
      * @var boolean
      */
@@ -42,70 +42,76 @@ class FixtureFactory
     public function __construct(EntityManager $em)
     {
         $this->em = $em;
-        
+
         $this->entityNamespace = '';
-        
+
         $this->entityDefs = [];
-        
+
         $this->singletons = [];
-        
+
         $this->persist = false;
     }
-    
+
     /**
      * Sets the namespace to be prefixed to all entity names passed to this class.
      */
     public function setEntityNamespace($namespace)
     {
         $this->entityNamespace = trim($namespace, '\\');
     }
-    
+
     public function getEntityNamespace()
     {
         return $this->entityNamespace;
     }
-    
-    
+
+
     /**
      * Get an entity and its dependencies.
      *
      * Whether the entity is new or not depends on whether you've created
      * a singleton with the entity name. See `getAsSingleton()`.
      *
      * If you've called `persistOnGet()` then the entity is also persisted.
+     *
+     * @throws EntityDefinitionUnavailable
      */
     public function get($name, array $fieldOverrides = [])
     {
         if (isset($this->singletons[$name])) {
             return $this->singletons[$name];
         }
-
+
+        if (!array_key_exists($name, $this->entityDefs)) {
+            throw EntityDefinitionUnavailable::for($name);
+        }
+
         $def = $this->entityDefs[$name];
         $config = $def->getConfig();
-        
+
         $this->checkFieldOverrides($def, $fieldOverrides);
-        
+
         $ent = $def->getEntityMetadata()->newInstance();
         $fieldValues = [];
         foreach ($def->getFieldDefs() as $fieldName => $fieldDef) {
             $fieldValues[$fieldName] = array_key_exists($fieldName, $fieldOverrides)
                 ? $fieldOverrides[$fieldName]
                 : $fieldDef($this);
         }
-        
+
         foreach ($fieldValues as $fieldName => $fieldValue) {
             $this->setField($ent, $def, $fieldName, $fieldValue);
         }
-        
+
         if (isset($config['afterCreate'])) {
             $config['afterCreate']($ent, $fieldValues);
         }
-        
-        
+
+
         if ($this->persist) {
             $this->em->persist($ent);
         }
-        
+
         return $ent;
     }
 
@@ -143,11 +149,11 @@ protected function checkFieldOverrides(EntityDef $def, array $fieldOverrides)
             throw new Exception("Field(s) not in " . $def->getEntityType() . ": '" . implode("', '", $extraFields) . "'");
         }
     }
-    
+
     protected function setField($ent, EntityDef $def, $fieldName, $fieldValue)
     {
         $metadata = $def->getEntityMetadata();
-        
+
         if ($metadata->isCollectionValuedAssociation($fieldName)) {
             $metadata->setFieldValue($ent, $fieldName, $this->createCollectionFrom($fieldValue));
         } else {
@@ -167,7 +173,7 @@ protected function createCollectionFrom($array = [])
 
         return new ArrayCollection();
     }
-    
+
     /**
      * Sets whether `get()` should automatically persist the entity it creates.
      * By default it does not. In any case, you still need to call
@@ -177,7 +183,7 @@ public function persistOnGet($enabled = true)
     {
         $this->persist = $enabled;
     }
-    
+
     /**
      * A shorthand combining `get()` and `setSingleton()`.
      *
@@ -191,7 +197,7 @@ public function getAsSingleton($name, array $fieldOverrides = [])
         $this->singletons[$name] = $this->get($name, $fieldOverrides);
         return $this->singletons[$name];
     }
-    
+
     /**
      * Sets `$entity` to be the singleton for `$name`.
      *
@@ -201,7 +207,7 @@ public function setSingleton($name, $entity)
     {
         $this->singletons[$name] = $entity;
     }
-    
+
     /**
      * Unsets the singleton for `$name`.
      *
@@ -211,7 +217,7 @@ public function unsetSingleton($name)
     {
         unset($this->singletons[$name]);
     }
-    
+
     /**
      * Defines how to create a default entity of type `$name`.
      *
@@ -224,22 +230,22 @@ public function defineEntity($name, array $fieldDefs = [], array $config = [])
         if (isset($this->entityDefs[$name])) {
             throw new Exception("Entity '$name' already defined in fixture factory");
         }
-        
+
         $type = $this->addNamespace($name);
         if (!class_exists($type, true)) {
             throw new Exception("Not a class: $type");
         }
-        
+
         $metadata = $this->em->getClassMetadata($type);
         if (!isset($metadata)) {
             throw new Exception("Unknown entity type: $type");
         }
-        
+
         $this->entityDefs[$name] = new EntityDef($this->em, $name, $type, $fieldDefs, $config);
-        
+
         return $this;
     }
-    
+
     /**
      * @param  string $name
      * @return string
@@ -254,7 +260,7 @@ protected function addNamespace($name)
 
         return $this->entityNamespace . '\\' . $name;
     }
-    
+
     protected function updateCollectionSideOfAssocation($entityBeingCreated, $metadata, $fieldName, $value)
     {
         $assoc = $metadata->getAssociationMapping($fieldName);

tests/Provider/Doctrine/EntityDefinitionUnavailableTest.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactoryGirl\Tests\Provider\Doctrine;
+
+use FactoryGirl\Provider\Doctrine\EntityDefinitionUnavailable;
+use PHPUnit\Framework;
+
+/**
+ * @covers \FactoryGirl\Provider\Doctrine\EntityDefinitionUnavailable
+ */
+final class EntityDefinitionUnavailableTest extends Framework\TestCase
+{
+    public function testForReturnsException(): void
+    {
+        $name = 'foo';
+
+        $exception = EntityDefinitionUnavailable::for($name);
+
+        self::assertInstanceOf(\OutOfRangeException::class, $exception);
+
+        $message = sprintf(
+            'An entity definition for name "%s" is not available.',
+            $name
+        );
+
+        self::assertSame($message, $exception->getMessage());
+    }
+}

tests/Provider/Doctrine/FixtureFactoryTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace FactoryGirl\Tests\Provider\Doctrine;
+
+use Doctrine\ORM\EntityManager;
+use FactoryGirl\Provider\Doctrine\EntityDefinitionUnavailable;
+use FactoryGirl\Provider\Doctrine\FixtureFactory;
+
+use PHPUnit\Framework;
+
+/**
+ * @covers \FactoryGirl\Provider\Doctrine\FixtureFactory
+ */
+final class FixtureFactoryTest extends Framework\TestCase
+{
+    public function testGetThrowsEntityDefinitionUnavailableWhenDefinitionIsUnavailable(): void
+    {
+        $entityManager = $this->prophesize(EntityManager::class)->reveal();
+
+        $fixtureFactory = new FixtureFactory($entityManager);
+
+        $this->expectException(EntityDefinitionUnavailable::class);
+
+        $fixtureFactory->get('foo');
+    }
+}