feat: introduce hook services

composer.json

@@ -38,6 +38,7 @@
         "phpunit/phpunit": "^9.5.0 || ^10.0 || ^11.0",
         "symfony/console": "^6.4|^7.0",
         "symfony/dotenv": "^6.4|^7.0",
+        "symfony/event-dispatcher": "^7.2",
         "symfony/maker-bundle": "^1.55",
         "symfony/phpunit-bridge": "^6.4|^7.0",
         "symfony/runtime": "^6.4|^7.0",

config/services.php

@@ -5,6 +5,7 @@
 use Faker;
 use Zenstruck\Foundry\Configuration;
 use Zenstruck\Foundry\FactoryRegistry;
+use Zenstruck\Foundry\Hooks\HooksRegistry;
 use Zenstruck\Foundry\Object\Instantiator;
 use Zenstruck\Foundry\StoryRegistry;
 
@@ -32,7 +33,13 @@
             service('.zenstruck_foundry.instantiator'),
             service('.zenstruck_foundry.story_registry'),
             service('.zenstruck_foundry.persistence_manager')->nullOnInvalid(),
+            service('.zenstruck_foundry.hooks.registry')->nullOnInvalid(),
         ])
         ->public()
+
+        ->set('.zenstruck_foundry.hooks.registry', HooksRegistry::class)
+        ->args([
+            abstract_arg('hooks_service_locator'),
+        ])
     ;
 };

src/Configuration.php

@@ -15,6 +15,7 @@
 use Zenstruck\Foundry\Exception\FoundryNotBooted;
 use Zenstruck\Foundry\Exception\PersistenceDisabled;
 use Zenstruck\Foundry\Exception\PersistenceNotAvailable;
+use Zenstruck\Foundry\Hooks\HooksRegistry;
 use Zenstruck\Foundry\Persistence\PersistenceManager;
 
 /**
@@ -50,6 +51,7 @@ public function __construct(
         callable $instantiator,
         public readonly StoryRegistry $stories,
         private readonly ?PersistenceManager $persistence = null,
+        private readonly ?HooksRegistry $hooksRegistry = null,
     ) {
         $this->instantiator = $instantiator;
     }
@@ -79,6 +81,16 @@ public function assertPersistenceEnabled(): void
         }
     }
 
+    public function isHooksRegistry(): bool
+    {
+        return (bool) $this->hooksRegistry;
+    }
+
+    public function hooksRegistry(): HooksRegistry
+    {
+        return $this->hooksRegistry ?? throw new \LogicException('noop!');
+    }
+
     public function inADataProvider(): bool
     {
         return $this->bootedForDataProvider;

src/Hooks/AfterInstantiate.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\Hooks;
+
+use Zenstruck\Foundry\Factory;
+use Zenstruck\Foundry\ObjectFactory;
+
+/**
+ * @phpstan-import-type Parameters from Factory
+ * @template T of object
+ * @implements HookEvent<T>
+ */
+final class AfterInstantiate implements HookEvent
+{
+    public function __construct(
+        /** @var T */
+        public readonly object $object,
+        /** @phpstan-var Parameters */
+        public readonly array $parameters,
+        /** @var ObjectFactory<T> */
+        public readonly ObjectFactory $factory,
+    ) {
+    }
+
+    public function getObjectClass(): string
+    {
+        return $this->object::class;
+    }
+}

src/Hooks/AfterPersist.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\Hooks;
+
+use Zenstruck\Foundry\Factory;
+use Zenstruck\Foundry\Persistence\PersistentObjectFactory;
+
+/**
+ * @phpstan-import-type Parameters from Factory
+ * @template T of object
+ * @implements HookEvent<T>
+ */
+final class AfterPersist implements HookEvent
+{
+    public function __construct(
+        /** @var T */
+        public readonly object $object,
+        /** @phpstan-var Parameters */
+        public readonly array $parameters,
+        /** @var PersistentObjectFactory<T> */
+        public readonly PersistentObjectFactory $factory,
+    ) {
+    }
+
+    public function getObjectClass(): string
+    {
+        return $this->object::class;
+    }
+}

src/Hooks/AsAfterInstantiateFoundryHook.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\Hooks;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class AsAfterInstantiateFoundryHook
+{
+    public function __construct(
+        public ?string $class = null,
+    ) {
+    }
+}

src/Hooks/AsAfterPersistFoundryHook.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\Hooks;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class AsAfterPersistFoundryHook
+{
+    public function __construct(
+        public ?string $class = null,
+    ) {
+    }
+}

src/Hooks/AsBeforeInstantiateFoundryHook.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\Hooks;
+
+#[\Attribute(\Attribute::TARGET_CLASS)]
+final class AsBeforeInstantiateFoundryHook
+{
+    public function __construct(
+        public ?string $class = null,
+    ) {
+    }
+}

src/Hooks/BeforeInstantiate.php

@@ -0,0 +1,40 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\Hooks;
+
+use Zenstruck\Foundry\Factory;
+use Zenstruck\Foundry\ObjectFactory;
+
+/**
+ * @phpstan-import-type Parameters from Factory
+ * @template T of object
+ * @implements HookEvent<T>
+ */
+final class BeforeInstantiate implements HookEvent
+{
+    public function __construct(
+        /** @phpstan-var Parameters */
+        public array $parameters,
+        /** @var class-string<T> */
+        public readonly string $objectClass,
+        /** @var ObjectFactory<T> */
+        public readonly ObjectFactory $factory,
+    ) {
+    }
+
+    public function getObjectClass(): string
+    {
+        return $this->objectClass;
+    }
+}

src/Hooks/HookEvent.php

@@ -0,0 +1,25 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\Hooks;
+
+/**
+ * todo: check if this is possible.
+ * @internal
+ * @template T of object
+ */
+interface HookEvent
+{
+    /** @return class-string<T> */
+    public function getObjectClass(): string;
+}

src/Hooks/HooksRegistry.php

@@ -0,0 +1,57 @@
+<?php
+
+declare(strict_types=1);
+
+/*
+ * This file is part of the zenstruck/foundry package.
+ *
+ * (c) Kevin Bond <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Zenstruck\Foundry\Hooks;
+
+use Symfony\Component\DependencyInjection\ServiceLocator;
+
+/**
+ * @internal
+ */
+final class HooksRegistry
+{
+    public function __construct(
+        /** @var ServiceLocator<array<string, callable(HookEvent<object>): void>> */
+        private ServiceLocator $serviceLocator,
+    ) {
+    }
+
+    /**
+     * @param HookEvent<object> $hookEvent
+     */
+    public function callHooks(HookEvent $hookEvent): void
+    {
+        foreach ($this->resolveHooks($hookEvent) as $hook) {
+            ($hook)($hookEvent);
+        }
+    }
+
+    public static function hookClassSpecificIndex(string $hookEventClass, string $objectClass): string
+    {
+        return "{$hookEventClass}-{$objectClass}";
+    }
+
+    /**
+     * @param  HookEvent<object>                     $hookEvent
+     * @return (callable(HookEvent<object>): void)[]
+     */
+    private function resolveHooks(HookEvent $hookEvent): array
+    {
+        $objectSpecificIndex = self::hookClassSpecificIndex($hookEvent::class, $hookEvent->getObjectClass());
+
+        return [
+            ...$this->serviceLocator->has($hookEvent::class) ? $this->serviceLocator->get($hookEvent::class) : [],
+            ...$this->serviceLocator->has($objectSpecificIndex) ? $this->serviceLocator->get($objectSpecificIndex) : [],
+        ];
+    }
+}

src/ObjectFactory.php

@@ -11,6 +11,8 @@
 
 namespace Zenstruck\Foundry;
 
+use Zenstruck\Foundry\Hooks\AfterInstantiate;
+use Zenstruck\Foundry\Hooks\BeforeInstantiate;
 use Zenstruck\Foundry\Object\Instantiator;
 
 /**
@@ -102,4 +104,31 @@ public function afterInstantiate(callable $callback): static
 
         return $clone;
     }
+
+    /**
+     * @internal
+     */
+    protected function initializeInternal(): static
+    {
+        if (!Configuration::instance()->isHooksRegistry()) {
+            return $this;
+        }
+
+        return $this->beforeInstantiate(
+            static function(array $parameters, string $objectClass, self $usedFactory): array {
+                Configuration::instance()->hooksRegistry()->callHooks(
+                    $hook = new BeforeInstantiate($parameters, $objectClass, $usedFactory)
+                );
+
+                return $hook->parameters;
+            }
+        )
+            ->afterInstantiate(
+                static function(object $object, array $parameters, self $usedFactory): void {
+                    Configuration::instance()->hooksRegistry()->callHooks(
+                        new AfterInstantiate($object, $parameters, $usedFactory)
+                    );
+                }
+            );
+    }
 }