Merge pull request #1037 from hydephp/add-kernel-callbacks

emmadesilva · web-flow · commit 57e0d28fe1d4 · 2023-02-15T18:50:27.000+01:00
Add HydeKernel booting callback API
diff --git a/packages/framework/src/Foundation/Concerns/BootsHydeKernel.php b/packages/framework/src/Foundation/Concerns/BootsHydeKernel.php
@@ -18,6 +18,15 @@ trait BootsHydeKernel
     private bool $readyToBoot = false;
     private bool $booting = false;
 
+    /** @var array<callable> */
+    protected array $bootingCallbacks = [];
+
+    /** @var array<callable> */
+    protected array $bootedCallbacks = [];
+
+    /**
+     * Boot the Hyde Kernel and run the Auto-Discovery Process.
+     */
     public function boot(): void
     {
         if (! $this->readyToBoot || $this->booting) {
@@ -30,14 +39,50 @@ public function boot(): void
         $this->pages = PageCollection::init($this);
         $this->routes = RouteCollection::init($this);
 
+        foreach ($this->bootingCallbacks as $callback) {
+            $callback($this);
+        }
+
         $this->files->boot();
         $this->pages->boot();
         $this->routes->boot();
 
+        foreach ($this->bootedCallbacks as $callback) {
+            $callback($this);
+        }
+
         $this->booting = false;
         $this->booted = true;
     }
 
+    /**
+     * Register a new boot listener.
+     *
+     * Your callback will be called before the kernel is booted.
+     * You can use this to register your own routes, pages, etc.
+     * The kernel instance will be passed to your callback.
+     *
+     * @param  callable(\Hyde\Foundation\HydeKernel): void  $callback
+     */
+    public function booting(callable $callback): void
+    {
+        $this->bootingCallbacks[] = $callback;
+    }
+
+    /**
+     * Register a new "booted" listener.
+     *
+     * Your callback will be called after the kernel is booted.
+     * You can use this to run any logic after discovery has completed.
+     * The kernel instance will be passed to your callback.
+     *
+     * @param  callable(\Hyde\Foundation\HydeKernel): void  $callback
+     */
+    public function booted(callable $callback): void
+    {
+        $this->bootedCallbacks[] = $callback;
+    }
+
     /** @internal */
     public function readyToBoot(): void
     {
diff --git a/packages/framework/tests/Feature/HydeKernelTest.php b/packages/framework/tests/Feature/HydeKernelTest.php
@@ -12,6 +12,7 @@
 use Hyde\Hyde;
 use Hyde\Pages\BladePage;
 use Hyde\Pages\DocumentationPage;
+use Hyde\Pages\InMemoryPage;
 use Hyde\Pages\MarkdownPage;
 use Hyde\Pages\MarkdownPost;
 use Hyde\Support\Facades\Render;
@@ -427,4 +428,103 @@ public function test_can_access_kernel_fluently_using_the_facade()
         $this->assertSame(HydeKernel::getInstance(), Hyde::kernel());
         $this->assertSame(HydeKernel::VERSION, Hyde::kernel()->version());
     }
+
+    public function test_can_register_booting_callback_closure()
+    {
+        $kernel = new HydeKernel();
+
+        $kernel->booting(function () {
+            $this->assertTrue(true);
+        });
+
+        $kernel->readyToBoot();
+        $kernel->boot();
+    }
+
+    public function test_can_register_booted_callback_closure()
+    {
+        $kernel = new HydeKernel();
+
+        $kernel->booted(function () {
+            $this->assertTrue(true);
+        });
+
+        $kernel->readyToBoot();
+        $kernel->boot();
+    }
+
+    public function test_can_register_booting_callback_callable()
+    {
+        $kernel = new HydeKernel();
+
+        $kernel->booting(new CallableClass($this));
+
+        $kernel->readyToBoot();
+        $kernel->boot();
+    }
+
+    public function test_can_register_booted_callback_callable()
+    {
+        $kernel = new HydeKernel();
+
+        $kernel->booted(new CallableClass($this));
+
+        $kernel->readyToBoot();
+        $kernel->boot();
+    }
+
+    public function test_booting_callback_receives_kernel_instance()
+    {
+        $kernel = new HydeKernel();
+
+        $kernel->booting(function ($_kernel) use ($kernel) {
+            $this->assertSame($kernel, $_kernel);
+        });
+
+        $kernel->readyToBoot();
+        $kernel->boot();
+    }
+
+    public function test_booted_callback_receives_kernel_instance()
+    {
+        $kernel = new HydeKernel();
+
+        $kernel->booted(function ($_kernel) use ($kernel) {
+            $this->assertSame($kernel, $_kernel);
+        });
+
+        $kernel->readyToBoot();
+        $kernel->boot();
+    }
+
+    public function test_can_use_booting_callbacks_to_inject_custom_pages()
+    {
+        $kernel = new HydeKernel();
+
+        $page = new InMemoryPage('foo');
+        $kernel->booting(function (HydeKernel $kernel) use ($page): void {
+            $kernel->pages()->addPage($page);
+        });
+
+        $kernel->readyToBoot();
+        $kernel->boot();
+
+        $this->assertSame($page, $kernel->pages()->getPage('foo'));
+        $this->assertEquals($page->getRoute(), $kernel->routes()->getRoute('foo'));
+    }
+}
+
+class CallableClass
+{
+    private TestCase $test;
+
+    public function __construct($test)
+    {
+        $this->test = $test;
+    }
+
+    public function __invoke(): void
+    {
+        $this->test->assertTrue(true);
+    }
 }
