From 0c9490e3942bab3b0e7b7e19884ecdd85ca27d4c Mon Sep 17 00:00:00 2001 From: "Daniel J. Summers" Date: Mon, 24 Jun 2024 22:04:11 -0400 Subject: [PATCH] Use Option for single doc queries --- composer.json | 5 +- composer.lock | 77 ++++++++++++++++- src/Custom.php | 7 +- src/Find.php | 17 ++-- tests/integration/postgresql/CustomTest.php | 6 +- tests/integration/postgresql/DocumentTest.php | 82 ++++++++++--------- tests/integration/postgresql/FindTest.php | 39 ++++----- tests/integration/postgresql/PatchTest.php | 9 +- .../postgresql/RemoveFieldsTest.php | 9 +- tests/integration/sqlite/CustomTest.php | 6 +- tests/integration/sqlite/DocumentTest.php | 82 ++++++++++--------- tests/integration/sqlite/FindTest.php | 20 ++--- tests/integration/sqlite/PatchTest.php | 4 +- tests/integration/sqlite/RemoveFieldsTest.php | 9 +- 14 files changed, 233 insertions(+), 139 deletions(-) diff --git a/composer.json b/composer.json index 7c2fddd..4d106e5 100644 --- a/composer.json +++ b/composer.json @@ -19,7 +19,8 @@ "require": { "php": ">=8.2", "netresearch/jsonmapper": "^4", - "ext-pdo": "*" + "ext-pdo": "*", + "phpoption/phpoption": "^1.9" }, "require-dev": { "phpunit/phpunit": "^11" @@ -42,4 +43,4 @@ "archive": { "exclude": [ "/tests", "/.gitattributes", "/.gitignore", "/.git", "/composer.lock" ] } -} \ No newline at end of file +} diff --git a/composer.lock b/composer.lock index 2727155..c5c6960 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": "20bf0d96304e429b431535d05ff4585a", + "content-hash": "71593fca8aa32b0cd963eb52bad1a34e", "packages": [ { "name": "netresearch/jsonmapper", @@ -56,6 +56,81 @@ "source": "https://github.com/cweiske/jsonmapper/tree/v4.4.1" }, "time": "2024-01-31T06:18:54+00:00" + }, + { + "name": "phpoption/phpoption", + "version": "1.9.2", + "source": { + "type": "git", + "url": "https://github.com/schmittjoh/php-option.git", + "reference": "80735db690fe4fc5c76dfa7f9b770634285fa820" + }, + "dist": { + "type": "zip", + "url": "https://api.github.com/repos/schmittjoh/php-option/zipball/80735db690fe4fc5c76dfa7f9b770634285fa820", + "reference": "80735db690fe4fc5c76dfa7f9b770634285fa820", + "shasum": "" + }, + "require": { + "php": "^7.2.5 || ^8.0" + }, + "require-dev": { + "bamarni/composer-bin-plugin": "^1.8.2", + "phpunit/phpunit": "^8.5.34 || ^9.6.13 || ^10.4.2" + }, + "type": "library", + "extra": { + "bamarni-bin": { + "bin-links": true, + "forward-command": true + }, + "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.2" + }, + "funding": [ + { + "url": "https://github.com/GrahamCampbell", + "type": "github" + }, + { + "url": "https://tidelift.com/funding/github/packagist/phpoption/phpoption", + "type": "tidelift" + } + ], + "time": "2023-11-12T21:59:55+00:00" } ], "packages-dev": [ diff --git a/src/Custom.php b/src/Custom.php index 8644cda..d2e6cfd 100644 --- a/src/Custom.php +++ b/src/Custom.php @@ -6,6 +6,7 @@ use BitBadger\PDODocument\Mapper\Mapper; use PDO; use PDOException; use PDOStatement; +use PhpOption\{None, Option, Some}; /** * Functions to execute custom queries @@ -92,14 +93,14 @@ class Custom * @param string $query The query to be executed (will have "LIMIT 1" appended) * @param array $parameters Parameters to use in executing the query * @param Mapper $mapper Mapper to deserialize the result - * @return false|TDoc The item if it is found, false if not + * @return Option A `Some` instance if the item is found, `None` otherwise * @throws DocumentException If any is encountered */ - public static function single(string $query, array $parameters, Mapper $mapper): mixed + public static function single(string $query, array $parameters, Mapper $mapper): Option { try { $stmt = &self::runQuery("$query LIMIT 1", $parameters); - return ($first = $stmt->fetch(PDO::FETCH_ASSOC)) ? $mapper->map($first) : false; + return ($first = $stmt->fetch(PDO::FETCH_ASSOC)) ? Some::create($mapper->map($first)) : None::create(); } finally { $stmt = null; } diff --git a/src/Find.php b/src/Find.php index 055868b..cdfda23 100644 --- a/src/Find.php +++ b/src/Find.php @@ -3,6 +3,7 @@ namespace BitBadger\PDODocument; use BitBadger\PDODocument\Mapper\DocumentMapper; +use PhpOption\Option; /** * Functions to find documents @@ -30,10 +31,10 @@ class Find * @param string $tableName The table from which the document should be retrieved * @param mixed $docId The ID of the document to retrieve * @param class-string $className The name of the class to be retrieved - * @return false|TDoc The document if it exists, false if not + * @return Option A `Some` instance if the document is found, `None` otherwise * @throws DocumentException If any is encountered */ - public static function byId(string $tableName, mixed $docId, string $className): mixed + public static function byId(string $tableName, mixed $docId, string $className): Option { return Custom::single(Query\Find::byId($tableName, $docId), Parameters::id($docId), new DocumentMapper($className)); @@ -97,11 +98,11 @@ class Find * @param array|Field[] $fields The field comparison to match * @param class-string $className The name of the class to be retrieved * @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All) - * @return false|TDoc The first document if any matches are found, false otherwise + * @return Option A `Some` instance with the first document if any matches are found, `None` otherwise * @throws DocumentException If any is encountered */ public static function firstByFields(string $tableName, array $fields, string $className, - ?FieldMatch $match = null): mixed + ?FieldMatch $match = null): Option { $namedFields = Parameters::nameFields($fields); return Custom::single(Query\Find::byFields($tableName, $namedFields, $match), @@ -115,10 +116,10 @@ class Find * @param string $tableName The name of the table from which documents should be retrieved * @param array|object $criteria The criteria for the JSON containment query * @param class-string $className The name of the class to be retrieved - * @return false|TDoc The first document matching the JSON containment query if any is found, false otherwise + * @return Option A `Some` instance with the first document if any matches are found, `None` otherwise * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs */ - public static function firstByContains(string $tableName, array|object $criteria, string $className): mixed + public static function firstByContains(string $tableName, array|object $criteria, string $className): Option { return Custom::single(Query\Find::byContains($tableName), Parameters::json(':criteria', $criteria), new DocumentMapper($className)); @@ -131,10 +132,10 @@ class Find * @param string $tableName The name of the table from which documents should be retrieved * @param string $path The JSON Path match string * @param class-string $className The name of the class to be retrieved - * @return false|TDoc The first document matching the JSON Path if any is found, false otherwise + * @return Option A `Some` instance with the first document if any matches are found, `None` otherwise * @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs */ - public static function firstByJsonPath(string $tableName, string $path, string $className): mixed + public static function firstByJsonPath(string $tableName, string $path, string $className): Option { return Custom::single(Query\Find::byJsonPath($tableName), [':path' => $path], new DocumentMapper($className)); } diff --git a/tests/integration/postgresql/CustomTest.php b/tests/integration/postgresql/CustomTest.php index 4366b53..b656b51 100644 --- a/tests/integration/postgresql/CustomTest.php +++ b/tests/integration/postgresql/CustomTest.php @@ -87,15 +87,15 @@ class CustomTest extends TestCase { $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'one'], new DocumentMapper(TestDocument::class)); - $this->assertNotNull($doc, 'There should have been a document returned'); - $this->assertEquals('one', $doc->id, 'The incorrect document was returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals('one', $doc->get()->id, 'The incorrect document was returned'); } public function testSingleSucceedsWhenARowIsNotFound(): void { $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'eighty'], new DocumentMapper(TestDocument::class)); - $this->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), '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 786e572..08fb4a8 100644 --- a/tests/integration/postgresql/DocumentTest.php +++ b/tests/integration/postgresql/DocumentTest.php @@ -33,8 +33,9 @@ class DocumentTest extends TestCase public function testInsertSucceedsForArrayNoAutoId(): void { Document::insert(ThrowawayDb::TABLE, ['id' => 'turkey', 'sub' => ['foo' => 'gobble', 'bar' => 'gobble']]); - $doc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document inserted'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); + $this->assertTrue($tryDoc->isDefined(), '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'); $this->assertEquals(0, $doc->num_value, 'The numeric value was incorrect'); @@ -52,15 +53,15 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $obj = json_decode($doc['data']); + $this->assertTrue($doc->isDefined(), '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->assertNotFalse($doc, 'There should have been a document returned'); - $obj = json_decode($doc['data']); + $this->assertTrue($doc->isDefined(), '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 { Configuration::$autoId = AutoId::None; @@ -75,8 +76,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $obj = json_decode($doc['data']); + $this->assertTrue($doc->isDefined(), '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 { Configuration::$autoId = AutoId::None; @@ -91,8 +92,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertNotEmpty($doc->id, 'The ID should have been auto-generated'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertNotEmpty($doc->get()->id, 'The ID should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; } @@ -107,8 +108,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals($uuid, $doc->id, 'The ID should not have been changed'); + $this->assertTrue($doc->isDefined(), '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; } @@ -123,8 +124,9 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(6, strlen($doc->id), 'The ID should have been auto-generated and had 6 characters'); + $this->assertTrue($doc->isDefined(), '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 { Configuration::$autoId = AutoId::None; Configuration::$idStringLength = 16; @@ -139,8 +141,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('my-key', $doc->id, 'The ID should not have been changed'); + $this->assertTrue($doc->isDefined(), '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; } @@ -150,8 +152,9 @@ class DocumentTest extends TestCase public function testInsertSucceedsForObjectNoAutoId(): void { Document::insert(ThrowawayDb::TABLE, new TestDocument('turkey', sub: new SubDocument('gobble', 'gobble'))); - $doc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document inserted'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); + $this->assertTrue($tryDoc->isDefined(), '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'); $this->assertEquals(0, $doc->num_value, 'The numeric value was incorrect'); @@ -169,13 +172,13 @@ class DocumentTest extends TestCase Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'taco')); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'taco')], NumDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(1, $doc->id, 'The ID 1 should have been auto-generated'); + $this->assertTrue($doc->isDefined(), '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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(2, $doc->id, 'The ID 2 should have been auto-generated'); + $this->assertTrue($doc->isDefined(), '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; } @@ -189,8 +192,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(64, $doc->id, 'The ID 64 should have been stored'); + $this->assertTrue($doc->isDefined(), '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; } @@ -204,8 +207,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertNotEmpty($doc->id, 'The ID should have been auto-generated'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertNotEmpty($doc->get()->id, 'The ID should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; } @@ -220,8 +223,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals($uuid, $doc->id, 'The ID should not have been changed'); + $this->assertTrue($doc->isDefined(), '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; } @@ -236,8 +239,9 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(40, strlen($doc->id), 'The ID should have been auto-generated and had 40 characters'); + $this->assertTrue($doc->isDefined(), '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 { Configuration::$autoId = AutoId::None; Configuration::$idStringLength = 16; @@ -252,8 +256,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('my-key', $doc->id, 'The ID should not have been changed'); + $this->assertTrue($doc->isDefined(), '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; } @@ -269,14 +273,15 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); } public function testSaveSucceedsWhenADocumentIsUpdated(): void { Document::save(ThrowawayDb::TABLE, new TestDocument('two', num_value: 44)); - $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); + $this->assertTrue($tryDoc->isDefined(), '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'); } @@ -284,8 +289,9 @@ class DocumentTest extends TestCase public function testUpdateSucceedsWhenReplacingADocument(): void { Document::update(ThrowawayDb::TABLE, 'one', new TestDocument('one', 'howdy', 8, new SubDocument('y', 'z'))); - $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); + $this->assertNotFalse($tryDoc->isDefined(), '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'); $this->assertNotNull($doc->sub, 'The sub-document should not have been null'); @@ -297,6 +303,6 @@ class DocumentTest extends TestCase { Document::update(ThrowawayDb::TABLE, 'two-hundred', new TestDocument('200')); $doc = Find::byId(ThrowawayDb::TABLE, 'two-hundred', TestDocument::class); - $this->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); } } diff --git a/tests/integration/postgresql/FindTest.php b/tests/integration/postgresql/FindTest.php index 3895d31..31695fc 100644 --- a/tests/integration/postgresql/FindTest.php +++ b/tests/integration/postgresql/FindTest.php @@ -49,8 +49,8 @@ class FindTest extends TestCase public function testByIdSucceedsWhenADocumentIsFound(): void { $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('two', $doc->id, 'An incorrect document was returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals('two', $doc->get()->id, 'An incorrect document was returned'); } #[TestDox('By ID succeeds when a document is found with numeric ID')] @@ -59,15 +59,15 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(18, $doc->id, 'An incorrect document was returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals(18, $doc->get()->id, 'An incorrect document was returned'); } #[TestDox('By ID succeeds when a document is not found')] public function testByIdSucceedsWhenADocumentIsNotFound(): void { $doc = Find::byId(ThrowawayDb::TABLE, 'seventy-five', TestDocument::class); - $this->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); } public function testByFieldsSucceedsWhenDocumentsAreFound(): void @@ -123,62 +123,63 @@ class FindTest extends TestCase public function testFirstByFieldsSucceedsWhenADocumentIsFound(): void { $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'another')], TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('two', $doc->id, 'The incorrect document was returned'); + $this->assertTrue($doc->isDefined(), '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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertContains($doc->id, ['two', 'four'], 'An incorrect document was returned'); + $this->assertTrue($doc->isDefined(), '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->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); } public function testFirstByContainsSucceedsWhenADocumentIsFound(): void { $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'FIRST!'], TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('one', $doc->id, 'The incorrect document was returned'); + $this->assertTrue($doc->isDefined(), '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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertContains($doc->id, ['four', 'five'], 'An incorrect document was returned'); + $this->assertTrue($doc->isDefined(), '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->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), '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->assertEquals('two', $doc->id, 'The incorrect document was returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals('two', $doc->get()->id, 'The incorrect document was returned'); } #[TestDox('First by JSON Path succeeds when multiple documents are found')] public function testFirstByJsonPathSucceedsWhenMultipleDocumentsAreFound(): void { $doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertContains($doc->id, ['four', 'five'], 'An incorrect document was returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertContains($doc->get()->id, ['four', 'five'], 'An incorrect document was returned'); } #[TestDox('First by JSON Path succeeds when a document is not found')] public function testFirstByJsonPathSucceedsWhenADocumentIsNotFound(): void { $doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 100)', TestDocument::class); - $this->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); } } diff --git a/tests/integration/postgresql/PatchTest.php b/tests/integration/postgresql/PatchTest.php index e8bfad1..d97d9b6 100644 --- a/tests/integration/postgresql/PatchTest.php +++ b/tests/integration/postgresql/PatchTest.php @@ -33,8 +33,8 @@ class PatchTest extends TestCase { Patch::byId(ThrowawayDb::TABLE, 'one', ['num_value' => 44]); $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(44, $doc->num_value, 'The updated document is not correct'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals(44, $doc->get()->num_value, 'The updated document is not correct'); } #[TestDox('By ID succeeds when no document is updated')] @@ -64,8 +64,9 @@ class PatchTest extends TestCase public function testByContainsSucceedsWhenDocumentsAreUpdated(): void { Patch::byContains(ThrowawayDb::TABLE, ['value' => 'another'], ['num_value' => 12]); - $doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'another'], TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); + $tryDoc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'another'], TestDocument::class); + $this->assertNotFalse($tryDoc->isDefined(), '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 9015e7a..772e7dc 100644 --- a/tests/integration/postgresql/RemoveFieldsTest.php +++ b/tests/integration/postgresql/RemoveFieldsTest.php @@ -32,8 +32,9 @@ class RemoveFieldsTest extends TestCase public function testByIdSucceedsWhenFieldsAreRemoved(): void { RemoveFields::byId(ThrowawayDb::TABLE, 'two', ['sub', 'value']); - $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); + $this->assertNotFalse($tryDoc->isDefined(), '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'); } @@ -56,8 +57,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertNull($doc->sub, 'Sub-document should have been null'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertNull($doc->get()->sub, 'Sub-document should have been null'); } public function testByFieldsSucceedsWhenAFieldIsNotRemoved(): void diff --git a/tests/integration/sqlite/CustomTest.php b/tests/integration/sqlite/CustomTest.php index bf83bdd..3eacc68 100644 --- a/tests/integration/sqlite/CustomTest.php +++ b/tests/integration/sqlite/CustomTest.php @@ -86,15 +86,15 @@ class CustomTest extends TestCase { $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'one'], new DocumentMapper(TestDocument::class)); - $this->assertNotNull($doc, 'There should have been a document returned'); - $this->assertEquals('one', $doc->id, 'The incorrect document was returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals('one', $doc->get()->id, 'The incorrect document was returned'); } public function testSingleSucceedsWhenARowIsNotFound(): void { $doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'eighty'], new DocumentMapper(TestDocument::class)); - $this->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), '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 d3aed8b..e69dc05 100644 --- a/tests/integration/sqlite/DocumentTest.php +++ b/tests/integration/sqlite/DocumentTest.php @@ -33,8 +33,9 @@ class DocumentTest extends TestCase public function testInsertSucceedsForArrayNoAutoId(): void { Document::insert(ThrowawayDb::TABLE, ['id' => 'turkey', 'sub' => ['foo' => 'gobble', 'bar' => 'gobble']]); - $doc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document inserted'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); + $this->assertTrue($tryDoc->isDefined(), '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'); $this->assertEquals(0, $doc->num_value, 'The numeric value was incorrect'); @@ -52,15 +53,15 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $obj = json_decode($doc['data']); + $this->assertTrue($doc->isDefined(), '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->assertNotFalse($doc, 'There should have been a document returned'); - $obj = json_decode($doc['data']); + $this->assertTrue($doc->isDefined(), '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 { Configuration::$autoId = AutoId::None; @@ -75,8 +76,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $obj = json_decode($doc['data']); + $this->assertTrue($doc->isDefined(), '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 { Configuration::$autoId = AutoId::None; @@ -91,8 +92,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertNotEmpty($doc->id, 'The ID should have been auto-generated'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertNotEmpty($doc->get()->id, 'The ID should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; } @@ -107,8 +108,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals($uuid, $doc->id, 'The ID should not have been changed'); + $this->assertTrue($doc->isDefined(), '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; } @@ -123,8 +124,9 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(6, strlen($doc->id), 'The ID should have been auto-generated and had 6 characters'); + $this->assertTrue($doc->isDefined(), '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 { Configuration::$autoId = AutoId::None; Configuration::$idStringLength = 16; @@ -139,8 +141,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('my-key', $doc->id, 'The ID should not have been changed'); + $this->assertTrue($doc->isDefined(), '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; } @@ -150,8 +152,9 @@ class DocumentTest extends TestCase public function testInsertSucceedsForObjectNoAutoId(): void { Document::insert(ThrowawayDb::TABLE, new TestDocument('turkey', sub: new SubDocument('gobble', 'gobble'))); - $doc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document inserted'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class); + $this->assertNotFalse($tryDoc->isDefined(), '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'); $this->assertEquals(0, $doc->num_value, 'The numeric value was incorrect'); @@ -169,13 +172,13 @@ class DocumentTest extends TestCase Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'taco')); $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'taco')], NumDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(1, $doc->id, 'The ID 1 should have been auto-generated'); + $this->assertTrue($doc->isDefined(), '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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(2, $doc->id, 'The ID 2 should have been auto-generated'); + $this->assertTrue($doc->isDefined(), '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; } @@ -189,8 +192,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(64, $doc->id, 'The ID 64 should have been stored'); + $this->assertTrue($doc->isDefined(), '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; } @@ -204,8 +207,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertNotEmpty($doc->id, 'The ID should have been auto-generated'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertNotEmpty($doc->get()->id, 'The ID should have been auto-generated'); } finally { Configuration::$autoId = AutoId::None; } @@ -220,8 +223,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals($uuid, $doc->id, 'The ID should not have been changed'); + $this->assertTrue($doc->isDefined(), '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; } @@ -236,8 +239,9 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(40, strlen($doc->id), 'The ID should have been auto-generated and had 40 characters'); + $this->assertTrue($doc->isDefined(), '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 { Configuration::$autoId = AutoId::None; Configuration::$idStringLength = 16; @@ -252,8 +256,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('my-key', $doc->id, 'The ID should not have been changed'); + $this->assertTrue($doc->isDefined(), '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; } @@ -269,14 +273,15 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); } public function testSaveSucceedsWhenADocumentIsUpdated(): void { Document::save(ThrowawayDb::TABLE, new TestDocument('two', num_value: 44)); - $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); + $this->assertTrue($tryDoc->isDefined(), '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'); } @@ -284,8 +289,9 @@ class DocumentTest extends TestCase public function testUpdateSucceedsWhenReplacingADocument(): void { Document::update(ThrowawayDb::TABLE, 'one', new TestDocument('one', 'howdy', 8, new SubDocument('y', 'z'))); - $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); + $this->assertTrue($tryDoc->isDefined(), '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'); $this->assertNotNull($doc->sub, 'The sub-document should not have been null'); @@ -297,6 +303,6 @@ class DocumentTest extends TestCase { Document::update(ThrowawayDb::TABLE, 'two-hundred', new TestDocument('200')); $doc = Find::byId(ThrowawayDb::TABLE, 'two-hundred', TestDocument::class); - $this->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); } } diff --git a/tests/integration/sqlite/FindTest.php b/tests/integration/sqlite/FindTest.php index c1677a0..661f902 100644 --- a/tests/integration/sqlite/FindTest.php +++ b/tests/integration/sqlite/FindTest.php @@ -49,8 +49,8 @@ class FindTest extends TestCase public function testByIdSucceedsWhenADocumentIsFound(): void { $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('two', $doc->id, 'An incorrect document was returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals('two', $doc->get()->id, 'An incorrect document was returned'); } #[TestDox('By ID succeeds when a document is found with numeric ID')] @@ -58,15 +58,15 @@ class FindTest extends TestCase { Document::insert(ThrowawayDb::TABLE, ['id' => 18, 'value' => 'howdy']); $doc = Find::byId(ThrowawayDb::TABLE, 18, TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('18', $doc->id, 'An incorrect document was returned'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals('18', $doc->get()->id, 'An incorrect document was returned'); } #[TestDox('By ID succeeds when a document is not found')] public function testByIdSucceedsWhenADocumentIsNotFound(): void { $doc = Find::byId(ThrowawayDb::TABLE, 'seventy-five', TestDocument::class); - $this->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), 'There should not have been a document returned'); } public function testByFieldsSucceedsWhenDocumentsAreFound(): void @@ -101,21 +101,21 @@ class FindTest extends TestCase public function testFirstByFieldsSucceedsWhenADocumentIsFound(): void { $doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::EQ('value', 'another')], TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals('two', $doc->id, 'The incorrect document was returned'); + $this->assertTrue($doc->isDefined(), '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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertContains($doc->id, ['two', 'four'], 'An incorrect document was returned'); + $this->assertTrue($doc->isDefined(), '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->assertFalse($doc, 'There should not have been a document returned'); + $this->assertTrue($doc->isEmpty(), '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 5598753..c87723c 100644 --- a/tests/integration/sqlite/PatchTest.php +++ b/tests/integration/sqlite/PatchTest.php @@ -33,8 +33,8 @@ class PatchTest extends TestCase { Patch::byId(ThrowawayDb::TABLE, 'one', ['num_value' => 44]); $doc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertEquals(44, $doc->num_value, 'The updated document is not correct'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertEquals(44, $doc->get()->num_value, 'The updated document is not correct'); } #[TestDox('By ID succeeds when no document is updated')] diff --git a/tests/integration/sqlite/RemoveFieldsTest.php b/tests/integration/sqlite/RemoveFieldsTest.php index d656ded..9d0bd08 100644 --- a/tests/integration/sqlite/RemoveFieldsTest.php +++ b/tests/integration/sqlite/RemoveFieldsTest.php @@ -32,8 +32,9 @@ class RemoveFieldsTest extends TestCase public function testByIdSucceedsWhenFieldsAreRemoved(): void { RemoveFields::byId(ThrowawayDb::TABLE, 'two', ['sub', 'value']); - $doc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); - $this->assertNotFalse($doc, 'There should have been a document returned'); + $tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class); + $this->assertTrue($tryDoc->isDefined(), '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'); } @@ -56,8 +57,8 @@ 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->assertNotFalse($doc, 'There should have been a document returned'); - $this->assertNull($doc->sub, 'Sub-document should have been null'); + $this->assertTrue($doc->isDefined(), 'There should have been a document returned'); + $this->assertNull($doc->get()->sub, 'Sub-document should have been null'); } public function testByFieldsSucceedsWhenAFieldIsNotRemoved(): void