Lazy generators (#116)

* Make generators lazy * Apply fixes from StyleCI * Revert generators * Add AR generator --------- Co-authored-by: StyleCI Bot <[email protected]>
yiisoft · Oct 8, 2023 · 31f9158 · 31f9158
1 parent e10310c
commit 31f9158
Show file tree

Hide file tree

Showing 4 changed files with 29 additions and 12 deletions.
diff --git a/config/di.php b/config/di.php
@@ -20,10 +20,10 @@
         foreach ($generators as $generator) {
             $class = $generator['class'];
             /**
-             * @var $generator GeneratorInterface
+             * @var $loader Closure(): GeneratorInterface
              */
-            $generator = $injector->make($class, $generator['parameters'] ?? []);
-            $generatorsInstances[] = $generator;
+            $loader = fn() => $injector->make($class, $generator['parameters'] ?? []);
+            $generatorsInstances[$class] = $loader;
         }
         return new Gii($generatorsInstances);
     },

diff --git a/config/params.php b/config/params.php
@@ -3,6 +3,7 @@
 declare(strict_types=1);
 
 use Yiisoft\Yii\Gii\Command\ControllerCommand;
+use Yiisoft\Yii\Gii\Generator as Generators;
 
 return [
     'yiisoft/yii-debug' => [
@@ -23,7 +24,16 @@
     'yiisoft/yii-gii' => [
         'enabled' => true,
         'allowedIPs' => ['127.0.0.1', '::1'],
-        'generators' => [],
+        'generators' => [
+            [
+                'class' => Generators\Controller\Generator::class,
+                'parameters' => [],
+            ],
+            [
+                'class' => Generators\ActiveRecord\Generator::class,
+                'parameters' => [],
+            ],
+        ],
         'parameters' => [
             'templates' => [],
         ],

diff --git a/src/Gii.php b/src/Gii.php
@@ -4,19 +4,19 @@
 
 namespace Yiisoft\Yii\Gii;
 
+use Closure;
 use Yiisoft\Yii\Gii\Exception\GeneratorNotFoundException;
 
+/**
+ * @psalm-import-type LazyGenerator from GiiInterface
+ */
 final class Gii implements GiiInterface
 {
     /**
-     * @param array<string, GeneratorInterface> $generators
+     * @param array<string, GeneratorInterface|LazyGenerator> $generators
      */
     public function __construct(private array $generators)
     {
-        $this->generators = array_combine(
-            array_map(fn (GeneratorInterface $generator) => $generator::getId(), $generators),
-            array_values($this->generators)
-        );
     }
 
     public function addGenerator(GeneratorInterface $generator): void
@@ -30,11 +30,14 @@ public function getGenerator(string $id): GeneratorInterface
             throw new GeneratorNotFoundException('Generator "' . $id . '" not found');
         }
 
-        return $this->generators[$id];
+        return $this->generators[$id] instanceof Closure ? $this->generators[$id]() : $this->generators[$id];
     }
 
     public function getGenerators(): array
     {
-        return $this->generators;
+        return array_map(
+            fn (Closure|GeneratorInterface $generator) => $generator instanceof Closure ? $generator() : $generator,
+            $this->generators
+        );
     }
 }
diff --git a/src/GiiInterface.php b/src/GiiInterface.php
@@ -4,12 +4,16 @@
 
 namespace Yiisoft\Yii\Gii;
 
+use Closure;
 use Yiisoft\Yii\Gii\Exception\GeneratorNotFoundException;
 
+/**
+ * @psalm-type LazyGenerator = Closure(): GeneratorInterface
+ */
 interface GiiInterface
 {
     /**
-     * @param GeneratorInterface $generator
+     * @psalm-param GeneratorInterface $generator
      */
     public function addGenerator(GeneratorInterface $generator): void;