From c17d8feaa403cb88ef0411d552e86cce9674d8d3 Mon Sep 17 00:00:00 2001
From: Jan Jakes <jan.jakes@automattic.com>
Date: Sat, 13 Jul 2024 13:36:14 +0200
Subject: [PATCH] Implement basic WPDB Doctrine driver with connection,
 statement, and result stubs

[MAILPOET-6142]
---
 mailpoet/lib/Doctrine/WPDB/Connection.php     | 48 +++++++++++++++++++
 mailpoet/lib/Doctrine/WPDB/Driver.php         | 11 +++++
 mailpoet/lib/Doctrine/WPDB/Result.php         | 43 +++++++++++++++++
 mailpoet/lib/Doctrine/WPDB/Statement.php      | 21 ++++++++
 .../integration/Doctrine/WPDB/DriverTest.php  | 20 ++++++++
 .../tests/unit/Doctrine/WPDB/DriverTest.php   | 19 ++++++++
 6 files changed, 162 insertions(+)
 create mode 100644 mailpoet/lib/Doctrine/WPDB/Connection.php
 create mode 100644 mailpoet/lib/Doctrine/WPDB/Driver.php
 create mode 100644 mailpoet/lib/Doctrine/WPDB/Result.php
 create mode 100644 mailpoet/lib/Doctrine/WPDB/Statement.php
 create mode 100644 mailpoet/tests/integration/Doctrine/WPDB/DriverTest.php
 create mode 100644 mailpoet/tests/unit/Doctrine/WPDB/DriverTest.php

diff --git a/mailpoet/lib/Doctrine/WPDB/Connection.php b/mailpoet/lib/Doctrine/WPDB/Connection.php
new file mode 100644
index 0000000000..007ca5caad
--- /dev/null
+++ b/mailpoet/lib/Doctrine/WPDB/Connection.php
@@ -0,0 +1,48 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\Doctrine\WPDB;
+
+use MailPoetVendor\Doctrine\DBAL\Driver\ServerInfoAwareConnection;
+use MailPoetVendor\Doctrine\DBAL\ParameterType;
+
+class Connection implements ServerInfoAwareConnection {
+  public function prepare(string $sql): Statement {
+    // TODO: Implement prepare() method.
+  }
+
+  public function query(string $sql): Result {
+    // TODO: Implement query() method.
+  }
+
+  public function exec(string $sql): int {
+    // TODO: Implement exec() method.
+  }
+
+  public function beginTransaction() {
+    // TODO: Implement beginTransaction() method.
+  }
+
+  public function commit() {
+    // TODO: Implement commit() method.
+  }
+
+  public function rollBack() {
+    // TODO: Implement rollBack() method.
+  }
+
+  public function quote($value, $type = ParameterType::STRING) {
+    // TODO: Implement quote() method.
+  }
+
+  public function lastInsertId($name = null) {
+    // TODO: Implement lastInsertId() method.
+  }
+
+  public function getServerVersion() {
+    // TODO: Implement getServerVersion() method.
+  }
+
+  public function __call($name, $arguments) {
+    // TODO: Implement @method object getNativeConnection()
+  }
+}
diff --git a/mailpoet/lib/Doctrine/WPDB/Driver.php b/mailpoet/lib/Doctrine/WPDB/Driver.php
new file mode 100644
index 0000000000..8d0c7dea4c
--- /dev/null
+++ b/mailpoet/lib/Doctrine/WPDB/Driver.php
@@ -0,0 +1,11 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\Doctrine\WPDB;
+
+use MailPoetVendor\Doctrine\DBAL\Driver\AbstractMySQLDriver;
+
+class Driver extends AbstractMySQLDriver {
+  public function connect(array $params): Connection {
+    return new Connection();
+  }
+}
diff --git a/mailpoet/lib/Doctrine/WPDB/Result.php b/mailpoet/lib/Doctrine/WPDB/Result.php
new file mode 100644
index 0000000000..17e1d773f7
--- /dev/null
+++ b/mailpoet/lib/Doctrine/WPDB/Result.php
@@ -0,0 +1,43 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\Doctrine\WPDB;
+
+use MailPoetVendor\Doctrine\DBAL\Driver\Result as ResultInterface;
+
+class Result implements ResultInterface {
+  public function fetchNumeric() {
+    // TODO: Implement fetchNumeric() method.
+  }
+
+  public function fetchAssociative() {
+    // TODO: Implement fetchAssociative() method.
+  }
+
+  public function fetchOne() {
+    // TODO: Implement fetchOne() method.
+  }
+
+  public function fetchAllNumeric(): array {
+    // TODO: Implement fetchAllNumeric() method.
+  }
+
+  public function fetchAllAssociative(): array {
+    // TODO: Implement fetchAllAssociative() method.
+  }
+
+  public function fetchFirstColumn(): array {
+    // TODO: Implement fetchFirstColumn() method.
+  }
+
+  public function rowCount(): int {
+    // TODO: Implement rowCount() method.
+  }
+
+  public function columnCount(): int {
+    // TODO: Implement columnCount() method.
+  }
+
+  public function free(): void {
+    // TODO: Implement free() method.
+  }
+}
diff --git a/mailpoet/lib/Doctrine/WPDB/Statement.php b/mailpoet/lib/Doctrine/WPDB/Statement.php
new file mode 100644
index 0000000000..53b626932a
--- /dev/null
+++ b/mailpoet/lib/Doctrine/WPDB/Statement.php
@@ -0,0 +1,21 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\Doctrine\WPDB;
+
+use MailPoetVendor\Doctrine\DBAL\Driver\Result;
+use MailPoetVendor\Doctrine\DBAL\Driver\Statement as StatementInterface;
+use MailPoetVendor\Doctrine\DBAL\ParameterType;
+
+class Statement implements StatementInterface {
+  public function bindValue($param, $value, $type = ParameterType::STRING) {
+    // TODO: Implement bindValue() method.
+  }
+
+  public function bindParam($param, &$variable, $type = ParameterType::STRING, $length = null) {
+    // TODO: Implement bindParam() method.
+  }
+
+  public function execute($params = null): Result {
+    // TODO: Implement execute() method.
+  }
+}
diff --git a/mailpoet/tests/integration/Doctrine/WPDB/DriverTest.php b/mailpoet/tests/integration/Doctrine/WPDB/DriverTest.php
new file mode 100644
index 0000000000..c38b11e7b6
--- /dev/null
+++ b/mailpoet/tests/integration/Doctrine/WPDB/DriverTest.php
@@ -0,0 +1,20 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\Test\Doctrine\WPDB;
+
+use MailPoet\Doctrine\WPDB\Connection;
+use MailPoet\Doctrine\WPDB\Driver;
+use MailPoetTest;
+use MailPoetVendor\Doctrine\DBAL\Driver\API\MySQL\ExceptionConverter;
+use MailPoetVendor\Doctrine\DBAL\Platforms\MariaDb1052Platform;
+use MailPoetVendor\Doctrine\DBAL\Platforms\MySQLPlatform;
+
+class DriverTest extends MailPoetTest {
+  public function testDriverSetup(): void {
+    $driver = new Driver();
+    $this->assertInstanceOf(Connection::class, $driver->connect([]));
+    $this->assertInstanceOf(MySQLPlatform::class, $driver->getDatabasePlatform());
+    $this->assertInstanceOf(MariaDb1052Platform::class, $driver->createDatabasePlatformForVersion('10.5.8-MariaDB-1:10.5.8+maria~focal'));
+    $this->assertInstanceOf(ExceptionConverter::class, $driver->getExceptionConverter());
+  }
+}
diff --git a/mailpoet/tests/unit/Doctrine/WPDB/DriverTest.php b/mailpoet/tests/unit/Doctrine/WPDB/DriverTest.php
new file mode 100644
index 0000000000..7631dd52ec
--- /dev/null
+++ b/mailpoet/tests/unit/Doctrine/WPDB/DriverTest.php
@@ -0,0 +1,19 @@
+<?php declare(strict_types = 1);
+
+namespace MailPoet\Doctrine\WPDB;
+
+use MailPoetUnitTest;
+use MailPoetVendor\Doctrine\DBAL\Driver\API\MySQL\ExceptionConverter;
+use MailPoetVendor\Doctrine\DBAL\Platforms\MariaDb1052Platform;
+use MailPoetVendor\Doctrine\DBAL\Platforms\MySQLPlatform;
+
+class DriverTest extends MailPoetUnitTest {
+  public function testDriverSetup(): void {
+    $driver = $this->createPartialMock(Driver::class, ['connect']);
+
+    $this->assertInstanceOf(Connection::class, $driver->connect([]));
+    $this->assertInstanceOf(MySQLPlatform::class, $driver->getDatabasePlatform());
+    $this->assertInstanceOf(MariaDb1052Platform::class, $driver->createDatabasePlatformForVersion('10.5.8-MariaDB-1:10.5.8+maria~focal'));
+    $this->assertInstanceOf(ExceptionConverter::class, $driver->getExceptionConverter());
+  }
+}