feature: split query collection into directory/class subclasses

for #84

Author: g105b

src/Query/QueryCollection.php

@@ -5,7 +5,7 @@
 use Gt\Database\Fetchable;
 use Gt\Database\Result\ResultSet;
 
-class QueryCollection {
+abstract class QueryCollection {
 	use Fetchable;
 
 	protected string $directoryPath;
@@ -14,7 +14,7 @@ class QueryCollection {
 	public function __construct(
 		string $directoryPath,
 		Driver $driver,
-		?QueryFactory $queryFactory = null
+		?QueryFactory $queryFactory = null,
 	) {
 		$this->directoryPath = $directoryPath;
 		$this->queryFactory = $queryFactory ?? new QueryFactory(

src/Query/QueryCollectionClass.php

@@ -0,0 +1,7 @@
+<?php
+namespace Gt\Database\Query;
+
+use Gt\Database\Query\QueryCollection;
+
+class QueryCollectionClass extends QueryCollection {
+}

src/Query/QueryCollectionDirectory.php

@@ -0,0 +1,5 @@
+<?php
+namespace Gt\Database\Query;
+
+class QueryCollectionDirectory extends QueryCollection {
+}

src/Query/QueryCollectionFactory.php

@@ -4,6 +4,7 @@
 use DirectoryIterator;
 use Gt\Database\Connection\Driver;
 use Gt\Database\Database;
+use SplFileInfo;
 
 class QueryCollectionFactory {
 	protected Driver $driver;
@@ -19,15 +20,9 @@ public function __construct(Driver $driver) {
 
 	public function create(string $name):QueryCollection {
 		if(!isset($this->queryCollectionCache[$name])) {
-			$directoryPath = $this->locateDirectory($name);
-
-			if(is_null($directoryPath)) {
-				throw new QueryCollectionNotFoundException($name);
-			}
-
-			$this->queryCollectionCache[$name] = new QueryCollection(
-				$directoryPath,
-				$this->driver
+			$this->queryCollectionCache[$name] = $this->findQueryCollection(
+				$name,
+				$this->driver,
 			);
 		}
 
@@ -74,13 +69,13 @@ protected function recurseLocateDirectory(
 			throw new BaseQueryPathDoesNotExistException($basePath);
 		}
 
+		/** @var SplFileInfo $fileInfo */
 		foreach(new DirectoryIterator($basePath) as $fileInfo) {
-			if($fileInfo->isDot()
-			|| !$fileInfo->isDir()) {
+			if($fileInfo->isDot()) {
 				continue;
 			}
 
-			$basename = $fileInfo->getBasename();
+			$basename = $fileInfo->getBasename(".php");
 			if(strtolower($part) === strtolower($basename)) {
 				$realPath = $fileInfo->getRealPath();
 
@@ -101,4 +96,30 @@ protected function recurseLocateDirectory(
 	protected function getDefaultBasePath():string {
 		return getcwd();
 	}
+
+	private function findQueryCollection(
+		string $name,
+		Driver $driver,
+	):QueryCollection {
+		$path = $this->locateDirectory($name);
+
+		if($path && is_dir($path)) {
+			$this->queryCollectionCache[$name] = new QueryCollectionDirectory(
+				$path,
+				$driver,
+			);
+		}
+		elseif($path && is_file($path)) {
+			$this->queryCollectionCache[$name] = new QueryCollectionClass(
+				$path,
+				$driver,
+			);
+		}
+		else {
+			throw new QueryCollectionNotFoundException($name);
+		}
+
+		return $this->queryCollectionCache[$name];
+	}
+
 }

test/phpunit/DatabaseTest.php

@@ -4,6 +4,7 @@
 use Gt\Database\Connection\Settings;
 use Gt\Database\Database;
 use Gt\Database\Query\QueryCollection;
+use Gt\Database\Query\QueryCollectionClass;
 use Gt\Database\Query\QueryCollectionNotFoundException;
 use PHPUnit\Framework\TestCase;
 
@@ -60,4 +61,27 @@ public function testQueryCollectionDots(
 		$queryCollection = $db->queryCollection($dotName);
 		self::assertInstanceOf(QueryCollection::class, $queryCollection);
 	}
-}
+
+	/** @dataProvider \Gt\Database\Test\Helper\Helper::queryCollectionPathNotExistsProvider() */
+	public function testQueryCollectionPhp(
+		string $name,
+		string $path,
+	) {
+		$path = "$path.php";
+		$baseQueryDirectory = dirname($path);
+		if(!is_dir($baseQueryDirectory)) {
+			mkdir($baseQueryDirectory, recursive: true);
+		}
+		touch($path);
+
+		$settings = new Settings(
+			$baseQueryDirectory,
+			Settings::DRIVER_SQLITE,
+			Settings::SCHEMA_IN_MEMORY,
+		);
+		$sut = new Database($settings);
+		$queryCollection = $sut->queryCollection($name);
+
+		self::assertInstanceOf(QueryCollectionClass::class, $queryCollection);
+	}
+}

test/phpunit/Helper/Helper.php

@@ -141,7 +141,11 @@ private static function queryCollectionPathProvider(
 			$nameParts = [];
 
 			for($n = 0; $n < $nested; $n++) {
-				$nameParts []= uniqid();
+				$uniqid = uniqid();
+				if(is_numeric($uniqid[0])) {
+					$uniqid = chr(rand(97, 102)) . $uniqid; // Add a random lowercase letter (a-f) to the beginning
+				}
+				$nameParts []= $uniqid;
 			}
 
 			$name = implode(DIRECTORY_SEPARATOR, $nameParts);

test/phpunit/Query/QueryCollectionCRUDsTest.php

@@ -5,6 +5,7 @@
 use Gt\Database\Connection\Driver;
 use Gt\Database\Query\Query;
 use Gt\Database\Query\QueryCollection;
+use Gt\Database\Query\QueryCollectionDirectory;
 use Gt\Database\Query\QueryFactory;
 use Gt\Database\Result\ResultSet;
 use Gt\Database\Result\Row;
@@ -27,7 +28,7 @@ protected function setUp():void {
 			->willReturn($this->mockQuery);
 
 		/** @var QueryFactory $mockQueryFactory */
-		$this->queryCollection = new QueryCollection(
+		$this->queryCollection = new QueryCollectionDirectory(
 			__DIR__,
 			new Driver(new DefaultSettings()),
 			$mockQueryFactory

test/phpunit/Query/QueryCollectionTest.php

@@ -5,6 +5,7 @@
 use Gt\Database\Connection\Driver;
 use Gt\Database\Query\Query;
 use Gt\Database\Query\QueryCollection;
+use Gt\Database\Query\QueryCollectionDirectory;
 use Gt\Database\Query\QueryFactory;
 use Gt\Database\Result\ResultSet;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -26,7 +27,7 @@ protected function setUp():void {
 			->with("something")
 			->willReturn($this->mockQuery);
 
-		$this->queryCollection = new QueryCollection(
+		$this->queryCollection = new QueryCollectionDirectory(
 			__DIR__,
 			new Driver(new DefaultSettings()),
 			$mockQueryFactory
@@ -83,4 +84,4 @@ public function testQueryShorthandNoParams() {
 			$this->queryCollection->something()
 		);
 	}
-}
+}

test/phpunit/Query/QueryFactoryTest.php

@@ -92,4 +92,4 @@ public function testSelectsCorrectFile() {
 			$queryFileList[$queryName] = $query->getFilePath();
 		}
 	}
-}
+}