[#460] Introduce db() helper to encapsulate Database DI lookup

src/Database/Helpers/db.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\Database\Database;
+use Quantum\Di\Di;
+
+/**
+ * Gets the Database instance from DI
+ */
+function db(): Database
+{
+    if (!Di::isRegistered(Database::class)) {
+        Di::register(Database::class);
+    }
+
+    return Di::get(Database::class);
+}

src/Database/Traits/RelationalTrait.php

@@ -16,8 +16,6 @@
 
 namespace Quantum\Database\Traits;
 
-use Quantum\Database\Database;
-use Quantum\Di\Di;
 use Quantum\Di\Exceptions\DiException;
 use ReflectionException;
 
@@ -87,10 +85,6 @@ public static function queryLog(): array
      */
     protected static function resolveQuery(string $method, string $query = '', array $parameters = [])
     {
-        if (!Di::isRegistered(Database::class)) {
-            Di::register(Database::class);
-        }
-
-        return Di::get(Database::class)->getOrmClass()::$method($query, $parameters);
+        return db()->getOrmClass()::$method($query, $parameters);
     }
 }

src/Database/Traits/TransactionTrait.php

@@ -18,9 +18,7 @@
 
 use Quantum\Database\Exceptions\DatabaseException;
 use Quantum\App\Exceptions\BaseException;
-use Quantum\Database\Database;
 use ReflectionException;
-use Quantum\Di\Di;
 use Throwable;
 
 /**
@@ -64,11 +62,7 @@ public static function rollback(): void
      */
     protected static function resolveTransaction(string $method)
     {
-        if (!Di::isRegistered(Database::class)) {
-            Di::register(Database::class);
-        }
-
-        $db = Di::get(Database::class)->getOrmClass();
+        $db = db()->getOrmClass();
 
         if (!method_exists($db, $method)) {
             throw DatabaseException::methodNotSupported($method, self::class);

src/Migration/MigrationManager.php

@@ -28,7 +28,6 @@
 use Quantum\Storage\FileSystem;
 use Quantum\Database\Database;
 use ReflectionException;
-use Quantum\Di\Di;
 
 /**
  * Class MigrationManager
@@ -77,11 +76,7 @@ public function __construct()
     {
         $this->fs = FileSystemFactory::get();
 
-        if (!Di::isRegistered(Database::class)) {
-            Di::register(Database::class);
-        }
-
-        $this->db = Di::get(Database::class);
+        $this->db = db();
 
         $this->tableFactory = new TableFactory();
 

src/Model/Factories/ModelFactory.php

@@ -20,11 +20,9 @@
 use Quantum\Model\Exceptions\ModelException;
 use Quantum\App\Exceptions\BaseException;
 use Quantum\Di\Exceptions\DiException;
-use Quantum\Database\Database;
 use Quantum\Model\DbModel;
 use Quantum\Model\Model;
 use ReflectionException;
-use Quantum\Di\Di;
 
 /**
  * Class ModelFactory
@@ -106,11 +104,7 @@ protected static function createOrmInstance(
         array  $foreignKeys = [],
         array  $hidden = []
     ): DbalInterface {
-        if (!Di::isRegistered(Database::class)) {
-            Di::register(Database::class);
-        }
-
-        $ormClass = Di::get(Database::class)->getOrmClass();
+        $ormClass = db()->getOrmClass();
 
         $instance = new $ormClass(
             $table,

tests/Unit/Database/Helpers/DbHelperTest.php

@@ -0,0 +1,32 @@
+<?php
+
+namespace Quantum\Tests\Unit\Database\Helpers;
+
+use Quantum\Tests\Unit\AppTestCase;
+use Quantum\Database\Database;
+use Quantum\Di\Di;
+
+class DbHelperTest extends AppTestCase
+{
+    public function testDbHelperReturnsDatabaseInstance(): void
+    {
+        $this->assertInstanceOf(Database::class, db());
+    }
+
+    public function testDbHelperReturnsSameInstance(): void
+    {
+        $first = db();
+        $second = db();
+
+        $this->assertSame($first, $second);
+    }
+
+    public function testDbHelperLazilyRegistersDatabase(): void
+    {
+        Di::resetContainer();
+
+        $this->assertFalse(Di::isRegistered(Database::class));
+        $this->assertInstanceOf(Database::class, db());
+        $this->assertTrue(Di::isRegistered(Database::class));
+    }
+}

tests/Unit/View/ViewTest.php

@@ -117,6 +117,8 @@ public function testRenderWithLayout(): void
 
         $this->assertIsString($renderedView);
 
+        $renderedView = str_replace("\n", PHP_EOL, $renderedView);
+
         $this->assertEquals('<html>' . PHP_EOL . '<head></head>' . PHP_EOL . '<body>' . PHP_EOL . '<p>Hello World, this is rendered html view</p></body>' . PHP_EOL . '</html>' . PHP_EOL, $renderedView);
     }