From 4d764cbb3f536d762e85c963542759c1596c1827 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Sun, 28 Jul 2024 19:21:37 -0400 Subject: [PATCH 1/3] WIP on new option library --- composer.json | 2 ++ composer.lock | 49 +++++++++++++++++++++++++++++++++++++++++-- src/Configuration.php | 25 ++++++++++++---------- src/Custom.php | 4 ++-- 4 files changed, 65 insertions(+), 15 deletions(-) diff --git a/composer.json b/composer.json index cce2a54..5bb93c1 100644 --- a/composer.json +++ b/composer.json @@ -17,8 +17,10 @@ "rss": "https://git.bitbadger.solutions/bit-badger/pdo-document.rss", "docs": "https://bitbadger.solutions/open-source/pdo-document/" }, + "minimum-stability": "beta", "require": { "php": ">=8.2", + "bit-badger/inspired-by-fsharp": "^1", "netresearch/jsonmapper": "^4", "ext-pdo": "*", "phpoption/phpoption": "^1.9" diff --git a/composer.lock b/composer.lock index 4ae6774..efe8e2a 100644 --- a/composer.lock +++ b/composer.lock @@ -4,8 +4,53 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "dc897c0ab21d662a65b3818331edd2f2", + "content-hash": "223a16e330809798fc103d89c35faaa7", "packages": [ + { + "name": "bit-badger/inspired-by-fsharp", + "version": "v1.0.0-beta1", + "source": { + "type": "git", + "url": "https://git.bitbadger.solutions/bit-badger/inspired-by-fsharp", + "reference": "efb3a4461edcb23e0dd82068adeb0591240870b0" + }, + "require": { + "php": "^8.2" + }, + "require-dev": { + "phpoption/phpoption": "^1", + "phpunit/phpunit": "^11" + }, + "type": "library", + "autoload": { + "psr-4": { + "BitBadger\\InspiredByFSharp\\": "./src" + } + }, + "notification-url": "https://packagist.org/downloads/", + "license": [ + "MIT" + ], + "authors": [ + { + "name": "Daniel J. Summers", + "email": "daniel@bitbadger.solutions", + "homepage": "https://bitbadger.solutions", + "role": "Developer" + } + ], + "description": "PHP utility classes whose functionality is inspired by their F# counterparts", + "keywords": [ + "option", + "result" + ], + "support": { + "email": "daniel@bitbadger.solutions", + "rss": "https://git.bitbadger.solutions/bit-badger/inspired-by-fsharp.rss", + "source": "https://git.bitbadger.solutions/bit-badger/inspired-by-fsharp" + }, + "time": "2024-07-28T21:35:11+00:00" + }, { "name": "netresearch/jsonmapper", "version": "v4.4.1", @@ -1816,7 +1861,7 @@ } ], "aliases": [], - "minimum-stability": "stable", + "minimum-stability": "beta", "stability-flags": [], "prefer-stable": false, "prefer-lowest": false, diff --git a/src/Configuration.php b/src/Configuration.php index 74ad318..a2b51db 100644 --- a/src/Configuration.php +++ b/src/Configuration.php @@ -8,9 +8,9 @@ declare(strict_types=1); namespace BitBadger\PDODocument; +use BitBadger\InspiredByFSharp\Option; use Exception; use PDO; -use PhpOption\{None, Option, Some}; /** * Common configuration for the document library @@ -55,10 +55,10 @@ class Configuration public static function useDSN(string $dsn): void { if (empty($dsn)) { - self::$mode = self::$pdoDSN = None::create(); + self::$mode = self::$pdoDSN = Option::None(); } else { - self::$mode = Some::create(Mode::deriveFromDSN($dsn)); - self::$pdoDSN = Some::create($dsn); + self::$mode = Option::Some(Mode::deriveFromDSN($dsn)); + self::$pdoDSN = Option::Some($dsn); } } @@ -66,14 +66,15 @@ class Configuration * Retrieve a new connection to the database * * @return PDO A new connection to the SQLite database with foreign key support enabled - * @throws Exception If this is called before a connection string is set + * @throws DocumentException If this is called before a connection string is set */ public static function dbConn(): PDO { if (is_null(self::$pdo)) { - $dsn = (self::$pdoDSN ?? None::create())->getOrThrow( - new DocumentException('Please provide a data source name (DSN) before attempting data access')); - self::$pdo = new PDO($dsn, $_ENV['PDO_DOC_USERNAME'] ?? self::$username, + if (self::$pdoDSN->isNone()) { + throw new DocumentException('Please provide a data source name (DSN) before attempting data access'); + } + self::$pdo = new PDO(self::$pdoDSN->get(), $_ENV['PDO_DOC_USERNAME'] ?? self::$username, $_ENV['PDO_DOC_PASSWORD'] ?? self::$password, self::$options); } @@ -88,8 +89,10 @@ class Configuration */ public static function mode(?string $process = null): Mode { - return self::$mode->getOrThrow( - new DocumentException('Database mode not set' . (is_null($process) ? '' : "; cannot $process"))); + if (self::$mode->isNone()) { + throw new DocumentException('Database mode not set' . (is_null($process) ? '' : "; cannot $process")); + } + return self::$mode->get(); } /** @@ -99,7 +102,7 @@ class Configuration */ public static function overrideMode(?Mode $mode): void { - self::$mode = Option::fromValue($mode); + self::$mode = Option::of($mode); } /** diff --git a/src/Custom.php b/src/Custom.php index 572fcb0..e01147c 100644 --- a/src/Custom.php +++ b/src/Custom.php @@ -8,11 +8,11 @@ declare(strict_types=1); namespace BitBadger\PDODocument; +use BitBadger\InspiredByFSharp\Option; use BitBadger\PDODocument\Mapper\Mapper; use PDO; use PDOException; use PDOStatement; -use PhpOption\{None, Option, Some}; /** * Functions to execute custom queries @@ -106,7 +106,7 @@ class Custom { try { $stmt = &self::runQuery("$query LIMIT 1", $parameters); - return ($first = $stmt->fetch(PDO::FETCH_ASSOC)) ? Some::create($mapper->map($first)) : None::create(); + return ($first = $stmt->fetch(PDO::FETCH_ASSOC)) ? Option::Some($mapper->map($first)) : Option::None(); } finally { $stmt = null; } -- 2.45.1 From 3d2bc2a9042e68a22bafe77d94f0df06d9957ee4 Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Sun, 28 Jul 2024 19:45:29 -0400 Subject: [PATCH 2/3] Finish migration to new option library --- composer.json | 3 +- composer.lock | 77 +------------------ src/Find.php | 2 +- tests/integration/postgresql/CustomTest.php | 4 +- tests/integration/postgresql/DocumentTest.php | 40 +++++----- tests/integration/postgresql/FindTest.php | 24 +++--- tests/integration/postgresql/PatchTest.php | 4 +- .../postgresql/RemoveFieldsTest.php | 4 +- tests/integration/sqlite/CustomTest.php | 4 +- tests/integration/sqlite/DocumentTest.php | 40 +++++----- tests/integration/sqlite/FindTest.php | 12 +-- tests/integration/sqlite/PatchTest.php | 2 +- tests/integration/sqlite/RemoveFieldsTest.php | 4 +- 13 files changed, 72 insertions(+), 148 deletions(-) diff --git a/composer.json b/composer.json index 5bb93c1..26ecd61 100644 --- a/composer.json +++ b/composer.json @@ -22,8 +22,7 @@ "php": ">=8.2", "bit-badger/inspired-by-fsharp": "^1", "netresearch/jsonmapper": "^4", - "ext-pdo": "*", - "phpoption/phpoption": "^1.9" + "ext-pdo": "*" }, "require-dev": { "phpunit/phpunit": "^11", diff --git a/composer.lock b/composer.lock index efe8e2a..06e78df 100644 --- a/composer.lock +++ b/composer.lock @@ -4,7 +4,7 @@ "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies", "This file is @generated automatically" ], - "content-hash": "223a16e330809798fc103d89c35faaa7", + "content-hash": "f3351c794dd1261ee4bf18380f58463d", "packages": [ { "name": "bit-badger/inspired-by-fsharp", @@ -101,81 +101,6 @@ "source": "https://github.com/cweiske/jsonmapper/tree/v4.4.1" }, "time": "2024-01-31T06:18:54+00:00" - }, - { - "name": "phpoption/phpoption", - "version": "1.9.3", - "source": { - "type": "git", - "url": "https://github.com/schmittjoh/php-option.git", - "reference": "e3fac8b24f56113f7cb96af14958c0dd16330f54" - }, - "dist": { - "type": "zip", - "url": "https://api.github.com/repos/schmittjoh/php-option/zipball/e3fac8b24f56113f7cb96af14958c0dd16330f54", - "reference": "e3fac8b24f56113f7cb96af14958c0dd16330f54", - "shasum": "" - }, - "require": { - "php": "^7.2.5 || ^8.0" - }, - "require-dev": { - "bamarni/composer-bin-plugin": "^1.8.2", - "phpunit/phpunit": "^8.5.39 || ^9.6.20 || ^10.5.28" - }, - "type": "library", - "extra": { - "bamarni-bin": { - "bin-links": true, - "forward-command": false - }, - "branch-alias": { - "dev-master": "1.9-dev" - } - }, - "autoload": { - "psr-4": { - "PhpOption\\": "src/PhpOption/" - } - }, - "notification-url": "https://packagist.org/downloads/", - "license": [ - "Apache-2.0" - ], - "authors": [ - { - "name": "Johannes M. Schmitt", - "email": "schmittjoh@gmail.com", - "homepage": "https://github.com/schmittjoh" - }, - { - "name": "Graham Campbell", - "email": "hello@gjcampbell.co.uk", - "homepage": "https://github.com/GrahamCampbell" - } - ], - "description": "Option Type for PHP", - "keywords": [ - "language", - "option", - "php", - "type" - ], - "support": { - "issues": "https://github.com/schmittjoh/php-option/issues", - "source": "https://github.com/schmittjoh/php-option/tree/1.9.3" - }, - "funding": [ - { - "url": "https://github.com/GrahamCampbell", - "type": "github" - }, - { - "url": "https://tidelift.com/funding/github/packagist/phpoption/phpoption", - "type": "tidelift" - } - ], - "time": "2024-07-20T21:41:07+00:00" } ], "packages-dev": [ diff --git a/src/Find.php b/src/Find.php index c283f4e..c39c414 100644 --- a/src/Find.php +++ b/src/Find.php @@ -8,8 +8,8 @@ declare(strict_types=1); namespace BitBadger\PDODocument; +use BitBadger\InspiredByFSharp\Option; use BitBadger\PDODocument\Mapper\DocumentMapper; -use PhpOption\Option; /** * Functions to find documents diff --git a/tests/integration/postgresql/CustomTest.php b/tests/integration/postgresql/CustomTest.php index 728b958..52f5c36 100644 --- a/tests/integration/postgresql/CustomTest.php +++ b/tests/integration/postgresql/CustomTest.php @@ -93,7 +93,7 @@ class CustomTest extends TestCase { $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'one'], new DocumentMapper(TestDocument::class)); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('one', $doc->get()->id, 'The incorrect document was returned'); } @@ -101,7 +101,7 @@ class CustomTest extends TestCase { $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'eighty'], new DocumentMapper(TestDocument::class)); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } public function testNonQuerySucceedsWhenOperatingOnData() diff --git a/tests/integration/postgresql/DocumentTest.php b/tests/integration/postgresql/DocumentTest.php index e5d5979..01d09d4 100644 --- a/tests/integration/postgresql/DocumentTest.php +++ b/tests/integration/postgresql/DocumentTest.php @@ -40,7 +40,7 @@ class DocumentTest extends TestCase { Document::insert(ThrowawayDb::TABLE, ['id' => 'turkey', 'sub' => ['foo' => 'gobble', 'bar' => 'gobble']]); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); - $this->assertTrue($tryDoc->isDefined(), 'There should have been a document inserted'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document inserted'); $doc = $tryDoc->get(); $this->assertEquals('turkey', $doc->id, 'The ID was incorrect'); $this->assertEquals('', $doc->value, 'The value was incorrect'); @@ -59,14 +59,14 @@ class DocumentTest extends TestCase Document::insert(ThrowawayDb::TABLE, ['id' => 0, 'value' => 'new', 'num_value' => 8]); $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE, [], new ArrayMapper()); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $obj = json_decode($doc->get()['data']); $this->assertEquals(1, $obj->id, 'The ID 1 should have been auto-generated'); Document::insert(ThrowawayDb::TABLE, ['id' => 0, 'value' => 'again', 'num_value' => 7]); $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE " . Query::whereById(docId: 2), [':id' => 2], new ArrayMapper()); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $obj = json_decode($doc->get()['data']); $this->assertEquals(2, $obj->id, 'The ID 2 should have been auto-generated'); } finally { @@ -82,7 +82,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, ['id' => 7, 'value' => 'new', 'num_value' => 8]); $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE, [], new ArrayMapper()); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $obj = json_decode($doc->get()['data']); $this->assertEquals(7, $obj->id, 'The ID 7 should have been stored'); } finally { @@ -98,7 +98,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, ['id' => '', 'num_value' => 5]); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 5)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertNotEmpty($doc->get()->id, 'The ID should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; @@ -114,7 +114,7 @@ class DocumentTest extends TestCase $uuid = AutoId::generateUUID(); Document::insert(ThrowawayDb::TABLE, ['id' => $uuid, 'value' => 'uuid', 'num_value' => 12]); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 12)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals($uuid, $doc->get()->id, 'The ID should not have been changed'); } finally { Configuration::$autoId = AutoId::None; @@ -130,7 +130,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, ['id' => '', 'value' => 'new', 'num_value' => 8]); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 8)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(6, strlen($doc->get()->id), 'The ID should have been auto-generated and had 6 characters'); } finally { @@ -147,7 +147,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, ['id' => 'my-key', 'value' => 'old', 'num_value' => 3]); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 3)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('my-key', $doc->get()->id, 'The ID should not have been changed'); } finally { Configuration::$autoId = AutoId::None; @@ -159,7 +159,7 @@ class DocumentTest extends TestCase { Document::insert(ThrowawayDb::TABLE, new TestDocument('turkey', sub: new SubDocument('gobble', 'gobble'))); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); - $this->assertTrue($tryDoc->isDefined(), 'There should have been a document inserted'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document inserted'); $doc = $tryDoc->get(); $this->assertEquals('turkey', $doc->id, 'The ID was incorrect'); $this->assertEquals('', $doc->value, 'The value was incorrect'); @@ -178,12 +178,12 @@ class DocumentTest extends TestCase Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'taco')); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'taco')], NumDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(1, $doc->get()->id, 'The ID 1 should have been auto-generated'); Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'burrito')); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'burrito')], NumDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(2, $doc->get()->id, 'The ID 2 should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; @@ -198,7 +198,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, new NumDocument(64, 'large')); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'large')], NumDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(64, $doc->get()->id, 'The ID 64 should have been stored'); } finally { Configuration::$autoId = AutoId::None; @@ -213,7 +213,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, new TestDocument(value: 'something', num_value: 9)); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EX('value')], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertNotEmpty($doc->get()->id, 'The ID should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; @@ -229,7 +229,7 @@ class DocumentTest extends TestCase $uuid = AutoId::generateUUID(); Document::insert(ThrowawayDb::TABLE, new TestDocument($uuid, num_value: 14)); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 14)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals($uuid, $doc->get()->id, 'The ID should not have been changed'); } finally { Configuration::$autoId = AutoId::None; @@ -245,7 +245,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, new TestDocument(num_value: 55)); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 55)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(40, strlen($doc->get()->id), 'The ID should have been auto-generated and had 40 characters'); } finally { @@ -262,7 +262,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, new TestDocument('my-key', num_value: 3)); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 3)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('my-key', $doc->get()->id, 'The ID should not have been changed'); } finally { Configuration::$autoId = AutoId::None; @@ -279,14 +279,14 @@ class DocumentTest extends TestCase { Document::save(ThrowawayDb::TABLE, new TestDocument('test', sub: new SubDocument('a', 'b'))); $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); } public function testSaveSucceedsWhenADocumentIsUpdated(): void { Document::save(ThrowawayDb::TABLE, new TestDocument('two', num_value: 44)); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertTrue($tryDoc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document returned'); $doc = $tryDoc->get(); $this->assertEquals(44, $doc->num_value, 'The numeric value was not updated'); $this->assertNull($doc->sub, 'The sub-document should have been null'); @@ -296,7 +296,7 @@ class DocumentTest extends TestCase { Document::update(ThrowawayDb::TABLE, 'one', new TestDocument('one', 'howdy', 8, new SubDocument('y', 'z'))); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertNotFalse($tryDoc->isDefined(), 'There should have been a document returned'); + $this->assertNotFalse($tryDoc->isSome(), 'There should have been a document returned'); $doc = $tryDoc->get(); $this->assertEquals('howdy', $doc->value, 'The value was incorrect'); $this->assertEquals(8, $doc->num_value, 'The numeric value was incorrect'); @@ -309,6 +309,6 @@ class DocumentTest extends TestCase { Document::update(ThrowawayDb::TABLE, 'two-hundred', new TestDocument('200')); $doc = Find::byId(ThrowawayDb::TABLE, 'two-hundred', TestDocument::class); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } } diff --git a/tests/integration/postgresql/FindTest.php b/tests/integration/postgresql/FindTest.php index b04523d..bb81b97 100644 --- a/tests/integration/postgresql/FindTest.php +++ b/tests/integration/postgresql/FindTest.php @@ -55,7 +55,7 @@ class FindTest extends TestCase public function testByIdSucceedsWhenADocumentIsFound(): void { $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('two', $doc->get()->id, 'An incorrect document was returned'); } @@ -65,7 +65,7 @@ class FindTest extends TestCase Delete::byFields(ThrowawayDb::TABLE, [Field::NEX('absent')]); Document::insert(ThrowawayDb::TABLE, ['id' => 18, 'value' => 'howdy']); $doc = Find::byId(ThrowawayDb::TABLE, 18, NumDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(18, $doc->get()->id, 'An incorrect document was returned'); } @@ -73,7 +73,7 @@ class FindTest extends TestCase public function testByIdSucceedsWhenADocumentIsNotFound(): void { $doc = Find::byId(ThrowawayDb::TABLE, 'seventy-five', TestDocument::class); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } public function testByFieldsSucceedsWhenDocumentsAreFound(): void @@ -129,48 +129,48 @@ class FindTest extends TestCase public function testFirstByFieldsSucceedsWhenADocumentIsFound(): void { $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'another')], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('two', $doc->get()->id, 'The incorrect document was returned'); } public function testFirstByFieldsSucceedsWhenMultipleDocumentsAreFound(): void { $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('sub.foo', 'green')], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertContains($doc->get()->id, ['two', 'four'], 'An incorrect document was returned'); } public function testFirstByFieldsSucceedsWhenADocumentIsNotFound(): void { $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'absent')], TestDocument::class); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } public function testFirstByContainsSucceedsWhenADocumentIsFound(): void { $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'FIRST!'], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('one', $doc->get()->id, 'The incorrect document was returned'); } public function testFirstByContainsSucceedsWhenMultipleDocumentsAreFound(): void { $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'purple'], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertContains($doc->get()->id, ['four', 'five'], 'An incorrect document was returned'); } public function testFirstByContainsSucceedsWhenADocumentIsNotFound(): void { $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'indigo'], TestDocument::class); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } #[TestDox('First by JSON Path succeeds when a document is found')] public function testFirstByJsonPathSucceedsWhenADocumentIsFound(): void { $doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ == 10)', TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('two', $doc->get()->id, 'The incorrect document was returned'); } @@ -178,7 +178,7 @@ class FindTest extends TestCase public function testFirstByJsonPathSucceedsWhenMultipleDocumentsAreFound(): void { $doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertContains($doc->get()->id, ['four', 'five'], 'An incorrect document was returned'); } @@ -186,6 +186,6 @@ class FindTest extends TestCase public function testFirstByJsonPathSucceedsWhenADocumentIsNotFound(): void { $doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 100)', TestDocument::class); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } } diff --git a/tests/integration/postgresql/PatchTest.php b/tests/integration/postgresql/PatchTest.php index 467ddf4..10ae185 100644 --- a/tests/integration/postgresql/PatchTest.php +++ b/tests/integration/postgresql/PatchTest.php @@ -39,7 +39,7 @@ class PatchTest extends TestCase { Patch::byId(ThrowawayDb::TABLE, 'one', ['num_value' => 44]); $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(44, $doc->get()->num_value, 'The updated document is not correct'); } @@ -71,7 +71,7 @@ class PatchTest extends TestCase { Patch::byContains(ThrowawayDb::TABLE, ['value' => 'another'], ['num_value' => 12]); $tryDoc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'another'], TestDocument::class); - $this->assertNotFalse($tryDoc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document returned'); $doc = $tryDoc->get(); $this->assertEquals('two', $doc->id, 'An incorrect document was returned'); $this->assertEquals(12, $doc->num_value, 'The document was not patched'); diff --git a/tests/integration/postgresql/RemoveFieldsTest.php b/tests/integration/postgresql/RemoveFieldsTest.php index e32f94c..dc68e8a 100644 --- a/tests/integration/postgresql/RemoveFieldsTest.php +++ b/tests/integration/postgresql/RemoveFieldsTest.php @@ -39,7 +39,7 @@ class RemoveFieldsTest extends TestCase { RemoveFields::byId(ThrowawayDb::TABLE, 'two', ['sub', 'value']); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertNotFalse($tryDoc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document returned'); $doc = $tryDoc->get(); $this->assertEquals('', $doc->value, 'Value should have been blank (its default value)'); $this->assertNull($doc->sub, 'Sub-document should have been null'); @@ -63,7 +63,7 @@ class RemoveFieldsTest extends TestCase { RemoveFields::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 17)], ['sub']); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 17)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertNull($doc->get()->sub, 'Sub-document should have been null'); } diff --git a/tests/integration/sqlite/CustomTest.php b/tests/integration/sqlite/CustomTest.php index 7d47d27..e4bc343 100644 --- a/tests/integration/sqlite/CustomTest.php +++ b/tests/integration/sqlite/CustomTest.php @@ -92,7 +92,7 @@ class CustomTest extends TestCase { $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'one'], new DocumentMapper(TestDocument::class)); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('one', $doc->get()->id, 'The incorrect document was returned'); } @@ -100,7 +100,7 @@ class CustomTest extends TestCase { $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'eighty'], new DocumentMapper(TestDocument::class)); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } public function testNonQuerySucceedsWhenOperatingOnData() diff --git a/tests/integration/sqlite/DocumentTest.php b/tests/integration/sqlite/DocumentTest.php index f7767df..b0b8f01 100644 --- a/tests/integration/sqlite/DocumentTest.php +++ b/tests/integration/sqlite/DocumentTest.php @@ -40,7 +40,7 @@ class DocumentTest extends TestCase { Document::insert(ThrowawayDb::TABLE, ['id' => 'turkey', 'sub' => ['foo' => 'gobble', 'bar' => 'gobble']]); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); - $this->assertTrue($tryDoc->isDefined(), 'There should have been a document inserted'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document inserted'); $doc = $tryDoc->get(); $this->assertEquals('turkey', $doc->id, 'The ID was incorrect'); $this->assertEquals('', $doc->value, 'The value was incorrect'); @@ -59,14 +59,14 @@ class DocumentTest extends TestCase Document::insert(ThrowawayDb::TABLE, ['id' => 0, 'value' => 'new', 'num_value' => 8]); $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE, [], new ArrayMapper()); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $obj = json_decode($doc->get()['data']); $this->assertEquals(1, $obj->id, 'The ID 1 should have been auto-generated'); Document::insert(ThrowawayDb::TABLE, ['id' => 0, 'value' => 'again', 'num_value' => 7]); $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = 2", [], new ArrayMapper()); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $obj = json_decode($doc->get()['data']); $this->assertEquals(2, $obj->id, 'The ID 2 should have been auto-generated'); } finally { @@ -82,7 +82,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, ['id' => 7, 'value' => 'new', 'num_value' => 8]); $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE, [], new ArrayMapper()); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $obj = json_decode($doc->get()['data']); $this->assertEquals(7, $obj->id, 'The ID 7 should have been stored'); } finally { @@ -98,7 +98,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, ['id' => '', 'num_value' => 5]); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 5)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertNotEmpty($doc->get()->id, 'The ID should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; @@ -114,7 +114,7 @@ class DocumentTest extends TestCase $uuid = AutoId::generateUUID(); Document::insert(ThrowawayDb::TABLE, ['id' => $uuid, 'value' => 'uuid', 'num_value' => 12]); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 12)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals($uuid, $doc->get()->id, 'The ID should not have been changed'); } finally { Configuration::$autoId = AutoId::None; @@ -130,7 +130,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, ['id' => '', 'value' => 'new', 'num_value' => 8]); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 8)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(6, strlen($doc->get()->id), 'The ID should have been auto-generated and had 6 characters'); } finally { @@ -147,7 +147,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, ['id' => 'my-key', 'value' => 'old', 'num_value' => 3]); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 3)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('my-key', $doc->get()->id, 'The ID should not have been changed'); } finally { Configuration::$autoId = AutoId::None; @@ -159,7 +159,7 @@ class DocumentTest extends TestCase { Document::insert(ThrowawayDb::TABLE, new TestDocument('turkey', sub: new SubDocument('gobble', 'gobble'))); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); - $this->assertNotFalse($tryDoc->isDefined(), 'There should have been a document inserted'); + $this->assertNotFalse($tryDoc->isSome(), 'There should have been a document inserted'); $doc = $tryDoc->get(); $this->assertEquals('turkey', $doc->id, 'The ID was incorrect'); $this->assertEquals('', $doc->value, 'The value was incorrect'); @@ -178,12 +178,12 @@ class DocumentTest extends TestCase Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'taco')); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'taco')], NumDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(1, $doc->get()->id, 'The ID 1 should have been auto-generated'); Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'burrito')); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'burrito')], NumDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(2, $doc->get()->id, 'The ID 2 should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; @@ -198,7 +198,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, new NumDocument(64, 'large')); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'large')], NumDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(64, $doc->get()->id, 'The ID 64 should have been stored'); } finally { Configuration::$autoId = AutoId::None; @@ -213,7 +213,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, new TestDocument(value: 'something', num_value: 9)); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EX('value')], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertNotEmpty($doc->get()->id, 'The ID should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; @@ -229,7 +229,7 @@ class DocumentTest extends TestCase $uuid = AutoId::generateUUID(); Document::insert(ThrowawayDb::TABLE, new TestDocument($uuid, num_value: 14)); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 14)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals($uuid, $doc->get()->id, 'The ID should not have been changed'); } finally { Configuration::$autoId = AutoId::None; @@ -245,7 +245,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, new TestDocument(num_value: 55)); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 55)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(40, strlen($doc->get()->id), 'The ID should have been auto-generated and had 40 characters'); } finally { @@ -262,7 +262,7 @@ class DocumentTest extends TestCase Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []); Document::insert(ThrowawayDb::TABLE, new TestDocument('my-key', num_value: 3)); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 3)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('my-key', $doc->get()->id, 'The ID should not have been changed'); } finally { Configuration::$autoId = AutoId::None; @@ -279,14 +279,14 @@ class DocumentTest extends TestCase { Document::save(ThrowawayDb::TABLE, new TestDocument('test', sub: new SubDocument('a', 'b'))); $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); } public function testSaveSucceedsWhenADocumentIsUpdated(): void { Document::save(ThrowawayDb::TABLE, new TestDocument('two', num_value: 44)); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertTrue($tryDoc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document returned'); $doc = $tryDoc->get(); $this->assertEquals(44, $doc->num_value, 'The numeric value was not updated'); $this->assertNull($doc->sub, 'The sub-document should have been null'); @@ -296,7 +296,7 @@ class DocumentTest extends TestCase { Document::update(ThrowawayDb::TABLE, 'one', new TestDocument('one', 'howdy', 8, new SubDocument('y', 'z'))); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertTrue($tryDoc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document returned'); $doc = $tryDoc->get(); $this->assertEquals('howdy', $doc->value, 'The value was incorrect'); $this->assertEquals(8, $doc->num_value, 'The numeric value was incorrect'); @@ -309,6 +309,6 @@ class DocumentTest extends TestCase { Document::update(ThrowawayDb::TABLE, 'two-hundred', new TestDocument('200')); $doc = Find::byId(ThrowawayDb::TABLE, 'two-hundred', TestDocument::class); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } } diff --git a/tests/integration/sqlite/FindTest.php b/tests/integration/sqlite/FindTest.php index b6f836b..ed3f175 100644 --- a/tests/integration/sqlite/FindTest.php +++ b/tests/integration/sqlite/FindTest.php @@ -55,7 +55,7 @@ class FindTest extends TestCase public function testByIdSucceedsWhenADocumentIsFound(): void { $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('two', $doc->get()->id, 'An incorrect document was returned'); } @@ -64,7 +64,7 @@ class FindTest extends TestCase { Document::insert(ThrowawayDb::TABLE, ['id' => 18, 'value' => 'howdy']); $doc = Find::byId(ThrowawayDb::TABLE, 18, TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('18', $doc->get()->id, 'An incorrect document was returned'); } @@ -72,7 +72,7 @@ class FindTest extends TestCase public function testByIdSucceedsWhenADocumentIsNotFound(): void { $doc = Find::byId(ThrowawayDb::TABLE, 'seventy-five', TestDocument::class); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } public function testByFieldsSucceedsWhenDocumentsAreFound(): void @@ -107,21 +107,21 @@ class FindTest extends TestCase public function testFirstByFieldsSucceedsWhenADocumentIsFound(): void { $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'another')], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals('two', $doc->get()->id, 'The incorrect document was returned'); } public function testFirstByFieldsSucceedsWhenMultipleDocumentsAreFound(): void { $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('sub.foo', 'green')], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertContains($doc->get()->id, ['two', 'four'], 'An incorrect document was returned'); } public function testFirstByFieldsSucceedsWhenADocumentIsNotFound(): void { $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'absent')], TestDocument::class); - $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); + $this->assertTrue($doc->isNone(), 'There should not have been a document returned'); } public function testFirstByContainsFails(): void diff --git a/tests/integration/sqlite/PatchTest.php b/tests/integration/sqlite/PatchTest.php index cd003b3..059b0cd 100644 --- a/tests/integration/sqlite/PatchTest.php +++ b/tests/integration/sqlite/PatchTest.php @@ -39,7 +39,7 @@ class PatchTest extends TestCase { Patch::byId(ThrowawayDb::TABLE, 'one', ['num_value' => 44]); $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertEquals(44, $doc->get()->num_value, 'The updated document is not correct'); } diff --git a/tests/integration/sqlite/RemoveFieldsTest.php b/tests/integration/sqlite/RemoveFieldsTest.php index 5972f3a..f0bdeb3 100644 --- a/tests/integration/sqlite/RemoveFieldsTest.php +++ b/tests/integration/sqlite/RemoveFieldsTest.php @@ -39,7 +39,7 @@ class RemoveFieldsTest extends TestCase { RemoveFields::byId(ThrowawayDb::TABLE, 'two', ['sub', 'value']); $tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertTrue($tryDoc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($tryDoc->isSome(), 'There should have been a document returned'); $doc = $tryDoc->get(); $this->assertEquals('', $doc->value, 'Value should have been blank (its default value)'); $this->assertNull($doc->sub, 'Sub-document should have been null'); @@ -63,7 +63,7 @@ class RemoveFieldsTest extends TestCase { RemoveFields::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 17)], ['sub']); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 17)], TestDocument::class); - $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertTrue($doc->isSome(), 'There should have been a document returned'); $this->assertNull($doc->get()->sub, 'Sub-document should have been null'); } -- 2.45.1 From 407441e8572c58c62897410000f8c2ba1c9c2c1f Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Sun, 28 Jul 2024 20:01:55 -0400 Subject: [PATCH 3/3] Add mapToArray to doc list --- src/DocumentList.php | 18 ++++++++++++++++++ .../postgresql/DocumentListTest.php | 11 +++++++++++ tests/integration/sqlite/DocumentListTest.php | 11 +++++++++++ 3 files changed, 40 insertions(+) diff --git a/src/DocumentList.php b/src/DocumentList.php index 47bdace..c72ea7f 100644 --- a/src/DocumentList.php +++ b/src/DocumentList.php @@ -103,6 +103,24 @@ class DocumentList } } + /** + * Iterate the generator, extracting key/value pairs returned as an associative array + * + * @template TValue The type for the mapped value + * @param callable(TDoc): (int|string) $keyFunc The function to extract a key from the document + * @param callable(TDoc): TValue $valueFunc The function to extract a value from the document + * @return TValue[] An associative array of values, keyed by the extracted keys + * @throws DocumentException If this is called once the generator has been consumed + */ + public function mapToArray(callable $keyFunc, callable $valueFunc): array + { + $results = []; + foreach ($this->items() as $item) { + $results[$keyFunc($item)] = $valueFunc($item); + } + return $results; + } + /** * Ensure the statement is destroyed if the generator is not exhausted */ diff --git a/tests/integration/postgresql/DocumentListTest.php b/tests/integration/postgresql/DocumentListTest.php index 135e434..88154e5 100644 --- a/tests/integration/postgresql/DocumentListTest.php +++ b/tests/integration/postgresql/DocumentListTest.php @@ -113,4 +113,15 @@ class DocumentListTest extends TestCase $this->assertEquals('*** *** ***** **** ****', implode(' ', $splats), 'Iteration did not have the expected result'); } + + public function testMapToArraySucceeds(): void + { + $list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [], + new DocumentMapper(TestDocument::class)); + $this->assertNotNull($list, 'There should have been a document list created'); + $this->assertTrue($list->hasItems(), 'There should be items in the list'); + $lookup = $list->mapToArray(fn($it) => $it->id, fn($it) => $it->value); + $expected = ['one' => 'FIRST!', 'two' => 'another', 'three' => '', 'four' => 'purple', 'five' => 'purple']; + $this->assertEquals($expected, $lookup, 'The array was not mapped correctly'); + } } diff --git a/tests/integration/sqlite/DocumentListTest.php b/tests/integration/sqlite/DocumentListTest.php index 88623a0..8962d69 100644 --- a/tests/integration/sqlite/DocumentListTest.php +++ b/tests/integration/sqlite/DocumentListTest.php @@ -111,4 +111,15 @@ class DocumentListTest extends TestCase $this->assertEquals('*** *** ***** **** ****', implode(' ', $splats), 'Iteration did not have the expected result'); } + + public function testMapToArraySucceeds(): void + { + $list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [], + new DocumentMapper(TestDocument::class)); + $this->assertNotNull($list, 'There should have been a document list created'); + $this->assertTrue($list->hasItems(), 'There should be items in the list'); + $lookup = $list->mapToArray(fn($it) => $it->id, fn($it) => $it->value); + $expected = ['one' => 'FIRST!', 'two' => 'another', 'three' => '', 'four' => 'purple', 'five' => 'purple']; + $this->assertEquals($expected, $lookup, 'The array was not mapped correctly'); + } } -- 2.45.1