refactor(v3): remove Factories and ResetDatabase traits

Author: nikophil

phpunit-deprecation-baseline.xml

@@ -4,9 +4,6 @@
         <line number="25" hash="c6af5d66288d0667e424978000f29571e4954b81">
             <issue><![CDATA[Since symfony/framework-bundle 6.4: Not setting the "framework.php_errors.log" config option is deprecated. It will default to "true" in 7.0.]]></issue>
 
-            <issue><![CDATA[Since zenstruck/foundry 2.9: Trait Zenstruck\Foundry\Test\Factories is deprecated and will be removed in Foundry 3. See https://github.com/zenstruck/foundry/blob/2.x/UPGRADE-2.9.md to upgrade.]]></issue>
-            <issue><![CDATA[Since zenstruck/foundry 2.9: Not using Foundry's PHPUnit extension is deprecated and will throw an error in Foundry 3. See https://github.com/zenstruck/foundry/blob/2.x/UPGRADE-2.9.md to upgrade.]]></issue>
-
             <issue><![CDATA[Since doctrine/mongodb-odm 2.14: Not using native lazy objects is deprecated and will be impossible in Doctrine MongoDB ODM 3.0.]]></issue>
             <issue><![CDATA[Since symfony/framework-bundle 7.3: Not setting the "property_info.with_constructor_extractor" option explicitly is deprecated because its default value will change in version 8.0.]]></issue>
             <issue><![CDATA[Since symfony/console 7.4: The "Symfony\Component\Console\Application::add()" method is deprecated and will be removed in Symfony 8.0, use "Symfony\Component\Console\Application::addCommand()" instead.]]></issue>

src/Configuration.php

@@ -13,16 +13,13 @@
 
 use Faker;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
-use Zenstruck\Foundry\Exception\FactoriesTraitNotUsed;
 use Zenstruck\Foundry\Exception\FoundryNotBooted;
 use Zenstruck\Foundry\Exception\PersistenceDisabled;
 use Zenstruck\Foundry\Exception\PersistenceNotAvailable;
 use Zenstruck\Foundry\InMemory\CannotEnableInMemory;
 use Zenstruck\Foundry\InMemory\InMemoryRepositoryRegistry;
 use Zenstruck\Foundry\Persistence\PersistedObjectsTracker;
 use Zenstruck\Foundry\Persistence\PersistenceManager;
-use Zenstruck\Foundry\PHPUnit\FoundryExtension;
-
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  *
@@ -118,10 +115,6 @@ public static function instance(): self
             throw new FoundryNotBooted();
         }
 
-        if (!FoundryExtension::isEnabled()) {
-            FactoriesTraitNotUsed::throwIfComingFromKernelTestCaseWithoutFactoriesTrait();
-        }
-
         return \is_callable(self::$instance) ? (self::$instance)() : self::$instance;
     }
 
@@ -143,10 +136,6 @@ public static function bootForDataProvider(\Closure|self $configuration): void
         self::$instance->bootedForDataProvider = true;
     }
 
-    /**
-     * /!\ Until PHPUnit 9 support is not dropped, this method MUST NOT call Configuration::instance()
-     * Otherwise, it will reboot the kernel, leading to complex bugs.
-     */
     public static function shutdown(): void
     {
         PersistedObjectsTracker::reset();

src/Exception/FactoriesTraitNotUsed.php

@@ -11,19 +11,13 @@
 
 namespace Zenstruck\Foundry\Exception;
 
-use Zenstruck\Foundry\PHPUnit\FoundryExtension;
-
 /**
  * @author Kevin Bond <kevinbond@gmail.com>
  */
 final class FoundryNotBooted extends \LogicException
 {
     public function __construct()
     {
-        $message = FoundryExtension::shouldBeEnabled()
-            ? 'Foundry is not yet booted. Ensure ZenstruckFoundryBundle is enabled. If in a test, ensure Foundry\'s extension is enabled.'
-            : 'Foundry is not yet booted. Ensure ZenstruckFoundryBundle is enabled. If in a test, ensure your TestCase has the Factories trait.';
-
-        parent::__construct($message);
+        parent::__construct('Foundry is not yet booted. Ensure ZenstruckFoundryBundle is enabled. If in a test, ensure Foundry\'s extension is enabled.');
     }
 }

src/Exception/FoundryNotBooted.php

@@ -27,39 +27,38 @@
  * @internal
  * @author Nicolas PHILIPPE <nikophil@gmail.com>
  */
-if (\interface_exists(Runner\Extension\Extension::class)) {
-    final class FoundryExtension implements Runner\Extension\Extension
-    {
-        public const PARAMETER_AUTO_RESET_DATABASE_CLASS = 'enabled-auto-reset';
+final class FoundryExtension implements Runner\Extension\Extension
+{
+    public const PARAMETER_AUTO_RESET_DATABASE_CLASS = 'enabled-auto-reset';
 
-        private static bool $enabled = false;
+    private static bool $enabled = false;
 
-        public function bootstrap(
-            TextUI\Configuration\Configuration $configuration,
-            Runner\Extension\Facade $facade,
-            Runner\Extension\ParameterCollection $parameters,
-        ): void {
-            // shutdown Foundry if for some reason it has been booted before
-            if (Configuration::isBooted()) {
-                Configuration::shutdown();
-            }
+    public function bootstrap(
+        TextUI\Configuration\Configuration $configuration,
+        Runner\Extension\Facade $facade,
+        Runner\Extension\ParameterCollection $parameters,
+    ): void {
+        // shutdown Foundry if for some reason it has been booted before
+        if (Configuration::isBooted()) {
+            Configuration::shutdown();
+        }
 
-            $autoResetEnabled = $parameters->has(self::PARAMETER_AUTO_RESET_DATABASE_CLASS)
-                && 'true' === $parameters->get(self::PARAMETER_AUTO_RESET_DATABASE_CLASS);
+        $autoResetEnabled = $parameters->has(self::PARAMETER_AUTO_RESET_DATABASE_CLASS)
+            && 'true' === $parameters->get(self::PARAMETER_AUTO_RESET_DATABASE_CLASS);
 
-            // ⚠️ order matters within each event
+        // ⚠️ order matters within each event
             $subscribers = [
                 Event\TestSuite\Started::class => [new ResetDatabaseOnTestSuiteStarted($autoResetEnabled)],
                 Event\Test\DataProviderMethodCalled::class => [new BootFoundryOnDataProviderMethodCalled()],
                 Event\Test\DataProviderMethodFinished::class => [new ShutdownFoundryOnDataProviderMethodFinished()],
                 Event\Test\PreparationStarted::class => [
-                    new BootFoundryOnPreparationStarted(),
-                    new ResetDatabaseOnPreparationStarted($autoResetEnabled),
-                    new EnableInMemoryOnPreparationStarted(),
+            new BootFoundryOnPreparationStarted(),
+            new ResetDatabaseOnPreparationStarted($autoResetEnabled),
+            new EnableInMemoryOnPreparationStarted(),
                 ],
                 Event\Test\Prepared::class => [
-                    new BuildStoryOnTestPrepared(),
-                    new TriggerDataProviderPersistenceOnTestPrepared(),
+            new BuildStoryOnTestPrepared(),
+            new TriggerDataProviderPersistenceOnTestPrepared(),
                 ],
                 Event\Test\Finished::class => [new ShutdownFoundryOnTestFinished()],
                 Event\TestRunner\Finished::class => [new DisplayFakerSeedOnApplicationFinished()],
@@ -72,35 +71,21 @@ public function bootstrap(
                 $subscribers = \array_filter(
                     $subscribers,
                     static fn($subscriber) => !$subscriber instanceof DataProviderSubscriberInterface
-                );
+        );
             }
 
             $facade->registerSubscribers(...$subscribers);
 
-            self::$enabled = true;
-        }
-
-        public static function shouldBeEnabled(): bool
-        {
-            return \defined('PHPUNIT_COMPOSER_INSTALL') && !self::isEnabled() && ConstraintRequirement::from('>=10')->isSatisfiedBy(Runner\Version::id());
-        }
-
-        public static function isEnabled(): bool
-        {
-            return self::$enabled;
-        }
+        self::$enabled = true;
     }
-} else {
-    final class FoundryExtension
+
+    public static function shouldBeEnabled(): bool
     {
-        public static function shouldBeEnabled(): bool
-        {
-            return false;
-        }
+        return \defined('PHPUNIT_COMPOSER_INSTALL') && !self::isEnabled() && ConstraintRequirement::from('>=10')->isSatisfiedBy(Runner\Version::id());
+    }
 
-        public static function isEnabled(): bool
-        {
-            return false;
-        }
+    public static function isEnabled(): bool
+    {
+        return self::$enabled;
     }
 }

src/PHPUnit/FoundryExtension.php

@@ -76,9 +76,6 @@ private function shouldReset(Event\Code\TestMethod $test): bool
             return true;
         }
 
-        return $hasResetDatabaseAttribute
-
-            // let's use ResetDatabase trait as a marker, the same way we're using the attribute
-            || (new \ReflectionClass($test->className()))->hasMethod('_resetDatabaseBeforeFirstTest');
+        return $hasResetDatabaseAttribute;
     }
 }

src/PHPUnit/ResetDatabase/ResetDatabaseOnPreparationStarted.php

@@ -69,9 +69,6 @@ private function shouldReset(string $testClassName): bool
             return true;
         }
 
-        return AttributeReader::classOrParentsHasAttribute($testClassName, ResetDatabase::class)
-
-            // let's use ResetDatabase trait as a marker, the same way we're using the attribute
-            || (new \ReflectionClass($testClassName))->hasMethod('_resetDatabaseBeforeFirstTest');
+        return AttributeReader::classOrParentsHasAttribute($testClassName, ResetDatabase::class);
     }
 }