Enhancement: Extract FieldDefinition\Value

CHANGELOG.md

@@ -32,6 +32,7 @@ For a full diff see [`fa9c564...master`][fa9c564...master].
 * Removed the fluent interface from `FixtureFactory::defineEntity()` ([#131]), by [@localheinz]
 * Extracted `FieldDefinition\Reference` ([#157]), by [@localheinz]
 * Extracted `FieldDefinition\References` ([#159]), by [@localheinz]
+* Extracted `FieldDefinition\Value` ([#160]), by [@localheinz]
 
 ### Fixed
 
@@ -86,5 +87,6 @@ For a full diff see [`fa9c564...master`][fa9c564...master].
 [#155]: https://github.com/ergebnis/factory-bot/pull/155
 [#157]: https://github.com/ergebnis/factory-bot/pull/157
 [#159]: https://github.com/ergebnis/factory-bot/pull/159
+[#160]: https://github.com/ergebnis/factory-bot/pull/160
 
 [@localheinz]: https://github.com/localheinz

phpstan-baseline.neon

@@ -30,6 +30,21 @@ parameters:
 			count: 1
 			path: src/FieldDefinition/Resolvable.php
 
+		-
+			message: "#^Property Ergebnis\\\\FactoryBot\\\\FieldDefinition\\\\Value\\:\\:\\$value has no typehint specified\\.$#"
+			count: 1
+			path: src/FieldDefinition/Value.php
+
+		-
+			message: "#^Method Ergebnis\\\\FactoryBot\\\\FieldDefinition\\\\Value\\:\\:__construct\\(\\) has parameter \\$value with no typehint specified\\.$#"
+			count: 1
+			path: src/FieldDefinition/Value.php
+
+		-
+			message: "#^Method Ergebnis\\\\FactoryBot\\\\FieldDefinition\\\\Value\\:\\:resolve\\(\\) has no return typehint specified\\.$#"
+			count: 1
+			path: src/FieldDefinition/Value.php
+
 		-
 			message: "#^Method Ergebnis\\\\FactoryBot\\\\FixtureFactory\\:\\:defineEntity\\(\\) has parameter \\$afterCreate with a nullable type declaration\\.$#"
 			count: 1

psalm-baseline.xml

@@ -21,9 +21,8 @@
     </MixedReturnStatement>
   </file>
   <file src="src/FieldDefinition.php">
-    <MissingClosureReturnType occurrences="2">
+    <MissingClosureReturnType occurrences="1">
       <code>static function () use (&amp;$n, $funcOrString) {</code>
-      <code>static function () use ($value) {</code>
     </MissingClosureReturnType>
     <MissingParamType occurrences="1">
       <code>$value</code>
@@ -56,6 +55,17 @@
       <code>resolve</code>
     </MissingReturnType>
   </file>
+  <file src="src/FieldDefinition/Value.php">
+    <MissingParamType occurrences="1">
+      <code>$value</code>
+    </MissingParamType>
+    <MissingPropertyType occurrences="1">
+      <code>$value</code>
+    </MissingPropertyType>
+    <MissingReturnType occurrences="1">
+      <code>resolve</code>
+    </MissingReturnType>
+  </file>
   <file src="src/FixtureFactory.php">
     <MissingClosureReturnType occurrences="1">
       <code>static function () use ($fieldDefinition) {</code>
@@ -82,6 +92,14 @@
       <code>$collection</code>
     </MixedAssignment>
   </file>
+  <file src="test/DataProvider/ValueProvider.php">
+    <InvalidReturnType occurrences="1">
+      <code>\Generator&lt;string, array&lt;string[], bool, float, int, object, \stdClass, string&gt;&gt;</code>
+    </InvalidReturnType>
+    <TooManyTemplateParams occurrences="1">
+      <code>\Generator&lt;string, array&lt;string[], bool, float, int, object, \stdClass, string&gt;&gt;</code>
+    </TooManyTemplateParams>
+  </file>
   <file src="test/Fixture/FixtureFactory/Entity/Organization.php">
     <PropertyNotSetInConstructor occurrences="1">
       <code>$id</code>
@@ -116,9 +134,11 @@
     <MixedArgumentTypeCoercion occurrences="1">
       <code>$fieldDefinitions</code>
     </MixedArgumentTypeCoercion>
-    <MixedInferredReturnType occurrences="1">
-      <code>\Generator</code>
-    </MixedInferredReturnType>
+  </file>
+  <file src="test/Unit/FieldDefinition/ValueTest.php">
+    <MixedAssignment occurrences="1">
+      <code>$resolved</code>
+    </MixedAssignment>
   </file>
   <file src="test/Unit/FieldDefinitionTest.php">
     <MixedAssignment occurrences="1">

src/FieldDefinition.php

@@ -112,10 +112,8 @@ public static function references(string $className, int $count = 1): FieldDefin
         );
     }
 
-    public static function value($value): self
+    public static function value($value): FieldDefinition\Value
     {
-        return new self(static function () use ($value) {
-            return $value;
-        });
+        return new FieldDefinition\Value($value);
     }
 }

src/FieldDefinition/Value.php

@@ -0,0 +1,34 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/factory-bot
+ */
+
+namespace Ergebnis\FactoryBot\FieldDefinition;
+
+use Ergebnis\FactoryBot\FixtureFactory;
+
+/**
+ * @internal
+ */
+final class Value implements Resolvable
+{
+    private $value;
+
+    public function __construct($value)
+    {
+        $this->value = $value;
+    }
+
+    public function resolve(FixtureFactory $fixtureFactory)
+    {
+        return $this->value;
+    }
+}

test/DataProvider/ValueProvider.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/factory-bot
+ */
+
+namespace Ergebnis\FactoryBot\Test\DataProvider;
+
+use Ergebnis\Test\Util\Helper;
+
+final class ValueProvider
+{
+    use Helper;
+
+    /**
+     * @return \Generator<string, array<string[], bool, float, int, object, \stdClass, string>>
+     */
+    public function arbitrary(): \Generator
+    {
+        $faker = self::faker();
+
+        $values = [
+            'array' => $faker->words,
+            'bool-false' => false,
+            'bool-true' => true,
+            'float' => $faker->randomFloat(),
+            'int' => $faker->numberBetween(),
+            'object' => new \stdClass(),
+            'resource' => \fopen(__FILE__, 'rb'),
+            'string' => $faker->sentence,
+        ];
+
+        foreach ($values as $key => $value) {
+            yield $key => [
+                $value,
+            ];
+        }
+    }
+}

test/Integration/FixtureFactoryTest.php

@@ -26,6 +26,7 @@
  * @uses \Ergebnis\FactoryBot\EntityDefinition
  * @uses \Ergebnis\FactoryBot\FieldDefinition
  * @uses \Ergebnis\FactoryBot\FieldDefinition\Reference
+ * @uses \Ergebnis\FactoryBot\FieldDefinition\Value
  */
 final class FixtureFactoryTest extends AbstractTestCase
 {

test/Unit/Definition/DefinitionsTest.php

@@ -29,6 +29,7 @@
  * @uses \Ergebnis\FactoryBot\Exception\InvalidDefinition
  * @uses \Ergebnis\FactoryBot\Exception\InvalidDirectory
  * @uses \Ergebnis\FactoryBot\FieldDefinition
+ * @uses \Ergebnis\FactoryBot\FieldDefinition\Value
  * @uses \Ergebnis\FactoryBot\FixtureFactory
  */
 final class DefinitionsTest extends AbstractTestCase

test/Unit/EntityDefinitionTest.php

@@ -33,7 +33,7 @@ final class EntityDefinitionTest extends Framework\TestCase
     use Helper;
 
     /**
-     * @dataProvider provideNotFieldDefinition
+     * @dataProvider \Ergebnis\FactoryBot\Test\DataProvider\ValueProvider::arbitrary()
      *
      * @param mixed $fieldDefinition
      */
@@ -57,28 +57,6 @@ static function ($entity, array $fieldValues): void {
         );
     }
 
-    public function provideNotFieldDefinition(): \Generator
-    {
-        $faker = self::faker();
-
-        $values = [
-            'array' => $faker->words,
-            'bool-false' => false,
-            'bool-true' => true,
-            'float' => $faker->randomFloat(),
-            'int' => $faker->numberBetween(),
-            'object' => new \stdClass(),
-            'resource' => \fopen(__FILE__, 'rb'),
-            'string' => $faker->sentence,
-        ];
-
-        foreach ($values as $key => $value) {
-            yield $key => [
-                $value,
-            ];
-        }
-    }
-
     public function testConstructorSetsValues(): void
     {
         $classMetadata = $this->prophesize(ORM\Mapping\ClassMetadata::class);

test/Unit/FieldDefinition/ReferenceTest.php

@@ -25,6 +25,7 @@
  *
  * @uses \Ergebnis\FactoryBot\EntityDefinition
  * @uses \Ergebnis\FactoryBot\FieldDefinition
+ * @uses \Ergebnis\FactoryBot\FieldDefinition\Value
  * @uses \Ergebnis\FactoryBot\FixtureFactory
  */
 final class ReferenceTest extends AbstractTestCase

test/Unit/FieldDefinition/ReferencesTest.php

@@ -27,6 +27,7 @@
  * @uses \Ergebnis\FactoryBot\EntityDefinition
  * @uses \Ergebnis\FactoryBot\Exception\InvalidCount
  * @uses \Ergebnis\FactoryBot\FieldDefinition
+ * @uses \Ergebnis\FactoryBot\FieldDefinition\Value
  * @uses \Ergebnis\FactoryBot\FixtureFactory
  */
 final class ReferencesTest extends AbstractTestCase

test/Unit/FieldDefinition/ValueTest.php

@@ -0,0 +1,46 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Copyright (c) 2020 Andreas Möller
+ *
+ * For the full copyright and license information, please view
+ * the LICENSE.md file that was distributed with this source code.
+ *
+ * @see https://github.com/ergebnis/factory-bot
+ */
+
+namespace Ergebnis\FactoryBot\Test\Unit\FieldDefinition;
+
+use Ergebnis\FactoryBot\FieldDefinition\Value;
+use Ergebnis\FactoryBot\FixtureFactory;
+use Ergebnis\FactoryBot\Test\Unit\AbstractTestCase;
+
+/**
+ * @internal
+ *
+ * @covers \Ergebnis\FactoryBot\FieldDefinition\Value
+ *
+ * @uses \Ergebnis\FactoryBot\EntityDefinition
+ * @uses \Ergebnis\FactoryBot\FieldDefinition
+ * @uses \Ergebnis\FactoryBot\FixtureFactory
+ */
+final class ValueTest extends AbstractTestCase
+{
+    /**
+     * @dataProvider \Ergebnis\FactoryBot\Test\DataProvider\ValueProvider::arbitrary()
+     *
+     * @param mixed $value
+     */
+    public function testResolveReturnsValue($value): void
+    {
+        $fixtureFactory = new FixtureFactory(self::entityManager());
+
+        $fieldDefinition = new Value($value);
+
+        $resolved = $fieldDefinition->resolve($fixtureFactory);
+
+        self::assertSame($value, $resolved);
+    }
+}

test/Unit/FieldDefinitionTest.php

@@ -28,6 +28,7 @@
  * @uses \Ergebnis\FactoryBot\Exception\InvalidCount
  * @uses \Ergebnis\FactoryBot\FieldDefinition\Reference
  * @uses \Ergebnis\FactoryBot\FieldDefinition\References
+ * @uses \Ergebnis\FactoryBot\FieldDefinition\Value
  * @uses \Ergebnis\FactoryBot\FixtureFactory
  */
 final class FieldDefinitionTest extends AbstractTestCase

test/Unit/FixtureFactoryTest.php

@@ -35,6 +35,7 @@
  * @uses \Ergebnis\FactoryBot\FieldDefinition
  * @uses \Ergebnis\FactoryBot\FieldDefinition\Reference
  * @uses \Ergebnis\FactoryBot\FieldDefinition\References
+ * @uses \Ergebnis\FactoryBot\FieldDefinition\Value
  */
 final class FixtureFactoryTest extends AbstractTestCase
 {