Fix: Move operations from EntityDefinition to FixtureFactory

ergebnis · Mar 28, 2020 · f0619a7 · f0619a7
1 parent a0a815f
commit f0619a7
Show file tree

Hide file tree

Showing 6 changed files with 179 additions and 122 deletions.
diff --git a/phpstan-baseline.neon b/phpstan-baseline.neon
@@ -1,15 +1,5 @@
 parameters:
 	ignoreErrors:
-		-
-			message: "#^Parameter \\#1 \\$object of function method_exists expects object\\|string, callable given\\.$#"
-			count: 1
-			path: src/EntityDefinition.php
-
-		-
-			message: "#^Method Ergebnis\\\\FactoryBot\\\\EntityDefinition\\:\\:normalizeFieldDefinition\\(\\) should return Closure but returns object\\.$#"
-			count: 1
-			path: src/EntityDefinition.php
-
 		-
 			message: "#^Class \"Ergebnis\\\\FactoryBot\\\\Exception\\\\EntityDefinitionUnavailable\" is not allowed to extend \"OutOfRangeException\"\\.$#"
 			count: 1
@@ -45,6 +35,16 @@ parameters:
 			count: 1
 			path: src/FixtureFactory.php
 
+		-
+			message: "#^Parameter \\#1 \\$object of function method_exists expects object\\|string, callable given\\.$#"
+			count: 1
+			path: src/FixtureFactory.php
+
+		-
+			message: "#^Method Ergebnis\\\\FactoryBot\\\\FixtureFactory\\:\\:normalizeFieldDefinition\\(\\) should return callable\\(\\)\\: mixed but returns object\\.$#"
+			count: 1
+			path: src/FixtureFactory.php
+
 		-
 			message: "#^Method Ergebnis\\\\FactoryBot\\\\Test\\\\Fixture\\\\FixtureFactory\\\\Entity\\\\Organization\\:\\:id\\(\\) has a nullable return type declaration\\.$#"
 			count: 1

diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -1,29 +1,5 @@
 <?xml version="1.0" encoding="UTF-8"?>
 <files psalm-version="3.10.1@eeed5ecccc10131397f0eb7ee6da810c0be3a7fc">
-  <file src="src/EntityDefinition.php">
-    <InvalidArgument occurrences="1">
-      <code>$fieldDefinition</code>
-    </InvalidArgument>
-    <MissingClosureReturnType occurrences="4">
-      <code>static function () {</code>
-      <code>static function () use ($defaultFieldValue) {</code>
-      <code>static function () use ($fieldDefinition) {</code>
-      <code>static function () use ($fieldDefinition) {</code>
-    </MissingClosureReturnType>
-    <MixedAssignment occurrences="2">
-      <code>$fieldDefinition</code>
-      <code>$defaultFieldValue</code>
-    </MixedAssignment>
-    <MixedInferredReturnType occurrences="1">
-      <code>\Closure</code>
-    </MixedInferredReturnType>
-    <MixedReturnStatement occurrences="1">
-      <code>$fieldDefinition</code>
-    </MixedReturnStatement>
-    <TypeDoesNotContainType occurrences="1">
-      <code>\method_exists($fieldDefinition, '__invoke')</code>
-    </TypeDoesNotContainType>
-  </file>
   <file src="src/FieldDefinition.php">
     <MissingClosureReturnType occurrences="1">
       <code>static function () use (&amp;$n, $funcOrString) {</code>
@@ -39,6 +15,15 @@
     </MixedOperand>
   </file>
   <file src="src/FixtureFactory.php">
+    <InvalidArgument occurrences="1">
+      <code>$fieldDefinition</code>
+    </InvalidArgument>
+    <MissingClosureReturnType occurrences="4">
+      <code>static function () {</code>
+      <code>static function () use ($defaultFieldValue) {</code>
+      <code>static function () use ($fieldDefinition) {</code>
+      <code>static function () use ($fieldDefinition) {</code>
+    </MissingClosureReturnType>
     <MissingParamType occurrences="3">
       <code>$fieldValue</code>
       <code>$array</code>
@@ -54,12 +39,22 @@
       <code>$configuration</code>
       <code>$fieldOverrides</code>
     </MixedArgumentTypeCoercion>
-    <MixedAssignment occurrences="4">
+    <MixedAssignment occurrences="5">
+      <code>$defaultFieldValue</code>
       <code>$fieldValues[$fieldName]</code>
       <code>$fieldValue</code>
       <code>$inversedBy</code>
       <code>$collection</code>
     </MixedAssignment>
+    <MixedInferredReturnType occurrences="1">
+      <code>callable</code>
+    </MixedInferredReturnType>
+    <MixedReturnStatement occurrences="1">
+      <code>$fieldDefinition</code>
+    </MixedReturnStatement>
+    <TypeDoesNotContainType occurrences="1">
+      <code>\method_exists($fieldDefinition, '__invoke')</code>
+    </TypeDoesNotContainType>
   </file>
   <file src="test/Fixture/FixtureFactory/Entity/Organization.php">
     <PropertyNotSetInConstructor occurrences="1">
@@ -87,6 +82,11 @@
       <code>addToAssertionCount</code>
     </InternalMethod>
   </file>
+  <file src="test/Unit/EntityDefinitionTest.php">
+    <MissingClosureParamType occurrences="1">
+      <code>$entity</code>
+    </MissingClosureParamType>
+  </file>
   <file src="test/Unit/FixtureFactoryTest.php">
     <MixedArgument occurrences="3">
       <code>$name</code>

diff --git a/src/EntityDefinition.php b/src/EntityDefinition.php
@@ -20,83 +20,22 @@
  */
 final class EntityDefinition
 {
-    /**
-     * @var ORM\Mapping\ClassMetadata
-     */
     private $classMetadata;
 
-    /**
-     * @var array<string, \Closure>
-     */
     private $fieldDefinitions;
 
-    /**
-     * @var array<string, callable>
-     */
     private $configuration;
 
     /**
      * @param ORM\Mapping\ClassMetadata $classMetadata
-     * @param array<string, mixed>      $fieldDefinitions
+     * @param array<string, callable>   $fieldDefinitions
      * @param array<string, callable>   $configuration
-     *
-     * @throws Exception\InvalidFieldNames
-     * @throws \Exception
      */
     public function __construct(ORM\Mapping\ClassMetadata $classMetadata, array $fieldDefinitions, array $configuration)
     {
         $this->classMetadata = $classMetadata;
-        $this->fieldDefinitions = [];
+        $this->fieldDefinitions = $fieldDefinitions;
         $this->configuration = $configuration;
-
-        /** @var string[] $allFieldNames */
-        $allFieldNames = \array_merge(
-            \array_keys($this->classMetadata->fieldMappings),
-            \array_keys($this->classMetadata->associationMappings),
-            \array_keys($this->classMetadata->embeddedClasses)
-        );
-
-        $fieldNames = \array_filter($allFieldNames, static function (string $fieldName): bool {
-            return false === \strpos($fieldName, '.');
-        });
-
-        $extraFieldNames = \array_diff(
-            \array_keys($fieldDefinitions),
-            $fieldNames
-        );
-
-        if ([] !== $extraFieldNames) {
-            throw Exception\InvalidFieldNames::notFoundIn(
-                $classMetadata->getName(),
-                ...$extraFieldNames
-            );
-        }
-
-        foreach ($fieldDefinitions as $fieldName => $fieldDefinition) {
-            $this->fieldDefinitions[$fieldName] = self::normalizeFieldDefinition($fieldDefinition);
-        }
-
-        $defaultEntity = $this->classMetadata->newInstance();
-
-        foreach ($fieldNames as $fieldName) {
-            if (\array_key_exists($fieldName, $this->fieldDefinitions)) {
-                continue;
-            }
-
-            $defaultFieldValue = $this->classMetadata->getFieldValue($defaultEntity, $fieldName);
-
-            if (null === $defaultFieldValue) {
-                $this->fieldDefinitions[$fieldName] = static function () {
-                    return null;
-                };
-
-                continue;
-            }
-
-            $this->fieldDefinitions[$fieldName] = static function () use ($defaultFieldValue) {
-                return $defaultFieldValue;
-            };
-        }
     }
 
     /**
@@ -112,7 +51,7 @@ public function className(): string
     /**
      * Returns the fielde definition callbacks.
      *
-     * @return array<string, \Closure>
+     * @return array<string, callable>
      */
     public function fieldDefinitions(): array
     {
@@ -138,26 +77,4 @@ public function configuration(): array
     {
         return $this->configuration;
     }
-
-    /**
-     * @param callable|\Closure|mixed $fieldDefinition
-     *
-     * @return \Closure
-     */
-    private static function normalizeFieldDefinition($fieldDefinition): \Closure
-    {
-        if (\is_callable($fieldDefinition)) {
-            if (\method_exists($fieldDefinition, '__invoke')) {
-                return $fieldDefinition;
-            }
-
-            return static function () use ($fieldDefinition) {
-                return \call_user_func_array($fieldDefinition, \func_get_args());
-            };
-        }
-
-        return static function () use ($fieldDefinition) {
-            return $fieldDefinition;
-        };
-    }
 }
diff --git a/src/FixtureFactory.php b/src/FixtureFactory.php
@@ -54,6 +54,9 @@ public function __construct(ORM\EntityManagerInterface $entityManager)
      * @param array  $fieldDefinitions
      * @param array  $configuration
      *
+     * @throws \Exception
+     * @throws Exception\InvalidFieldNames
+     *
      * @return FixtureFactory
      */
     public function defineEntity(string $name, array $fieldDefinitions = [], array $configuration = [])
@@ -84,6 +87,56 @@ public function defineEntity(string $name, array $fieldDefinitions = [], array $
             ));
         }
 
+        /** @var string[] $allFieldNames */
+        $allFieldNames = \array_merge(
+            \array_keys($classMetadata->fieldMappings),
+            \array_keys($classMetadata->associationMappings),
+            \array_keys($classMetadata->embeddedClasses)
+        );
+
+        $fieldNames = \array_filter($allFieldNames, static function (string $fieldName): bool {
+            return false === \strpos($fieldName, '.');
+        });
+
+        /** @var array<int, string> $extraFieldNames */
+        $extraFieldNames = \array_diff(
+            \array_keys($fieldDefinitions),
+            $fieldNames
+        );
+
+        if ([] !== $extraFieldNames) {
+            throw Exception\InvalidFieldNames::notFoundIn(
+                $classMetadata->getName(),
+                ...$extraFieldNames
+            );
+        }
+
+        $fieldDefinitions = \array_map(static function ($fieldDefinition): callable {
+            return self::normalizeFieldDefinition($fieldDefinition);
+        }, $fieldDefinitions);
+
+        $defaultEntity = $classMetadata->newInstance();
+
+        foreach ($fieldNames as $fieldName) {
+            if (\array_key_exists($fieldName, $fieldDefinitions)) {
+                continue;
+            }
+
+            $defaultFieldValue = $classMetadata->getFieldValue($defaultEntity, $fieldName);
+
+            if (null === $defaultFieldValue) {
+                $fieldDefinitions[$fieldName] = static function () {
+                    return null;
+                };
+
+                continue;
+            }
+
+            $fieldDefinitions[$fieldName] = static function () use ($defaultFieldValue) {
+                return $defaultFieldValue;
+            };
+        }
+
         $this->entityDefinitions[$name] = new EntityDefinition(
             $classMetadata,
             $fieldDefinitions,
@@ -311,4 +364,26 @@ private function updateCollectionSideOfAssocation(
             }
         }
     }
+
+    /**
+     * @param callable|\Closure|mixed|object $fieldDefinition
+     *
+     * @return callable
+     */
+    private static function normalizeFieldDefinition($fieldDefinition): callable
+    {
+        if (\is_callable($fieldDefinition)) {
+            if (\method_exists($fieldDefinition, '__invoke')) {
+                return $fieldDefinition;
+            }
+
+            return static function () use ($fieldDefinition) {
+                return \call_user_func_array($fieldDefinition, \func_get_args());
+            };
+        }
+
+        return static function () use ($fieldDefinition) {
+            return $fieldDefinition;
+        };
+    }
 }
diff --git a/test/AutoReview/SrcCodeTest.php b/test/AutoReview/SrcCodeTest.php
@@ -33,7 +33,6 @@ public function testSrcClassesHaveUnitTests(): void
             'Ergebnis\\FactoryBot\\',
             'Ergebnis\\FactoryBot\\Test\\Unit',
             [
-                FactoryBot\EntityDefinition::class,
                 FactoryBot\FieldDefinition::class,
             ]
         );