refactor: Allow for lazy injections

Author: ollieread

src/Concise.php

@@ -6,6 +6,7 @@
 use Articulate\Concise\Contracts\EntityMapper;
 use Articulate\Concise\Contracts\Mapper;
 use Articulate\Concise\Contracts\Repository;
+use Closure;
 use Illuminate\Database\RecordsNotFoundException;
 use Illuminate\Foundation\Application;
 use Illuminate\Support\Str;
@@ -153,50 +154,49 @@ public function repository(string $class): Repository
      *
      * @template EntityObject of object
      *
-     * @param class-string<EntityObject> $class
-     * @param string|int                 $identity
-     * @param array<string, mixed>       $data
+     * @param class-string<EntityObject>     $class
+     * @param string|int                     $identity
+     * @param array<string, mixed>           $data
+     * @param (\Closure():EntityObject)|null $factory
      *
-     * @return object|null
+     * @return object
      *
-     * @phpstan-return EntityObject|null
+     * @phpstan-return EntityObject
      *
      * @throws \Illuminate\Contracts\Container\BindingResolutionException
      */
-    public function lazy(string $class, string|int $identity, array $data = []): ?object
+    public function lazy(string $class, string|int $identity, array $data = [], ?Closure $factory = null): object
     {
         /** @var \Articulate\Concise\Contracts\EntityMapper<EntityObject>|null $mapper */
         $mapper = $this->entity($class);
 
         if ($mapper === null) {
-            return null;
+            throw new RuntimeException('No entity mapper registered for class [' . $class . ']');
         }
 
         $repository = $this->repository($class);
 
         try {
             $reflector = new ReflectionClass($class);
-            $lazy      = $reflector->newLazyProxy(
-            /**
-             * @phpstan-param EntityObject $proxy
-             */
-                function (object $proxy) use ($repository, $identity, $mapper) {
-                    /** @var EntityObject|null $entity */
-                    $entity = $repository->getOne(Criterion::forIdentifier($identity));
-
-                    if ($entity === null) {
-                        throw new RecordsNotFoundException('No results for entity [' . $mapper->class() . ']');
-                    }
-
-                    return $entity;
+
+            $factory   ??= static function (object $proxy) use ($repository, $identity, $mapper) {
+                /** @var EntityObject|null $entity */
+                $entity = $repository->getOne(Criterion::forIdentifier($identity));
+
+                if ($entity === null) {
+                    throw new RecordsNotFoundException('No results for entity [' . $mapper->class() . ']');
                 }
-            );
+
+                return $entity;
+            };
+
+            $lazy      = $reflector->newLazyProxy($factory);
 
             $reflector->getProperty($mapper->identity())->setRawValueWithoutLazyInitialization($lazy, $identity);
         } catch (Throwable $e) {
             report($e);
 
-            return null;
+            throw new RuntimeException('Unable to create lazy proxy for entity [' . $class . ']');
         }
 
         foreach ($data as $property => $value) {

src/Support/ImplicitBindingSubstitution.php

@@ -19,6 +19,18 @@
  */
 final class ImplicitBindingSubstitution
 {
+    private static bool $lazyInjection = false;
+
+    public static function lazilyInject(): void
+    {
+        self::$lazyInjection = true;
+    }
+
+    public static function eagerlyInject(): void
+    {
+        self::$lazyInjection = false;
+    }
+
     /**
      * @var \Articulate\Concise\Concise
      */
@@ -131,18 +143,26 @@ private function resolveEntity(EntityMapper $mapper, string $value, ?string $bin
         /** @var \Articulate\Concise\Contracts\Repository<EntityObject> $repository */
         $repository = $this->concise->repository($mapper->class());
 
-        if ($repository instanceof RoutableRepository) {
-            $entity = $repository->getOneForRouting($value, $bindingField);
-        } else {
-            $entity = $repository->getOne(Criterion::forIdentifier($value));
-        }
+        $resolver = static function () use ($repository, $value, $bindingField, $mapper) {
+            if ($repository instanceof RoutableRepository) {
+                $entity = $repository->getOneForRouting($value, $bindingField);
+            } else {
+                $entity = $repository->getOne(Criterion::forIdentifier($value));
+            }
+
+            /** @var EntityObject|null $entity */
+
+            if ($entity === null) {
+                throw new RecordsNotFoundException('No results for entity [' . $mapper->class() . ']');
+            }
 
-        /** @var EntityObject|null $entity */
+            return $entity;
+        };
 
-        if ($entity === null) {
-            throw new RecordsNotFoundException('No results for entity [' . $mapper->class() . ']');
+        if (self::$lazyInjection === true) {
+            return $this->concise->lazy($mapper->class(), $value, factory: $resolver);
         }
 
-        return $entity;
+        return $resolver();
     }
 }