Support additional databases through adapters

Author: WyriHaximus

src/Adapter/Postgres.php

@@ -0,0 +1,31 @@
+<?php declare(strict_types=1);
+
+namespace WyriHaximus\React\SimpleORM\Adapter;
+
+use PgAsync\Client as PgClient;
+use Plasma\SQL\Grammar\PostgreSQL;
+use Plasma\SQL\GrammarInterface;
+use Plasma\SQL\QueryBuilder;
+use Rx\Observable;
+use WyriHaximus\React\SimpleORM\AdapterInterface;
+
+final class Postgres implements AdapterInterface
+{
+    /** @var PgClient */
+    private $client;
+
+    public function __construct(PgClient $client)
+    {
+        $this->client = $client;
+    }
+
+    public function query(QueryBuilder $query): Observable
+    {
+        return $this->client->executeStatement($query->getQuery(), $query->getParameters());
+    }
+
+    public function getGrammar(): GrammarInterface
+    {
+        return new PostgreSQL();
+    }
+}

src/AdapterInterface.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+namespace WyriHaximus\React\SimpleORM;
+
+use Plasma\SQL\GrammarInterface;
+use Plasma\SQL\QueryBuilder;
+use Rx\Observable;
+
+interface AdapterInterface
+{
+    public function query(QueryBuilder $query): Observable;
+
+    public function getGrammar(): GrammarInterface;
+}

src/Client.php

@@ -16,8 +16,8 @@
 
 final class Client implements ClientInterface
 {
-    /** @var PgClient */
-    private $client;
+    /** @var AdapterInterface */
+    private $adapter;
 
     /** @var EntityInspector */
     private $entityInspector;
@@ -31,28 +31,28 @@ final class Client implements ClientInterface
     /**
      * @param array<int, MiddlewareInterface> $middleware
      */
-    public static function create(PgClient $client, MiddlewareInterface ...$middleware): self
+    public static function create(AdapterInterface $adapter, MiddlewareInterface ...$middleware): self
     {
-        return new self($client, new AnnotationReader(), ...$middleware);
+        return new self($adapter, new AnnotationReader(), ...$middleware);
     }
 
     /**
      * @param array<int, MiddlewareInterface> $middleware
      */
-    public static function createWithAnnotationReader(PgClient $client, Reader $annotationReader, MiddlewareInterface ...$middleware): self
+    public static function createWithAnnotationReader(AdapterInterface $adapter, Reader $annotationReader, MiddlewareInterface ...$middleware): self
     {
-        return new self($client, $annotationReader, ...$middleware);
+        return new self($adapter, $annotationReader, ...$middleware);
     }
 
     /**
      * @param array<int, MiddlewareInterface> $middleware
      */
-    private function __construct(PgClient $client, Reader $annotationReader, MiddlewareInterface ...$middleware)
+    private function __construct(AdapterInterface $adapter, Reader $annotationReader, MiddlewareInterface ...$middleware)
     {
-        $this->client = $client;
+        $this->adapter = $adapter;
         $this->entityInspector = new EntityInspector($annotationReader);
 
-        $middleware[] = new GrammarMiddleware(new PostgreSQL());
+        $middleware[] = new GrammarMiddleware($adapter->getGrammar());
 
         $this->middlewareRunner = new MiddlewareRunner(...$middleware);
     }
@@ -72,7 +72,7 @@ public function query(QueryBuilder $query): Observable
             $query,
             function (QueryBuilder $query): PromiseInterface
             {
-                return resolve($this->client->executeStatement($query->getQuery(), $query->getParameters()));
+                return resolve($this->adapter->query($query));
             }
         ));
     }

tests/ClientTest.php

@@ -2,6 +2,7 @@
 
 namespace WyriHaximus\React\Tests\SimpleORM;
 
+use WyriHaximus\React\SimpleORM\Adapter\Postgres;
 use function ApiClients\Tools\Rx\observableFromArray;
 use Doctrine\Common\Annotations\Reader;
 use PgAsync\Client as PgClient;
@@ -40,7 +41,7 @@ protected function setUp(): void
 
         $this->pgClient = $this->prophesize(PgClient::class);
         $this->annotationReader = $this->prophesize(Reader::class);
-        $this->client = Client::createWithAnnotationReader($this->pgClient->reveal(), $this->annotationReader->reveal());
+        $this->client = Client::createWithAnnotationReader(new Postgres($this->pgClient->reveal()), $this->annotationReader->reveal());
     }
 
     public function testGetRepository(): void

tests/FunctionalTest.php

@@ -6,6 +6,7 @@
 use React\EventLoop\Factory;
 use React\EventLoop\LoopInterface;
 use WyriHaximus\AsyncTestUtilities\AsyncTestCase;
+use WyriHaximus\React\SimpleORM\Adapter\Postgres;
 use WyriHaximus\React\SimpleORM\Client;
 use WyriHaximus\React\SimpleORM\ClientInterface;
 use WyriHaximus\React\SimpleORM\Middleware\QueryCountMiddleware;
@@ -45,15 +46,17 @@ protected function setUp(): void
 
         $this->loop = Factory::create();
         $this->client = Client::create(
-            new PgClient(
-                [
-                    'host' => 'localhost',
-                    'port' => 5432,
-                    'user'     => \getenv('PHINX_DB_USER'),
-                    'password' => \getenv('PHINX_DB_PASSWORD'),
-                    'database' => \getenv('PHINX_DB_DATABASE'),
-                ],
-                $this->loop
+            new Postgres(
+                new PgClient(
+                    [
+                        'host' => 'localhost',
+                        'port' => 5432,
+                        'user'     => \getenv('PHINX_DB_USER'),
+                        'password' => \getenv('PHINX_DB_PASSWORD'),
+                        'database' => \getenv('PHINX_DB_DATABASE'),
+                    ],
+                    $this->loop
+                )
             ),
             $this->counter
         );