Enhancement: Introduce named constructor and mark primary constructor private

CHANGELOG.md

@@ -35,6 +35,7 @@ For a full diff see [`fa9c564...master`][fa9c564...master].
 * Extracted `FieldDefinition\Value` ([#160]), by [@localheinz]
 * Extracted `FieldDefinition\Closure` ([#161]), by [@localheinz]
 * Extracted `FieldDefinition\Sequence` ([#164]), by [@localheinz]
+* Introduced named constructors for field definitions and marked primary constructor as `private` ([#188]), by [@localheinz]
 
 ### Fixed
 
@@ -93,5 +94,6 @@ For a full diff see [`fa9c564...master`][fa9c564...master].
 [#161]: https://github.com/ergebnis/factory-bot/pull/161
 [#164]: https://github.com/ergebnis/factory-bot/pull/164
 [#185]: https://github.com/ergebnis/factory-bot/pull/185
+[#188]: https://github.com/ergebnis/factory-bot/pull/188
 
 [@localheinz]: https://github.com/localheinz

phpstan-baseline.neon

@@ -65,11 +65,6 @@ parameters:
 			count: 1
 			path: test/Fixture/FixtureFactory/Entity/User.php
 
-		-
-			message: "#^Call to static method PHPUnit\\\\Framework\\\\Assert\\:\\:assertInstanceOf\\(\\) with 'Ergebnis\\\\\\\\FactoryBot\\\\\\\\Test\\\\\\\\Fixture\\\\\\\\FixtureFactory\\\\\\\\Entity\\\\\\\\User' and Ergebnis\\\\FactoryBot\\\\Test\\\\Fixture\\\\FixtureFactory\\\\Entity\\\\User will always evaluate to true\\.$#"
-			count: 1
-			path: test/Unit/FieldDefinition/ReferenceTest.php
-
 		-
 			message: "#^Parameter \\#1 \\$className of method Ergebnis\\\\FactoryBot\\\\FixtureFactory\\:\\:defineEntity\\(\\) expects class\\-string\\<NotAClass\\>, string given\\.$#"
 			count: 1

psalm-baseline.xml

@@ -5,6 +5,44 @@
       <code>return !$fieldDefinition instanceof FieldDefinition\Resolvable;</code>
     </DocblockTypeContradiction>
   </file>
+  <file src="src/FieldDefinition.php">
+    <ArgumentTypeCoercion occurrences="2">
+      <code>$className</code>
+      <code>$className</code>
+    </ArgumentTypeCoercion>
+    <MixedArgumentTypeCoercion occurrences="1">
+      <code>$value</code>
+    </MixedArgumentTypeCoercion>
+    <MixedReturnTypeCoercion occurrences="4">
+      <code>FieldDefinition\Reference::required($className)</code>
+      <code>FieldDefinition\Reference&lt;T&gt;</code>
+      <code>FieldDefinition\References&lt;T&gt;</code>
+    </MixedReturnTypeCoercion>
+  </file>
+  <file src="src/FieldDefinition/Reference.php">
+    <MixedInferredReturnType occurrences="1">
+      <code>self&lt;T&gt;</code>
+    </MixedInferredReturnType>
+    <UndefinedDocblockClass occurrences="1">
+      <code>class-string&lt;T&gt;</code>
+    </UndefinedDocblockClass>
+  </file>
+  <file src="src/FieldDefinition/References.php">
+    <MixedInferredReturnType occurrences="1">
+      <code>self&lt;T&gt;</code>
+    </MixedInferredReturnType>
+    <UndefinedDocblockClass occurrences="1">
+      <code>class-string&lt;T&gt;</code>
+    </UndefinedDocblockClass>
+  </file>
+  <file src="src/FieldDefinition/Value.php">
+    <MixedInferredReturnType occurrences="1">
+      <code>self&lt;T&gt;</code>
+    </MixedInferredReturnType>
+    <UndefinedClass occurrences="1">
+      <code>T</code>
+    </UndefinedClass>
+  </file>
   <file src="src/FixtureFactory.php">
     <MixedAssignment occurrences="5">
       <code>$fieldValues[$fieldName]</code>
@@ -58,15 +96,34 @@
     </MixedArgumentTypeCoercion>
   </file>
   <file src="test/Unit/FieldDefinition/ReferenceTest.php">
-    <RedundantConditionGivenDocblockType occurrences="1">
-      <code>assertInstanceOf</code>
-    </RedundantConditionGivenDocblockType>
+    <InvalidArgument occurrences="1">
+      <code>$className</code>
+    </InvalidArgument>
+  </file>
+  <file src="test/Unit/FieldDefinition/ReferencesTest.php">
+    <InvalidArgument occurrences="2">
+      <code>Fixture\FixtureFactory\Entity\User::class</code>
+      <code>$className</code>
+    </InvalidArgument>
   </file>
   <file src="test/Unit/FieldDefinition/ValueTest.php">
+    <MixedArgument occurrences="1">
+      <code>$value</code>
+    </MixedArgument>
     <MixedAssignment occurrences="1">
       <code>$resolved</code>
     </MixedAssignment>
   </file>
+  <file src="test/Unit/FieldDefinitionTest.php">
+    <InvalidArgument occurrences="3">
+      <code>$className</code>
+      <code>$className</code>
+      <code>$className</code>
+    </InvalidArgument>
+    <MixedArgument occurrences="1">
+      <code>$value</code>
+    </MixedArgument>
+  </file>
   <file src="test/Unit/FixtureFactoryTest.php">
     <ArgumentTypeCoercion occurrences="1">
       <code>$className</code>

src/FieldDefinition.php

@@ -17,7 +17,7 @@ final class FieldDefinition
 {
     public static function closure(\Closure $closure): FieldDefinition\Closure
     {
-        return new FieldDefinition\Closure($closure);
+        return FieldDefinition\Closure::required($closure);
     }
 
     /**
@@ -32,7 +32,7 @@ public static function sequence($value, int $initialNumber = 1): FieldDefinition
             $value .= '%d';
         }
 
-        return new FieldDefinition\Sequence(
+        return FieldDefinition\Sequence::required(
             $value,
             $initialNumber
         );
@@ -53,7 +53,7 @@ public static function sequence($value, int $initialNumber = 1): FieldDefinition
      */
     public static function reference(string $className): FieldDefinition\Reference
     {
-        return new FieldDefinition\Reference($className);
+        return FieldDefinition\Reference::required($className);
     }
 
     /**
@@ -74,7 +74,7 @@ public static function reference(string $className): FieldDefinition\Reference
      */
     public static function references(string $className, int $count = 1): FieldDefinition\References
     {
-        return new FieldDefinition\References(
+        return FieldDefinition\References::required(
             $className,
             $count
         );
@@ -95,6 +95,6 @@ public static function references(string $className, int $count = 1): FieldDefin
      */
     public static function value($value): FieldDefinition\Value
     {
-        return new FieldDefinition\Value($value);
+        return FieldDefinition\Value::required($value);
     }
 }

src/FieldDefinition/Closure.php

@@ -25,11 +25,16 @@ final class Closure implements Resolvable
      */
     private $closure;
 
-    public function __construct(\Closure $closure)
+    private function __construct(\Closure $closure)
     {
         $this->closure = $closure;
     }
 
+    public static function required(\Closure $closure): self
+    {
+        return new self($closure);
+    }
+
     public function resolve(FixtureFactory $fixtureFactory)
     {
         $closure = $this->closure;

src/FieldDefinition/Reference.php

@@ -40,11 +40,27 @@ final class Reference implements Resolvable
      *
      * @param string $className
      */
-    public function __construct(string $className)
+    private function __construct(string $className)
     {
         $this->className = $className;
     }
 
+    /**
+     * @phpstan-param class-string<T> $className
+     * @phpstan-return self<T>
+     *
+     * @psalm-param class-string<T> $className
+     * @psalm-return self<T>
+     *
+     * @param string $className
+     *
+     * @return self
+     */
+    public static function required(string $className): self
+    {
+        return new self($className);
+    }
+
     /**
      * @phpstan-return T
      *

src/FieldDefinition/References.php

@@ -46,10 +46,28 @@ final class References implements Resolvable
      *
      * @param string $className
      * @param int    $count
+     */
+    private function __construct(string $className, int $count)
+    {
+        $this->className = $className;
+        $this->count = $count;
+    }
+
+    /**
+     * @phpstan-param class-string<T> $className
+     * @phpstan-return self<T>
+     *
+     * @psalm-param class-string<T> $className
+     * @psalm-return self<T>
+     *
+     * @param string $className
+     * @param int    $count
      *
      * @throws Exception\InvalidCount
+     *
+     * @return self
      */
-    public function __construct(string $className, int $count)
+    public static function required(string $className, int $count): self
     {
         if (1 > $count) {
             throw Exception\InvalidCount::notGreaterThanOrEqualTo(
@@ -58,8 +76,10 @@ public function __construct(string $className, int $count)
             );
         }
 
-        $this->className = $className;
-        $this->count = $count;
+        return new self(
+            $className,
+            $count
+        );
     }
 
     /**

src/FieldDefinition/Sequence.php

@@ -31,19 +31,30 @@ final class Sequence implements Resolvable
      */
     private $sequentialNumber;
 
+    private function __construct(string $value, int $initialNumber)
+    {
+        $this->value = $value;
+        $this->sequentialNumber = $initialNumber;
+    }
+
     /**
      * @param string $value
      * @param int    $initialNumber
      *
      * @throws Exception\InvalidSequence
+     *
+     * @return self
      */
-    public function __construct(string $value, int $initialNumber)
+    public static function required(string $value, int $initialNumber): self
     {
         if (false === \strpos($value, '%d')) {
             throw Exception\InvalidSequence::value($value);
         }
-        $this->value = $value;
-        $this->sequentialNumber = $initialNumber;
+
+        return new self(
+            $value,
+            $initialNumber
+        );
     }
 
     public function resolve(FixtureFactory $fixtureFactory): string

src/FieldDefinition/Value.php

@@ -40,11 +40,27 @@ final class Value implements Resolvable
      *
      * @param mixed $value
      */
-    public function __construct($value)
+    private function __construct($value)
     {
         $this->value = $value;
     }
 
+    /**
+     * @phpstan-param T $value
+     * @phpstan-return self<T>
+     *
+     * @psalm-param T $value
+     * @psalm-return self<T>
+     *
+     * @param mixed $value
+     *
+     * @return self
+     */
+    public static function required($value): self
+    {
+        return new self($value);
+    }
+
     /**
      * @phpstan-return T
      *

test/Unit/FieldDefinition/ClosureTest.php

@@ -40,7 +40,7 @@ public function testResolveReturnsResultOfInvokingClosureWithFixtureFactory(): v
             return $fixtureFactory->get(Fixture\FixtureFactory\Entity\User::class);
         };
 
-        $fieldDefinition = new Closure($closure);
+        $fieldDefinition = Closure::required($closure);
 
         $resolved = $fieldDefinition->resolve($fixtureFactory);
 

test/Unit/FieldDefinition/ReferenceTest.php

@@ -38,7 +38,7 @@ public function testResolveReturnsObjectFromFixtureFactory(): void
 
         $fixtureFactory->defineEntity($className);
 
-        $fieldDefinition = new Reference($className);
+        $fieldDefinition = Reference::required($className);
 
         $resolved = $fieldDefinition->resolve($fixtureFactory);
 

test/Unit/FieldDefinition/ReferencesTest.php

@@ -45,7 +45,7 @@ public function testConstructorRejectsInvalidCount(int $count): void
             $count
         ));
 
-        new References(
+        References::required(
             Fixture\FixtureFactory\Entity\User::class,
             $count
         );
@@ -64,7 +64,7 @@ public function testResolveReturnsObjectsFromFixtureFactory(int $count): void
 
         $fixtureFactory->defineEntity($className);
 
-        $fieldDefinition = new References(
+        $fieldDefinition = References::required(
             $className,
             $count
         );

test/Unit/FieldDefinition/SequenceTest.php

@@ -41,7 +41,7 @@ public function testConstructorRejectsValueWhenItIsMissingPercentDPlaceholder():
             $value
         ));
 
-        new Sequence(
+        Sequence::required(
             $value,
             $initialNumber
         );
@@ -57,7 +57,7 @@ public function testResolveReturnsValueWithPercentDReplacedWithSequentialNumber(
 
         $fixtureFactory = new FixtureFactory(self::entityManager());
 
-        $fieldDefinition = new Sequence(
+        $fieldDefinition = Sequence::required(
             $value,
             $initialNumber
         );

test/Unit/FieldDefinition/ValueTest.php

@@ -37,7 +37,7 @@ public function testResolveReturnsValue($value): void
     {
         $fixtureFactory = new FixtureFactory(self::entityManager());
 
-        $fieldDefinition = new Value($value);
+        $fieldDefinition = Value::required($value);
 
         $resolved = $fieldDefinition->resolve($fixtureFactory);