[#458] Refactor debugbar() helper for structural and behavioral consi…

src/Debugger/Debugger.php

@@ -149,10 +149,14 @@ public function resetStore(): void
 
     /**
      * Renders the debug bar
-     * @throws DebugBarException
+     * @throws DebugBarException|DiException|ReflectionException
      */
     public function render(): string
     {
+        if (!$this->isEnabled()) {
+            return '';
+        }
+
         foreach ([self::MESSAGES, self::QUERIES, self::ROUTES, self::HOOKS, self::MAILS] as $tab) {
             $this->createTab($tab);
         }

src/Debugger/Helpers/debugger.php

@@ -0,0 +1,30 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * Quantum PHP Framework
+ *
+ * An open source software development framework for PHP
+ *
+ * @package Quantum
+ * @author Arman Ag. <arman.ag@softberg.org>
+ * @copyright Copyright (c) 2018 Softberg LLC (https://softberg.org)
+ * @link http://quantum.softberg.org/
+ * @since 3.0.0
+ */
+
+use Quantum\Debugger\Debugger;
+use Quantum\Di\Di;
+
+/**
+ * Gets the Debugger instance from DI
+ */
+function debugbar(): Debugger
+{
+    if (!Di::isRegistered(Debugger::class)) {
+        Di::register(Debugger::class);
+    }
+
+    return Di::get(Debugger::class);
+}

src/Module/Templates/DefaultWeb/src/Views/layouts/main.php.tpl

@@ -14,7 +14,7 @@
 
         <main><?php echo view() ?></main>
 
-        <?php echo debugbar() ?>
+        <?= debugbar()->render() ?>
 
         <?php assets("js") ?>
     </body>

src/Module/Templates/DemoWeb/src/Views/layouts/main.php.tpl

@@ -16,7 +16,7 @@
 
         <footer class="page-footer"><?php echo partial('partials/footer') ?></footer>
 
-        <?php echo debugbar() ?>
+        <?= debugbar()->render() ?>
 
         <?php assets("js") ?>
     </body>

src/Module/Templates/Toolkit/src/Views/layouts/main.php.tpl

@@ -33,7 +33,7 @@
     </div>
 </main>
 
-<?php echo debugbar() ?>
+<?= debugbar()->render() ?>
 
 <?php assets("js") ?>
 <script src="https://cdnjs.cloudflare.com/ajax/libs/jsoneditor/10.1.2/jsoneditor.min.js"></script>

src/View/Helpers/view.php

@@ -21,10 +21,7 @@
 use Quantum\App\Exceptions\BaseException;
 use Quantum\View\Factories\ViewFactory;
 use Quantum\Di\Exceptions\DiException;
-use DebugBar\DebugBarException;
-use Quantum\Debugger\Debugger;
 use Quantum\View\RawParam;
-use Quantum\Di\Di;
 
 /**
  * Rendered view
@@ -67,25 +64,6 @@ function raw_param($value): RawParam
     return new RawParam($value);
 }
 
-/**
- * Rendered debug bar
- * @throws DebugBarException|DiException|ReflectionException
- */
-function debugbar(): ?string
-{
-    if (!Di::isRegistered(Debugger::class)) {
-        Di::register(Debugger::class);
-    }
-
-    $debugger = Di::get(Debugger::class);
-
-    if ($debugger->isEnabled()) {
-        return $debugger->render();
-    }
-
-    return null;
-}
-
 /**
  * @throws CommonMarkException
  */

tests/Unit/Debugger/DebuggerTest.php

@@ -104,6 +104,8 @@ public function testDebuggerResetStore(): void
 
     public function testDebugbarRender(): void
     {
+        config()->set('app.debug', true);
+
         $this->debugger->initStore();
 
         $rendererMock = Mockery::mock('alias:' . JavascriptRenderer::class);
@@ -121,4 +123,13 @@ public function testDebugbarRender(): void
         $this->assertStringContainsString('<head></head>', $output);
         $this->assertStringContainsString('<div>Debug Bar</div>', $output);
     }
+
+    public function testDebugbarRenderReturnsEmptyWhenDisabled(): void
+    {
+        config()->set('app.debug', false);
+
+        $output = $this->debugger->render();
+
+        $this->assertEmpty($output);
+    }
 }

tests/Unit/Debugger/Helpers/DebuggerHelperTest.php

@@ -0,0 +1,27 @@
+<?php
+
+namespace Quantum\Tests\Unit\Debugger\Helpers;
+
+use Quantum\Tests\Unit\AppTestCase;
+use Quantum\Debugger\Debugger;
+
+class DebuggerHelperTest extends AppTestCase
+{
+    public function setUp(): void
+    {
+        parent::setUp();
+    }
+
+    public function testDebugbarHelperReturnsDebuggerInstance(): void
+    {
+        $this->assertInstanceOf(Debugger::class, debugbar());
+    }
+
+    public function testDebugbarHelperReturnsSameInstance(): void
+    {
+        $first = debugbar();
+        $second = debugbar();
+
+        $this->assertSame($first, $second);
+    }
+}