Fix: Split persistOnGet()

CHANGELOG.md

@@ -12,6 +12,7 @@ For a full diff see [`0.1.0...main`][0.1.0...main].
 
 * Renamed `InvalidDefinition::fromClassNameAndException()` to `InvalidDefinition::throwsExceptionDuringInstantiation()` ([#300]), by [@localheinz]
 * Renamed `Number` to `Count` ([#309]), by [@localheinz]
+* Split `FixtureFactory::persistOnGet()` into `FixtureFactory::persistAfterCreate()` and `FixtureFactory::doNotPersistAfterCreate()` ([#311]), by [@localheinz]
 
 ### Fixed
 
@@ -148,5 +149,6 @@ For a full diff see [`fa9c564...0.1.0`][fa9c564...0.1.0].
 [#301]: https://github.com/ergebnis/factory-bot/pull/301
 [#302]: https://github.com/ergebnis/factory-bot/pull/302
 [#309]: https://github.com/ergebnis/factory-bot/pull/309
+[#311]: https://github.com/ergebnis/factory-bot/pull/311
 
 [@localheinz]: https://github.com/localheinz

src/FixtureFactory.php

@@ -42,7 +42,7 @@ final class FixtureFactory
     /**
      * @var bool
      */
-    private $persist = false;
+    private $persistAfterCreate = false;
 
     public function __construct(ORM\EntityManagerInterface $entityManager, Generator $faker)
     {
@@ -218,7 +218,7 @@ public function createOne(string $className, array $fieldDefinitionOverrides = [
             $this->faker
         );
 
-        if ($this->persist && false === $classMetadata->isEmbeddedClass) {
+        if ($this->persistAfterCreate && false === $classMetadata->isEmbeddedClass) {
             $this->entityManager->persist($entity);
         }
 
@@ -261,15 +261,19 @@ public function createMany(string $className, Count $count, array $fieldDefiniti
     }
 
     /**
-     * Sets whether `get()` should automatically persist the entity it creates.
-     * By default it does not. In any case, you still need to call
-     * flush() yourself.
-     *
-     * @param bool $enabled
+     * Enable persisting of entities after creation.
+     */
+    public function persistAfterCreate(): void
+    {
+        $this->persistAfterCreate = true;
+    }
+
+    /**
+     * Disable persisting of entities after creation.
      */
-    public function persistOnGet(bool $enabled = true): void
+    public function doNotPersistAfterCreate(): void
     {
-        $this->persist = $enabled;
+        $this->persistAfterCreate = false;
     }
 
     /**

test/Integration/FixtureFactoryTest.php

@@ -59,7 +59,7 @@ public function testCreateOneDoesNotPersistEntityByDefault(): void
         self::assertNull($organization);
     }
 
-    public function testCreateOnePersistsEntityWhenPersistOnGetHasBeenEnabled(): void
+    public function testCreateOnePersistsEntityWhenPersistAfterCreateHasBeenEnabled(): void
     {
         $entityManager = self::entityManager();
         $faker = self::faker();
@@ -75,7 +75,7 @@ public function testCreateOnePersistsEntityWhenPersistOnGetHasBeenEnabled(): voi
             'name' => $name,
         ]);
 
-        $fixtureFactory->persistOnGet();
+        $fixtureFactory->persistAfterCreate();
 
         $fixtureFactory->createOne(Fixture\FixtureFactory\Entity\Organization::class);
 
@@ -89,7 +89,7 @@ public function testCreateOnePersistsEntityWhenPersistOnGetHasBeenEnabled(): voi
         self::assertInstanceOf(Fixture\FixtureFactory\Entity\Organization::class, $organization);
     }
 
-    public function testCreateOneDoesNotPersistEntityWhenPersistOnGetHasBeenDisabled(): void
+    public function testCreateOneDoesNotPersistEntityWhenPersistAfterCreateHasBeenDisabled(): void
     {
         $entityManager = self::entityManager();
         $faker = self::faker();
@@ -105,8 +105,8 @@ public function testCreateOneDoesNotPersistEntityWhenPersistOnGetHasBeenDisabled
             'name' => $name,
         ]);
 
-        $fixtureFactory->persistOnGet();
-        $fixtureFactory->persistOnGet(false);
+        $fixtureFactory->persistAfterCreate();
+        $fixtureFactory->doNotPersistAfterCreate();
 
         $fixtureFactory->createOne(Fixture\FixtureFactory\Entity\Organization::class);
 
@@ -120,7 +120,7 @@ public function testCreateOneDoesNotPersistEntityWhenPersistOnGetHasBeenDisabled
         self::assertNull($organization);
     }
 
-    public function testCreateOneDoesNotPersistEmbeddablesWhenPersistOnGetHasBeenEnabled(): void
+    public function testCreateOneDoesNotPersistEmbeddablesWhenPersistAfterCreateHasBeenEnabled(): void
     {
         $entityManager = self::entityManager();
         $faker = self::faker();
@@ -141,7 +141,7 @@ public function testCreateOneDoesNotPersistEmbeddablesWhenPersistOnGetHasBeenEna
             'login' => $faker->userName,
         ]);
 
-        $fixtureFactory->persistOnGet();
+        $fixtureFactory->persistAfterCreate();
 
         $fixtureFactory->createOne(Fixture\FixtureFactory\Entity\User::class);
 
@@ -176,7 +176,7 @@ public function testCreateManyDoesNotPersistEntitiesByDefault(): void
         self::assertEmpty($organizations);
     }
 
-    public function testCreateManyPersistsEntitiesWhenPersistOnGetHasBeenEnabled(): void
+    public function testCreateManyPersistsEntitiesWhenPersistAfterCreateHasBeenEnabled(): void
     {
         $entityManager = self::entityManager();
         $faker = self::faker();
@@ -190,7 +190,7 @@ public function testCreateManyPersistsEntitiesWhenPersistOnGetHasBeenEnabled():
             'name' => FieldDefinition::sequence('name-%d'),
         ]);
 
-        $fixtureFactory->persistOnGet();
+        $fixtureFactory->persistAfterCreate();
 
         $value = $faker->numberBetween(1, 5);
 
@@ -207,7 +207,7 @@ public function testCreateManyPersistsEntitiesWhenPersistOnGetHasBeenEnabled():
         self::assertCount($value, $organizations);
     }
 
-    public function testCreateManyDoesNotPersistEntitiesWhenPersistOnGetHasBeenDisabled(): void
+    public function testCreateManyDoesNotPersistEntitiesWhenPersistAfterCreateHasBeenDisabled(): void
     {
         $entityManager = self::entityManager();
         $faker = self::faker();
@@ -221,8 +221,8 @@ public function testCreateManyDoesNotPersistEntitiesWhenPersistOnGetHasBeenDisab
             'name' => FieldDefinition::sequence('name-%d'),
         ]);
 
-        $fixtureFactory->persistOnGet();
-        $fixtureFactory->persistOnGet(false);
+        $fixtureFactory->persistAfterCreate();
+        $fixtureFactory->doNotPersistAfterCreate();
 
         $value = $faker->numberBetween(1, 5);