Add JsonTable and related test

Author: rkrx

src/Tools/JsonTable.php

@@ -0,0 +1,51 @@
+<?php
+
+namespace Kir\MySQL\Tools;
+
+use Kir\MySQL\Builder\Internal\Types;
+use Kir\MySQL\Common\SpecialTable;
+use Kir\MySQL\Database;
+use Stringable;
+
+/**
+ * @phpstan-type TColumn string|array{name: string, type: string, jsonPath: string}
+ *
+ * @phpstan-type TColumns list<string|TColumn>
+ */
+class JsonTable implements SpecialTable {
+	/**
+	 * @param string $dataExpression The field to get the source json data from
+	 * @param string $jsonPath The json path to the array to be turned into a table
+	 * @param TColumns $columns The projected columns
+	 */
+	public function __construct(
+		private string $dataExpression,
+		private string $jsonPath,
+		private $columns
+	) {}
+
+	public function asString(Database $db): string {
+		return sprintf(
+			'JSON_TABLE(%s, %s, %s)',
+			$this->dataExpression,
+			$this->jsonPath,
+			$this->translateColumns($db, $this->columns)
+		);
+	}
+
+	/**
+	 * @param Database $db
+	 * @param TColumns $columns
+	 * @return string
+	 */
+	private function translateColumns(Database $db, $columns) {
+		$result = [];
+		foreach($columns as $column) {
+			if(!is_string($column)) {
+				$column = sprintf('%s %s PATH \'%s\'', $column['name'], $column['type'], $column['jsonPath']);
+			}
+			$result[] = $column;
+		}
+		return sprintf('COLUMNS(%s)', implode(', ', $result));
+	}
+}

tests/Builder/SelectTest.php

@@ -12,6 +12,7 @@
 use Kir\MySQL\Builder\Value\DBOptionalValue;
 use Kir\MySQL\Common\DBTestCase;
 use Kir\MySQL\Databases\TestDB;
+use Kir\MySQL\Tools\JsonTable;
 use Kir\MySQL\Tools\VirtualTable;
 
 class SelectTest extends DBTestCase {
@@ -555,4 +556,20 @@ public function testArrayTables(): void {
 
 		self::assertEquals("SELECT\n\ta.value\nFROM\n\t(SELECT 1 AS `value`\n\tUNION ALL\n\tSELECT 2 AS `value`\n\tUNION ALL\n\tSELECT 3 AS `value`\n\tUNION ALL\n\tSELECT 4 AS `value`\n\tUNION ALL\n\tSELECT 5 AS `value`\n\tUNION ALL\n\tSELECT 6 AS `value`\n\tUNION ALL\n\tSELECT 7 AS `value`\n\tUNION ALL\n\tSELECT 8 AS `value`\n\tUNION ALL\n\tSELECT 9 AS `value`) a\n", $vt1);
 	}
+
+	public function testJsonTable(): void {
+		$vt1 = $this->select()
+		->field('a.id')
+		->field('b.id', 'json_id')
+		->field('b.title', 'json_title')
+		->from('a', 'source_table')
+		->joinInner('b', new JsonTable('a.json_field', '$.key', [[
+			'name' => 'id', 'type' => 'INT', 'jsonPath' => '$.id'
+		], [
+			'name' => 'title', 'type' => 'VARCHAR(255)', 'jsonPath' => '$.title'
+		]]), 'a.id = b.id')
+		->asString();
+
+		self::assertEquals("SELECT\n\ta.id,\n\tb.id AS `json_id`,\n\tb.title AS `json_title`\nFROM\n\tsource_table a\nINNER JOIN\n\tJSON_TABLE(a.json_field, $.key, COLUMNS(id INT PATH '$.id', title VARCHAR(255) PATH '$.title')) b ON a.id = b.id\n", $vt1);
+	}
 }