feat(debug): emit ItemsDebugged on debug (#796)

Author: innocenzi

src/Tempest/Debug/src/Debug.php

@@ -4,34 +4,35 @@
 
 namespace Tempest\Debug;
 
+use Exception;
 use Symfony\Component\VarDumper\Cloner\VarCloner;
 use Symfony\Component\VarDumper\Dumper\CliDumper;
 use Symfony\Component\VarDumper\VarDumper;
 use Tempest\Container\GenericContainer;
+use Tempest\EventBus\EventBus;
 use Tempest\Highlight\Themes\TerminalStyle;
 use Tempest\Log\LogConfig;
 
 final readonly class Debug
 {
-    private function __construct(private ?LogConfig $logConfig = null)
-    {
+    private function __construct(
+        private ?LogConfig $logConfig = null,
+        private ?EventBus $eventBus = null,
+    ) {
     }
 
     public static function resolve(): self
     {
-        if (! class_exists(GenericContainer::class)) {
-            return new self();
-        }
-
-        if (! class_exists(LogConfig::class)) {
+        try {
+            $container = GenericContainer::instance();
+
+            return new self(
+                logConfig: $container?->get(LogConfig::class),
+                eventBus: $container?->get(EventBus::class),
+            );
+        } catch (Exception) {
             return new self();
         }
-
-        $container = GenericContainer::instance();
-
-        $logConfig = $container?->get(LogConfig::class);
-
-        return new self($logConfig);
     }
 
     public function log(array $items, bool $writeToLog = true, bool $writeToOut = true): void
@@ -46,6 +47,8 @@ public function log(array $items, bool $writeToLog = true, bool $writeToOut = tr
         if ($writeToOut) {
             $this->writeToOut($items, $callPath);
         }
+
+        $this->eventBus?->dispatch(new ItemsDebugged($items));
     }
 
     private function writeToLog(array $items, string $callPath): void

src/Tempest/Debug/src/ItemsDebugged.php

@@ -0,0 +1,13 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tempest\Debug;
+
+final class ItemsDebugged
+{
+    public function __construct(
+        public array $items,
+    ) {
+    }
+}

src/Tempest/Debug/src/functions.php

@@ -40,6 +40,17 @@ function ll(mixed ...$input): void
         }
     }
 
+    if (! function_exists('le')) {
+        /**
+         * Emits a `ItemsDebugged` event.
+         * @see \Tempest\Debug\Debug::log()
+         */
+        function le(mixed ...$input): void
+        {
+            Debug::resolve()->log($input, writeToOut: false, writeToLog: false);
+        }
+    }
+
     if (! function_exists('dd')) {
         /**
          * Writes the given `$input` to the logs, dumps it, and stops the execution of the script.

tests/Integration/Debug/DebugTest.php

@@ -0,0 +1,29 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Tests\Tempest\Integration\Debug;
+
+use stdClass;
+use Tempest\Debug\Debug;
+use Tempest\Debug\ItemsDebugged;
+use Tempest\EventBus\EventBus;
+use Tests\Tempest\Integration\FrameworkIntegrationTestCase;
+
+/**
+ * @internal
+ */
+final class DebugTest extends FrameworkIntegrationTestCase
+{
+    public function test_event(): void
+    {
+        $class = new stdClass();
+
+        $eventBus = $this->container->get(EventBus::class);
+        $eventBus->listen(ItemsDebugged::class, function (ItemsDebugged $event) use ($class): void {
+            $this->assertSame(['foo', $class], $event->items);
+        });
+
+        Debug::resolve()->log(['foo', $class], writeToLog: false, writeToOut: false);
+    }
+}