Compare commits
24 Commits
v1.0.0-alp
...
v1.0.0
| Author | SHA1 | Date | |
|---|---|---|---|
| 3b2d2ced98 | |||
| 529e823955 | |||
| df436c9ef4 | |||
| d067f8983f | |||
| 9e0e663811 | |||
| 039283224a | |||
| 407441e857 | |||
| 3d2bc2a904 | |||
| 4d764cbb3f | |||
| 57d8f9ddc1 | |||
| 37fa200fa7 | |||
| adbe4e6614 | |||
| 0659de3f99 | |||
| d8330d828a | |||
| 1a37b009ea | |||
| 5201e564ca | |||
| 478684621c | |||
| 50854275a8 | |||
| 0c9490e394 | |||
| 124426fa12 | |||
| 330e272187 | |||
| 1f1f06679f | |||
| 2902059cd4 | |||
| 17748354c4 |
8
.gitattributes
vendored
8
.gitattributes
vendored
@@ -1,4 +1,4 @@
|
||||
.gitignore export-ignore
|
||||
.gitattributes export-ignore
|
||||
composer.lock export-ignore
|
||||
tests/**/* export-ignore
|
||||
/.gitignore export-ignore
|
||||
/.gitattributes export-ignore
|
||||
/composer.lock export-ignore
|
||||
/tests/**/* export-ignore
|
||||
|
||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,2 +1,3 @@
|
||||
.idea
|
||||
vendor
|
||||
*-tests.txt
|
||||
|
||||
27
README.md
27
README.md
@@ -1,11 +1,32 @@
|
||||
# PDODocument
|
||||
|
||||
This library allows SQLite (and, by v1.0.0-beta1, PostgreSQL) to be treated as a document database. It is a PHP implementation of the .NET [BitBadger.Documents](https://git.bitbadger.solutions/bit-badger/BitBadger.Documents) library.
|
||||
This library allows SQLite and PostgreSQL to be treated as document databases. It is a PHP implementation of the .NET [BitBadger.Documents](https://git.bitbadger.solutions/bit-badger/BitBadger.Documents) library.
|
||||
|
||||
## Add via Composer
|
||||
|
||||
`compose require bit-badger/pdo-document`
|
||||
[](https://packagist.org/packages/bit-badger/pdo-document)
|
||||
|
||||
`composer require bit-badger/pdo-document`
|
||||
|
||||
## Configuration
|
||||
|
||||
### Connection Details
|
||||
|
||||
The [PDO data source name](https://www.php.net/manual/en/pdo.construct.php#refsect1-pdo.construct-parameters) must be provided via `Configuration::useDSN()`. `Configuration` also has `$username`, `$password`, and `$options` variables that will be used to construct the PDO object it will use for data access.
|
||||
|
||||
### Document Identifiers
|
||||
|
||||
Each document must have a unique identifier. By default, the library assumes that this is a property or array key named `id`, but this can be controlled by setting `Configuration::$idField`. Once documents exist, this should not be changed.
|
||||
|
||||
IDs can be generated automatically on insert. The `AutoId` enumeration has 4 values:
|
||||
|
||||
- `AutoId::None` is the default; no IDs will be generated
|
||||
- `AutoId::Number` will assign max-ID-plus-one to documents with an ID of 0
|
||||
- `AutoId::UUID` will generate a v4 <abbr title="Universally Unique Identifier">UUID</abbr> for documents with an empty `string` ID
|
||||
- `AutoId::RandomString` will generate a string of letters and numbers for documents with an empty `string` ID; `Configuration::$idStringLength` controls the length of the generated string, and defaults to 16 characters
|
||||
|
||||
In all generated scenarios, if the ID value is not 0 or blank, that ID will be used instead of a generated one.
|
||||
|
||||
## Usage
|
||||
|
||||
Documentation for this library is not complete; however, its structure is very similar to the .NET version, so [its documentation will help](https://bitbadger.solutions/open-source/relational-documents/basic-usage.html) until its project specific documentation is developed. Things like `Count.All()` become `Count::all`, and all the `byField` operations are named `byFields` and take an array of fields.
|
||||
Full documentation [is available on the project site](https://bitbadger.solutions/open-source/pdo-document/).
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
{
|
||||
"name": "bit-badger/pdo-document",
|
||||
"description": "Treat SQLite (and soon PostgreSQL) as a document store",
|
||||
"keywords": ["database", "document", "sqlite", "pdo"],
|
||||
"description": "Treat SQLite and PostgreSQL as document stores",
|
||||
"keywords": ["database", "document", "sqlite", "pdo", "postgresql"],
|
||||
"license": "MIT",
|
||||
"authors": [
|
||||
{
|
||||
@@ -14,15 +14,19 @@
|
||||
"support": {
|
||||
"email": "daniel@bitbadger.solutions",
|
||||
"source": "https://git.bitbadger.solutions/bit-badger/pdo-document",
|
||||
"rss": "https://git.bitbadger.solutions/bit-badger/pdo-document.rss"
|
||||
"rss": "https://git.bitbadger.solutions/bit-badger/pdo-document.rss",
|
||||
"docs": "https://bitbadger.solutions/open-source/pdo-document/"
|
||||
},
|
||||
"require": {
|
||||
"php": ">=8.3",
|
||||
"php": "8.2 - 8.3",
|
||||
"bit-badger/inspired-by-fsharp": "^1",
|
||||
"netresearch/jsonmapper": "^4",
|
||||
"ext-pdo": "*"
|
||||
},
|
||||
"require-dev": {
|
||||
"phpunit/phpunit": "^11"
|
||||
"square/pjson": "^0.5.0",
|
||||
"phpstan/phpstan": "^1.12",
|
||||
"pestphp/pest": "^3.2"
|
||||
},
|
||||
"autoload": {
|
||||
"psr-4": {
|
||||
@@ -33,9 +37,18 @@
|
||||
},
|
||||
"autoload-dev": {
|
||||
"psr-4": {
|
||||
"Test\\Unit\\": "./tests/unit",
|
||||
"Test\\Integration\\": "./tests/integration",
|
||||
"Test\\Integration\\SQLite\\": "./tests/integration/sqlite"
|
||||
"Test\\": "./tests",
|
||||
"Test\\Integration\\": "./tests/Integration",
|
||||
"Test\\Integration\\PostgreSQL\\": "./tests/Integration/PostgreSQL",
|
||||
"Test\\Integration\\SQLite\\": "./tests/Integration/SQLite"
|
||||
}
|
||||
},
|
||||
"archive": {
|
||||
"exclude": [ "/tests", "/.gitattributes", "/.gitignore", "/.git", "/composer.lock" ]
|
||||
},
|
||||
"config": {
|
||||
"allow-plugins": {
|
||||
"pestphp/pest-plugin": true
|
||||
}
|
||||
}
|
||||
}
|
||||
2639
composer.lock
generated
2639
composer.lock
generated
File diff suppressed because it is too large
Load Diff
18
phpunit.xml
Normal file
18
phpunit.xml
Normal file
@@ -0,0 +1,18 @@
|
||||
<?xml version="1.0" encoding="UTF-8"?>
|
||||
<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
|
||||
xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/10.3/phpunit.xsd"
|
||||
bootstrap="vendor/autoload.php"
|
||||
colors="true"
|
||||
>
|
||||
<testsuites>
|
||||
<testsuite name="Test Suite">
|
||||
<directory suffix="Test.php">./tests</directory>
|
||||
</testsuite>
|
||||
</testsuites>
|
||||
<source>
|
||||
<include>
|
||||
<directory suffix=".php">./app</directory>
|
||||
<directory suffix=".php">./src</directory>
|
||||
</include>
|
||||
</source>
|
||||
</phpunit>
|
||||
58
src/AutoId.php
Normal file
58
src/AutoId.php
Normal file
@@ -0,0 +1,58 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
use Random\RandomException;
|
||||
|
||||
/**
|
||||
* How automatic ID generation should be performed
|
||||
*/
|
||||
enum AutoId
|
||||
{
|
||||
/** Do not automatically generate IDs */
|
||||
case None;
|
||||
|
||||
/** New documents with a 0 ID should receive max ID plus one */
|
||||
case Number;
|
||||
|
||||
/** New documents with a blank ID should receive a v4 UUID (Universally Unique Identifier) */
|
||||
case UUID;
|
||||
|
||||
/** New documents with a blank ID should receive a random string (set `Configuration::$idStringLength`) */
|
||||
case RandomString;
|
||||
|
||||
/**
|
||||
* Generate a v4 UUID
|
||||
*
|
||||
* @return string The v4 UUID
|
||||
* @throws RandomException If an appropriate source of randomness cannot be found
|
||||
*/
|
||||
public static function generateUUID(): string
|
||||
{
|
||||
// hat tip: https://stackoverflow.com/a/15875555/276707
|
||||
$bytes = random_bytes(16);
|
||||
|
||||
$bytes[6] = chr(ord($bytes[6]) & 0x0f | 0x40); // set version to 0100
|
||||
$bytes[8] = chr(ord($bytes[8]) & 0x3f | 0x80); // set bits 6-7 to 10
|
||||
|
||||
return vsprintf('%s%s-%s-%s-%s-%s%s%s', str_split(bin2hex($bytes), 4));
|
||||
}
|
||||
|
||||
/**
|
||||
* Generate a random string ID
|
||||
*
|
||||
* @param int|null $length The length of string to generate (optional; defaults to configured ID string length)
|
||||
* @return string A string filled with the hexadecimal representation of random bytes
|
||||
* @throws RandomException If an appropriate source of randomness cannot be found
|
||||
*/
|
||||
public static function generateRandom(?int $length = null): string
|
||||
{
|
||||
return bin2hex(random_bytes(($length ?? Configuration::$idStringLength) / 2));
|
||||
}
|
||||
}
|
||||
@@ -1,7 +1,15 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
use BitBadger\InspiredByFSharp\Option;
|
||||
use Exception;
|
||||
use PDO;
|
||||
|
||||
/**
|
||||
@@ -12,8 +20,13 @@ class Configuration
|
||||
/** @var string The name of the ID field used in the database (will be treated as the primary key) */
|
||||
public static string $idField = 'id';
|
||||
|
||||
/** @var string The data source name (DSN) of the connection string */
|
||||
public static string $pdoDSN = '';
|
||||
/** @var AutoId The automatic ID generation process to use */
|
||||
public static AutoId $autoId = AutoId::None;
|
||||
|
||||
/**
|
||||
* @var int The number of characters a string generated by `AutoId::RandomString` will have (must be an even number)
|
||||
*/
|
||||
public static int $idStringLength = 16;
|
||||
|
||||
/** @var string|null The username to use to establish a data connection (use env PDO_DOC_USERNAME if possible) */
|
||||
public static ?string $username = null;
|
||||
@@ -21,47 +34,79 @@ class Configuration
|
||||
/** @var string|null The password to use to establish a data connection (use env PDO_DOC_PASSWORD if possible) */
|
||||
public static ?string $password = null;
|
||||
|
||||
/** @var array|null Options to use for connections (driver-specific) */
|
||||
/** @var mixed[]|null Options to use for connections (driver-specific) */
|
||||
public static ?array $options = null;
|
||||
|
||||
/** @var Mode|null The mode in which the library is operating (filled after first connection if not configured) */
|
||||
public static ?Mode $mode = null;
|
||||
/** @var Option<Mode> The mode in which the library is operating */
|
||||
public static Option $mode;
|
||||
|
||||
/** @var Option<string> The data source name (DSN) of the connection string */
|
||||
private static Option $pdoDSN;
|
||||
|
||||
/** @var PDO|null The PDO instance to use for database commands */
|
||||
private static ?PDO $_pdo = null;
|
||||
private static ?PDO $pdo = null;
|
||||
|
||||
/**
|
||||
* Use a Data Source Name (DSN)
|
||||
*
|
||||
* @param string $dsn The data source name to use (driver:[parameters])
|
||||
* @throws DocumentException If a DSN does not start with `pgsql:` or `sqlite:`
|
||||
*/
|
||||
public static function useDSN(string $dsn): void
|
||||
{
|
||||
if (empty($dsn)) {
|
||||
self::$mode = self::$pdoDSN = Option::None();
|
||||
} else {
|
||||
self::$mode = Option::Some(Mode::deriveFromDSN($dsn));
|
||||
self::$pdoDSN = Option::Some($dsn);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve a new connection to the database
|
||||
*
|
||||
* @return PDO A new connection to the SQLite database with foreign key support enabled
|
||||
* @throws DocumentException If this is called before a connection string is set
|
||||
* @throws Exception If this is called before a connection string is set
|
||||
*/
|
||||
public static function dbConn(): PDO
|
||||
{
|
||||
if (is_null(self::$_pdo)) {
|
||||
if (empty(self::$pdoDSN)) {
|
||||
throw new DocumentException('Please provide a data source name (DSN) before attempting data access');
|
||||
}
|
||||
self::$_pdo = new PDO(self::$pdoDSN, $_ENV['PDO_DOC_USERNAME'] ?? self::$username,
|
||||
if (is_null(self::$pdo)) {
|
||||
$dsn = self::$pdoDSN->getOrThrow(fn()
|
||||
=> new DocumentException('Please provide a data source name (DSN) before attempting data access'));
|
||||
self::$pdo = new PDO($dsn, $_ENV['PDO_DOC_USERNAME'] ?? self::$username,
|
||||
$_ENV['PDO_DOC_PASSWORD'] ?? self::$password, self::$options);
|
||||
|
||||
if (is_null(self::$mode)) {
|
||||
$driver = self::$_pdo->getAttribute(PDO::ATTR_DRIVER_NAME);
|
||||
self::$mode = match ($driver) {
|
||||
'pgsql' => Mode::PgSQL,
|
||||
'sqlite' => Mode::SQLite,
|
||||
default => throw new DocumentException(
|
||||
"Unsupported driver $driver: this library currently supports PostgreSQL and SQLite")
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
return self::$_pdo;
|
||||
return self::$pdo;
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve the mode for the current database connection
|
||||
*
|
||||
* @return Mode The mode for the current database connection
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
public static function mode(?string $process = null): Mode
|
||||
{
|
||||
return self::$mode->getOrThrow(fn()
|
||||
=> new DocumentException('Database mode not set' . (is_null($process) ? '' : "; cannot $process")));
|
||||
}
|
||||
|
||||
/**
|
||||
* You probably don't mean to be calling this; it is here for testing only
|
||||
*
|
||||
* @param Mode|null $mode The mode to set
|
||||
*/
|
||||
public static function overrideMode(?Mode $mode): void
|
||||
{
|
||||
self::$mode = Option::of($mode);
|
||||
}
|
||||
|
||||
/**
|
||||
* Clear the current PDO instance
|
||||
*/
|
||||
public static function resetPDO(): void
|
||||
{
|
||||
self::$_pdo = null;
|
||||
self::$pdo = null;
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -25,15 +31,42 @@ class Count
|
||||
* Count matching documents using a comparison on JSON fields
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be counted
|
||||
* @param array|Field[] $fields The field comparison to match
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @return int The count of documents matching the field comparison
|
||||
* @throws DocumentException If one is encountered
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): int
|
||||
public static function byFields(string $tableName, array $fields, ?FieldMatch $match = null): int
|
||||
{
|
||||
$namedFields = Parameters::nameFields($fields);
|
||||
return Custom::scalar(Query\Count::byFields($tableName, $namedFields, $conjunction),
|
||||
Parameters::addFields($namedFields, []), new CountMapper());
|
||||
Parameters::nameFields($fields);
|
||||
return Custom::scalar(Query\Count::byFields($tableName, $fields, $match), Parameters::addFields($fields, []),
|
||||
new CountMapper());
|
||||
}
|
||||
|
||||
/**
|
||||
* Count matching documents using a JSON containment query (`@>`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be counted
|
||||
* @param mixed[]|object $criteria The criteria for the JSON containment query
|
||||
* @return int The number of documents matching the JSON containment query
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byContains(string $tableName, array|object $criteria): int
|
||||
{
|
||||
return Custom::scalar(Query\Count::byContains($tableName), Parameters::json(':criteria', $criteria),
|
||||
new CountMapper());
|
||||
}
|
||||
|
||||
/**
|
||||
* Count matching documents using a JSON Path match query (`@?`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be counted
|
||||
* @param string $path The JSON Path match string
|
||||
* @return int The number of documents matching the given JSON Path criteria
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byJsonPath(string $tableName, string $path): int
|
||||
{
|
||||
return Custom::scalar(Query\Count::byJsonPath($tableName), [':path' => $path], new CountMapper());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,14 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
use BitBadger\InspiredByFSharp\Option;
|
||||
use BitBadger\PDODocument\Mapper\Mapper;
|
||||
use PDO;
|
||||
use PDOException;
|
||||
@@ -16,7 +23,7 @@ class Custom
|
||||
* Prepare a query for execution and run it
|
||||
*
|
||||
* @param string $query The query to be run
|
||||
* @param array $parameters The parameters for the query
|
||||
* @param array<string, mixed> $parameters The parameters for the query
|
||||
* @return PDOStatement The result of executing the query
|
||||
* @throws DocumentException If the query execution is unsuccessful
|
||||
*/
|
||||
@@ -38,7 +45,7 @@ class Custom
|
||||
is_bool($value) => PDO::PARAM_BOOL,
|
||||
is_int($value) => PDO::PARAM_INT,
|
||||
is_null($value) => PDO::PARAM_NULL,
|
||||
default => PDO::PARAM_STR
|
||||
default => PDO::PARAM_STR,
|
||||
};
|
||||
$stmt->bindValue($key, $value, $dataType);
|
||||
}
|
||||
@@ -60,7 +67,7 @@ class Custom
|
||||
*
|
||||
* @template TDoc The domain type of the document to retrieve
|
||||
* @param string $query The query to be executed
|
||||
* @param array $parameters Parameters to use in executing the query
|
||||
* @param array<string, mixed> $parameters Parameters to use in executing the query
|
||||
* @param Mapper<TDoc> $mapper Mapper to deserialize the result
|
||||
* @return DocumentList<TDoc> The items matching the query
|
||||
* @throws DocumentException If any is encountered
|
||||
@@ -75,7 +82,7 @@ class Custom
|
||||
*
|
||||
* @template TDoc The domain type of the document to retrieve
|
||||
* @param string $query The query to be executed
|
||||
* @param array $parameters Parameters to use in executing the query
|
||||
* @param array<string, mixed> $parameters Parameters to use in executing the query
|
||||
* @param Mapper<TDoc> $mapper Mapper to deserialize the result
|
||||
* @return TDoc[] The items matching the query
|
||||
* @throws DocumentException If any is encountered
|
||||
@@ -90,16 +97,16 @@ class Custom
|
||||
*
|
||||
* @template TDoc The domain type of the document to retrieve
|
||||
* @param string $query The query to be executed (will have "LIMIT 1" appended)
|
||||
* @param array $parameters Parameters to use in executing the query
|
||||
* @param array<string, mixed> $parameters Parameters to use in executing the query
|
||||
* @param Mapper<TDoc> $mapper Mapper to deserialize the result
|
||||
* @return false|TDoc The item if it is found, false if not
|
||||
* @return Option<TDoc> 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)) ? Option::Some($mapper->map($first)) : Option::None();
|
||||
} finally {
|
||||
$stmt = null;
|
||||
}
|
||||
@@ -109,7 +116,7 @@ class Custom
|
||||
* Execute a query that does not return a value
|
||||
*
|
||||
* @param string $query The query to execute
|
||||
* @param array $parameters Parameters to use in executing the query
|
||||
* @param array<string, mixed> $parameters Parameters to use in executing the query
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function nonQuery(string $query, array $parameters): void
|
||||
@@ -126,7 +133,7 @@ class Custom
|
||||
*
|
||||
* @template T The scalar type to return
|
||||
* @param string $query The query to retrieve the value
|
||||
* @param array $parameters Parameters to use in executing the query
|
||||
* @param array<string, mixed> $parameters Parameters to use in executing the query
|
||||
* @param Mapper<T> $mapper The mapper to obtain the result
|
||||
* @return mixed|false|T The scalar value if found, false if not
|
||||
* @throws DocumentException If any is encountered
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -24,11 +30,23 @@ class Definition
|
||||
*
|
||||
* @param string $tableName The name of the table which should be indexed
|
||||
* @param string $indexName The name of the index
|
||||
* @param array $fields Fields which should be a part of this index
|
||||
* @param string[] $fields Fields which should be a part of this index
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function ensureFieldIndex(string $tableName, string $indexName, array $fields): void
|
||||
{
|
||||
Custom::nonQuery(Query\Definition::ensureIndexOn($tableName, $indexName, $fields), []);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a full-document index on a table (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table on which the document index should be created
|
||||
* @param DocumentIndex $indexType The type of document index to create
|
||||
* @throws DocumentException If the database mode is not PostgreSQL or if an error occurs creating the index
|
||||
*/
|
||||
public static function ensureDocumentIndex(string $tableName, DocumentIndex $indexType): void
|
||||
{
|
||||
Custom::nonQuery(Query\Definition::ensureDocumentIndexOn($tableName, $indexType), []);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -16,21 +22,44 @@ class Delete
|
||||
*/
|
||||
public static function byId(string $tableName, mixed $docId): void
|
||||
{
|
||||
Custom::nonQuery(Query\Delete::byId($tableName), Parameters::id($docId));
|
||||
Custom::nonQuery(Query\Delete::byId($tableName, $docId), Parameters::id($docId));
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete documents by matching a comparison on JSON fields
|
||||
*
|
||||
* @param string $tableName The table from which documents should be deleted
|
||||
* @param array|Field[] $fields The field comparison to match
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): void
|
||||
public static function byFields(string $tableName, array $fields, ?FieldMatch $match = null): void
|
||||
{
|
||||
$namedFields = Parameters::nameFields($fields);
|
||||
Custom::nonQuery(Query\Delete::byFields($tableName, $namedFields, $conjunction),
|
||||
Parameters::addFields($namedFields, []));
|
||||
Parameters::nameFields($fields);
|
||||
Custom::nonQuery(Query\Delete::byFields($tableName, $fields, $match), Parameters::addFields($fields, []));
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete documents matching a JSON containment query (`@>`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The table from which documents should be deleted
|
||||
* @param mixed[]|object $criteria The JSON containment query values
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byContains(string $tableName, array|object $criteria): void
|
||||
{
|
||||
Custom::nonQuery(Query\Delete::byContains($tableName), Parameters::json(':criteria', $criteria));
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete documents matching a JSON Path match query (`@?`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The table from which documents should be deleted
|
||||
* @param string $path The JSON Path match string
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byJsonPath(string $tableName, string $path): void
|
||||
{
|
||||
Custom::nonQuery(Query\Delete::byJsonPath($tableName), [':path' => $path]);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -11,19 +17,37 @@ class Document
|
||||
* Insert a new document
|
||||
*
|
||||
* @param string $tableName The name of the table into which the document should be inserted
|
||||
* @param array|object $document The document to be inserted
|
||||
* @param mixed[]|object $document The document to be inserted
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function insert(string $tableName, array|object $document): void
|
||||
{
|
||||
Custom::nonQuery(Query::insert($tableName), Parameters::json(':data', $document));
|
||||
$doInsert = fn() => Custom::nonQuery(Query::insert($tableName), Parameters::json(':data', $document));
|
||||
|
||||
if (Configuration::$autoId === AutoId::None) {
|
||||
$doInsert();
|
||||
return;
|
||||
}
|
||||
|
||||
$id = Configuration::$idField;
|
||||
$idProvided =
|
||||
(is_array( $document) && is_int( $document[$id]) && $document[$id] <> 0)
|
||||
|| (is_array( $document) && is_string($document[$id]) && $document[$id] <> '')
|
||||
|| (is_object($document) && is_int( $document->{$id}) && $document->{$id} <> 0)
|
||||
|| (is_object($document) && is_string($document->{$id}) && $document->{$id} <> '');
|
||||
|
||||
if ($idProvided) {
|
||||
$doInsert();
|
||||
} else {
|
||||
Custom::nonQuery(Query::insert($tableName, Configuration::$autoId), Parameters::json(':data', $document));
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Save a document, inserting it if it does not exist and updating it if it does (AKA "upsert")
|
||||
*
|
||||
* @param string $tableName The name of the table to which the document should be saved
|
||||
* @param array|object $document The document to be saved
|
||||
* @param mixed[]|object $document The document to be saved
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function save(string $tableName, array|object $document): void
|
||||
@@ -36,7 +60,7 @@ class Document
|
||||
*
|
||||
* @param string $tableName The table in which the document should be updated
|
||||
* @param mixed $docId The ID of the document to be updated
|
||||
* @param array|object $document The document to be updated
|
||||
* @param mixed[]|object $document The document to be updated
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function update(string $tableName, mixed $docId, array|object $document): void
|
||||
|
||||
@@ -1,14 +1,21 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
use Exception;
|
||||
use Stringable;
|
||||
use Throwable;
|
||||
|
||||
/**
|
||||
* Exceptions occurring during document processing
|
||||
*/
|
||||
class DocumentException extends Exception
|
||||
class DocumentException extends Exception implements Stringable
|
||||
{
|
||||
/**
|
||||
* Constructor
|
||||
|
||||
21
src/DocumentIndex.php
Normal file
21
src/DocumentIndex.php
Normal file
@@ -0,0 +1,21 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
/**
|
||||
* The type of index to generate for the document
|
||||
*/
|
||||
enum DocumentIndex
|
||||
{
|
||||
/** A GIN index with standard operations (all operators supported) */
|
||||
case Full;
|
||||
|
||||
/** A GIN index with JSONPath operations (optimized for @>, @?, @@ operators) */
|
||||
case Optimized;
|
||||
}
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -15,8 +21,11 @@ use PDOStatement;
|
||||
*/
|
||||
class DocumentList
|
||||
{
|
||||
/** @var TDoc|null $_first The first item from the results */
|
||||
private mixed $_first = null;
|
||||
/** @var TDoc|null $first The first item from the results */
|
||||
private mixed $first = null;
|
||||
|
||||
/** @var bool $isConsumed This is set to true once the generator has been exhausted */
|
||||
private bool $isConsumed = false;
|
||||
|
||||
/**
|
||||
* Constructor
|
||||
@@ -26,41 +35,13 @@ class DocumentList
|
||||
*/
|
||||
private function __construct(private ?PDOStatement &$result, private readonly Mapper $mapper)
|
||||
{
|
||||
if (!is_null($this->result)) {
|
||||
if ($row = $this->result->fetch(PDO::FETCH_ASSOC)) {
|
||||
$this->_first = $this->mapper->map($row);
|
||||
$this->first = $this->mapper->map($row);
|
||||
} else {
|
||||
$this->result = null;
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct a new document list
|
||||
*
|
||||
* @param string $query The query to run to retrieve results
|
||||
* @param array $parameters An associative array of parameters for the query
|
||||
* @param Mapper<TDoc> $mapper A mapper to deserialize JSON documents
|
||||
* @return static The document list instance
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function create(string $query, array $parameters, Mapper $mapper): static
|
||||
{
|
||||
$stmt = &Custom::runQuery($query, $parameters);
|
||||
return new static($stmt, $mapper);
|
||||
}
|
||||
|
||||
/**
|
||||
* The items from the query result
|
||||
*
|
||||
* @return Generator<TDoc> The items from the document list
|
||||
*/
|
||||
public function items(): Generator
|
||||
{
|
||||
if (!$this->result) return;
|
||||
yield $this->_first;
|
||||
while ($row = $this->result->fetch(PDO::FETCH_ASSOC)) {
|
||||
yield $this->mapper->map($row);
|
||||
}
|
||||
$this->result = null;
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -73,6 +54,80 @@ class DocumentList
|
||||
return !is_null($this->result);
|
||||
}
|
||||
|
||||
/**
|
||||
* The items from the query result
|
||||
*
|
||||
* @return Generator<TDoc> The items from the document list
|
||||
* @throws DocumentException If this is called once the generator has been consumed
|
||||
*/
|
||||
public function items(): Generator
|
||||
{
|
||||
if (!$this->result) {
|
||||
if ($this->isConsumed) {
|
||||
throw new DocumentException('Cannot call items() multiple times');
|
||||
}
|
||||
$this->isConsumed = true;
|
||||
return;
|
||||
}
|
||||
if (!$this->first) {
|
||||
$this->isConsumed = true;
|
||||
$this->result = null;
|
||||
return;
|
||||
}
|
||||
yield $this->first;
|
||||
while ($row = $this->result->fetch(PDO::FETCH_ASSOC)) {
|
||||
yield $this->mapper->map($row);
|
||||
}
|
||||
$this->isConsumed = true;
|
||||
$this->result = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Map items by consuming the generator
|
||||
*
|
||||
* @template U The type to which each item should be mapped
|
||||
* @param callable(TDoc): U $map The mapping function
|
||||
* @return Generator<U> The result of the mapping function
|
||||
* @throws DocumentException If this is called once the generator has been consumed
|
||||
*/
|
||||
public function map(callable $map): Generator
|
||||
{
|
||||
foreach ($this->items() as $item) {
|
||||
yield $map($item);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Iterate the generator, running the given function for each item
|
||||
*
|
||||
* @param callable(TDoc): void $f The function to run for each item
|
||||
* @throws DocumentException If this is called once the generator has been consumed
|
||||
*/
|
||||
public function iter(callable $f): void
|
||||
{
|
||||
foreach ($this->items() as $item) {
|
||||
$f($item);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* 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
|
||||
*/
|
||||
@@ -80,4 +135,19 @@ class DocumentList
|
||||
{
|
||||
if (!is_null($this->result)) $this->result = null;
|
||||
}
|
||||
|
||||
/**
|
||||
* Construct a new document list
|
||||
*
|
||||
* @param string $query The query to run to retrieve results
|
||||
* @param array<string, mixed> $parameters An associative array of parameters for the query
|
||||
* @param Mapper<TDoc> $mapper A mapper to deserialize JSON documents
|
||||
* @return self<TDoc> The document list instance
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function create(string $query, array $parameters, Mapper $mapper): self
|
||||
{
|
||||
$stmt = &Custom::runQuery($query, $parameters);
|
||||
return new self($stmt, $mapper);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -19,7 +25,7 @@ class Exists
|
||||
*/
|
||||
public static function byId(string $tableName, mixed $docId): bool
|
||||
{
|
||||
return Custom::scalar(Query\Exists::byId($tableName), Parameters::id($docId), new ExistsMapper());
|
||||
return Custom::scalar(Query\Exists::byId($tableName, $docId), Parameters::id($docId), new ExistsMapper());
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -27,14 +33,41 @@ class Exists
|
||||
*
|
||||
* @param string $tableName The name of the table in which document existence should be determined
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @return bool True if any documents match the field comparison, false if not
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): bool
|
||||
public static function byFields(string $tableName, array $fields, ?FieldMatch $match = null): bool
|
||||
{
|
||||
$namedFields = Parameters::nameFields($fields);
|
||||
return Custom::scalar(Query\Exists::byFields($tableName, $namedFields, $conjunction),
|
||||
Parameters::addFields($namedFields, []), new ExistsMapper());
|
||||
Parameters::nameFields($fields);
|
||||
return Custom::scalar(Query\Exists::byFields($tableName, $fields, $match), Parameters::addFields($fields, []),
|
||||
new ExistsMapper());
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if documents exist by a JSON containment query (`@>`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which document existence should be determined
|
||||
* @param mixed[]|object $criteria The criteria for the JSON containment query
|
||||
* @return bool True if any documents match the JSON containment query, false if not
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byContains(string $tableName, array|object $criteria): bool
|
||||
{
|
||||
return Custom::scalar(Query\Exists::byContains($tableName), Parameters::json(':criteria', $criteria),
|
||||
new ExistsMapper());
|
||||
}
|
||||
|
||||
/**
|
||||
* Determine if documents exist by a JSON Path match query (`@?`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which document existence should be determined
|
||||
* @param string $path The JSON Path match string
|
||||
* @return bool True if any documents match the JSON Path string, false if not
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byJsonPath(string $tableName, string $path): bool
|
||||
{
|
||||
return Custom::scalar(Query\Exists::byJsonPath($tableName), [':path' => $path], new ExistsMapper());
|
||||
}
|
||||
}
|
||||
|
||||
318
src/Field.php
318
src/Field.php
@@ -1,7 +1,15 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Criteria for a field WHERE clause
|
||||
*/
|
||||
@@ -19,57 +27,110 @@ class Field
|
||||
* @param string $paramName The name of the parameter to which this should be bound
|
||||
* @param string $qualifier A table qualifier for the `data` column
|
||||
*/
|
||||
public function __construct(public string $fieldName = '', public Op $op = Op::EQ, public mixed $value = '',
|
||||
public function __construct(public string $fieldName = '', public Op $op = Op::Equal, public mixed $value = '',
|
||||
public string $paramName = '', public string $qualifier = '') { }
|
||||
|
||||
/**
|
||||
* Append the parameter name and value to the given associative array
|
||||
*
|
||||
* @param array $existing The existing parameters
|
||||
* @return array The given parameter array with this field's name and value appended
|
||||
* @param array<string, mixed> $existing The existing parameters
|
||||
* @return array<string, mixed> The given parameter array with this field's name and value(s) appended
|
||||
*/
|
||||
public function appendParameter(array $existing): array
|
||||
{
|
||||
switch ($this->op) {
|
||||
case Op::EX:
|
||||
case Op::NEX:
|
||||
case Op::Exists:
|
||||
case Op::NotExists:
|
||||
break;
|
||||
case Op::BT:
|
||||
case Op::Between:
|
||||
$existing["{$this->paramName}min"] = $this->value[0];
|
||||
$existing["{$this->paramName}max"] = $this->value[1];
|
||||
break;
|
||||
case Op::In:
|
||||
for ($idx = 0; $idx < count($this->value); $idx++) {
|
||||
$existing["{$this->paramName}_$idx"] = $this->value[$idx];
|
||||
}
|
||||
break;
|
||||
case Op::InArray:
|
||||
$mkString = Configuration::mode("Append parameters for InArray condition") === Mode::PgSQL;
|
||||
$values = $this->value['values'];
|
||||
for ($idx = 0; $idx < count($values); $idx++) {
|
||||
$existing["{$this->paramName}_$idx"] = $mkString ? "$values[$idx]" : $values[$idx];
|
||||
}
|
||||
break;
|
||||
default:
|
||||
$existing[$this->paramName] = $this->value;
|
||||
}
|
||||
return $existing;
|
||||
}
|
||||
|
||||
/**
|
||||
* Derive the path for this field
|
||||
*
|
||||
* @param bool $asJSON Whether the field should be treated as JSON in the query (optional, default false)
|
||||
* @return string The path for this field
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
public function path(bool $asJSON = false): string
|
||||
{
|
||||
$extra = $asJSON ? '' : '>';
|
||||
if (str_contains($this->fieldName, '.')) {
|
||||
$mode = Configuration::mode('determine field path');
|
||||
if ($mode === Mode::PgSQL) {
|
||||
return "data#>$extra'{" . implode(',', explode('.', $this->fieldName)) . "}'";
|
||||
}
|
||||
if ($mode === Mode::SQLite) {
|
||||
$parts = explode('.', $this->fieldName);
|
||||
$last = array_pop($parts);
|
||||
return "data->'" . implode("'->'", $parts) . "'->$extra'$last'";
|
||||
}
|
||||
}
|
||||
return "data->$extra'$this->fieldName'";
|
||||
}
|
||||
|
||||
/**
|
||||
* Get the WHERE clause fragment for this parameter
|
||||
*
|
||||
* @return string The WHERE clause fragment for this parameter
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
* @throws Exception|DocumentException If the database mode has not been set
|
||||
*/
|
||||
public function toWhere(): string
|
||||
{
|
||||
$mode = Configuration::mode('make field WHERE clause');
|
||||
$fieldName = (empty($this->qualifier) ? '' : "$this->qualifier.") . $this->path($this->op === Op::InArray);
|
||||
$fieldPath = match ($mode) {
|
||||
Mode::PgSQL => match (true) {
|
||||
$this->op === Op::Between,
|
||||
$this->op === Op::In => is_numeric($this->value[0]) ? "($fieldName)::numeric" : $fieldName,
|
||||
is_numeric($this->value) => "($fieldName)::numeric",
|
||||
default => $fieldName,
|
||||
},
|
||||
default => $fieldName,
|
||||
};
|
||||
$criteria = match ($this->op) {
|
||||
Op::EX, Op::NEX => '',
|
||||
Op::BT => " {$this->paramName}min AND {$this->paramName}max",
|
||||
default => " $this->paramName"
|
||||
Op::Exists,
|
||||
Op::NotExists => '',
|
||||
Op::Between => " {$this->paramName}min AND {$this->paramName}max",
|
||||
Op::In => ' (' . $this->inParameterNames() . ')',
|
||||
Op::InArray => $mode === Mode::PgSQL ? ' ARRAY[' . $this->inParameterNames() . ']' : '',
|
||||
default => " $this->paramName",
|
||||
};
|
||||
$prefix = $this->qualifier == '' ? '' : "$this->qualifier.";
|
||||
$fieldPath = match (Configuration::$mode) {
|
||||
Mode::SQLite => "{$prefix}data->>'"
|
||||
. (str_contains($this->fieldName, '.')
|
||||
? implode("'->>'", explode('.', $this->fieldName))
|
||||
: $this->fieldName)
|
||||
. "'",
|
||||
Mode::PgSQL => $this->op == Op::BT && is_numeric($this->value[0])
|
||||
? "({$prefix}data->>'$this->fieldName')::numeric"
|
||||
: "{$prefix}data->>'$this->fieldName'",
|
||||
default => throw new DocumentException('Database mode not set; cannot make field WHERE clause')
|
||||
};
|
||||
return $fieldPath . ' ' . $this->op->toString() . $criteria;
|
||||
return $mode === Mode::SQLite && $this->op === Op::InArray
|
||||
? "EXISTS (SELECT 1 FROM json_each({$this->value['table']}.data, '\$.$this->fieldName') WHERE value IN ("
|
||||
. $this->inParameterNames() . '))'
|
||||
: $fieldPath . ' ' . $this->op->toSQL() . $criteria;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create parameter names for an IN clause
|
||||
*
|
||||
* @return string A comma-delimited string of parameter names
|
||||
*/
|
||||
private function inParameterNames(): string
|
||||
{
|
||||
$values = $this->op === Op::In ? $this->value : $this->value['values'];
|
||||
return implode(', ',
|
||||
array_map(fn($value, $key) => "{$this->paramName}_$key", $values, range(0, count($values) - 1)));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -78,11 +139,24 @@ class Field
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for which equality will be checked
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function EQ(string $fieldName, mixed $value, string $paramName = ''): static
|
||||
public static function equal(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return new static($fieldName, Op::EQ, $value, $paramName);
|
||||
return new self($fieldName, Op::Equal, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an equals (=) field criterion _(alias for `Field.equal`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for which equality will be checked
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function EQ(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return self::equal($fieldName, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -91,11 +165,24 @@ class Field
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the greater than comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function GT(string $fieldName, mixed $value, string $paramName = ''): static
|
||||
public static function greater(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return new static($fieldName, Op::GT, $value, $paramName);
|
||||
return new self($fieldName, Op::Greater, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a greater than (>) field criterion _(alias for `Field.greater`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the greater than comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function GT(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return self::greater($fieldName, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -104,11 +191,24 @@ class Field
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the greater than or equal to comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function GE(string $fieldName, mixed $value, string $paramName = ''): static
|
||||
public static function greaterOrEqual(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return new static($fieldName, Op::GE, $value, $paramName);
|
||||
return new self($fieldName, Op::GreaterOrEqual, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a greater than or equal to (>=) field criterion _(alias for `Field.greaterOrEqual`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the greater than or equal to comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function GE(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return self::greaterOrEqual($fieldName, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -117,11 +217,24 @@ class Field
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the less than comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function LT(string $fieldName, mixed $value, string $paramName = ''): static
|
||||
public static function less(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return new static($fieldName, Op::LT, $value, $paramName);
|
||||
return new self($fieldName, Op::Less, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a less than (<) field criterion _(alias for `Field.less`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the less than comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function LT(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return self::less($fieldName, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -130,11 +243,24 @@ class Field
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the less than or equal to comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function LE(string $fieldName, mixed $value, string $paramName = ''): static
|
||||
public static function lessOrEqual(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return new static($fieldName, Op::LE, $value, $paramName);
|
||||
return new self($fieldName, Op::LessOrEqual, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a less than or equal to (<=) field criterion _(alias for `Field.lessOrEqual`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the less than or equal to comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function LE(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return self::lessOrEqual($fieldName, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -143,11 +269,24 @@ class Field
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the not equals comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function NE(string $fieldName, mixed $value, string $paramName = ''): static
|
||||
public static function notEqual(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return new static($fieldName, Op::NE, $value, $paramName);
|
||||
return new self($fieldName, Op::NotEqual, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a not equals (<>) field criterion _(alias for `Field.notEqual`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $value The value for the not equals comparison
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function NE(string $fieldName, mixed $value, string $paramName = ''): self
|
||||
{
|
||||
return self::notEqual($fieldName, $value, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -157,32 +296,109 @@ class Field
|
||||
* @param mixed $minValue The lower value for range
|
||||
* @param mixed $maxValue The upper value for the range
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function BT(string $fieldName, mixed $minValue, mixed $maxValue, string $paramName = ''): static
|
||||
public static function between(string $fieldName, mixed $minValue, mixed $maxValue, string $paramName = ''): self
|
||||
{
|
||||
return new static($fieldName, Op::BT, [$minValue, $maxValue], $paramName);
|
||||
return new self($fieldName, Op::Between, [$minValue, $maxValue], $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a BETWEEN field criterion _(alias for `Field.between`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the value will be compared
|
||||
* @param mixed $minValue The lower value for range
|
||||
* @param mixed $maxValue The upper value for the range
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function BT(string $fieldName, mixed $minValue, mixed $maxValue, string $paramName = ''): self
|
||||
{
|
||||
return self::between($fieldName, $minValue, $maxValue, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an IN field criterion
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the values will be compared
|
||||
* @param mixed[] $values The potential matching values for the field
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function in(string $fieldName, array $values, string $paramName = ''): self
|
||||
{
|
||||
return new self($fieldName, Op::In, $values, $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an IN ARRAY field criterion
|
||||
*
|
||||
* @param string $fieldName The name of the field against which the values will be compared
|
||||
* @param string $tableName The table name where this field is located
|
||||
* @param mixed[] $values The potential matching values for the field
|
||||
* @param string $paramName The name of the parameter to which this should be bound (optional; generated if blank)
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function inArray(string $fieldName, string $tableName, array $values, string $paramName = ''): self
|
||||
{
|
||||
return new self($fieldName, Op::InArray, ['table' => $tableName, 'values' => $values], $paramName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an exists (IS NOT NULL) field criterion
|
||||
*
|
||||
* @param string $fieldName The name of the field for which existence will be checked
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function EX(string $fieldName): static
|
||||
public static function exists(string $fieldName): self
|
||||
{
|
||||
return new static($fieldName, Op::EX, '', '');
|
||||
return new self($fieldName, Op::Exists, '', '');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an exists (IS NOT NULL) field criterion _(alias for `Field.exists`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field for which existence will be checked
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function EX(string $fieldName): self
|
||||
{
|
||||
return self::exists($fieldName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a not exists (IS NULL) field criterion
|
||||
*
|
||||
* @param string $fieldName The name of the field for which non-existence will be checked
|
||||
* @return static The field with the requested criterion
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function NEX(string $fieldName): static
|
||||
public static function notExists(string $fieldName): self
|
||||
{
|
||||
return new static($fieldName, Op::NEX, '', '');
|
||||
return new self($fieldName, Op::NotExists, '', '');
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a not exists (IS NULL) field criterion _(alias for `Field.notExists`)_
|
||||
*
|
||||
* @param string $fieldName The name of the field for which non-existence will be checked
|
||||
* @return self The field with the requested criterion
|
||||
*/
|
||||
public static function NEX(string $fieldName): self
|
||||
{
|
||||
return self::notExists($fieldName);
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a named fields (used for creating fields for ORDER BY clauses)
|
||||
*
|
||||
* Prepend the field name with 'n:' to treat the field as a number; prepend the field name with 'i:' to perform
|
||||
* a case-insensitive ordering.
|
||||
*
|
||||
* @param string $name The name of the field, plus any direction for the ordering
|
||||
* @return self
|
||||
*/
|
||||
public static function named(string $name): self
|
||||
{
|
||||
return new self($name, Op::Equal, '', '');
|
||||
}
|
||||
}
|
||||
|
||||
34
src/FieldMatch.php
Normal file
34
src/FieldMatch.php
Normal file
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
/**
|
||||
* How multiple fields should be matched
|
||||
*/
|
||||
enum FieldMatch
|
||||
{
|
||||
/** Match all provided fields (`AND`) */
|
||||
case All;
|
||||
|
||||
/** Match any provided fields (`OR`) */
|
||||
case Any;
|
||||
|
||||
/**
|
||||
* Get the SQL keyword for this enumeration value
|
||||
*
|
||||
* @return string The SQL keyword for this enumeration value
|
||||
*/
|
||||
public function toSQL(): string
|
||||
{
|
||||
return match ($this) {
|
||||
FieldMatch::All => 'AND',
|
||||
FieldMatch::Any => 'OR',
|
||||
};
|
||||
}
|
||||
}
|
||||
122
src/Find.php
122
src/Find.php
@@ -1,7 +1,14 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
use BitBadger\InspiredByFSharp\Option;
|
||||
use BitBadger\PDODocument\Mapper\DocumentMapper;
|
||||
|
||||
/**
|
||||
@@ -15,12 +22,14 @@ class Find
|
||||
* @template TDoc The type of document to be retrieved
|
||||
* @param string $tableName The table from which documents should be retrieved
|
||||
* @param class-string<TDoc> $className The name of the class to be retrieved
|
||||
* @param Field[] $orderBy Fields by which the results should be ordered (optional, default no ordering)
|
||||
* @return DocumentList<TDoc> A list of all documents from the table
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function all(string $tableName, string $className): DocumentList
|
||||
public static function all(string $tableName, string $className, array $orderBy = []): DocumentList
|
||||
{
|
||||
return Custom::list(Query::selectFromTable($tableName), [], new DocumentMapper($className));
|
||||
return Custom::list(Query::selectFromTable($tableName) . Query::orderBy($orderBy), [],
|
||||
new DocumentMapper($className));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -30,12 +39,13 @@ 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<TDoc> $className The name of the class to be retrieved
|
||||
* @return false|TDoc The document if it exists, false if not
|
||||
* @return Option<TDoc> 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), Parameters::id($docId), new DocumentMapper($className));
|
||||
return Custom::single(Query\Find::byId($tableName, $docId), Parameters::id($docId),
|
||||
new DocumentMapper($className));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -43,18 +53,55 @@ class Find
|
||||
*
|
||||
* @template TDoc The type of document to be retrieved
|
||||
* @param string $tableName The table from which documents should be retrieved
|
||||
* @param array|Field[] $fields The field comparison to match
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param class-string<TDoc> $className The name of the class to be retrieved
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @param Field[] $orderBy Fields by which the results should be ordered (optional, default no ordering)
|
||||
* @return DocumentList<TDoc> A list of documents matching the given field comparison
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, string $className,
|
||||
string $conjunction = 'AND'): DocumentList
|
||||
?FieldMatch $match = null, array $orderBy = []): DocumentList
|
||||
{
|
||||
$namedFields = Parameters::nameFields($fields);
|
||||
return Custom::list(Query\Find::byFields($tableName, $namedFields, $conjunction),
|
||||
Parameters::addFields($namedFields, []), new DocumentMapper($className));
|
||||
Parameters::nameFields($fields);
|
||||
return Custom::list(Query\Find::byFields($tableName, $fields, $match) . Query::orderBy($orderBy),
|
||||
Parameters::addFields($fields, []), new DocumentMapper($className));
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve documents via a JSON containment query (`@>`; PostgreSQL only)
|
||||
*
|
||||
* @template TDoc The type of document to be retrieved
|
||||
* @param string $tableName The name of the table from which documents should be retrieved
|
||||
* @param mixed[]|object $criteria The criteria for the JSON containment query
|
||||
* @param class-string<TDoc> $className The name of the class to be retrieved
|
||||
* @param Field[] $orderBy Fields by which the results should be ordered (optional, default no ordering)
|
||||
* @return DocumentList<TDoc> A list of documents matching the JSON containment query
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byContains(string $tableName, array|object $criteria, string $className,
|
||||
array $orderBy = []): DocumentList
|
||||
{
|
||||
return Custom::list(Query\Find::byContains($tableName) . Query::orderBy($orderBy),
|
||||
Parameters::json(':criteria', $criteria), new DocumentMapper($className));
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve documents via a JSON Path match query (`@?`; PostgreSQL only)
|
||||
*
|
||||
* @template TDoc The type of document to be retrieved
|
||||
* @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<TDoc> $className The name of the class to be retrieved
|
||||
* @param Field[] $orderBy Fields by which the results should be ordered (optional, default no ordering)
|
||||
* @return DocumentList<TDoc> A list of documents matching the JSON Path
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byJsonPath(string $tableName, string $path, string $className,
|
||||
array $orderBy = []): DocumentList
|
||||
{
|
||||
return Custom::list(Query\Find::byJsonPath($tableName) . Query::orderBy($orderBy), [':path' => $path],
|
||||
new DocumentMapper($className));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -62,17 +109,54 @@ class Find
|
||||
*
|
||||
* @template TDoc The type of document to be retrieved
|
||||
* @param string $tableName The table from which the document should be retrieved
|
||||
* @param array|Field[] $fields The field comparison to match
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param class-string<TDoc> $className The name of the class to be retrieved
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @return false|TDoc The first document if any matches are found, false otherwise
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @param Field[] $orderBy Fields by which the results should be ordered (optional, default no ordering)
|
||||
* @return Option<TDoc> 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,
|
||||
string $conjunction = 'AND'): mixed
|
||||
?FieldMatch $match = null, array $orderBy = []): Option
|
||||
{
|
||||
$namedFields = Parameters::nameFields($fields);
|
||||
return Custom::single(Query\Find::byFields($tableName, $namedFields, $conjunction),
|
||||
Parameters::addFields($namedFields, []), new DocumentMapper($className));
|
||||
Parameters::nameFields($fields);
|
||||
return Custom::single(Query\Find::byFields($tableName, $fields, $match) . Query::orderBy($orderBy),
|
||||
Parameters::addFields($fields, []), new DocumentMapper($className));
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve documents via a JSON containment query (`@>`), returning only the first result (PostgreSQL only)
|
||||
*
|
||||
* @template TDoc The type of document to be retrieved
|
||||
* @param string $tableName The name of the table from which documents should be retrieved
|
||||
* @param mixed[]|object $criteria The criteria for the JSON containment query
|
||||
* @param class-string<TDoc> $className The name of the class to be retrieved
|
||||
* @param Field[] $orderBy Fields by which the results should be ordered (optional, default no ordering)
|
||||
* @return Option<TDoc> 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,
|
||||
array $orderBy = []): Option
|
||||
{
|
||||
return Custom::single(Query\Find::byContains($tableName) . Query::orderBy($orderBy),
|
||||
Parameters::json(':criteria', $criteria), new DocumentMapper($className));
|
||||
}
|
||||
|
||||
/**
|
||||
* Retrieve documents via a JSON Path match query (`@?`), returning only the first result (PostgreSQL only)
|
||||
*
|
||||
* @template TDoc The type of document to be retrieved
|
||||
* @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<TDoc> $className The name of the class to be retrieved
|
||||
* @param Field[] $orderBy Fields by which the results should be ordered (optional, default no ordering)
|
||||
* @return Option<TDoc> 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,
|
||||
array $orderBy = []): Option
|
||||
{
|
||||
return Custom::single(Query\Find::byJsonPath($tableName) . Query::orderBy($orderBy), [':path' => $path],
|
||||
new DocumentMapper($className));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,14 +1,23 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Mapper;
|
||||
|
||||
/**
|
||||
* A mapper that returns the associative array from the database
|
||||
*
|
||||
* @implements Mapper<array<string|int, mixed>>
|
||||
*/
|
||||
class ArrayMapper implements Mapper
|
||||
{
|
||||
/**
|
||||
* @inheritDoc
|
||||
* @return array<string|int, mixed> The array given as the parameter
|
||||
*/
|
||||
public function map(array $result): array
|
||||
{
|
||||
|
||||
@@ -1,15 +1,21 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Mapper;
|
||||
|
||||
/**
|
||||
* A mapper that returns the integer value of the first item in the results
|
||||
*
|
||||
* @implements Mapper<int>
|
||||
*/
|
||||
class CountMapper implements Mapper
|
||||
{
|
||||
/**
|
||||
* @inheritDoc
|
||||
*/
|
||||
/** @inheritDoc */
|
||||
public function map(array $result): int
|
||||
{
|
||||
return (int) $result[0];
|
||||
|
||||
@@ -1,10 +1,16 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Mapper;
|
||||
|
||||
use BitBadger\PDODocument\DocumentException;
|
||||
use Exception;
|
||||
use JsonMapper;
|
||||
use JsonMapper_Exception;
|
||||
|
||||
/**
|
||||
* Map domain class instances from JSON documents
|
||||
@@ -20,24 +26,27 @@ class DocumentMapper implements Mapper
|
||||
* @param class-string<TDoc> $className The type of class to be returned by this mapping
|
||||
* @param string $fieldName The name of the field (optional; defaults to `data`)
|
||||
*/
|
||||
public function __construct(public string $className, public string $fieldName = 'data') { }
|
||||
public function __construct(public string $className, public string $fieldName = 'data') {}
|
||||
|
||||
/**
|
||||
* Map a result to a domain class instance
|
||||
*
|
||||
* @param array $result An associative array representing a single database result
|
||||
* @param array<string|int, mixed> $result An associative array representing a single database result
|
||||
* @return TDoc The document, deserialized from its JSON representation
|
||||
* @throws DocumentException If the JSON cannot be deserialized
|
||||
*/
|
||||
public function map(array $result): mixed
|
||||
{
|
||||
try {
|
||||
if (method_exists($this->className, 'fromJsonString')) {
|
||||
return $this->className::fromJsonString($result[$this->fieldName]);
|
||||
}
|
||||
$json = json_decode($result[$this->fieldName]);
|
||||
if (is_null($json)) {
|
||||
throw new DocumentException("Could not map document for $this->className: " . json_last_error_msg());
|
||||
}
|
||||
return (new JsonMapper())->map($json, $this->className);
|
||||
} catch (JsonMapper_Exception $ex) {
|
||||
} catch (Exception $ex) {
|
||||
throw new DocumentException("Could not map document for $this->className", previous: $ex);
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,24 +1,32 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Mapper;
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Mode};
|
||||
use BitBadger\PDODocument\{Configuration, Mode};
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Map an EXISTS result to a boolean value
|
||||
*
|
||||
* @implements Mapper<bool>
|
||||
*/
|
||||
class ExistsMapper implements Mapper
|
||||
{
|
||||
/**
|
||||
* @inheritDoc
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
public function map(array $result): bool
|
||||
{
|
||||
return match (Configuration::$mode) {
|
||||
return match (Configuration::mode('map existence result')) {
|
||||
Mode::PgSQL => (bool)$result[0],
|
||||
Mode::SQLite => (int)$result[0] > 0,
|
||||
default => throw new DocumentException('Database mode not set; cannot map existence result'),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Mapper;
|
||||
|
||||
@@ -12,7 +18,7 @@ interface Mapper
|
||||
/**
|
||||
* Map a result to the specified type
|
||||
*
|
||||
* @param array $result An associative array representing a single database result
|
||||
* @param array<string|int, mixed> $result An associative array representing a single database result
|
||||
* @return T The item mapped from the given result
|
||||
*/
|
||||
public function map(array $result): mixed;
|
||||
|
||||
@@ -1,9 +1,15 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Mapper;
|
||||
|
||||
/**
|
||||
* Map a string result from the
|
||||
* Map a string result from the named field
|
||||
*
|
||||
* @implements Mapper<string>
|
||||
*/
|
||||
@@ -24,7 +30,7 @@ class StringMapper implements Mapper
|
||||
return match (false) {
|
||||
key_exists($this->fieldName, $result) => null,
|
||||
is_string($result[$this->fieldName]) => "{$result[$this->fieldName]}",
|
||||
default => $result[$this->fieldName]
|
||||
default => $result[$this->fieldName],
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
23
src/Mode.php
23
src/Mode.php
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -12,4 +18,19 @@ enum Mode
|
||||
|
||||
/** Storing documents in a SQLite database */
|
||||
case SQLite;
|
||||
|
||||
/**
|
||||
* Derive the mode from the Data Source Name (DSN)
|
||||
*
|
||||
* @return Mode The database mode based on the DSN
|
||||
* @throws DocumentException If the DSN does not start with `pgsql:` or `sqlite:`
|
||||
*/
|
||||
public static function deriveFromDSN(string $dsn): Mode
|
||||
{
|
||||
return match (true) {
|
||||
str_starts_with($dsn, 'pgsql:') => Mode::PgSQL,
|
||||
str_starts_with($dsn, 'sqlite:') => Mode::SQLite,
|
||||
default => throw new DocumentException('This library currently supports PostgreSQL and SQLite'),
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
56
src/Op.php
56
src/Op.php
@@ -1,48 +1,60 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
/**
|
||||
* The types of logical operations allowed for JSON fields
|
||||
* The types of comparison operators allowed for JSON fields
|
||||
*/
|
||||
enum Op
|
||||
{
|
||||
/** Equals (=) */
|
||||
case EQ;
|
||||
case Equal;
|
||||
/** Greater Than (>) */
|
||||
case GT;
|
||||
case Greater;
|
||||
/** Greater Than or Equal To (>=) */
|
||||
case GE;
|
||||
case GreaterOrEqual;
|
||||
/** Less Than (<) */
|
||||
case LT;
|
||||
case Less;
|
||||
/** Less Than or Equal To (<=) */
|
||||
case LE;
|
||||
case LessOrEqual;
|
||||
/** Not Equal to (<>) */
|
||||
case NE;
|
||||
case NotEqual;
|
||||
/** Between (BETWEEN) */
|
||||
case BT;
|
||||
case Between;
|
||||
/** In (IN) */
|
||||
case In;
|
||||
/** In Array (PostgreSQL - ?|, SQLite - EXISTS / json_each / IN) */
|
||||
case InArray;
|
||||
/** Exists (IS NOT NULL) */
|
||||
case EX;
|
||||
case Exists;
|
||||
/** Does Not Exist (IS NULL) */
|
||||
case NEX;
|
||||
case NotExists;
|
||||
|
||||
/**
|
||||
* Get the string representation of this operator
|
||||
* Get the SQL representation of this operator
|
||||
*
|
||||
* @return string The operator to use in SQL statements
|
||||
*/
|
||||
public function toString(): string
|
||||
public function toSQL(): string
|
||||
{
|
||||
return match ($this) {
|
||||
Op::EQ => "=",
|
||||
Op::GT => ">",
|
||||
Op::GE => ">=",
|
||||
Op::LT => "<",
|
||||
Op::LE => "<=",
|
||||
Op::NE => "<>",
|
||||
Op::BT => "BETWEEN",
|
||||
Op::EX => "IS NOT NULL",
|
||||
Op::NEX => "IS NULL"
|
||||
Op::Equal => "=",
|
||||
Op::Greater => ">",
|
||||
Op::GreaterOrEqual => ">=",
|
||||
Op::Less => "<",
|
||||
Op::LessOrEqual => "<=",
|
||||
Op::NotEqual => "<>",
|
||||
Op::Between => "BETWEEN",
|
||||
Op::In => "IN",
|
||||
Op::InArray => "??|", // The actual operator is ?|, but needs to be escaped by doubling
|
||||
Op::Exists => "IS NOT NULL",
|
||||
Op::NotExists => "IS NULL",
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,7 +1,15 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Functions to create parameters for queries
|
||||
*/
|
||||
@@ -11,45 +19,61 @@ class Parameters
|
||||
* Create an ID parameter (name ":id", key will be treated as a string)
|
||||
*
|
||||
* @param mixed $key The key representing the ID of the document
|
||||
* @return array|string[] An associative array with an "@id" parameter/value pair
|
||||
* @return array<string, mixed> An associative array with an "@id" parameter/value pair
|
||||
*/
|
||||
public static function id(mixed $key): array
|
||||
{
|
||||
return [':id' => is_int($key) || is_string($key) ? $key : "$key"];
|
||||
return [':id' => ((is_int($key) || is_string($key)) ? $key : "$key")];
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a parameter with a JSON value
|
||||
*
|
||||
* @param string $name The name of the JSON parameter
|
||||
* @param object|array $document The value that should be passed as a JSON string
|
||||
* @return array An associative array with the named parameter/value pair
|
||||
* @param mixed[]|object $document The value that should be passed as a JSON string
|
||||
* @return array<string, string> An associative array with the named parameter/value pair
|
||||
*/
|
||||
public static function json(string $name, object|array $document): array
|
||||
{
|
||||
return [$name => json_encode($document, JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES)];
|
||||
$flags = JSON_UNESCAPED_UNICODE | JSON_UNESCAPED_SLASHES;
|
||||
|
||||
if (is_object($document)) {
|
||||
return [
|
||||
$name => method_exists($document, 'toJson') ? $document->toJson($flags) : json_encode($document, $flags)
|
||||
];
|
||||
}
|
||||
|
||||
$key = array_key_first($document);
|
||||
if (is_array($document[$key])) {
|
||||
if (empty($document[$key])) return [$name => json_encode($document, $flags)];
|
||||
if (method_exists($document[$key][array_key_first($document[$key])], 'toJson')) {
|
||||
return [
|
||||
$name => sprintf('{%s:[%s]}', json_encode($key, $flags),
|
||||
implode(',', array_map(fn($it) => $it->toJson($flags), $document[$key])))
|
||||
];
|
||||
}
|
||||
}
|
||||
return [$name => json_encode($document, $flags)];
|
||||
}
|
||||
|
||||
/**
|
||||
* Fill in parameter names for any fields missing one
|
||||
*
|
||||
* @param array|Field[] $fields The fields for the query
|
||||
* @return array|Field[] The fields, all with non-blank parameter names
|
||||
* @param Field[] $fields The fields for the query (entries with no names will be modified)
|
||||
*/
|
||||
public static function nameFields(array $fields): array
|
||||
public static function nameFields(array &$fields): void
|
||||
{
|
||||
for ($idx = 0; $idx < sizeof($fields); $idx++) {
|
||||
if ($fields[$idx]->paramName == '') $fields[$idx]->paramName = ":field$idx";
|
||||
}
|
||||
return $fields;
|
||||
array_walk($fields, function (Field $field, int $idx) {
|
||||
if (empty($field->paramName)) $field->paramName =":field$idx";
|
||||
});
|
||||
}
|
||||
|
||||
/**
|
||||
* Add field parameters to the given set of parameters
|
||||
*
|
||||
* @param array|Field[] $fields The fields being compared in the query
|
||||
* @param array $parameters An associative array of parameters to which the fields should be added
|
||||
* @return array An associative array of parameter names and values with the fields added
|
||||
* @param Field[] $fields The fields being compared in the query
|
||||
* @param array<string, mixed> $parameters An associative array of parameters to which the fields should be added
|
||||
* @return array<string, mixed> An associative array of parameter names and values with the fields added
|
||||
*/
|
||||
public static function addFields(array $fields, array $parameters): array
|
||||
{
|
||||
@@ -60,22 +84,18 @@ class Parameters
|
||||
* Create JSON field name parameters for the given field names to the given parameter
|
||||
*
|
||||
* @param string $paramName The name of the parameter for the field names
|
||||
* @param array|string[] $fieldNames The names of the fields for the parameter
|
||||
* @return array An associative array of parameter/value pairs for the field names
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
* @param string[] $fieldNames The names of the fields for the parameter
|
||||
* @return array<string, string> An associative array of parameter/value pairs for the field names
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
public static function fieldNames(string $paramName, array $fieldNames): array
|
||||
{
|
||||
switch (Configuration::$mode) {
|
||||
case Mode::PgSQL:
|
||||
return [$paramName => "ARRAY['" . implode("','", $fieldNames) . "']"];
|
||||
case Mode::SQLite:
|
||||
$it = [];
|
||||
$idx = 0;
|
||||
foreach ($fieldNames as $field) $it[$paramName . $idx++] = "$.$field";
|
||||
return $it;
|
||||
default:
|
||||
throw new DocumentException('Database mode not set; cannot generate field name parameters');
|
||||
}
|
||||
$mode = Configuration::mode('generate field name parameters');
|
||||
return match ($mode) {
|
||||
Mode::PgSQL => [$paramName => "{" . implode(",", $fieldNames) . "}"],
|
||||
Mode::SQLite => array_combine(array_map(fn($idx) => $paramName . $idx,
|
||||
empty($fieldNames) ? [] : range(0, sizeof($fieldNames) - 1)),
|
||||
array_map(fn($field) => "$.$field", $fieldNames))
|
||||
};
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -12,12 +18,12 @@ class Patch
|
||||
*
|
||||
* @param string $tableName The table in which the document should be patched
|
||||
* @param mixed $docId The ID of the document to be patched
|
||||
* @param array|object $patch The object with which the document should be patched (will be JSON-encoded)
|
||||
* @param mixed[]|object $patch The object with which the document should be patched (will be JSON-encoded)
|
||||
* @throws DocumentException If any is encountered (database mode must be set)
|
||||
*/
|
||||
public static function byId(string $tableName, mixed $docId, array|object $patch): void
|
||||
{
|
||||
Custom::nonQuery(Query\Patch::byId($tableName),
|
||||
Custom::nonQuery(Query\Patch::byId($tableName, $docId),
|
||||
array_merge(Parameters::id($docId), Parameters::json(':data', $patch)));
|
||||
}
|
||||
|
||||
@@ -25,16 +31,44 @@ class Patch
|
||||
* Patch documents using a comparison on JSON fields
|
||||
*
|
||||
* @param string $tableName The table in which documents should be patched
|
||||
* @param array|Field[] $fields The field comparison to match
|
||||
* @param array|object $patch The object with which the documents should be patched (will be JSON-encoded)
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param mixed[]|object $patch The object with which the documents should be patched (will be JSON-encoded)
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, array|object $patch,
|
||||
string $conjunction = 'AND'): void
|
||||
?FieldMatch $match = null): void
|
||||
{
|
||||
$namedFields = Parameters::nameFields($fields);
|
||||
Custom::nonQuery(Query\Patch::byFields($tableName, $namedFields, $conjunction),
|
||||
Parameters::addFields($namedFields, Parameters::json(':data', $patch)));
|
||||
Parameters::nameFields($fields);
|
||||
Custom::nonQuery(Query\Patch::byFields($tableName, $fields, $match),
|
||||
Parameters::addFields($fields, Parameters::json(':data', $patch)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Patch documents using a JSON containment query (`@>`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The table in which documents should be patched
|
||||
* @param mixed[]|object $criteria The JSON containment query values to match
|
||||
* @param mixed[]|object $patch The object with which the documents should be patched (will be JSON-encoded)
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byContains(string $tableName, array|object $criteria, array|object $patch): void
|
||||
{
|
||||
Custom::nonQuery(Query\Patch::byContains($tableName),
|
||||
array_merge(Parameters::json(':criteria', $criteria), Parameters::json(':data', $patch)));
|
||||
}
|
||||
|
||||
/**
|
||||
* Patch documents using a JSON Path match query (`@?`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The table in which documents should be patched
|
||||
* @param string $path The JSON Path match string
|
||||
* @param mixed[]|object $patch The object with which the documents should be patched (will be JSON-encoded)
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byJsonPath(string $tableName, string $path, array|object $patch): void
|
||||
{
|
||||
Custom::nonQuery(Query\Patch::byJsonPath($tableName),
|
||||
array_merge([':path' => $path], Parameters::json(':data', $patch)));
|
||||
}
|
||||
}
|
||||
|
||||
144
src/Query.php
144
src/Query.php
@@ -1,7 +1,16 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
use Exception;
|
||||
use Random\RandomException;
|
||||
|
||||
/**
|
||||
* Query construction functions
|
||||
*/
|
||||
@@ -22,34 +31,92 @@ class Query
|
||||
* Create a WHERE clause fragment to implement a comparison on fields in a JSON document
|
||||
*
|
||||
* @param Field[] $fields The field comparison to generate
|
||||
* @param string $conjunction How to join multiple conditions (optional; defaults to AND)
|
||||
* @param FieldMatch|null $match How to join multiple conditions (optional; defaults to All)
|
||||
* @return string The WHERE clause fragment matching the given fields and parameter
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function whereByFields(array $fields, string $conjunction = 'AND'): string
|
||||
public static function whereByFields(array $fields, ?FieldMatch $match = null): string
|
||||
{
|
||||
return implode(" $conjunction ", array_map(fn($it) => $it->toWhere(), $fields));
|
||||
return implode(' ' . ($match ?? FieldMatch::All)->toSQL() . ' ', array_map(fn($it) => $it->toWhere(), $fields));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a WHERE clause fragment to implement an ID-based query
|
||||
*
|
||||
* @param string $paramName The parameter name where the value of the ID will be provided (optional; default @id)
|
||||
* @param mixed $docId The ID of the document to be retrieved; used to determine type for potential JSON field
|
||||
* casts (optional; string ID assumed if no value is provided)
|
||||
* @return string The WHERE clause fragment to match by ID
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function whereById(string $paramName = ':id'): string
|
||||
public static function whereById(string $paramName = ':id', mixed $docId = null): string
|
||||
{
|
||||
return self::whereByFields([Field::EQ(Configuration::$idField, 0, $paramName)]);
|
||||
return self::whereByFields([Field::equal(Configuration::$idField, $docId ?? '', $paramName)]);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to insert a document
|
||||
* Create a WHERE clause fragment to implement a JSON containment query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table into which a document should be inserted
|
||||
* @return string The INSERT statement for the given table
|
||||
* @param string $paramName The name of the parameter (optional; defaults to `:criteria`)
|
||||
* @return string The WHERE clause fragment for a JSON containment query
|
||||
* @throws Exception|DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function insert(string $tableName): string
|
||||
public static function whereDataContains(string $paramName = ':criteria'): string
|
||||
{
|
||||
return "INSERT INTO $tableName VALUES (:data)";
|
||||
if (Configuration::mode() <> Mode::PgSQL) {
|
||||
throw new DocumentException('JSON containment is only supported on PostgreSQL');
|
||||
}
|
||||
return "data @> $paramName";
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a WHERE clause fragment to implement a JSON Path match query (PostgreSQL only)
|
||||
*
|
||||
* @param string $paramName The name of the parameter (optional; defaults to `:path`)
|
||||
* @return string The WHERE clause fragment for a JSON Path match query
|
||||
* @throws Exception|DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function whereJsonPathMatches(string $paramName = ':path'): string
|
||||
{
|
||||
if (Configuration::mode() <> Mode::PgSQL) {
|
||||
throw new DocumentException('JSON Path matching is only supported on PostgreSQL');
|
||||
}
|
||||
return "jsonb_path_exists(data, $paramName::jsonpath)";
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an `INSERT` statement for a document
|
||||
*
|
||||
* @param string $tableName The name of the table into which the document will be inserted
|
||||
* @param AutoId|null $autoId The version of automatic ID query to generate (optional, defaults to None)
|
||||
* @return string The `INSERT` statement to insert a document
|
||||
* @throws Exception|DocumentException If the database mode is not set
|
||||
*/
|
||||
public static function insert(string $tableName, ?AutoId $autoId = null): string
|
||||
{
|
||||
try {
|
||||
$id = Configuration::$idField;
|
||||
$values = match (Configuration::mode('generate auto-ID INSERT statement')) {
|
||||
Mode::SQLite => match ($autoId ?? AutoId::None) {
|
||||
AutoId::None => ':data',
|
||||
AutoId::Number => "json_set(:data, '$.$id', "
|
||||
. "(SELECT coalesce(max(data->>'$id'), 0) + 1 FROM $tableName))",
|
||||
AutoId::UUID => "json_set(:data, '$.$id', '" . AutoId::generateUUID() . "')",
|
||||
AutoId::RandomString => "json_set(:data, '$.$id', '" . AutoId::generateRandom() ."')",
|
||||
},
|
||||
Mode::PgSQL => match ($autoId ?? AutoId::None) {
|
||||
AutoId::None => ':data',
|
||||
AutoId::Number => ":data::jsonb || ('{\"$id\":' || "
|
||||
. "(SELECT COALESCE(MAX((data->>'$id')::numeric), 0) + 1 "
|
||||
. "FROM $tableName) || '}')::jsonb",
|
||||
AutoId::UUID => ":data::jsonb || '{\"$id\":\"" . AutoId::generateUUID() . "\"}'",
|
||||
AutoId::RandomString => ":data::jsonb || '{\"$id\":\"" . AutoId::generateRandom() . "\"}'",
|
||||
}
|
||||
};
|
||||
return "INSERT INTO $tableName VALUES ($values)";
|
||||
} catch (RandomException $ex) {
|
||||
throw new DocumentException('Unable to generate ID: ' . $ex->getMessage(), previous: $ex);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -60,8 +127,8 @@ class Query
|
||||
*/
|
||||
public static function save(string $tableName): string
|
||||
{
|
||||
return self::insert($tableName)
|
||||
. " ON CONFLICT ((data->>'" . Configuration::$idField . "')) DO UPDATE SET data = EXCLUDED.data";
|
||||
$id = Configuration::$idField;
|
||||
return "INSERT INTO $tableName VALUES (:data) ON CONFLICT ((data->>'$id')) DO UPDATE SET data = EXCLUDED.data";
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -69,9 +136,60 @@ class Query
|
||||
*
|
||||
* @param string $tableName The name of the table in which the document should be updated
|
||||
* @return string The UPDATE query for the document
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function update(string $tableName): string
|
||||
{
|
||||
return "UPDATE $tableName SET data = :data WHERE " . self::whereById();
|
||||
}
|
||||
|
||||
/**
|
||||
* Transform a field to an ORDER BY clause segment
|
||||
*
|
||||
* @param Field $field The field by which ordering should be implemented
|
||||
* @return string The ORDER BY fragment for the given field
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
private static function mapToOrderBy(Field $field): string
|
||||
{
|
||||
$mode = Configuration::mode('render ORDER BY clause');
|
||||
|
||||
if (str_contains($field->fieldName, ' ')) {
|
||||
$parts = explode(' ', $field->fieldName);
|
||||
$field->fieldName = array_shift($parts);
|
||||
$direction = ' ' . implode(' ', $parts);
|
||||
} else {
|
||||
$direction = '';
|
||||
}
|
||||
|
||||
if (str_starts_with($field->fieldName, 'n:')) {
|
||||
$field->fieldName = substr($field->fieldName, 2);
|
||||
$value = match ($mode) {
|
||||
Mode::PgSQL => '(' . $field->path() . ')::numeric',
|
||||
Mode::SQLite => $field->path()
|
||||
};
|
||||
} elseif (str_starts_with($field->fieldName, 'i:')) {
|
||||
$field->fieldName = substr($field->fieldName, 2);
|
||||
$value = match ($mode) {
|
||||
Mode::PgSQL => 'LOWER(' . $field->path() . ')',
|
||||
Mode::SQLite => $field->path() . ' COLLATE NOCASE'
|
||||
};
|
||||
} else {
|
||||
$value = $field->path();
|
||||
}
|
||||
|
||||
return (empty($field->qualifier) ? '' : "$field->qualifier.") . $value . $direction;
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an `ORDER BY` clause ('n:' treats field as number, 'i:' does case-insensitive ordering)
|
||||
*
|
||||
* @param Field[] $fields The fields, named for the field plus directions (ex. 'field DESC NULLS FIRST')
|
||||
* @return string The ORDER BY clause with the given fields
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
public static function orderBy(array $fields): string
|
||||
{
|
||||
return empty($fields) ? "" : ' ORDER BY ' . implode(', ', array_map(self::mapToOrderBy(...), $fields));
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Query;
|
||||
|
||||
use BitBadger\PDODocument\{Field, Query};
|
||||
use BitBadger\PDODocument\{DocumentException, Field, FieldMatch, Query};
|
||||
|
||||
/**
|
||||
* Queries for counting documents
|
||||
@@ -25,11 +31,36 @@ class Count
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be counted
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param FieldMatch|null $match How to join multiple conditions (optional; defaults to All)
|
||||
* @return string The query to count documents using a field comparison
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): string
|
||||
public static function byFields(string $tableName, array $fields, ?FieldMatch $match = null): string
|
||||
{
|
||||
return self::all($tableName) . ' WHERE ' . Query::whereByFields($fields, $conjunction);
|
||||
return self::all($tableName) . ' WHERE ' . Query::whereByFields($fields, $match);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to count matching documents using a JSON containment query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be counted
|
||||
* @return string The query to count documents using a JSON containment query
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byContains(string $tableName): string
|
||||
{
|
||||
return self::all($tableName) . ' WHERE ' . Query::whereDataContains();
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to count matching documents using a JSON Path match (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be counted
|
||||
* @return string The query to count documents using a JSON Path match
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byJsonPath(string $tableName): string
|
||||
{
|
||||
return self::all($tableName) . ' WHERE ' . Query::whereJsonPathMatches();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,15 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Query;
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Mode};
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, DocumentIndex, Mode};
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Queries to define tables and indexes
|
||||
@@ -14,14 +21,13 @@ class Definition
|
||||
*
|
||||
* @param string $name The name of the table (including schema, if applicable)
|
||||
* @return string The CREATE TABLE statement for the document table
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
public static function ensureTable(string $name): string
|
||||
{
|
||||
$dataType = match (Configuration::$mode) {
|
||||
$dataType = match (Configuration::mode('make create table statement')) {
|
||||
Mode::PgSQL => 'JSONB',
|
||||
Mode::SQLite => 'TEXT',
|
||||
default => throw new DocumentException('Database mode not set; cannot make create table statement')
|
||||
};
|
||||
return "CREATE TABLE IF NOT EXISTS $name (data $dataType NOT NULL)";
|
||||
}
|
||||
@@ -35,7 +41,7 @@ class Definition
|
||||
private static function splitSchemaAndTable(string $tableName): array
|
||||
{
|
||||
$parts = explode('.', $tableName);
|
||||
return sizeof($parts) == 1 ? ["", $tableName] : [$parts[0], $parts[1]];
|
||||
return sizeof($parts) === 1 ? ["", $tableName] : [$parts[0], $parts[1]];
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -43,7 +49,7 @@ class Definition
|
||||
*
|
||||
* @param string $tableName The name of the table which should be indexed
|
||||
* @param string $indexName The name of the index to create
|
||||
* @param array $fields An array of fields to be indexed; may contain direction (ex. 'salary DESC')
|
||||
* @param string[] $fields An array of fields to be indexed; may contain direction (ex. 'salary DESC')
|
||||
* @return string The CREATE INDEX statement to ensure the index exists
|
||||
*/
|
||||
public static function ensureIndexOn(string $tableName, string $indexName, array $fields): string
|
||||
@@ -51,7 +57,7 @@ class Definition
|
||||
[, $tbl] = self::splitSchemaAndTable($tableName);
|
||||
$jsonFields = implode(', ', array_map(function (string $field) {
|
||||
$parts = explode(' ', $field);
|
||||
$fieldName = sizeof($parts) == 1 ? $field : $parts[0];
|
||||
$fieldName = sizeof($parts) === 1 ? $field : $parts[0];
|
||||
$direction = sizeof($parts) < 2 ? "" : " $parts[1]";
|
||||
return "(data->>'$fieldName')$direction";
|
||||
}, $fields));
|
||||
@@ -68,4 +74,25 @@ class Definition
|
||||
{
|
||||
return str_replace('INDEX', 'UNIQUE INDEX', self::ensureIndexOn($tableName, 'key', [Configuration::$idField]));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a document-wide index on a table (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table on which the document index should be created
|
||||
* @param DocumentIndex $indexType The type of index to be created
|
||||
* @return string The SQL statement to create an index on JSON documents in the specified table
|
||||
* @throws Exception|DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function ensureDocumentIndexOn(string $tableName, DocumentIndex $indexType): string
|
||||
{
|
||||
if (Configuration::mode() <> Mode::PgSQL) {
|
||||
throw new DocumentException('Document indexes are only supported on PostgreSQL');
|
||||
}
|
||||
[, $tbl] = self::splitSchemaAndTable($tableName);
|
||||
$extraOps = match ($indexType) {
|
||||
DocumentIndex::Full => '',
|
||||
DocumentIndex::Optimized => ' jsonb_path_ops',
|
||||
};
|
||||
return "CREATE INDEX IF NOT EXISTS idx_{$tbl}_document ON $tableName USING GIN (data$extraOps)";
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Query;
|
||||
|
||||
use BitBadger\PDODocument\{Field, Query};
|
||||
use BitBadger\PDODocument\{DocumentException, Field, FieldMatch, Query};
|
||||
|
||||
/**
|
||||
* Queries to delete documents
|
||||
@@ -13,11 +19,13 @@ class Delete
|
||||
* Query to delete a document by its ID
|
||||
*
|
||||
* @param string $tableName The name of the table from which a document should be deleted
|
||||
* @param mixed $docId The ID of the document to be deleted (optional; string ID assumed)
|
||||
* @return string The DELETE statement to delete a document by its ID
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byId(string $tableName): string
|
||||
public static function byId(string $tableName, mixed $docId = null): string
|
||||
{
|
||||
return "DELETE FROM $tableName WHERE " . Query::whereById();
|
||||
return "DELETE FROM $tableName WHERE " . Query::whereById(docId: $docId);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -25,11 +33,36 @@ class Delete
|
||||
*
|
||||
* @param string $tableName The name of the table from which documents should be deleted
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @return string The DELETE statement to delete documents via field comparison
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): string
|
||||
public static function byFields(string $tableName, array $fields, ?FieldMatch $match = null): string
|
||||
{
|
||||
return "DELETE FROM $tableName WHERE " . Query::whereByFields($fields, $conjunction);
|
||||
return "DELETE FROM $tableName WHERE " . Query::whereByFields($fields, $match);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to delete documents using a JSON containment query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table from which documents should be deleted
|
||||
* @return string The DELETE statement to delete documents via a JSON containment query
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byContains(string $tableName): string
|
||||
{
|
||||
return "DELETE FROM $tableName WHERE " . Query::whereDataContains();
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to delete documents using a JSON Path match query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table from which documents should be deleted
|
||||
* @return string The DELETE statement to delete documents via a JSON Path match
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byJsonPath(string $tableName): string
|
||||
{
|
||||
return "DELETE FROM $tableName WHERE " . Query::whereJsonPathMatches();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Query;
|
||||
|
||||
use BitBadger\PDODocument\{Field, Query};
|
||||
use BitBadger\PDODocument\{DocumentException, Field, FieldMatch, Query};
|
||||
|
||||
/**
|
||||
* Queries to determine document existence
|
||||
@@ -25,11 +31,13 @@ class Exists
|
||||
* Query to determine if a document exists for the given ID
|
||||
*
|
||||
* @param string $tableName The name of the table in which document existence should be checked
|
||||
* @param mixed $docId The ID of the document whose existence should be checked (optional; string ID assumed)
|
||||
* @return string The query to determine document existence by ID
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byId(string $tableName): string
|
||||
public static function byId(string $tableName, mixed $docId = null): string
|
||||
{
|
||||
return self::query($tableName, Query::whereById());
|
||||
return self::query($tableName, Query::whereById(docId: $docId));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -37,11 +45,36 @@ class Exists
|
||||
*
|
||||
* @param string $tableName The name of the table in which document existence should be checked
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @return string The query to determine document existence by field comparison
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): string
|
||||
public static function byFields(string $tableName, array $fields, ?FieldMatch $match = null): string
|
||||
{
|
||||
return self::query($tableName, Query::whereByFields($fields, $conjunction));
|
||||
return self::query($tableName, Query::whereByFields($fields, $match));
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to determine if documents exist using a JSON containment query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which document existence should be checked
|
||||
* @return string The query to determine document existence by a JSON containment query
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byContains(string $tableName): string
|
||||
{
|
||||
return self::query($tableName, Query::whereDataContains());
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to determine if documents exist using a JSON Path match query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which document existence should be checked
|
||||
* @return string The query to determine document existence by a JSON Path match
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byJsonPath(string $tableName): string
|
||||
{
|
||||
return self::query($tableName, Query::whereJsonPathMatches());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,14 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Query;
|
||||
|
||||
use BitBadger\PDODocument\{Field, Query};
|
||||
use BitBadger\PDODocument\{DocumentException, Field, FieldMatch, Query};
|
||||
|
||||
/**
|
||||
* Queries for retrieving documents
|
||||
@@ -13,11 +19,13 @@ class Find
|
||||
* Query to retrieve a document by its ID
|
||||
*
|
||||
* @param string $tableName The name of the table from which a document should be retrieved
|
||||
* @param mixed $docId The ID of the document to be retrieved (optional; string ID assumed)
|
||||
* @return string The SELECT statement to retrieve a document by its ID
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byId(string $tableName): string
|
||||
public static function byId(string $tableName, mixed $docId = null): string
|
||||
{
|
||||
return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereById();
|
||||
return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereById(docId: $docId);
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -25,11 +33,36 @@ class Find
|
||||
*
|
||||
* @param string $tableName The name of the table from which documents should be retrieved
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @return string The SELECT statement to retrieve documents by field comparison
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, string $conjunction = 'AND'): string
|
||||
public static function byFields(string $tableName, array $fields, ?FieldMatch $match = null): string
|
||||
{
|
||||
return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereByFields($fields, $conjunction);
|
||||
return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereByFields($fields, $match);
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to retrieve documents using a JSON containment query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table from which documents should be retrieved
|
||||
* @return string The SELECT statement to retrieve documents by a JSON containment query
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byContains(string $tableName): string
|
||||
{
|
||||
return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereDataContains();
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to retrieve documents using a JSON Path match query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table from which documents should be retrieved
|
||||
* @return string The SELECT statement to retrieve documents by a JSON Path match
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byJsonPath(string $tableName): string
|
||||
{
|
||||
return Query::selectFromTable($tableName) . ' WHERE ' . Query::whereJsonPathMatches();
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,15 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Query;
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode, Query};
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, FieldMatch, Mode, Query};
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Queries to perform partial updates on documents
|
||||
@@ -15,14 +22,13 @@ class Patch
|
||||
* @param string $tableName The name of the table in which documents should be patched
|
||||
* @param string $whereClause The body of the WHERE clause to use in the UPDATE statement
|
||||
* @return string The UPDATE statement to perform the patch
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
public static function update(string $tableName, string $whereClause): string
|
||||
{
|
||||
$setValue = match (Configuration::$mode) {
|
||||
$setValue = match (Configuration::mode('make patch statement')) {
|
||||
Mode::PgSQL => 'data || :data',
|
||||
Mode::SQLite => 'json_patch(data, json(:data))',
|
||||
default => throw new DocumentException('Database mode not set; cannot make patch statement')
|
||||
};
|
||||
return "UPDATE $tableName SET data = $setValue WHERE $whereClause";
|
||||
}
|
||||
@@ -31,12 +37,13 @@ class Patch
|
||||
* Query to patch (partially update) a document by its ID
|
||||
*
|
||||
* @param string $tableName The name of the table in which a document should be patched
|
||||
* @param mixed $docId The ID of the document to be patched (optional; string ID assumed)
|
||||
* @return string The query to patch a document by its ID
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byId(string $tableName): string
|
||||
public static function byId(string $tableName, mixed $docId = null): string
|
||||
{
|
||||
return self::update($tableName, Query::whereById());
|
||||
return self::update($tableName, Query::whereById(docId: $docId));
|
||||
}
|
||||
|
||||
/**
|
||||
@@ -44,12 +51,36 @@ class Patch
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be patched
|
||||
* @param array|Field[] $field The field comparison to match
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @return string The query to patch documents via field comparison
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byFields(string $tableName, array $field, string $conjunction = 'AND'): string
|
||||
public static function byFields(string $tableName, array $field, ?FieldMatch $match = null): string
|
||||
{
|
||||
return self::update($tableName, Query::whereByFields($field, $conjunction));
|
||||
return self::update($tableName, Query::whereByFields($field, $match));
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to patch (partially update) a document via a JSON containment query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be patched
|
||||
* @return string The query to patch documents via a JSON containment query
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byContains(string $tableName): string
|
||||
{
|
||||
return self::update($tableName, Query::whereDataContains());
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to patch (partially update) a document via a JSON Path match query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be patched
|
||||
* @return string The query to patch documents via a JSON Path match
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byJsonPath(string $tableName): string
|
||||
{
|
||||
return self::update($tableName, Query::whereJsonPathMatches());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,8 +1,15 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument\Query;
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode, Query};
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, FieldMatch, Mode, Query};
|
||||
use Exception;
|
||||
|
||||
/**
|
||||
* Queries to remove fields from documents
|
||||
@@ -17,50 +24,74 @@ class RemoveFields
|
||||
* Create an UPDATE statement to remove fields from a JSON document
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be manipulated
|
||||
* @param array $parameters The parameter list for the query
|
||||
* @param array<string, mixed> $parameters The parameter list for the query
|
||||
* @param string $whereClause The body of the WHERE clause for the update
|
||||
* @return string The UPDATE statement to remove fields from a JSON document
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
* @throws Exception If the database mode has not been set
|
||||
*/
|
||||
public static function update(string $tableName, array $parameters, string $whereClause): string
|
||||
{
|
||||
switch (Configuration::$mode) {
|
||||
case Mode::PgSQL:
|
||||
return "UPDATE $tableName SET data = data - " . array_keys($parameters)[0] . " WHERE $whereClause";
|
||||
case Mode::SQLite:
|
||||
$paramNames = implode(', ', array_keys($parameters));
|
||||
return "UPDATE $tableName SET data = json_remove(data, $paramNames) WHERE $whereClause";
|
||||
default:
|
||||
throw new DocumentException('Database mode not set; cannot generate field removal query');
|
||||
}
|
||||
return match (Configuration::mode('generate field removal query')) {
|
||||
Mode::PgSQL => "UPDATE $tableName SET data = data - " . array_keys($parameters)[0]
|
||||
. "::text[] WHERE $whereClause",
|
||||
Mode::SQLite => "UPDATE $tableName SET data = json_remove(data, " . implode(', ', array_keys($parameters))
|
||||
. ") WHERE $whereClause",
|
||||
};
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to remove fields from a document by the document's ID
|
||||
*
|
||||
* @param string $tableName The name of the table in which the document should be manipulated
|
||||
* @param array $parameters The parameter list for the query
|
||||
* @param array<string, mixed> $parameters The parameter list for the query
|
||||
* @param mixed $docId The ID of the document from which fields should be removed (optional; string ID assumed)
|
||||
* @return string The UPDATE statement to remove fields from a document by its ID
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byId(string $tableName, array $parameters): string
|
||||
public static function byId(string $tableName, array $parameters, mixed $docId = null): string
|
||||
{
|
||||
return self::update($tableName, $parameters, Query::whereById());
|
||||
return self::update($tableName, $parameters, Query::whereById(docId: $docId));
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to remove fields from documents via a comparison on JSON fields within the document
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be manipulated
|
||||
* @param array|Field[] $fields The field comparison to match
|
||||
* @param array $parameters The parameter list for the query
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param array<string, mixed> $parameters The parameter list for the query
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @return string The UPDATE statement to remove fields from documents via field comparison
|
||||
* @throws DocumentException If the database mode has not been set
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, array $parameters,
|
||||
string $conjunction = 'AND'): string
|
||||
?FieldMatch $match = null): string
|
||||
{
|
||||
return self::update($tableName, $parameters, Query::whereByFields($fields, $conjunction));
|
||||
return self::update($tableName, $parameters, Query::whereByFields($fields, $match));
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to remove fields from documents via a JSON containment query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be manipulated
|
||||
* @param array<string, mixed> $parameters The parameter list for the query
|
||||
* @return string The UPDATE statement to remove fields from documents via a JSON containment query
|
||||
* @throws DocumentException If the database mode is not PostgreSQL
|
||||
*/
|
||||
public static function byContains(string $tableName, array $parameters): string
|
||||
{
|
||||
return self::update($tableName, $parameters, Query::whereDataContains());
|
||||
}
|
||||
|
||||
/**
|
||||
* Query to remove fields from documents via a JSON Path match query (PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The name of the table in which documents should be manipulated
|
||||
* @param array<string, mixed> $parameters The parameter list for the query
|
||||
* @return string The UPDATE statement to remove fields from documents via a JSON Path match
|
||||
* @throws DocumentException
|
||||
*/
|
||||
public static function byJsonPath(string $tableName, array $parameters): string
|
||||
{
|
||||
return self::update($tableName, $parameters, Query::whereJsonPathMatches());
|
||||
}
|
||||
}
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace BitBadger\PDODocument;
|
||||
|
||||
@@ -12,13 +18,13 @@ class RemoveFields
|
||||
*
|
||||
* @param string $tableName The table in which the document should have fields removed
|
||||
* @param mixed $docId The ID of the document from which fields should be removed
|
||||
* @param array|string[] $fieldNames The names of the fields to be removed
|
||||
* @param string[] $fieldNames The names of the fields to be removed
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function byId(string $tableName, mixed $docId, array $fieldNames): void
|
||||
{
|
||||
$nameParams = Parameters::fieldNames(':name', $fieldNames);
|
||||
Custom::nonQuery(Query\RemoveFields::byId($tableName, $nameParams),
|
||||
Custom::nonQuery(Query\RemoveFields::byId($tableName, $nameParams, $docId),
|
||||
array_merge(Parameters::id($docId), $nameParams));
|
||||
}
|
||||
|
||||
@@ -26,17 +32,47 @@ class RemoveFields
|
||||
* Remove fields from documents via a comparison on a JSON field in the document
|
||||
*
|
||||
* @param string $tableName The table in which documents should have fields removed
|
||||
* @param array|Field[] $fields The field comparison to match
|
||||
* @param array|string[] $fieldNames The names of the fields to be removed
|
||||
* @param string $conjunction How to handle multiple conditions (optional; defaults to `AND`)
|
||||
* @param Field[] $fields The field comparison to match
|
||||
* @param string[] $fieldNames The names of the fields to be removed
|
||||
* @param FieldMatch|null $match How to handle multiple conditions (optional; defaults to All)
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function byFields(string $tableName, array $fields, array $fieldNames,
|
||||
string $conjunction = 'AND'): void
|
||||
?FieldMatch $match = null): void
|
||||
{
|
||||
$nameParams = Parameters::fieldNames(':name', $fieldNames);
|
||||
$namedFields = Parameters::nameFields($fields);
|
||||
Custom::nonQuery(Query\RemoveFields::byFields($tableName, $namedFields, $nameParams, $conjunction),
|
||||
Parameters::addFields($namedFields, $nameParams));
|
||||
Parameters::nameFields($fields);
|
||||
Custom::nonQuery(Query\RemoveFields::byFields($tableName, $fields, $nameParams, $match),
|
||||
Parameters::addFields($fields, $nameParams));
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove fields from documents via a JSON containment query (`@>`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The table in which documents should have fields removed
|
||||
* @param mixed[]|object $criteria The JSON containment query values
|
||||
* @param string[] $fieldNames The names of the fields to be removed
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byContains(string $tableName, array|object $criteria, array $fieldNames): void
|
||||
{
|
||||
$nameParams = Parameters::fieldNames(':name', $fieldNames);
|
||||
Custom::nonQuery(Query\RemoveFields::byContains($tableName, $nameParams),
|
||||
array_merge(Parameters::json(':criteria', $criteria), $nameParams));
|
||||
}
|
||||
|
||||
/**
|
||||
* Remove fields from documents via a JSON Path match query (`@?`; PostgreSQL only)
|
||||
*
|
||||
* @param string $tableName The table in which documents should have fields removed
|
||||
* @param string $path The JSON Path match string
|
||||
* @param string[] $fieldNames The names of the fields to be removed
|
||||
* @throws DocumentException If the database mode is not PostgreSQL, or if an error occurs
|
||||
*/
|
||||
public static function byJsonPath(string $tableName, string $path, array $fieldNames): void
|
||||
{
|
||||
$nameParams = Parameters::fieldNames(':name', $fieldNames);
|
||||
Custom::nonQuery(Query\RemoveFields::byJsonPath($tableName, $nameParams),
|
||||
array_merge([':path' => $path], $nameParams));
|
||||
}
|
||||
}
|
||||
|
||||
35
tests/Integration/ArrayDocument.php
Normal file
35
tests/Integration/ArrayDocument.php
Normal file
@@ -0,0 +1,35 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration;
|
||||
|
||||
/**
|
||||
* A document with an array of values
|
||||
*/
|
||||
class ArrayDocument
|
||||
{
|
||||
/**
|
||||
* @param string $id The ID of the document
|
||||
* @param string[] $values The values for the document
|
||||
*/
|
||||
public function __construct(public string $id = '', public array $values = []) { }
|
||||
|
||||
/**
|
||||
* A set of documents used for integration tests
|
||||
*
|
||||
* @return ArrayDocument[] Test documents for InArray tests
|
||||
*/
|
||||
public static function testDocuments(): array
|
||||
{
|
||||
return [
|
||||
new ArrayDocument('first', ['a', 'b', 'c']),
|
||||
new ArrayDocument('second', ['c', 'd', 'e']),
|
||||
new ArrayDocument('third', ['x', 'y', 'z'])
|
||||
];
|
||||
}
|
||||
}
|
||||
17
tests/Integration/NumDocument.php
Normal file
17
tests/Integration/NumDocument.php
Normal file
@@ -0,0 +1,17 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration;
|
||||
|
||||
/**
|
||||
* A test document with a numeric ID
|
||||
*/
|
||||
class NumDocument
|
||||
{
|
||||
public function __construct(public int $id = 0, public string $value = '') { }
|
||||
}
|
||||
60
tests/Integration/PgIntegrationTest.php
Normal file
60
tests/Integration/PgIntegrationTest.php
Normal file
@@ -0,0 +1,60 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
* @see https://github.com/Zaid-Ajaj/ThrowawayDb The origin concept
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration;
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, Custom, Delete, DocumentException, Field};
|
||||
use BitBadger\PDODocument\Mapper\ExistsMapper;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
|
||||
/**
|
||||
* Integration Test Class wrapper for PostgreSQL integration tests
|
||||
*/
|
||||
class PgIntegrationTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
static private string $dbName = '';
|
||||
|
||||
public static function setUpBeforeClass(): void
|
||||
{
|
||||
self::$dbName = ThrowawayDb::create(false);
|
||||
}
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
ThrowawayDb::loadData();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
Delete::byFields(ThrowawayDb::TABLE, [ Field::exists(Configuration::$idField)]);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public static function tearDownAfterClass(): void
|
||||
{
|
||||
ThrowawayDb::destroy(self::$dbName);
|
||||
self::$dbName = '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Does the given named object exist in the database?
|
||||
*
|
||||
* @param string $name The name of the object whose existence should be verified
|
||||
* @return bool True if the object exists, false if not
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
protected function dbObjectExists(string $name): bool
|
||||
{
|
||||
return Custom::scalar('SELECT EXISTS (SELECT 1 FROM pg_class WHERE relname = :name)',
|
||||
[':name' => $name], new ExistsMapper());
|
||||
}
|
||||
}
|
||||
45
tests/Integration/PostgreSQL/CountTest.php
Normal file
45
tests/Integration/PostgreSQL/CountTest.php
Normal file
@@ -0,0 +1,45 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Count, Field};
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::all()', function () {
|
||||
test('counts all documents', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('counts for numeric range correctly', function () {
|
||||
expect(Count::byFields(ThrowawayDb::TABLE, [Field::between('num_value', 10, 20)]))->toBe(3);
|
||||
});
|
||||
test('counts for non-numeric range correctly', function () {
|
||||
expect(Count::byFields(ThrowawayDb::TABLE, [Field::between('value', 'aardvark', 'apple')]))->toBe(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('counts matching documents', function () {
|
||||
expect(Count::byContains(ThrowawayDb::TABLE, ['value' => 'purple']))->toBe(2);
|
||||
});
|
||||
test('returns 0 for no matching documents', function () {
|
||||
expect(Count::byContains(ThrowawayDb::TABLE, ['value' => 'magenta']))->toBe(0);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('counts matching documents', function () {
|
||||
expect(Count::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ < 5)'))->toBe(2);
|
||||
});
|
||||
test('returns 0 for no matching documents', function () {
|
||||
expect(Count::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 100)'))->toBe(0);
|
||||
});
|
||||
});
|
||||
98
tests/Integration/PostgreSQL/CustomTest.php
Normal file
98
tests/Integration/PostgreSQL/CustomTest.php
Normal file
@@ -0,0 +1,98 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Count, Custom, DocumentException, Query};
|
||||
use BitBadger\PDODocument\Mapper\{CountMapper, DocumentMapper};
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::runQuery()', function () {
|
||||
test('runs a valid query successfully', function () {
|
||||
$stmt = &Custom::runQuery('SELECT data FROM ' . ThrowawayDb::TABLE . ' LIMIT 1', []);
|
||||
try {
|
||||
expect($stmt)->not->toBeNull();
|
||||
} finally {
|
||||
$stmt = null;
|
||||
}
|
||||
});
|
||||
test('fails with an invalid query', function () {
|
||||
$stmt = null;
|
||||
try {
|
||||
expect(function () use (&$stmt) { $stmt = &Custom::runQuery('GRAB stuff FROM over_there UNTIL done', []); })
|
||||
->toThrow(DocumentException::class);
|
||||
} finally {
|
||||
$stmt = null;
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('::list()', function () {
|
||||
test('returns non-empty list when data found', function () {
|
||||
$list = Custom::list(Query::selectFromTable(ThrowawayDb::TABLE), [], new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($list->items() as $ignored) $count++;
|
||||
expect($count)->toBe(5);
|
||||
});
|
||||
test('returns empty list when no data found', function () {
|
||||
expect(Custom::list(
|
||||
Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE (data->>'num_value')::numeric > :value",
|
||||
[':value' => 100], new DocumentMapper(TestDocument::class)))
|
||||
->not->toBeNull()
|
||||
->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::array()', function () {
|
||||
test('returns non-empty array when data found', function () {
|
||||
expect(Custom::array(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'sub' IS NOT NULL", [],
|
||||
new DocumentMapper(TestDocument::class)))
|
||||
->not->toBeNull()
|
||||
->toHaveCount(2);
|
||||
});
|
||||
test('returns empty array when no data found', function () {
|
||||
expect(Custom::array(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'value' = :value",
|
||||
[':value' => 'not there'], new DocumentMapper(TestDocument::class)))
|
||||
->not->toBeNull()
|
||||
->toBeEmpty();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::single()', function () {
|
||||
test('returns a document when one is found', function () {
|
||||
expect(Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'one'],
|
||||
new DocumentMapper(TestDocument::class)))
|
||||
->isSome()->toBeTrue()
|
||||
->get()->id->toBe('one');
|
||||
});
|
||||
test('returns no document when one is not found', function () {
|
||||
expect(Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id",
|
||||
[':id' => 'eighty'], new DocumentMapper(TestDocument::class)))
|
||||
->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::nonQuery()', function () {
|
||||
test('works when documents match the WHERE clause', function () {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(0);
|
||||
});
|
||||
test('works when no documents match the WHERE clause', function () {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE . " WHERE (data->>'num_value')::numeric > :value",
|
||||
[':value' => 100]);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::scalar()', function () {
|
||||
test('returns a scalar value', function () {
|
||||
expect(Custom::scalar("SELECT 5 AS it", [], new CountMapper()))->toBe(5);
|
||||
});
|
||||
});
|
||||
47
tests/Integration/PostgreSQL/DefinitionTest.php
Normal file
47
tests/Integration/PostgreSQL/DefinitionTest.php
Normal file
@@ -0,0 +1,47 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Definition, DocumentIndex};
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::ensureTable()', function () {
|
||||
test('creates a table', function () {
|
||||
expect($this->dbObjectExists('ensured'))->toBeFalse()
|
||||
->and($this->dbObjectExists('idx_ensured_key'))->toBeFalse();
|
||||
Definition::ensureTable('ensured');
|
||||
expect($this->dbObjectExists('ensured'))->toBeTrue()
|
||||
->and($this->dbObjectExists('idx_ensured_key'))->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::ensureFieldIndex()', function () {
|
||||
test('creates an index', function () {
|
||||
expect($this->dbObjectExists('idx_ensured_test'))->toBeFalse();
|
||||
Definition::ensureTable('ensured');
|
||||
Definition::ensureFieldIndex('ensured', 'test', ['name', 'age']);
|
||||
expect($this->dbObjectExists('idx_ensured_test'))->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::ensureDocumentIndex()', function () {
|
||||
test('creates a full index', function () {
|
||||
$docIdx = 'idx_doc_table_document';
|
||||
Definition::ensureTable('doc_table');
|
||||
expect($this->dbObjectExists($docIdx))->toBeFalse();
|
||||
Definition::ensureDocumentIndex('doc_table', DocumentIndex::Full);
|
||||
expect($this->dbObjectExists($docIdx))->toBeTrue();
|
||||
});
|
||||
test('creates an optimized index', function () {
|
||||
$docIdx = 'idx_doc_tbl_document';
|
||||
Definition::ensureTable('doc_tbl');
|
||||
expect($this->dbObjectExists($docIdx))->toBeFalse();
|
||||
Definition::ensureDocumentIndex('doc_tbl', DocumentIndex::Optimized);
|
||||
expect($this->dbObjectExists($docIdx))->toBeTrue();
|
||||
});
|
||||
});
|
||||
64
tests/Integration/PostgreSQL/DeleteTest.php
Normal file
64
tests/Integration/PostgreSQL/DeleteTest.php
Normal file
@@ -0,0 +1,64 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Count, Delete, Field};
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('deletes a document when ID is matched', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byId(ThrowawayDb::TABLE, 'four');
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(4);
|
||||
});
|
||||
test('does not delete a document when ID is not matched', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byId(ThrowawayDb::TABLE, 'negative four');
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('deletes documents when fields match', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::notEqual('value', 'purple')]);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(2);
|
||||
});
|
||||
test('does not delete documents when fields are not matched', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::equal('value', 'crimson')]);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('deletes documents when containment matches', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byContains(ThrowawayDb::TABLE, ['value' => 'purple']);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(3);
|
||||
});
|
||||
test('does not delete documents when containment is not matched', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byContains(ThrowawayDb::TABLE, ['target' => 'acquired']);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('deletes documents when path matches', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ <> 0)');
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(1);
|
||||
});
|
||||
test('does not delete documents when path is not matched', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ < 0)');
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
96
tests/Integration/PostgreSQL/DocumentListTest.php
Normal file
96
tests/Integration/PostgreSQL/DocumentListTest.php
Normal file
@@ -0,0 +1,96 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{DocumentException, DocumentList, Query};
|
||||
use BitBadger\PDODocument\Mapper\DocumentMapper;
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::create()', function () {
|
||||
test('creates a document list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull();
|
||||
$list = null; // free database result
|
||||
});
|
||||
});
|
||||
|
||||
describe('->items()', function () {
|
||||
test('enumerates items in the list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($list->items() as $item) {
|
||||
expect(['one', 'two', 'three', 'four', 'five'])->toContain($item->id);
|
||||
$count++;
|
||||
}
|
||||
expect($count)->toBe(5);
|
||||
});
|
||||
test('fails when the list is exhausted', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
$ignored = iterator_to_array($list->items());
|
||||
expect($list)->hasItems()->toBeFalse()
|
||||
->and(fn () => iterator_to_array($list->items()))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('->hasItems()', function () {
|
||||
test('returns false when no items are in the list', function () {
|
||||
expect(DocumentList::create(
|
||||
Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE (data->>'num_value')::numeric < 0", [],
|
||||
new DocumentMapper(TestDocument::class)))
|
||||
->not->toBeNull()
|
||||
->hasItems()->toBeFalse();
|
||||
});
|
||||
test('returns true when items are in the list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
foreach ($list->items() as $ignored) {
|
||||
expect($list)->hasItems()->toBeTrue();
|
||||
}
|
||||
expect($list)->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('->map()', function () {
|
||||
test('transforms the list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
foreach ($list->map(fn($doc) => strrev($doc->id)) as $mapped) {
|
||||
expect(['eno', 'owt', 'eerht', 'ruof', 'evif'])->toContain($mapped);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('->iter()', function () {
|
||||
test('walks the list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
$splats = [];
|
||||
$list->iter(function ($doc) use (&$splats) { $splats[] = str_repeat('*', strlen($doc->id)); });
|
||||
expect(implode(' ', $splats))->toBe('*** *** ***** **** ****');
|
||||
});
|
||||
});
|
||||
|
||||
describe('->mapToArray()', function () {
|
||||
test('creates an associative array', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue()
|
||||
->and($list->mapToArray(fn($it) => $it->id, fn($it) => $it->value))
|
||||
->toBe(['one' => 'FIRST!', 'two' => 'another', 'three' => '', 'four' => 'purple', 'five' => 'purple']);
|
||||
});
|
||||
});
|
||||
249
tests/Integration/PostgreSQL/DocumentTest.php
Normal file
249
tests/Integration/PostgreSQL/DocumentTest.php
Normal file
@@ -0,0 +1,249 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{AutoId, Configuration, Custom, Document, DocumentException, Field, Find, Query};
|
||||
use BitBadger\PDODocument\Mapper\ArrayMapper;
|
||||
use Test\Integration\{NumDocument, SubDocument, TestDocument};
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::insert()', function () {
|
||||
test('inserts an array with no automatic ID', function () {
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => 'turkey', 'sub' => ['foo' => 'gobble', 'bar' => 'gobble']]);
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class);
|
||||
expect($tryDoc)
|
||||
->isSome()->toBeTrue()
|
||||
->and($tryDoc->get())
|
||||
->id->toBe('turkey')
|
||||
->value->toBe('')
|
||||
->num_value->toBe(0)
|
||||
->sub->not->toBeNull()
|
||||
->sub->foo->toBe('gobble')
|
||||
->sub->bar->toBe('gobble');
|
||||
});
|
||||
test('inserts an array with auto-number ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::Number;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => 0, 'value' => 'new', 'num_value' => 8]);
|
||||
$doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE, [], new ArrayMapper());
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and(json_decode($doc->get()['data']))
|
||||
->id->toBe(1);
|
||||
|
||||
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());
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and(json_decode($doc->get()['data']))
|
||||
->id->toBe(2);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-number ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::Number;
|
||||
try {
|
||||
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());
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and(json_decode($doc->get()['data']))
|
||||
->id->toBe(7);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
|
||||
});
|
||||
test('inserts an array with auto-UUID ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::UUID;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => '', 'num_value' => 5]);
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 5)], TestDocument::class);
|
||||
expect($doc)
|
||||
->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->not->toBeEmpty();
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-UUID ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::UUID;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
$uuid = AutoId::generateUUID();
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => $uuid, 'value' => 'uuid', 'num_value' => 12]);
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 12)], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toBe($uuid);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-string ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::RandomString;
|
||||
Configuration::$idStringLength = 6;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => '', 'value' => 'new', 'num_value' => 8]);
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 8)], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toHaveLength(6);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
Configuration::$idStringLength = 16;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-string ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::RandomString;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => 'my-key', 'value' => 'old', 'num_value' => 3]);
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 3)], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toBe('my-key');
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with no automatic ID', function () {
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument('turkey', sub: new SubDocument('gobble', 'gobble')));
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue();
|
||||
$doc = $tryDoc->get();
|
||||
expect($doc)
|
||||
->id->toBe('turkey')
|
||||
->num_value->toBe(0)
|
||||
->sub->not->toBeNull()
|
||||
->sub->foo->toBe('gobble')
|
||||
->sub->bar->toBe('gobble')
|
||||
->and($doc->value)->toBe('');
|
||||
});
|
||||
test('inserts an object with auto-number ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::Number;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
|
||||
Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'taco'));
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'taco')], NumDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toBe(1);
|
||||
|
||||
Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'burrito'));
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'burrito')], NumDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toBe(2);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-number ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::Number;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, new NumDocument(64, 'large'));
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'large')], NumDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toBe(64);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-UUID ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::UUID;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument(value: 'something', num_value: 9));
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::exists('value')], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->not->toBeEmpty();
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-UUID ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::UUID;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
$uuid = AutoId::generateUUID();
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument($uuid, num_value: 14));
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 14)], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toBe($uuid);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-string ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::RandomString;
|
||||
Configuration::$idStringLength = 40;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument(num_value: 55));
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 55)], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toHaveLength(40);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
Configuration::$idStringLength = 16;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-string ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::RandomString;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument('my-key', num_value: 3));
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 3)], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and($doc->get())->id->toBe('my-key');
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('throws an exception for duplicate key', function () {
|
||||
expect(fn () => Document::insert(ThrowawayDb::TABLE, new TestDocument('one')))
|
||||
->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::save()', function () {
|
||||
test('inserts a new document', function () {
|
||||
Document::save(ThrowawayDb::TABLE, new TestDocument('test', sub: new SubDocument('a', 'b')));
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class))->isSome()->toBeTrue();
|
||||
});
|
||||
test('updates an existing document', function () {
|
||||
Document::save(ThrowawayDb::TABLE, new TestDocument('two', num_value: 44));
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue()
|
||||
->and($tryDoc->get())
|
||||
->num_value->toBe(44)
|
||||
->sub->toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::update()', function () {
|
||||
test('replaces an existing document', function () {
|
||||
Document::update(ThrowawayDb::TABLE, 'one', new TestDocument('one', 'howdy', 8, new SubDocument('y', 'z')));
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue();
|
||||
$doc = $tryDoc->get();
|
||||
expect($doc)
|
||||
->num_value->toBe(8)
|
||||
->sub->not->toBeNull()
|
||||
->sub->foo->toBe('y')
|
||||
->sub->bar->toBe('z')
|
||||
->and($doc->value)->toBe('howdy');
|
||||
});
|
||||
test('does nothing for a non-existent document', function () {
|
||||
Document::update(ThrowawayDb::TABLE, 'two-hundred', new TestDocument('200'));
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'two-hundred', TestDocument::class))->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
48
tests/Integration/PostgreSQL/ExistsTest.php
Normal file
48
tests/Integration/PostgreSQL/ExistsTest.php
Normal file
@@ -0,0 +1,48 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Exists, Field};
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('returns true when a document exists', function () {
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, 'three'))->toBeTrue();
|
||||
});
|
||||
test('returns false when a document does not exist', function () {
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, 'seven'))->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('returns true when matching documents exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::equal('num_value', 10)]))->toBeTrue();
|
||||
});
|
||||
test('returns false when no matching documents exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::less('nothing', 'none')]))->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('returns true when matching documents exist', function () {
|
||||
expect(Exists::byContains(ThrowawayDb::TABLE, ['value' => 'purple']))->toBeTrue();
|
||||
});
|
||||
test('returns false when no matching documents exist', function () {
|
||||
expect(Exists::byContains(ThrowawayDb::TABLE, ['value' => 'violet']))->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('returns true when matching documents exist', function () {
|
||||
expect(Exists::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ == 10)'))->toBeTrue();
|
||||
});
|
||||
test('returns false when no matching documents exist', function () {
|
||||
expect(Exists::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ == 10.1)'))->toBeFalse();
|
||||
});
|
||||
});
|
||||
216
tests/Integration/PostgreSQL/FindTest.php
Normal file
216
tests/Integration/PostgreSQL/FindTest.php
Normal file
@@ -0,0 +1,216 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Custom, Delete, Document, Field, FieldMatch, Find};
|
||||
use Test\Integration\{ArrayDocument, NumDocument, TestDocument};
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::all()', function () {
|
||||
test('retrieves data', function () {
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(5);
|
||||
});
|
||||
test('sorts data ascending', function () {
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class, [Field::named('id')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))
|
||||
->toBe(['five', 'four', 'one', 'three', 'two']);
|
||||
});
|
||||
test('sorts data descending', function () {
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class, [Field::named('id DESC')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))
|
||||
->toBe(['two', 'three', 'one', 'four', 'five']);
|
||||
});
|
||||
test('sorts data numerically', function () {
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class,
|
||||
[Field::named('sub.foo NULLS LAST'), Field::named('n:num_value')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))
|
||||
->toBe(['two', 'four', 'one', 'three', 'five']);
|
||||
});
|
||||
test('retrieves empty results', function () {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
expect(Find::all(ThrowawayDb::TABLE, TestDocument::class))
|
||||
->not->toBeNull()
|
||||
->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('retrieves a document via string ID', function () {
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class))
|
||||
->isSome()->toBeTrue()
|
||||
->get()->id->toBe('two');
|
||||
});
|
||||
test('retrieves a document via numeric ID', function () {
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::notExists('absent')]);
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => 18, 'value' => 'howdy']);
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 18, NumDocument::class))
|
||||
->isSome()->toBeTrue()
|
||||
->get()->id->toBe(18);
|
||||
});
|
||||
test('returns None when a document is not found', function () {
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'seventy-five', TestDocument::class))->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('retrieves matching documents', function () {
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::in('value', ['blue', 'purple']), Field::exists('sub')],
|
||||
TestDocument::class, FieldMatch::All);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(1);
|
||||
});
|
||||
test('retrieves ordered matching documents', function () {
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::equal('value', 'purple')], TestDocument::class,
|
||||
FieldMatch::All, [Field::named('id')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))->toBe(['five', 'four']);
|
||||
});
|
||||
test('retrieves documents matching a numeric IN clause', function () {
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::in('num_value', [2, 4, 6, 8])], TestDocument::class);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(1);
|
||||
});
|
||||
test('returns an empty list when no matching documents are found', function () {
|
||||
expect(Find::byFields(ThrowawayDb::TABLE, [Field::greater('num_value', 100)], TestDocument::class))
|
||||
->not->toBeNull()
|
||||
->hasItems()->toBeFalse();
|
||||
});
|
||||
test('retrieves documents matching an inArray condition', function () {
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::notExists('absentField')]);
|
||||
foreach (ArrayDocument::testDocuments() as $doc) Document::insert(ThrowawayDb::TABLE, $doc);
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::inArray('values', ThrowawayDb::TABLE, ['c'])],
|
||||
ArrayDocument::class);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(2);
|
||||
});
|
||||
test('returns an empty list when no documents match an inArray condition', function () {
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::notExists('absentField')]);
|
||||
foreach (ArrayDocument::testDocuments() as $doc) Document::insert(ThrowawayDb::TABLE, $doc);
|
||||
expect(Find::byFields(ThrowawayDb::TABLE, [Field::inArray('values', ThrowawayDb::TABLE, ['j'])],
|
||||
ArrayDocument::class))
|
||||
->not->toBeNull()
|
||||
->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('retrieves matching documents', function () {
|
||||
$docs = Find::byContains(ThrowawayDb::TABLE, ['value' => 'purple'], TestDocument::class);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(2);
|
||||
});
|
||||
test('retrieves ordered matching documents', function () {
|
||||
$docs = Find::byContains(ThrowawayDb::TABLE, ['sub' => ['foo' => 'green']], TestDocument::class,
|
||||
[Field::named('value')]);
|
||||
expect($docs)
|
||||
->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))->toBe(['two', 'four']);
|
||||
});
|
||||
test('returns an empty list when no documents match', function () {
|
||||
expect(Find::byContains(ThrowawayDb::TABLE, ['value' => 'indigo'], TestDocument::class))
|
||||
->not->toBeNull()
|
||||
->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('retrieves matching documents', function () {
|
||||
$docs = Find::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(2);
|
||||
});
|
||||
test('retrieves ordered matching documents', function () {
|
||||
$docs = Find::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class,
|
||||
[Field::named('id')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))->toBe(['five', 'four']);
|
||||
});
|
||||
test('returns an empty list when no documents match', function () {
|
||||
expect(Find::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 100)', TestDocument::class))
|
||||
->not->toBeNull()
|
||||
->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::firstByFields()', function () {
|
||||
test('retrieves a matching document', function () {
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'another')], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('two');
|
||||
});
|
||||
test('retrieves a document for multiple results', function () {
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('sub.foo', 'green')], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()->and(['two', 'four'])->toContain($doc->get()->id);
|
||||
});
|
||||
test('retrieves a document for multiple ordered results', function () {
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('sub.foo', 'green')], TestDocument::class,
|
||||
orderBy: [Field::named('n:num_value DESC')]))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('four');
|
||||
});
|
||||
test('returns None when no documents match', function () {
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'absent')], TestDocument::class))
|
||||
->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::firstByContains()', function () {
|
||||
test('retrieves a matching document', function () {
|
||||
expect(Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'FIRST!'], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('one');
|
||||
});
|
||||
test('retrieves a document for multiple results', function () {
|
||||
$doc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'purple'], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()->and(['four', 'five'])->toContain($doc->get()->id);
|
||||
});
|
||||
test('retrieves a document for multiple ordered results', function () {
|
||||
expect(Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'purple'], TestDocument::class,
|
||||
[Field::named('sub.bar NULLS FIRST')]))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('five');
|
||||
});
|
||||
test('returns None when no documents match', function () {
|
||||
expect(Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'indigo'], TestDocument::class))
|
||||
->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::firstByJsonPath()', function () {
|
||||
test('retrieves a matching document', function () {
|
||||
expect(Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ == 10)', TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('two');
|
||||
});
|
||||
test('retrieves a document for multiple results', function () {
|
||||
$doc = Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()->and(['four', 'five'])->toContain($doc->get()->id);
|
||||
});
|
||||
test('retrieves a document for multiple ordered results', function () {
|
||||
expect(Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class,
|
||||
[Field::named('id DESC')]))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('four');
|
||||
});
|
||||
test('returns None when no documents match', function () {
|
||||
expect(Find::firstByJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 100)', TestDocument::class))
|
||||
->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
72
tests/Integration/PostgreSQL/PatchTest.php
Normal file
72
tests/Integration/PostgreSQL/PatchTest.php
Normal file
@@ -0,0 +1,72 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Count, Exists, Field, Find, Patch};
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('updates an existing document', function () {
|
||||
Patch::byId(ThrowawayDb::TABLE, 'one', ['num_value' => 44]);
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class))
|
||||
->isSome()->toBeTrue()
|
||||
->get()->num_value->toBe(44);
|
||||
});
|
||||
test('does nothing when a document does not exist', function () {
|
||||
$id = 'forty-seven';
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, $id))->toBeFalse();
|
||||
Patch::byId(ThrowawayDb::TABLE, $id, ['foo' => 'green']); // no exception = pass
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('updates existing documents', function () {
|
||||
Patch::byFields(ThrowawayDb::TABLE, [Field::equal('value', 'purple')], ['num_value' => 77]);
|
||||
expect(Count::byFields(ThrowawayDb::TABLE, [Field::equal('num_value', 77)]))->toBe(2);
|
||||
});
|
||||
test('does nothing when no matching documents exist', function () {
|
||||
$fields = [Field::equal('value', 'burgundy')];
|
||||
expect(Count::byFields(ThrowawayDb::TABLE, $fields))->toBe(0);
|
||||
Patch::byFields(ThrowawayDb::TABLE, $fields, ['foo' => 'green']); // no exception = pass
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('updates existing documents', function () {
|
||||
Patch::byContains(ThrowawayDb::TABLE, ['value' => 'another'], ['num_value' => 12]);
|
||||
$tryDoc = Find::firstByContains(ThrowawayDb::TABLE, ['value' => 'another'], TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue()
|
||||
->and($tryDoc->get())
|
||||
->id->toBe('two')
|
||||
->num_value->toBe(12);
|
||||
});
|
||||
test('does nothing when no matching documents exist', function () {
|
||||
$criteria = ['value' => 'updated'];
|
||||
expect(Count::byContains(ThrowawayDb::TABLE, $criteria))->toBe(0);
|
||||
Patch::byContains(ThrowawayDb::TABLE, $criteria, ['sub.foo' => 'green']); // no exception = pass
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('updates existing documents', function () {
|
||||
Patch::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', ['value' => 'blue']);
|
||||
$docs = Find::byJsonPath(ThrowawayDb::TABLE, '$.num_value ? (@ > 10)', TestDocument::class);
|
||||
expect($docs)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
foreach ($docs->items() as $item) {
|
||||
expect(['four', 'five'])->toContain($item->id)
|
||||
->and($item->value)->toBe('blue');
|
||||
}
|
||||
});
|
||||
test('does nothing when no matching documents exist', function () {
|
||||
$path = '$.num_value ? (@ > 100)';
|
||||
expect(Count::byJsonPath(ThrowawayDb::TABLE, $path))->toBe(0);
|
||||
Patch::byJsonPath(ThrowawayDb::TABLE, $path, ['value' => 'blue']); // no exception = pass
|
||||
});
|
||||
});
|
||||
91
tests/Integration/PostgreSQL/RemoveFieldsTest.php
Normal file
91
tests/Integration/PostgreSQL/RemoveFieldsTest.php
Normal file
@@ -0,0 +1,91 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Exists, Field, Find, RemoveFields};
|
||||
use Test\Integration\PostgreSQL\ThrowawayDb;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
pest()->group('integration', 'postgresql');
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('removes fields', function () {
|
||||
RemoveFields::byId(ThrowawayDb::TABLE, 'two', ['sub', 'value']);
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue();
|
||||
$doc = $tryDoc->get();
|
||||
expect($doc)->sub->toBeNull()
|
||||
->and($doc->value)->toBeEmpty();
|
||||
});
|
||||
test('does nothing when the field to remove does not exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::exists('a_field_that_does_not_exist')]))->toBeFalse();
|
||||
RemoveFields::byId(ThrowawayDb::TABLE, 'one', ['a_field_that_does_not_exist']); // no exception = pass
|
||||
});
|
||||
test('does nothing when the document does not exist', function () {
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, 'fifty'))->toBeFalse();
|
||||
RemoveFields::byId(ThrowawayDb::TABLE, 'fifty', ['sub']); // no exception = pass
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('removes fields from matching documents', function () {
|
||||
RemoveFields::byFields(ThrowawayDb::TABLE, [Field::equal('num_value', 17)], ['sub']);
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 17)], TestDocument::class))
|
||||
->isSome()->toBeTrue()
|
||||
->get()->sub->toBeNull();
|
||||
});
|
||||
test('does nothing when the field to remove does not exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::exists('nada')]))->toBeFalse();
|
||||
RemoveFields::byFields(ThrowawayDb::TABLE, [Field::equal('num_value', 17)], ['nada']); // no exception = pass
|
||||
});
|
||||
test('does nothing when no documents match', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::notEqual('missing', 'nope')]))->toBeFalse();
|
||||
RemoveFields::byFields(ThrowawayDb::TABLE, [Field::notEqual('missing', 'nope')], ['value']); // no exn = pass
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('removes fields from matching documents', function () {
|
||||
$criteria = ['sub' => ['foo' => 'green']];
|
||||
RemoveFields::byContains(ThrowawayDb::TABLE, $criteria, ['value']);
|
||||
$docs = Find::byContains(ThrowawayDb::TABLE, $criteria, TestDocument::class);
|
||||
expect($docs)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
foreach ($docs->items() as $item) {
|
||||
expect(['two', 'four'])->toContain($item->id)
|
||||
->and($item->value)->toBeEmpty();
|
||||
}
|
||||
});
|
||||
test('does nothing when the field to remove does not exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::exists('invalid_field')]))->toBeFalse();
|
||||
RemoveFields::byContains(ThrowawayDb::TABLE, ['sub' => ['foo' => 'green']], ['invalid_field']); // no exn = pass
|
||||
});
|
||||
test('does nothing when no documents match', function () {
|
||||
expect(Exists::byContains(ThrowawayDb::TABLE, ['value' => 'substantial']))->toBeFalse();
|
||||
RemoveFields::byContains(ThrowawayDb::TABLE, ['value' => 'substantial'], ['num_value']); // no exception = pass
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('removes fields from matching documents', function () {
|
||||
$path = '$.value ? (@ == "purple")';
|
||||
RemoveFields::byJsonPath(ThrowawayDb::TABLE, $path, ['sub']);
|
||||
$docs = Find::byJsonPath(ThrowawayDb::TABLE, $path, TestDocument::class);
|
||||
expect($docs)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
foreach ($docs->items() as $item) {
|
||||
expect(['four', 'five'])->toContain($item->id)
|
||||
->and($item->sub)->toBeNull();
|
||||
}
|
||||
});
|
||||
test('does nothing when the field to remove does not exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::exists('submarine')]))->toBeFalse();
|
||||
RemoveFields::byJsonPath(ThrowawayDb::TABLE, '$.value ? (@ == "purple")', ['submarine']); // no exception = pass
|
||||
});
|
||||
test('does nothing when no documents match', function () {
|
||||
expect(Exists::byJsonPath(ThrowawayDb::TABLE, '$.value ? (@ == "mauve")'))->toBeFalse();
|
||||
RemoveFields::byJsonPath(ThrowawayDb::TABLE, '$.value ? (@ == "mauve")', ['value']); // no exception = pass
|
||||
});
|
||||
});
|
||||
92
tests/Integration/PostgreSQL/ThrowawayDb.php
Normal file
92
tests/Integration/PostgreSQL/ThrowawayDb.php
Normal file
@@ -0,0 +1,92 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
* @see https://github.com/Zaid-Ajaj/ThrowawayDb The origin concept
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\PostgreSQL;
|
||||
|
||||
use BitBadger\PDODocument\{AutoId, Configuration, Custom, Definition, Document, DocumentException};
|
||||
use Random\RandomException;
|
||||
use Test\Integration\{SubDocument, TestDocument};
|
||||
|
||||
/**
|
||||
* Utilities to create and destroy a throwaway PostgreSQL database to use for testing
|
||||
*/
|
||||
class ThrowawayDb
|
||||
{
|
||||
/** @var string The table used for document manipulation */
|
||||
public const TABLE = 'test_table';
|
||||
|
||||
/**
|
||||
* Configure the document library for the given database (or the main PostgreSQL connection, if the database name
|
||||
* is not provided; this is used for creating and dropping databases)
|
||||
*
|
||||
* @param string|null $dbName The name of the database to configure (optional, defaults to env or "postgres")
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
private static function configure(?string $dbName = null): void
|
||||
{
|
||||
Configuration::useDSN(sprintf("pgsql:host=%s;dbname=%s", $_ENV['PDO_DOC_PGSQL_HOST'] ?? 'localhost',
|
||||
$dbName ?? $_ENV['PDO_DOC_PGSQL_DB'] ?? 'postgres'));
|
||||
Configuration::$username = $_ENV['PDO_DOC_PGSQL_USER'] ?? 'postgres';
|
||||
Configuration::$password = $_ENV['PDO_DOC_PGSQL_PASS'] ?? 'postgres';
|
||||
Configuration::resetPDO();
|
||||
}
|
||||
|
||||
/**
|
||||
* Load data into the test table
|
||||
*
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function loadData(): void
|
||||
{
|
||||
Document::insert(self::TABLE, new TestDocument('one', 'FIRST!', 0));
|
||||
Document::insert(self::TABLE, new TestDocument('two', 'another', 10, new SubDocument('green', 'blue')));
|
||||
Document::insert(self::TABLE, new TestDocument('three', '', 4));
|
||||
Document::insert(self::TABLE, new TestDocument('four', 'purple', 17, new SubDocument('green', 'red')));
|
||||
Document::insert(self::TABLE, new TestDocument('five', 'purple', 18));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a throwaway PostgreSQL database
|
||||
*
|
||||
* @param bool $withData Whether to initialize this database with data (optional; defaults to `true`)
|
||||
* @return string The name of the database (use to pass to `destroy` function at end of test)
|
||||
* @throws DocumentException|RandomException If any is encountered
|
||||
*/
|
||||
public static function create(bool $withData = true): string
|
||||
{
|
||||
$dbName = 'throwaway_' . AutoId::generateRandom(10);
|
||||
self::configure();
|
||||
Custom::nonQuery("CREATE DATABASE $dbName WITH OWNER " . Configuration::$username, []);
|
||||
self::configure($dbName);
|
||||
|
||||
Definition::ensureTable(self::TABLE);
|
||||
|
||||
if ($withData) {
|
||||
self::loadData();
|
||||
}
|
||||
|
||||
return $dbName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroy a throwaway PostgreSQL database
|
||||
*
|
||||
* @param string $dbName The name of the PostgreSQL database to be dropped
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function destroy(string $dbName): void
|
||||
{
|
||||
self::configure();
|
||||
Custom::nonQuery("DROP DATABASE IF EXISTS $dbName WITH (FORCE)", []);
|
||||
Configuration::useDSN('');
|
||||
Configuration::$username = null;
|
||||
Configuration::$password = null;
|
||||
Configuration::resetPDO();
|
||||
}
|
||||
}
|
||||
39
tests/Integration/SQLite/CountTest.php
Normal file
39
tests/Integration/SQLite/CountTest.php
Normal file
@@ -0,0 +1,39 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Count, DocumentException, Field};
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::all()', function () {
|
||||
test('counts all documents', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('counts by numeric range', function () {
|
||||
expect(Count::byFields(ThrowawayDb::TABLE, [Field::between('num_value', 10, 20)]))->toBe(3);
|
||||
});
|
||||
test('counts by non-numeric range', function () {
|
||||
expect(Count::byFields(ThrowawayDb::TABLE, [Field::between('value', 'aardvark', 'apple')]))->toBe(1);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Count::byContains('', []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Count::byJsonPath('', ''))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
94
tests/Integration/SQLite/CustomTest.php
Normal file
94
tests/Integration/SQLite/CustomTest.php
Normal file
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Count, Custom, DocumentException, Query};
|
||||
use BitBadger\PDODocument\Mapper\{CountMapper, DocumentMapper};
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::runQuery()', function () {
|
||||
test('runs a valid query successfully', function () {
|
||||
$stmt = &Custom::runQuery('SELECT data FROM ' . ThrowawayDb::TABLE . ' LIMIT 1', []);
|
||||
try {
|
||||
expect($stmt)->not->toBeNull();
|
||||
} finally {
|
||||
$stmt = null;
|
||||
}
|
||||
});
|
||||
test('fails with an invalid query', function () {
|
||||
$stmt = null;
|
||||
try {
|
||||
expect(function () use (&$stmt) { $stmt = &Custom::runQuery('GRAB stuff FROM over_there UNTIL done', []); })
|
||||
->toThrow(DocumentException::class);
|
||||
} finally {
|
||||
$stmt = null;
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('::list()', function () {
|
||||
test('returns non-empty list when data is found', function () {
|
||||
$list = Custom::list(Query::selectFromTable(ThrowawayDb::TABLE), [], new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($list->items() as $ignored) $count++;
|
||||
expect($count)->toBe(5);
|
||||
});
|
||||
test('returns empty list when not data is found', function () {
|
||||
expect(Custom::list(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'num_value' > :value",
|
||||
[':value' => 100], new DocumentMapper(TestDocument::class)))
|
||||
->not->toBeNull()
|
||||
->hasItems()->toBeFalse();
|
||||
|
||||
});
|
||||
});
|
||||
|
||||
describe('::array()', function () {
|
||||
test('returns non-empty array when data is found', function () {
|
||||
expect(Custom::array(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'sub' IS NOT NULL", [],
|
||||
new DocumentMapper(TestDocument::class)))
|
||||
->not->toBeNull()->toHaveCount(2);
|
||||
});
|
||||
test('returns empty array when data is not found', function () {
|
||||
expect(Custom::array(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'value' = :value",
|
||||
[':value' => 'not there'], new DocumentMapper(TestDocument::class)))
|
||||
->not->toBeNull()->toBeEmpty();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::single()', function () {
|
||||
test('returns a document when one is found', function () {
|
||||
expect(Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id", [':id' => 'one'],
|
||||
new DocumentMapper(TestDocument::class)))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('one');
|
||||
});
|
||||
test('returns no document when none is found', function () {
|
||||
expect(Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE . " WHERE data->>'id' = :id",
|
||||
[':id' => 'eighty'], new DocumentMapper(TestDocument::class)))
|
||||
->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::nonQuery()', function () {
|
||||
test('works when documents match the WHERE clause', function () {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(0);
|
||||
});
|
||||
test('works when no documents match the WHERE clause', function () {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE . " WHERE data->>'num_value' > :value", [':value' => 100]);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::scalar()', function () {
|
||||
test('returns a scalar value', function () {
|
||||
expect(Custom::scalar("SELECT 5 AS it", [], new CountMapper()))->toBe(5);
|
||||
});
|
||||
});
|
||||
36
tests/Integration/SQLite/DefinitionTest.php
Normal file
36
tests/Integration/SQLite/DefinitionTest.php
Normal file
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Definition, DocumentException, DocumentIndex};
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::ensureTable()', function () {
|
||||
test('creates table and PK index', function () {
|
||||
expect($this->dbObjectExists('ensured'))->toBeFalse()
|
||||
->and($this->dbObjectExists('idx_ensured_key'))->toBeFalse();
|
||||
Definition::ensureTable('ensured');
|
||||
expect($this->dbObjectExists('ensured'))->toBeTrue()
|
||||
->and($this->dbObjectExists('idx_ensured_key'))->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::ensureFieldIndex()', function () {
|
||||
test('creates an index', function () {
|
||||
expect($this->dbObjectExists('idx_ensured_test'))->toBeFalse();
|
||||
Definition::ensureTable('ensured');
|
||||
Definition::ensureFieldIndex('ensured', 'test', ['name', 'age']);
|
||||
expect($this->dbObjectExists('idx_ensured_test'))->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::ensureDocumentIndex()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Definition::ensureDocumentIndex('', DocumentIndex::Full))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
50
tests/Integration/SQLite/DeleteTest.php
Normal file
50
tests/Integration/SQLite/DeleteTest.php
Normal file
@@ -0,0 +1,50 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Count, Delete, DocumentException, Field};
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('deletes a document when one exists', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byId(ThrowawayDb::TABLE, 'four');
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(4);
|
||||
});
|
||||
test('does nothing when the document does not exist', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byId(ThrowawayDb::TABLE, 'negative four');
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('deletes matching documents', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::notEqual('value', 'purple')]);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(2);
|
||||
});
|
||||
test('does nothing when no documents match', function () {
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::equal('value', 'crimson')]);
|
||||
expect(Count::all(ThrowawayDb::TABLE))->toBe(5);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Delete::byContains('', []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Delete::byJsonPath('', ''))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
94
tests/Integration/SQLite/DocumentListTest.php
Normal file
94
tests/Integration/SQLite/DocumentListTest.php
Normal file
@@ -0,0 +1,94 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{DocumentException, DocumentList, Query};
|
||||
use BitBadger\PDODocument\Mapper\DocumentMapper;
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::create()', function () {
|
||||
test('creates a document list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull();
|
||||
$list = null; // free database result
|
||||
});
|
||||
});
|
||||
|
||||
describe('->items()', function () {
|
||||
test('enumerates items in the list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($list->items() as $item) {
|
||||
expect(['one', 'two', 'three', 'four', 'five'])->toContain($item->id);
|
||||
$count++;
|
||||
}
|
||||
expect($count)->toBe(5);
|
||||
});
|
||||
test('fails when the list is exhausted', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
$ignored = iterator_to_array($list->items());
|
||||
expect($list)->hasItems()->toBeFalse()
|
||||
->and(fn () => iterator_to_array($list->items()))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('->hasItems()', function () {
|
||||
test('returns true when items exist', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
foreach ($list->items() as $ignored) {
|
||||
expect($list)->hasItems()->toBeTrue();
|
||||
}
|
||||
expect($list)->hasItems()->toBeFalse();
|
||||
});
|
||||
test('returns false when no items exist', function () {
|
||||
expect(DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'num_value' < 0", [],
|
||||
new DocumentMapper(TestDocument::class)))
|
||||
->not->toBeNull()->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('->map()', function () {
|
||||
test('transforms the list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
foreach ($list->map(fn($doc) => strrev($doc->id)) as $mapped) {
|
||||
expect(['eno', 'owt', 'eerht', 'ruof', 'evif'])->toContain($mapped);
|
||||
}
|
||||
});
|
||||
});
|
||||
|
||||
describe('->iter()', function () {
|
||||
test('walks the list', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue();
|
||||
$splats = [];
|
||||
$list->iter(function ($doc) use (&$splats) { $splats[] = str_repeat('*', strlen($doc->id)); });
|
||||
expect(implode(' ', $splats))->toBe('*** *** ***** **** ****');
|
||||
});
|
||||
});
|
||||
|
||||
describe('->mapToArray()', function () {
|
||||
test('creates an associative array', function () {
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
expect($list)->not->toBeNull()->hasItems()->toBeTrue()
|
||||
->and($list->mapToArray(fn($it) => $it->id, fn($it) => $it->value))
|
||||
->toBe(['one' => 'FIRST!', 'two' => 'another', 'three' => '', 'four' => 'purple', 'five' => 'purple']);
|
||||
});
|
||||
});
|
||||
231
tests/Integration/SQLite/DocumentTest.php
Normal file
231
tests/Integration/SQLite/DocumentTest.php
Normal file
@@ -0,0 +1,231 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{AutoId, Configuration, Custom, Document, DocumentException, Exists, Field, Find};
|
||||
use BitBadger\PDODocument\Mapper\ArrayMapper;
|
||||
use Test\Integration\{NumDocument, SubDocument, TestDocument};
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::insert()', function () {
|
||||
test('inserts an array with no automatic ID', function () {
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => 'turkey', 'sub' => ['foo' => 'gobble', 'bar' => 'gobble']]);
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue()
|
||||
->and($tryDoc->get())
|
||||
->id->toBe('turkey')
|
||||
->num_value->toBe(0)
|
||||
->sub->not->toBeNull()
|
||||
->sub->foo->toBe('gobble')
|
||||
->sub->bar->toBe('gobble')
|
||||
->and($tryDoc->get()->value)->toBeEmpty();
|
||||
});
|
||||
test('inserts an array with auto-number ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::Number;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => 0, 'value' => 'new', 'num_value' => 8]);
|
||||
$doc = Custom::single('SELECT data FROM ' . ThrowawayDb::TABLE, [], new ArrayMapper());
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and(json_decode($doc->get()['data']))->id->toBe(1);
|
||||
|
||||
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());
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and(json_decode($doc->get()['data']))->id->toBe(2);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-number ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::Number;
|
||||
try {
|
||||
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());
|
||||
expect($doc)->isSome()->toBeTrue()
|
||||
->and(json_decode($doc->get()['data']))->id->toBe(7);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-UUID ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::UUID;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => '', 'num_value' => 5]);
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 5)], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->not->toBeEmpty();
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-UUID ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::UUID;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
$uuid = AutoId::generateUUID();
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => $uuid, 'value' => 'uuid', 'num_value' => 12]);
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 12)], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe($uuid);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-string ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::RandomString;
|
||||
Configuration::$idStringLength = 6;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => '', 'value' => 'new', 'num_value' => 8]);
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 8)], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toHaveLength(6);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
Configuration::$idStringLength = 16;
|
||||
}
|
||||
});
|
||||
test('inserts an array with auto-string ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::RandomString;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => 'my-key', 'value' => 'old', 'num_value' => 3]);
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 3)], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('my-key');
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with no automatic ID', function () {
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument('turkey', sub: new SubDocument('gobble', 'gobble')));
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'turkey', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue()
|
||||
->and($tryDoc->get())
|
||||
->id->toBe('turkey')
|
||||
->num_value->toBe(0)
|
||||
->sub->not->toBeNull()
|
||||
->sub->foo->toBe('gobble')
|
||||
->sub->bar->toBe('gobble')
|
||||
->and($tryDoc->get()->value)->toBeEmpty();
|
||||
});
|
||||
test('inserts an object with auto-number ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::Number;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
|
||||
Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'taco'));
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'taco')], NumDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe(1);
|
||||
|
||||
Document::insert(ThrowawayDb::TABLE, new NumDocument(value: 'burrito'));
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'burrito')], NumDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe(2);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-number ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::Number;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, new NumDocument(64, 'large'));
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'large')], NumDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe(64);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-UUID ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::UUID;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument(value: 'something', num_value: 9));
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::exists('value')], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->not->toBeEmpty();
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-UUID ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::UUID;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
$uuid = AutoId::generateUUID();
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument($uuid, num_value: 14));
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 14)], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe($uuid);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-string ID, not provided', function () {
|
||||
Configuration::$autoId = AutoId::RandomString;
|
||||
Configuration::$idStringLength = 40;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument(num_value: 55));
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 55)], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toHaveLength(40);
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
Configuration::$idStringLength = 16;
|
||||
}
|
||||
});
|
||||
test('inserts an object with auto-string ID, provided', function () {
|
||||
Configuration::$autoId = AutoId::RandomString;
|
||||
try {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument('my-key', num_value: 3));
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 3)], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('my-key');
|
||||
} finally {
|
||||
Configuration::$autoId = AutoId::None;
|
||||
}
|
||||
});
|
||||
test('throws an exception for duplicate key', function () {
|
||||
expect(fn () => Document::insert(ThrowawayDb::TABLE, new TestDocument('one')))
|
||||
->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::save()', function () {
|
||||
test('inserts a new document', function () {
|
||||
Document::save(ThrowawayDb::TABLE, new TestDocument('test', sub: new SubDocument('a', 'b')));
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class))->isSome()->toBeTrue();
|
||||
});
|
||||
test('updates an existing document', function () {
|
||||
Document::save(ThrowawayDb::TABLE, new TestDocument('two', num_value: 44));
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue()
|
||||
->and($tryDoc->get())
|
||||
->num_value->toBe(44)
|
||||
->sub->toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::update()', function () {
|
||||
test('replaces an existing document', function () {
|
||||
Document::update(ThrowawayDb::TABLE, 'one', new TestDocument('one', 'howdy', 8, new SubDocument('y', 'z')));
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue()
|
||||
->and($tryDoc->get())
|
||||
->num_value->toBe(8)
|
||||
->sub->not->toBeNull()
|
||||
->sub->foo->toBe('y')
|
||||
->sub->bar->toBe('z')
|
||||
->and($tryDoc->get()->value)->toBe('howdy');
|
||||
});
|
||||
test('does nothing for a non-existent document', function () {
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, 'two-hundred'))->toBeFalse();
|
||||
Document::update(ThrowawayDb::TABLE, 'two-hundred', new TestDocument('200'));
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'two-hundred', TestDocument::class))->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
42
tests/Integration/SQLite/ExistsTest.php
Normal file
42
tests/Integration/SQLite/ExistsTest.php
Normal file
@@ -0,0 +1,42 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{DocumentException, Exists, Field};
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('returns true when a document exists', function () {
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, 'three'))->toBeTrue();
|
||||
});
|
||||
test('returns false when no document exists', function () {
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, 'seven'))->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('returns true when matching documents exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::equal('num_value', 10)]))->toBeTrue();
|
||||
});
|
||||
test('returns false when no matching documents exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::less('nothing', 'none')]))->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Exists::byContains('', []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Exists::byJsonPath('', ''))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
151
tests/Integration/SQLite/FindTest.php
Normal file
151
tests/Integration/SQLite/FindTest.php
Normal file
@@ -0,0 +1,151 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Custom, Delete, Document, DocumentException, Field, FieldMatch, Find};
|
||||
use Test\Integration\{ArrayDocument, TestDocument};
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::all()', function () {
|
||||
test('retrieves data', function () {
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(5);
|
||||
});
|
||||
test('sorts data ascending', function () {
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class, [Field::named('id')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))
|
||||
->toBe(['five', 'four', 'one', 'three', 'two']);
|
||||
});
|
||||
test('sorts data descending', function () {
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class, [Field::named('id DESC')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))
|
||||
->toBe(['two', 'three', 'one', 'four', 'five']);
|
||||
});
|
||||
test('sorts data numerically', function () {
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class,
|
||||
[Field::named('sub.foo NULLS LAST'), Field::named('n:num_value')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))
|
||||
->toBe(['two', 'four', 'one', 'three', 'five']);
|
||||
});
|
||||
test('returns an empty list when no data exists', function () {
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
expect(Find::all(ThrowawayDb::TABLE, TestDocument::class))
|
||||
->not->toBeNull()->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('returns a document when it exists', function () {
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('two');
|
||||
});
|
||||
test('returns a document with a numeric ID', function () {
|
||||
Document::insert(ThrowawayDb::TABLE, ['id' => 18, 'value' => 'howdy']);
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 18, TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('18');
|
||||
});
|
||||
test('returns None when no document exists', function () {
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'seventy-five', TestDocument::class))->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('returns matching documents', function () {
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::in('value', ['blue', 'purple']), Field::exists('sub')],
|
||||
TestDocument::class, FieldMatch::All);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(1);
|
||||
});
|
||||
test('returns ordered matching documents', function () {
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::equal('value', 'purple')], TestDocument::class,
|
||||
FieldMatch::All, [Field::named('id')]);
|
||||
expect($docs)->not->toBeNull()
|
||||
->and(iterator_to_array($docs->map(fn ($it) => $it->id), false))->toBe(['five', 'four']);
|
||||
});
|
||||
test('returns documents matching numeric IN clause', function () {
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::in('num_value', [2, 4, 6, 8])], TestDocument::class);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(1);
|
||||
});
|
||||
test('returns empty list when no documents match', function () {
|
||||
expect(Find::byFields(ThrowawayDb::TABLE, [Field::greater('num_value', 100)], TestDocument::class))
|
||||
->not->toBeNull()->hasItems()->toBeFalse();
|
||||
});
|
||||
test('returns matching documents for inArray comparison', function () {
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::notExists('absentField')]);
|
||||
foreach (ArrayDocument::testDocuments() as $doc) Document::insert(ThrowawayDb::TABLE, $doc);
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::inArray('values', ThrowawayDb::TABLE, ['c'])],
|
||||
ArrayDocument::class);
|
||||
expect($docs)->not->toBeNull();
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
expect($count)->toBe(2);
|
||||
});
|
||||
test('returns empty list when no documents match inArray comparison', function () {
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::notExists('absentField')]);
|
||||
foreach (ArrayDocument::testDocuments() as $doc) Document::insert(ThrowawayDb::TABLE, $doc);
|
||||
expect(Find::byFields(ThrowawayDb::TABLE, [Field::inArray('values', ThrowawayDb::TABLE, ['j'])],
|
||||
ArrayDocument::class))
|
||||
->not->toBeNull()->hasItems()->toBeFalse();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Find::byContains('', [], TestDocument::class))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Find::byJsonPath('', '', TestDocument::class))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::firstByFields()', function () {
|
||||
test('returns a matching document', function () {
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'another')], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('two');
|
||||
});
|
||||
test('returns one of several matching documents', function () {
|
||||
$doc = Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('sub.foo', 'green')], TestDocument::class);
|
||||
expect($doc)->isSome()->toBeTrue()->and(['two', 'four'])->toContain($doc->get()->id);
|
||||
});
|
||||
test('returns first of ordered matching documents', function () {
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('sub.foo', 'green')], TestDocument::class,
|
||||
orderBy: [Field::named('n:num_value DESC')]))
|
||||
->isSome()->toBeTrue()->get()->id->toBe('four');
|
||||
});
|
||||
test('returns None when no documents match', function () {
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('value', 'absent')], TestDocument::class))
|
||||
->isNone()->toBeTrue();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::firstByContains()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Find::firstByContains('', [], TestDocument::class))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::firstByJsonPath()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Find::firstByJsonPath('', '', TestDocument::class))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
48
tests/Integration/SQLite/PatchTest.php
Normal file
48
tests/Integration/SQLite/PatchTest.php
Normal file
@@ -0,0 +1,48 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Count, DocumentException, Exists, Field, Find, Patch};
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('updates an existing document', function () {
|
||||
Patch::byId(ThrowawayDb::TABLE, 'one', ['num_value' => 44]);
|
||||
expect(Find::byId(ThrowawayDb::TABLE, 'one', TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->num_value->toBe(44);
|
||||
});
|
||||
test('does nothing when no document exists', function () {
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, 'forty-seven'))->toBeFalse();
|
||||
Patch::byId(ThrowawayDb::TABLE, 'forty-seven', ['foo' => 'green']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('updates matching documents', function () {
|
||||
Patch::byFields(ThrowawayDb::TABLE, [Field::equal('value', 'purple')], ['num_value' => 77]);
|
||||
expect(Count::byFields(ThrowawayDb::TABLE, [Field::equal('num_value', 77)]))->toBe(2);
|
||||
});
|
||||
test('does nothing when no documents match', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::equal('value', 'burgundy')]))->toBeFalse();
|
||||
Patch::byFields(ThrowawayDb::TABLE, [Field::equal('value', 'burgundy')], ['foo' => 'green']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Patch::byContains('', [], []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => Patch::byJsonPath('', '', []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
59
tests/Integration/SQLite/RemoveFieldsTest.php
Normal file
59
tests/Integration/SQLite/RemoveFieldsTest.php
Normal file
@@ -0,0 +1,59 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{DocumentException, Exists, Field, Find, RemoveFields};
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
pest()->group('integration', 'sqlite');
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('updates an existing document', function () {
|
||||
RemoveFields::byId(ThrowawayDb::TABLE, 'two', ['sub', 'value']);
|
||||
$tryDoc = Find::byId(ThrowawayDb::TABLE, 'two', TestDocument::class);
|
||||
expect($tryDoc)->isSome()->toBeTrue()
|
||||
->and($tryDoc->get())->sub->toBeNull()
|
||||
->and($tryDoc->get()->value)->toBeEmpty();
|
||||
});
|
||||
test('does nothing when the field to remove does not exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::exists('a_field_that_does_not_exist')]))->toBeFalse();
|
||||
RemoveFields::byId(ThrowawayDb::TABLE, 'one', ['a_field_that_does_not_exist']);
|
||||
});
|
||||
test('does nothing when the document does not exist', function () {
|
||||
expect(Exists::byId(ThrowawayDb::TABLE, 'fifty'))->toBeFalse();
|
||||
RemoveFields::byId(ThrowawayDb::TABLE, 'fifty', ['sub']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('updates matching documents', function () {
|
||||
RemoveFields::byFields(ThrowawayDb::TABLE, [Field::equal('num_value', 17)], ['sub']);
|
||||
expect(Find::firstByFields(ThrowawayDb::TABLE, [Field::equal('num_value', 17)], TestDocument::class))
|
||||
->isSome()->toBeTrue()->get()->sub->toBeNull();
|
||||
});
|
||||
test('does nothing when the field to remove does not exist', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::exists('nada')]))->toBeFalse();
|
||||
RemoveFields::byFields(ThrowawayDb::TABLE, [Field::equal('num_value', 17)], ['nada']);
|
||||
});
|
||||
test('does nothing when no documents match', function () {
|
||||
expect(Exists::byFields(ThrowawayDb::TABLE, [Field::notEqual('missing', 'nope')]))->toBeFalse();
|
||||
RemoveFields::byFields(ThrowawayDb::TABLE, [Field::notEqual('missing', 'nope')], ['value']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => RemoveFields::byContains('', [], []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('throws an exception', function () {
|
||||
expect(fn () => RemoveFields::byJsonPath('', '', []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
70
tests/Integration/SQLite/ThrowawayDb.php
Normal file
70
tests/Integration/SQLite/ThrowawayDb.php
Normal file
@@ -0,0 +1,70 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
* @see https://github.com/Zaid-Ajaj/ThrowawayDb The origin concept
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{AutoId, Configuration, Definition, Document, DocumentException};
|
||||
use Random\RandomException;
|
||||
use Test\Integration\{SubDocument, TestDocument};
|
||||
|
||||
/**
|
||||
* Utilities to create and destroy a throwaway SQLite database to use for testing
|
||||
*/
|
||||
class ThrowawayDb
|
||||
{
|
||||
/** @var string The table used for document manipulation */
|
||||
public const TABLE = 'test_table';
|
||||
|
||||
/**
|
||||
* Load data into the test table
|
||||
*
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
public static function loadData(): void
|
||||
{
|
||||
Document::insert(self::TABLE, new TestDocument('one', 'FIRST!', 0));
|
||||
Document::insert(self::TABLE, new TestDocument('two', 'another', 10, new SubDocument('green', 'blue')));
|
||||
Document::insert(self::TABLE, new TestDocument('three', '', 4));
|
||||
Document::insert(self::TABLE, new TestDocument('four', 'purple', 17, new SubDocument('green', 'red')));
|
||||
Document::insert(self::TABLE, new TestDocument('five', 'purple', 18));
|
||||
}
|
||||
|
||||
/**
|
||||
* Create a throwaway SQLite database
|
||||
*
|
||||
* @param bool $withData Whether to initialize this database with data (optional; defaults to `true`)
|
||||
* @return string The name of the database (use to pass to `destroy` function at end of test)
|
||||
* @throws DocumentException|RandomException If any is encountered
|
||||
*/
|
||||
public static function create(bool $withData = true): string
|
||||
{
|
||||
$fileName = sprintf('throwaway-%s.db', AutoId::generateRandom(10));
|
||||
Configuration::useDSN("sqlite:./$fileName");
|
||||
Configuration::resetPDO();
|
||||
|
||||
Definition::ensureTable(self::TABLE);
|
||||
|
||||
if ($withData) {
|
||||
self::loadData();
|
||||
}
|
||||
|
||||
return $fileName;
|
||||
}
|
||||
|
||||
/**
|
||||
* Destroy a throwaway SQLite database
|
||||
*
|
||||
* @param string $fileName The name of the SQLite database to be deleted
|
||||
*/
|
||||
public static function destroy(string $fileName): void
|
||||
{
|
||||
Configuration::resetPDO();
|
||||
if (file_exists("./$fileName")) unlink("./$fileName");
|
||||
}
|
||||
}
|
||||
60
tests/Integration/SQLiteIntegrationTest.php
Normal file
60
tests/Integration/SQLiteIntegrationTest.php
Normal file
@@ -0,0 +1,60 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
* @see https://github.com/Zaid-Ajaj/ThrowawayDb The origin concept
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration;
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, Custom, Delete, DocumentException, Field};
|
||||
use BitBadger\PDODocument\Mapper\ExistsMapper;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Test\Integration\SQLite\ThrowawayDb;
|
||||
|
||||
/**
|
||||
* Integration Test Class wrapper for SQLite integration tests
|
||||
*/
|
||||
class SQLiteIntegrationTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
static private string $dbName = '';
|
||||
|
||||
public static function setUpBeforeClass(): void
|
||||
{
|
||||
self::$dbName = ThrowawayDb::create(false);
|
||||
}
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
ThrowawayDb::loadData();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
Delete::byFields(ThrowawayDb::TABLE, [ Field::exists(Configuration::$idField)]);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public static function tearDownAfterClass(): void
|
||||
{
|
||||
ThrowawayDb::destroy(self::$dbName);
|
||||
self::$dbName = '';
|
||||
}
|
||||
|
||||
/**
|
||||
* Does the given named object exist in the database?
|
||||
*
|
||||
* @param string $name The name of the object whose existence should be verified
|
||||
* @return bool True if the object exists, false if not
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
protected function dbObjectExists(string $name): bool
|
||||
{
|
||||
return Custom::scalar('SELECT EXISTS (SELECT 1 FROM sqlite_master WHERE name = :name)',
|
||||
[':name' => $name], new ExistsMapper());
|
||||
}
|
||||
}
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration;
|
||||
|
||||
@@ -1,4 +1,10 @@
|
||||
<?php declare(strict_types=1);
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration;
|
||||
|
||||
55
tests/Pest.php
Normal file
55
tests/Pest.php
Normal file
@@ -0,0 +1,55 @@
|
||||
<?php
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Test Case
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| The closure you provide to your test functions is always bound to a specific PHPUnit test
|
||||
| case class. By default, that class is "PHPUnit\Framework\TestCase". Of course, you may
|
||||
| need to change it using the "pest()" function to bind a different classes or traits.
|
||||
|
|
||||
*/
|
||||
|
||||
// pest()->extend(Tests\TestCase::class)->in('Feature');
|
||||
pest()->extend(Test\Integration\PgIntegrationTest::class)->in('Integration/PostgreSQL');
|
||||
pest()->extend(Test\Integration\SQLiteIntegrationTest::class)->in('Integration/SQLite');
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Expectations
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| When you're writing tests, you often need to check that values meet certain conditions. The
|
||||
| "expect()" function gives you access to a set of "expectations" methods that you can use
|
||||
| to assert different things. Of course, you may extend the Expectation API at any time.
|
||||
|
|
||||
*/
|
||||
|
||||
expect()->extend('toBeOne', function () {
|
||||
return $this->toBe(1);
|
||||
});
|
||||
|
||||
/*
|
||||
|--------------------------------------------------------------------------
|
||||
| Functions
|
||||
|--------------------------------------------------------------------------
|
||||
|
|
||||
| While Pest is very powerful out-of-the-box, you may have some testing code specific to your
|
||||
| project that you don't want to repeat in every file. Here you can also expose helpers as
|
||||
| global functions to help you to reduce the number of lines of code in your test files.
|
||||
|
|
||||
*/
|
||||
|
||||
/**
|
||||
* Reset the database mode
|
||||
*/
|
||||
function reset_mode(): void
|
||||
{
|
||||
\BitBadger\PDODocument\Configuration::overrideMode(null);
|
||||
}
|
||||
|
||||
function something()
|
||||
{
|
||||
// ..
|
||||
}
|
||||
22
tests/PjsonDocument.php
Normal file
22
tests/PjsonDocument.php
Normal file
@@ -0,0 +1,22 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test;
|
||||
|
||||
use Square\Pjson\{Json, JsonSerialize};
|
||||
|
||||
/**
|
||||
* A test document annotated with pjson attributes using the `JsonSerialize` trait
|
||||
*/
|
||||
class PjsonDocument
|
||||
{
|
||||
use JsonSerialize;
|
||||
|
||||
public function __construct(#[Json] public PjsonId $id = new PjsonId(''), #[Json] public string $name = '',
|
||||
#[Json('num_value')] public int $numValue = 0, public string $skipped = 'yep') { }
|
||||
}
|
||||
34
tests/PjsonId.php
Normal file
34
tests/PjsonId.php
Normal file
@@ -0,0 +1,34 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Test;
|
||||
|
||||
use Square\Pjson\JsonDataSerializable;
|
||||
|
||||
/**
|
||||
* A serializable ID wrapper class
|
||||
*/
|
||||
final class PjsonId implements JsonDataSerializable
|
||||
{
|
||||
public function __construct(protected string $value) { }
|
||||
|
||||
public function toJsonData(): string
|
||||
{
|
||||
return $this->value;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param mixed $jd JSON data
|
||||
* @param mixed[]|string $path path segments
|
||||
* @return static
|
||||
*/
|
||||
public static function fromJsonData($jd, array|string $path = []): static
|
||||
{
|
||||
return new static($jd);
|
||||
}
|
||||
}
|
||||
36
tests/Unit/ConfigurationTest.php
Normal file
36
tests/Unit/ConfigurationTest.php
Normal file
@@ -0,0 +1,36 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{AutoId, Configuration, DocumentException};
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('::$idField', function () {
|
||||
test('has expected default value', function () {
|
||||
expect(Configuration::$idField)->toBe('id');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::$autoId', function () {
|
||||
test('has expected default value', function () {
|
||||
expect(Configuration::$autoId)->toBe(AutoId::None);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::$idStringLength', function () {
|
||||
test('has expected default value', function () {
|
||||
expect(Configuration::$idStringLength)->toBe(16);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::dbConn()', function () {
|
||||
test('throws if DSN has not been set', function () {
|
||||
Configuration::useDSN('');
|
||||
expect(fn() => Configuration::dbConn())->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
40
tests/Unit/DocumentExceptionTest.php
Normal file
40
tests/Unit/DocumentExceptionTest.php
Normal file
@@ -0,0 +1,40 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\DocumentException;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('Constructor', function () {
|
||||
test('fills code and prior exception if provided', function () {
|
||||
$priorEx = new Exception('Uh oh');
|
||||
expect(new DocumentException('Test Exception', 17, $priorEx))
|
||||
->not->toBeNull()
|
||||
->getMessage()->toBe('Test Exception')
|
||||
->getCode()->toBe(17)
|
||||
->getPrevious()->toBe($priorEx);
|
||||
});
|
||||
test('uses expected code and prior exception if not provided', function () {
|
||||
expect(new DocumentException('Oops'))
|
||||
->not->toBeNull()
|
||||
->getMessage()->toBe('Oops')
|
||||
->getCode()->toBe(0)
|
||||
->getPrevious()->toBeNull();
|
||||
});
|
||||
});
|
||||
|
||||
describe('->__toString()', function () {
|
||||
test('excludes code if 0', function () {
|
||||
$ex = new DocumentException('Test failure');
|
||||
expect("$ex")->toBe("BitBadger\PDODocument\DocumentException: Test failure\n");
|
||||
});
|
||||
test('includes code if non-zero', function () {
|
||||
$ex = new DocumentException('Oof', -6);
|
||||
expect("$ex")->toBe("BitBadger\PDODocument\DocumentException: [-6] Oof\n");
|
||||
});
|
||||
});
|
||||
20
tests/Unit/FieldMatchTest.php
Normal file
20
tests/Unit/FieldMatchTest.php
Normal file
@@ -0,0 +1,20 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\FieldMatch;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('->toSQL()', function () {
|
||||
test('returns AND for All', function () {
|
||||
expect(FieldMatch::All)->toSQL()->toBe('AND');
|
||||
});
|
||||
test('returns OR for Any', function () {
|
||||
expect(FieldMatch::Any)->toSQL()->toBe('OR');
|
||||
});
|
||||
});
|
||||
418
tests/Unit/FieldTest.php
Normal file
418
tests/Unit/FieldTest.php
Normal file
@@ -0,0 +1,418 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, Field, Mode, Op};
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('->appendParameter()', function () {
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
test('appends no parameter for exists', function () {
|
||||
expect(Field::exists('exists')->appendParameter([]))->toBeEmpty();
|
||||
});
|
||||
test('appends no parameter for notExists', function () {
|
||||
expect(Field::notExists('absent')->appendParameter([]))->toBeEmpty();
|
||||
});
|
||||
test('appends two parameters for between', function () {
|
||||
expect(Field::between('exists', 5, 9, '@num')->appendParameter([]))
|
||||
->toHaveLength(2)
|
||||
->toEqual(['@nummin' => 5, '@nummax' => 9]);
|
||||
});
|
||||
test('appends a parameter for each value for in', function () {
|
||||
expect(Field::in('it', ['test', 'unit', 'great'], ':val')->appendParameter([]))
|
||||
->toHaveLength(3)
|
||||
->toEqual([':val_0' => 'test', ':val_1' => 'unit', ':val_2' => 'great']);
|
||||
});
|
||||
test('appends a parameter for each value for inArray [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::inArray('it', 'table', [2, 8, 64], ':bit')->appendParameter([]))
|
||||
->toHaveLength(3)
|
||||
->toEqual([':bit_0' => '2', ':bit_1' => '8', ':bit_2' => '64']);
|
||||
})->group('postgresql');
|
||||
test('appends a parameter for each value for inArray [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::inArray('it', 'table', [2, 8, 64], ':bit')->appendParameter([]))
|
||||
->toHaveLength(3)
|
||||
->toEqual([':bit_0' => 2, ':bit_1' => 8, ':bit_2' => 64]);
|
||||
})->group('sqlite');
|
||||
test('appends a parameter for other operators', function () {
|
||||
expect(Field::equal('the_field', 33, ':test')->appendParameter([]))
|
||||
->toHaveLength(1)
|
||||
->toEqual([':test' => 33]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('->path()', function () {
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
test('returns simple SQL path [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::equal('it', 'that'))->path()->toBe("data->>'it'");
|
||||
})->group('postgresql');
|
||||
test('returns simple SQL path [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::equal('top', 'that'))->path()->toBe("data->>'top'");
|
||||
})->group('sqlite');
|
||||
test('returns nested SQL path [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::equal('parts.to.the.path', ''))->path()->toBe("data#>>'{parts,to,the,path}'");
|
||||
})->group('postgresql');
|
||||
test('returns nested SQL path [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::equal('one.two.three', ''))->path()->toBe("data->'one'->'two'->>'three'");
|
||||
})->group('sqlite');
|
||||
test('returns simple JSON path [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::equal('it', 'that'))->path(true)->toBe("data->'it'");
|
||||
})->group('postgresql');
|
||||
test('returns simple JSON path [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::equal('top', 'that'))->path(true)->toBe("data->'top'");
|
||||
})->group('sqlite');
|
||||
test('returns nested JSON path [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::equal('parts.to.the.path', ''))->path(true)->toBe("data#>'{parts,to,the,path}'");
|
||||
})->group('postgresql');
|
||||
test('returns nested JSON path [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::equal('one.two.three', ''))->path(true)->toBe("data->'one'->'two'->'three'");
|
||||
})->group('sqlite');
|
||||
});
|
||||
|
||||
describe('->toWhere()', function () {
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
test('generates IS NOT NULL for exists w/o qualifier [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::exists('that_field'))->toWhere()->toBe("data->>'that_field' IS NOT NULL");
|
||||
})->group('postgresql');
|
||||
test('generates IS NOT NULL for exists w/o qualifier [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::exists('that_field'))->toWhere()->toBe("data->>'that_field' IS NOT NULL");
|
||||
})->group('sqlite');
|
||||
test('generates IS NULL for notExists w/o qualifier [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::notExists('a_field'))->toWhere()->toBe("data->>'a_field' IS NULL");
|
||||
})->group('postgresql');
|
||||
test('generates IS NULL for notExists w/o qualifier [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::notExists('a_field'))->toWhere()->toBe("data->>'a_field' IS NULL");
|
||||
})->group('sqlite');
|
||||
test('generates BETWEEN for between w/o qualifier [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::between('age', 13, 17, '@age'))->toWhere()->toBe("data->>'age' BETWEEN @agemin AND @agemax");
|
||||
})->group('sqlite');
|
||||
test('generates BETWEEN for between w/o qualifier, numeric range [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::between('age', 13, 17, '@age'))->toWhere()
|
||||
->toBe("(data->>'age')::numeric BETWEEN @agemin AND @agemax");
|
||||
})->group('postgresql');
|
||||
test('generates BETWEEN for between w/o qualifier, non-numeric range [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::between('city', 'Atlanta', 'Chicago', ':city'))->toWhere()
|
||||
->toBe("data->>'city' BETWEEN :citymin AND :citymax");
|
||||
})->group('postgresql');
|
||||
test('generates BETWEEN for between w/ qualifier [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
$field = Field::between('age', 13, 17, '@age');
|
||||
$field->qualifier = 'me';
|
||||
expect($field)->toWhere()->toBe("me.data->>'age' BETWEEN @agemin AND @agemax");
|
||||
})->group('sqlite');
|
||||
test('generates BETWEEN for between w/ qualifier, numeric range [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
$field = Field::between('age', 13, 17, '@age');
|
||||
$field->qualifier = 'me';
|
||||
expect($field)->toWhere()->toBe("(me.data->>'age')::numeric BETWEEN @agemin AND @agemax");
|
||||
})->group('postgresql');
|
||||
test('generates BETWEEN for between w/ qualifier, non-numeric range [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
$field = Field::between('city', 'Atlanta', 'Chicago', ':city');
|
||||
$field->qualifier = 'me';
|
||||
expect($field)->toWhere()->toBe("me.data->>'city' BETWEEN :citymin AND :citymax");
|
||||
})->group('postgresql');
|
||||
test('generates IN for in, non-numeric values [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::in('test', ['Atlanta', 'Chicago'], ':city'))->toWhere()
|
||||
->toBe("data->>'test' IN (:city_0, :city_1)");
|
||||
})->group('postgresql');
|
||||
test('generates IN for in, numeric values [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::in('even', [2, 4, 6], ':nbr'))->toWhere()
|
||||
->toBe("(data->>'even')::numeric IN (:nbr_0, :nbr_1, :nbr_2)");
|
||||
})->group('postgresql');
|
||||
test('generates IN for in [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::in('test', ['Atlanta', 'Chicago'], ':city'))->toWhere()
|
||||
->toBe("data->>'test' IN (:city_0, :city_1)");
|
||||
})->group('sqlite');
|
||||
test('generates clause for inArray [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::inArray('even', 'tbl', [2, 4, 6, 8], ':it'))->toWhere()
|
||||
->toBe("data->'even' ??| ARRAY[:it_0, :it_1, :it_2, :it_3]");
|
||||
})->group('postgresql');
|
||||
test('generates clause for inArray [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::inArray('test', 'tbl', ['Atlanta', 'Chicago'], ':city'))->toWhere()
|
||||
->toBe("EXISTS (SELECT 1 FROM json_each(tbl.data, '\$.test') WHERE value IN (:city_0, :city_1))");
|
||||
})->group('sqlite');
|
||||
test('generates clause for other operators w/o qualifier [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Field::equal('some_field', '', ':value'))->toWhere()->toBe("data->>'some_field' = :value");
|
||||
})->group('postgresql');
|
||||
test('generates clause for other operators w/o qualifier [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Field::equal('some_field', '', ':value'))->toWhere()->toBe("data->>'some_field' = :value");
|
||||
})->group('sqlite');
|
||||
test('generates no-parameter clause w/ qualifier [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
$field = Field::exists('no_field');
|
||||
$field->qualifier = 'test';
|
||||
expect($field)->toWhere()->toBe("test.data->>'no_field' IS NOT NULL");
|
||||
})->group('postgresql');
|
||||
test('generates no-parameter clause w/ qualifier [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
$field = Field::exists('no_field');
|
||||
$field->qualifier = 'test';
|
||||
expect($field)->toWhere()->toBe("test.data->>'no_field' IS NOT NULL");
|
||||
})->group('sqlite');
|
||||
test('generates parameter clause w/ qualifier [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
$field = Field::lessOrEqual('le_field', 18, ':it');
|
||||
$field->qualifier = 'q';
|
||||
expect($field)->toWhere()->toBe("(q.data->>'le_field')::numeric <= :it");
|
||||
})->group('postgresql');
|
||||
test('generates parameter clause w/ qualifier [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
$field = Field::lessOrEqual('le_field', 18, ':it');
|
||||
$field->qualifier = 'q';
|
||||
expect($field)->toWhere()->toBe("q.data->>'le_field' <= :it");
|
||||
})->group('sqlite');
|
||||
});
|
||||
|
||||
describe('::equal()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::equal('my_test', 9);
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('my_test')
|
||||
->op->toBe(Op::Equal)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toBe(9);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::equal('another_test', 'turkey', ':test');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('another_test')
|
||||
->op->toBe(Op::Equal)
|
||||
->paramName->toBe(':test')
|
||||
->and($field->value)->toBe('turkey');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::greater()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::greater('your_test', 4);
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('your_test')
|
||||
->op->toBe(Op::Greater)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toBe(4);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::greater('more_test', 'chicken', ':value');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('more_test')
|
||||
->op->toBe(Op::Greater)
|
||||
->paramName->toBe(':value')
|
||||
->and($field->value)->toBe('chicken');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::greaterOrEqual()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::greaterOrEqual('their_test', 6);
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('their_test')
|
||||
->op->toBe(Op::GreaterOrEqual)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toBe(6);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::greaterOrEqual('greater_test', 'poultry', ':cluck');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('greater_test')
|
||||
->op->toBe(Op::GreaterOrEqual)
|
||||
->paramName->toBe(':cluck')
|
||||
->and($field->value)->toBe('poultry');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::less()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::less('z', 32);
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('z')
|
||||
->op->toBe(Op::Less)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toBe(32);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::less('additional_test', 'fowl', ':boo');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('additional_test')
|
||||
->op->toBe(Op::Less)
|
||||
->paramName->toBe(':boo')
|
||||
->and($field->value)->toBe('fowl');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::lessOrEqual()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::lessOrEqual('g', 87);
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('g')
|
||||
->op->toBe(Op::LessOrEqual)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toBe(87);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::lessOrEqual('lesser_test', 'hen', ':woo');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('lesser_test')
|
||||
->op->toBe(Op::LessOrEqual)
|
||||
->paramName->toBe(':woo')
|
||||
->and($field->value)->toBe('hen');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::notEqual()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::notEqual('j', 65);
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('j')
|
||||
->op->toBe(Op::NotEqual)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toBe(65);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::notEqual('unequal_test', 'egg', ':zoo');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('unequal_test')
|
||||
->op->toBe(Op::NotEqual)
|
||||
->paramName->toBe(':zoo')
|
||||
->and($field->value)->toBe('egg');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::between()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::between('k', 'alpha', 'zed');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('k')
|
||||
->op->toBe(Op::Between)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toEqual(['alpha', 'zed']);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::between('between_test', 18, 49, ':count');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('between_test')
|
||||
->op->toBe(Op::Between)
|
||||
->paramName->toBe(':count')
|
||||
->and($field->value)->toEqual([18, 49]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::in()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::in('test', [1, 2, 3]);
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('test')
|
||||
->op->toBe(Op::In)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toEqual([1, 2, 3]);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::in('unit', ['a', 'b'], ':inParam');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('unit')
|
||||
->op->toBe(Op::In)
|
||||
->paramName->toBe(':inParam')
|
||||
->and($field->value)->toEqual(['a', 'b']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::inArray()', function () {
|
||||
test('creates Field w/o parameter', function () {
|
||||
$field = Field::inArray('test', 'tbl', [1, 2, 3]);
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('test')
|
||||
->op->toBe(Op::InArray)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toEqual(['table' => 'tbl', 'values' => [1, 2, 3]]);
|
||||
});
|
||||
test('creates Field w/ parameter', function () {
|
||||
$field = Field::inArray('unit', 'tab', ['a', 'b'], ':inAParam');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('unit')
|
||||
->op->toBe(Op::InArray)
|
||||
->paramName->toBe(':inAParam')
|
||||
->and($field->value)->toEqual(['table' => 'tab', 'values' => ['a', 'b']]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::exists()', function () {
|
||||
test('creates Field', function () {
|
||||
$field = Field::exists('be_there');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('be_there')
|
||||
->op->toBe(Op::Exists)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toBeEmpty();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::notExists()', function () {
|
||||
test('creates Field', function () {
|
||||
$field = Field::notExists('be_absent');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('be_absent')
|
||||
->op->toBe(Op::NotExists)
|
||||
->paramName->toBeEmpty()
|
||||
->and($field->value)->toBeEmpty();
|
||||
});
|
||||
});
|
||||
|
||||
describe('::named()', function () {
|
||||
test('creates Field', function () {
|
||||
$field = Field::named('the_field');
|
||||
expect($field)
|
||||
->not->toBeNull()
|
||||
->fieldName->toBe('the_field')
|
||||
->op->toBe(Op::Equal)
|
||||
->value->toBeEmpty()
|
||||
->and($field->value)->toBeEmpty();
|
||||
});
|
||||
});
|
||||
18
tests/Unit/Mapper/ArrayMapperTest.php
Normal file
18
tests/Unit/Mapper/ArrayMapperTest.php
Normal file
@@ -0,0 +1,18 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\Mapper\ArrayMapper;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('->map()', function () {
|
||||
test('returns the given array', function () {
|
||||
$result = ['one' => 2, 'three' => 4, 'eight' => 'five'];
|
||||
expect((new ArrayMapper())->map($result))->toBe($result);
|
||||
});
|
||||
});
|
||||
17
tests/Unit/Mapper/CountMapperTest.php
Normal file
17
tests/Unit/Mapper/CountMapperTest.php
Normal file
@@ -0,0 +1,17 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\Mapper\CountMapper;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('->map()', function () {
|
||||
test('returns item 0 in the given array', function () {
|
||||
expect((new CountMapper())->map([5, 8, 10]))->toBe(5);
|
||||
});
|
||||
});
|
||||
65
tests/Unit/Mapper/DocumentMapperTest.php
Normal file
65
tests/Unit/Mapper/DocumentMapperTest.php
Normal file
@@ -0,0 +1,65 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{DocumentException, Field};
|
||||
use BitBadger\PDODocument\Mapper\DocumentMapper;
|
||||
use Test\{PjsonDocument, PjsonId};
|
||||
|
||||
// ** Test class hierarchy for serialization **
|
||||
|
||||
class DocMapSubDoc
|
||||
{
|
||||
public function __construct(public int $id = 0, public string $name = '') { }
|
||||
}
|
||||
|
||||
class DocMapTestDoc
|
||||
{
|
||||
public function __construct(public int $id = 0, public DocMapSubDoc $subDoc = new DocMapSubDoc()) { }
|
||||
}
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('Constructor', function () {
|
||||
test('uses "data" as the default field name', function () {
|
||||
expect(new DocumentMapper(Field::class))->fieldName->toBe('data');
|
||||
});
|
||||
test('uses the provided field name', function () {
|
||||
expect(new DocumentMapper(Field::class, 'json'))->fieldName->toBe('json');
|
||||
});
|
||||
});
|
||||
|
||||
describe('->map()', function () {
|
||||
test('deserializes valid JSON', function () {
|
||||
$doc = (new DocumentMapper(DocMapTestDoc::class))
|
||||
->map(['data' => '{"id":7,"subDoc":{"id":22,"name":"tester"}}']);
|
||||
expect($doc)
|
||||
->not->toBeNull()
|
||||
->id->toBe(7)
|
||||
->and($doc->subDoc)
|
||||
->not->toBeNull()
|
||||
->id->toBe(22)
|
||||
->name->toBe('tester');
|
||||
});
|
||||
test('deserializes valid JSON [Pjson]', function () {
|
||||
$doc = (new DocumentMapper(PjsonDocument::class))->map(['data' => '{"id":"seven","name":"bob","num_value":8}']);
|
||||
expect($doc)
|
||||
->not->toBeNull()
|
||||
->id->toEqual(new PjsonId('seven'))
|
||||
->name->toBe('bob')
|
||||
->numValue->toBe(8)
|
||||
->skipped->toBeEmpty();
|
||||
});
|
||||
test('throws for invalid JSON', function () {
|
||||
expect(fn() => (new DocumentMapper(DocMapTestDoc::class))->map(['data' => 'this is not valid']))
|
||||
->toThrow(DocumentException::class);
|
||||
});
|
||||
test('throws for invalid JSON [Pjson]', function () {
|
||||
expect(fn() => (new DocumentMapper(PjsonDocument::class))->map(['data' => 'not even close']))
|
||||
->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
28
tests/Unit/Mapper/ExistsMapperTest.php
Normal file
28
tests/Unit/Mapper/ExistsMapperTest.php
Normal file
@@ -0,0 +1,28 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Mode};
|
||||
use BitBadger\PDODocument\Mapper\ExistsMapper;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
|
||||
describe('->map()', function () {
|
||||
test('returns a boolean value from index 0 [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect((new ExistsMapper())->map([false, 'nope']))->toBeFalse();
|
||||
});
|
||||
test('returns a number value as boolean from index 0 [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect((new ExistsMapper())->map([1, 'yep']))->toBeTrue();
|
||||
});
|
||||
test('throws if mode is not set', function () {
|
||||
expect(fn() => (new ExistsMapper())->map(['0']))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
23
tests/Unit/Mapper/StringMapperTest.php
Normal file
23
tests/Unit/Mapper/StringMapperTest.php
Normal file
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\Mapper\StringMapper;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('->map()', function () {
|
||||
test('returns existing string column value', function () {
|
||||
expect(new StringMapper('test_field'))->map(['test_field' => 'test_value'])->toBe('test_value');
|
||||
});
|
||||
test('returns string value of non-string column', function () {
|
||||
expect(new StringMapper('a_number'))->map(['a_number' => 6.7])->toBe('6.7');
|
||||
});
|
||||
test('returns null for a missing column', function () {
|
||||
expect(new StringMapper('something_else'))->map([])->toBeNull();
|
||||
});
|
||||
});
|
||||
23
tests/Unit/ModeTest.php
Normal file
23
tests/Unit/ModeTest.php
Normal file
@@ -0,0 +1,23 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{DocumentException, Mode};
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('::deriveFromDSN()', function () {
|
||||
test('derives for PostgreSQL', function () {
|
||||
expect(Mode::deriveFromDSN('pgsql:Host=localhost'))->toBe(Mode::PgSQL);
|
||||
})->group('postgresql');
|
||||
test('derives for SQLite', function () {
|
||||
expect(Mode::deriveFromDSN('sqlite:data.db'))->toBe(Mode::SQLite);
|
||||
})->group('sqlite');
|
||||
test('throws for other drivers', function () {
|
||||
expect(fn() => Mode::deriveFromDSN('mysql:Host=localhost'))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
47
tests/Unit/OpTest.php
Normal file
47
tests/Unit/OpTest.php
Normal file
@@ -0,0 +1,47 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\Op;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('->toSQL()', function () {
|
||||
test('returns "=" for Equal', function () {
|
||||
expect(Op::Equal)->toSQL()->toBe('=');
|
||||
});
|
||||
test('returns ">" for Greater', function () {
|
||||
expect(Op::Greater)->toSQL()->toBe('>');
|
||||
});
|
||||
test('returns ">=" for GreaterOrEqual', function () {
|
||||
expect(Op::GreaterOrEqual)->toSQL()->toBe('>=');
|
||||
});
|
||||
test('returns "<" for Less', function () {
|
||||
expect(Op::Less)->toSQL()->toBe('<');
|
||||
});
|
||||
test('returns "<=" for LessOrEqual', function () {
|
||||
expect(Op::LessOrEqual)->toSQL()->toBe('<=');
|
||||
});
|
||||
test('returns "<>" for NotEqual', function () {
|
||||
expect(Op::NotEqual)->toSQL()->toBe('<>');
|
||||
});
|
||||
test('returns "BETWEEN" for Between', function () {
|
||||
expect(Op::Between)->toSQL()->toBe('BETWEEN');
|
||||
});
|
||||
test('returns "IN" for In', function () {
|
||||
expect(Op::In)->toSQL()->toBe('IN');
|
||||
});
|
||||
test('returns "?|" (escaped) for InArray', function () {
|
||||
expect(Op::InArray)->toSQL()->toBe('??|');
|
||||
});
|
||||
test('returns "IS NOT NULL" for Exists', function () {
|
||||
expect(Op::Exists)->toSQL()->toBe('IS NOT NULL');
|
||||
});
|
||||
test('returns "IS NULL" for NotExists', function () {
|
||||
expect(Op::NotExists)->toSQL()->toBe('IS NULL');
|
||||
});
|
||||
});
|
||||
85
tests/Unit/ParametersTest.php
Normal file
85
tests/Unit/ParametersTest.php
Normal file
@@ -0,0 +1,85 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode, Parameters};
|
||||
use Test\{PjsonDocument, PjsonId};
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('::id()', function () {
|
||||
test('creates string ID parameter', function () {
|
||||
expect(Parameters::id('key'))->toEqual([':id' => 'key']);
|
||||
});
|
||||
test('creates string from numeric ID parameter', function () {
|
||||
expect(Parameters::id(7))->toEqual([':id' => '7']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::json()', function () {
|
||||
test('serializes an array', function () {
|
||||
expect(Parameters::json(':it', ['id' => 18, 'url' => 'https://www.unittest.com']))
|
||||
->toEqual([':it' => '{"id":18,"url":"https://www.unittest.com"}']);
|
||||
});
|
||||
test('serializes an array w/ an empty array value', function () {
|
||||
expect(Parameters::json(':it', ['id' => 18, 'urls' => []]))->toEqual([':it' => '{"id":18,"urls":[]}']);
|
||||
});
|
||||
test('serializes a 1-D array w/ an empty array value', function () {
|
||||
expect(Parameters::json(':it', ['urls' => []]))->toEqual([':it' => '{"urls":[]}']);
|
||||
});
|
||||
test('serializes a stdClass instance', function () {
|
||||
$obj = new stdClass();
|
||||
$obj->id = 19;
|
||||
$obj->url = 'https://testhere.info';
|
||||
expect(Parameters::json(':it', $obj))->toEqual([':it' => '{"id":19,"url":"https://testhere.info"}']);
|
||||
});
|
||||
test('serializes a Pjson class instance', function () {
|
||||
expect(Parameters::json(':it', new PjsonDocument(new PjsonId('999'), 'a test', 98, 'nothing')))
|
||||
->toEqual([':it' => '{"id":"999","name":"a test","num_value":98}']);
|
||||
});
|
||||
test('serializes an array of Pjson class instances', function () {
|
||||
expect(Parameters::json(':it',
|
||||
['pjson' => [new PjsonDocument(new PjsonId('997'), 'another test', 94, 'nothing')]]))
|
||||
->toEqual([':it' => '{"pjson":[{"id":"997","name":"another test","num_value":94}]}']);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::nameFields()', function () {
|
||||
test('provides missing parameter names', function () {
|
||||
$named = [Field::equal('it', 17), Field::equal('also', 22, ':also'), Field::equal('other', 24)];
|
||||
Parameters::nameFields($named);
|
||||
expect($named)
|
||||
->toHaveLength(3)
|
||||
->sequence(
|
||||
fn($it) => $it->paramName->toBe(':field0'),
|
||||
fn($it) => $it->paramName->toBe(':also'),
|
||||
fn($it) => $it->paramName->toBe(':field2'));
|
||||
});
|
||||
});
|
||||
|
||||
describe('::addFields()', function () {
|
||||
test('appends to an existing parameter array', function () {
|
||||
expect(Parameters::addFields([Field::equal('b', 'two', ':b'), Field::equal('z', 18, ':z')], [':a' => 1]))
|
||||
->toEqual([':a' => 1, ':b' => 'two', ':z' => 18]);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::fieldNames()', function () {
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
test('generates names [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Parameters::fieldNames(':names', ['one', 'two', 'seven']))->toEqual([':names' => "{one,two,seven}"]);
|
||||
})->group('postgresql');
|
||||
test('generates names [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Parameters::fieldNames(':it', ['test', 'unit', 'wow']))
|
||||
->toEqual([':it0' => '$.test', ':it1' => '$.unit', ':it2' => '$.wow']);
|
||||
})->group('sqlite');
|
||||
test('throws when mode is not set', function () {
|
||||
expect(fn() => Parameters::fieldNames('', []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
51
tests/Unit/Query/CountTest.php
Normal file
51
tests/Unit/Query/CountTest.php
Normal file
@@ -0,0 +1,51 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode};
|
||||
use BitBadger\PDODocument\Query\Count;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
|
||||
describe('::all()', function () {
|
||||
test('generates the correct SQL', function () {
|
||||
expect(Count::all('a_table'))->toBe('SELECT COUNT(*) FROM a_table');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('generates the correct SQL', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Count::byFields('somewhere', [Field::greater('errors', 10, ':errors')]))
|
||||
->toBe("SELECT COUNT(*) FROM somewhere WHERE data->>'errors' > :errors");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('generates the correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Count::byContains('the_table'))->toBe('SELECT COUNT(*) FROM the_table WHERE data @> :criteria');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Count::byContains(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('generates the correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Count::byJsonPath('a_table'))
|
||||
->toBe('SELECT COUNT(*) FROM a_table WHERE jsonb_path_exists(data, :path::jsonpath)');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Count::byJsonPath(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
65
tests/Unit/Query/DefinitionTest.php
Normal file
65
tests/Unit/Query/DefinitionTest.php
Normal file
@@ -0,0 +1,65 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, DocumentIndex, Mode};
|
||||
use BitBadger\PDODocument\Query\Definition;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
describe('::ensureTable()', function () {
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Definition::ensureTable('documents'))
|
||||
->toBe('CREATE TABLE IF NOT EXISTS documents (data JSONB NOT NULL)');
|
||||
})->group('postgresql');
|
||||
test('generates correct SQL [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Definition::ensureTable('dox'))->toBe('CREATE TABLE IF NOT EXISTS dox (data TEXT NOT NULL)');
|
||||
})->group('sqlite');
|
||||
test('throws an exception if mode is not set', function () {
|
||||
expect(fn () => Definition::ensureTable(''))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::ensureIndexOn()', function () {
|
||||
test('generates correct SQL for unqualified table, single ascending field', function () {
|
||||
expect(Definition::ensureIndexOn('test', 'fields', ['details']))
|
||||
->toBe("CREATE INDEX IF NOT EXISTS idx_test_fields ON test ((data->>'details'))");
|
||||
});
|
||||
test('generates correct SQL for qualified table, multiple fields', function () {
|
||||
expect(Definition::ensureIndexOn('sch.testing', 'json', ['group', 'sub_group DESC']))
|
||||
->toBe('CREATE INDEX IF NOT EXISTS idx_testing_json ON sch.testing '
|
||||
. "((data->>'group'), (data->>'sub_group') DESC)");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::ensureKey()', function () {
|
||||
test('generates correct SQL', function () {
|
||||
expect(Definition::ensureKey('tbl'))
|
||||
->toBe("CREATE UNIQUE INDEX IF NOT EXISTS idx_tbl_key ON tbl ((data->>'id'))");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::ensureDocumentIndexOn()', function () {
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
test('generates correct SQL for qualified table, full index [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Definition::ensureDocumentIndexOn('my.tbl', DocumentIndex::Full))
|
||||
->toBe("CREATE INDEX IF NOT EXISTS idx_tbl_document ON my.tbl USING GIN (data)");
|
||||
})->group('postgresql');
|
||||
test('generates correct SQL for unqualified table, optimized index [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Definition::ensureDocumentIndexOn('it', DocumentIndex::Optimized))
|
||||
->toBe("CREATE INDEX IF NOT EXISTS idx_it_document ON it USING GIN (data jsonb_path_ops)");
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Definition::ensureDocumentIndexOn('', DocumentIndex::Full))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
52
tests/Unit/Query/DeleteTest.php
Normal file
52
tests/Unit/Query/DeleteTest.php
Normal file
@@ -0,0 +1,52 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode};
|
||||
use BitBadger\PDODocument\Query\Delete;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('generates correct SQL', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Delete::byId('over_there'))->toBe("DELETE FROM over_there WHERE data->>'id' = :id");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('generates correct SQL', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Delete::byFields('my_table',
|
||||
[Field::less('value', 99, ':max'), Field::greaterOrEqual('value', 18, ':min')]))
|
||||
->toBe("DELETE FROM my_table WHERE data->>'value' < :max AND data->>'value' >= :min");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Delete::byContains('somewhere'))->toBe('DELETE FROM somewhere WHERE data @> :criteria');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Delete::byContains(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Delete::byJsonPath('here'))->toBe('DELETE FROM here WHERE jsonb_path_exists(data, :path::jsonpath)');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Delete::byJsonPath(''))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
59
tests/Unit/Query/ExistsTest.php
Normal file
59
tests/Unit/Query/ExistsTest.php
Normal file
@@ -0,0 +1,59 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode};
|
||||
use BitBadger\PDODocument\Query\Exists;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
|
||||
describe('::query()', function () {
|
||||
test('generates correct SQL', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Exists::query('abc', 'def'))->toBe('SELECT EXISTS (SELECT 1 FROM abc WHERE def)');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('generates correct SQL', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Exists::byId('dox'))->toBe("SELECT EXISTS (SELECT 1 FROM dox WHERE data->>'id' = :id)");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('generates correct SQL', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Exists::byFields('box', [Field::notEqual('status', 'occupied', ':status')]))
|
||||
->toBe("SELECT EXISTS (SELECT 1 FROM box WHERE data->>'status' <> :status)");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Exists::byContains('pocket'))->toBe('SELECT EXISTS (SELECT 1 FROM pocket WHERE data @> :criteria)');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Exists::byContains(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Exists::byJsonPath('lint'))
|
||||
->toBe('SELECT EXISTS (SELECT 1 FROM lint WHERE jsonb_path_exists(data, :path::jsonpath))');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Exists::byJsonPath(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
53
tests/Unit/Query/FindTest.php
Normal file
53
tests/Unit/Query/FindTest.php
Normal file
@@ -0,0 +1,53 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, FieldMatch, Mode};
|
||||
use BitBadger\PDODocument\Query\Find;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('generates correct SQL', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Find::byId('here'))->toBe("SELECT data FROM here WHERE data->>'id' = :id");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('generates correct SQL', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Find::byFields('there', [Field::equal('active', true, ':act'), Field::equal('locked', true, ':lock')],
|
||||
FieldMatch::Any))
|
||||
->toBe("SELECT data FROM there WHERE data->>'active' = :act OR data->>'locked' = :lock");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Find::byContains('disc'))->toBe('SELECT data FROM disc WHERE data @> :criteria');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Find::byContains(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Find::byJsonPath('light'))
|
||||
->toBe('SELECT data FROM light WHERE jsonb_path_exists(data, :path::jsonpath)');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Find::byJsonPath(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
68
tests/Unit/Query/PatchTest.php
Normal file
68
tests/Unit/Query/PatchTest.php
Normal file
@@ -0,0 +1,68 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode};
|
||||
use BitBadger\PDODocument\Query\Patch;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Patch::byId('doc_table'))->toBe("UPDATE doc_table SET data = data || :data WHERE data->>'id' = :id");
|
||||
})->group('postgresql');
|
||||
test('generates correct SQL [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Patch::byId('my_table'))
|
||||
->toBe("UPDATE my_table SET data = json_patch(data, json(:data)) WHERE data->>'id' = :id");
|
||||
})->group('sqlite');
|
||||
test('throws an exception [mode not set]', function () {
|
||||
expect(fn () => Patch::byId(''))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Patch::byFields('that', [Field::less('something', 17, ':some')]))
|
||||
->toBe("UPDATE that SET data = data || :data WHERE (data->>'something')::numeric < :some");
|
||||
})->group('postgresql');
|
||||
test('generates correct SQL [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(Patch::byFields('a_table', [Field::greater('something', 17, ':it')]))
|
||||
->toBe("UPDATE a_table SET data = json_patch(data, json(:data)) WHERE data->>'something' > :it");
|
||||
})->group('sqlite');
|
||||
test('throws an exception [mode not set]', function () {
|
||||
expect(fn () => Patch::byFields('', []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Patch::byContains('this'))->toBe('UPDATE this SET data = data || :data WHERE data @> :criteria');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Patch::byContains(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Patch::byJsonPath('that'))
|
||||
->toBe('UPDATE that SET data = data || :data WHERE jsonb_path_exists(data, :path::jsonpath)');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(fn () => Patch::byJsonPath(''))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
86
tests/Unit/Query/RemoveFieldsTest.php
Normal file
86
tests/Unit/Query/RemoveFieldsTest.php
Normal file
@@ -0,0 +1,86 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode, Parameters};
|
||||
use BitBadger\PDODocument\Query\RemoveFields;
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
|
||||
describe('::update()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(RemoveFields::update('taco', [':names' => "{one,two}"], 'it = true'))
|
||||
->toBe('UPDATE taco SET data = data - :names::text[] WHERE it = true');
|
||||
})->group('postgresql');
|
||||
test('generates correct SQL [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(RemoveFields::update('burrito', Parameters::fieldNames(':name', ['one', 'two', 'ten']), 'a = b'))
|
||||
->toBe('UPDATE burrito SET data = json_remove(data, :name0, :name1, :name2) WHERE a = b');
|
||||
})->group('sqlite');
|
||||
test('throws an exception [mode not set]', function () {
|
||||
expect(fn () => RemoveFields::update('', [], ''))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byId()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(RemoveFields::byId('churro', Parameters::fieldNames(':bite', ['byte'])))
|
||||
->toBe("UPDATE churro SET data = data - :bite::text[] WHERE data->>'id' = :id");
|
||||
})->group('postgresql');
|
||||
test('generates correct SQL [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(RemoveFields::byId('quesadilla', Parameters::fieldNames(':bite', ['byte'])))
|
||||
->toBe("UPDATE quesadilla SET data = json_remove(data, :bite0) WHERE data->>'id' = :id");
|
||||
})->group('sqlite');
|
||||
test('throws an exception [mode not set]', function () {
|
||||
expect(fn () => RemoveFields::byId('', []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byFields()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(RemoveFields::byFields('enchilada', [Field::equal('cheese', 'jack', ':queso')],
|
||||
Parameters::fieldNames(':sauce', ['white'])))
|
||||
->toBe("UPDATE enchilada SET data = data - :sauce::text[] WHERE data->>'cheese' = :queso");
|
||||
})->group('postgresql');
|
||||
test('generates correct SQL [SQLite]', function () {
|
||||
Configuration::overrideMode(Mode::SQLite);
|
||||
expect(RemoveFields::byFields('chimichanga', [Field::equal('side', 'beans', ':rice')],
|
||||
Parameters::fieldNames(':filling', ['beef'])))
|
||||
->toBe("UPDATE chimichanga SET data = json_remove(data, :filling0) WHERE data->>'side' = :rice");
|
||||
})->group('sqlite');
|
||||
test('throws an exception [mode not set]', function () {
|
||||
expect(fn () => RemoveFields::byFields('', [], []))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::byContains()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(RemoveFields::byContains('food', Parameters::fieldNames(':drink', ['a', 'b'])))
|
||||
->toBe('UPDATE food SET data = data - :drink::text[] WHERE data @> :criteria');
|
||||
})->group('postgresql');
|
||||
test('throws an exception [SQLite]', function () {
|
||||
expect(fn () => RemoveFields::byContains('', []))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
|
||||
describe('::byJsonPath()', function () {
|
||||
test('generates correct SQL [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(RemoveFields::byJsonPath('dessert', Parameters::fieldNames(':cake', ['b', 'c'])))
|
||||
->toBe('UPDATE dessert SET data = data - :cake::text[] WHERE jsonb_path_exists(data, :path::jsonpath)');
|
||||
});
|
||||
test('throws an exception [SQLite]', function () {
|
||||
expect(fn () => RemoveFields::byJsonPath('', []))->toThrow(DocumentException::class);
|
||||
})->group('sqlite');
|
||||
});
|
||||
201
tests/Unit/QueryTest.php
Normal file
201
tests/Unit/QueryTest.php
Normal file
@@ -0,0 +1,201 @@
|
||||
<?php
|
||||
/**
|
||||
* @author Daniel J. Summers <daniel@bitbadger.solutions>
|
||||
* @license MIT
|
||||
*/
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
use BitBadger\PDODocument\{AutoId, Configuration, DocumentException, Field, FieldMatch, Mode, Query};
|
||||
|
||||
pest()->group('unit');
|
||||
|
||||
beforeEach(function () { Configuration::overrideMode(Mode::SQLite); });
|
||||
afterEach(function () { Configuration::overrideMode(null); });
|
||||
|
||||
describe('::selectFromTable()', function () {
|
||||
test('correctly forms a query', function () {
|
||||
expect(Query::selectFromTable('testing'))->toBe('SELECT data FROM testing');
|
||||
});
|
||||
});
|
||||
|
||||
describe('::whereByFields()', function () {
|
||||
test('generates a single field correctly', function () {
|
||||
expect(Query::whereByFields([Field::lessOrEqual('test_field', '', ':it')]))->toBe("data->>'test_field' <= :it");
|
||||
});
|
||||
test('generates all fields correctly', function () {
|
||||
expect(Query::whereByFields(
|
||||
|
||||
[Field::lessOrEqual('test_field', '', ':it'), Field::equal('other_field', '', ':other')]))
|
||||
->toBe("data->>'test_field' <= :it AND data->>'other_field' = :other",);
|
||||
});
|
||||
test('generates any field correctly', function () {
|
||||
expect(Query::whereByFields(
|
||||
[Field::lessOrEqual('test_field', '', ':it'), Field::equal('other_field', '', ':other')],
|
||||
FieldMatch::Any))
|
||||
->toBe("data->>'test_field' <= :it OR data->>'other_field' = :other");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::whereById()', function () {
|
||||
test('uses default parameter name', function () {
|
||||
expect(Query::whereById())->toBe("data->>'id' = :id");
|
||||
});
|
||||
test('uses provided parameter name', function () {
|
||||
expect(Query::whereById(':di'))->toBe("data->>'id' = :di");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::whereDataContains()', function () {
|
||||
test('uses default parameter [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::whereDataContains())->toBe('data @> :criteria');
|
||||
});
|
||||
test('uses provided parameter [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::whereDataContains(':it'))->toBe('data @> :it');
|
||||
});
|
||||
test('throws [SQLite]', function () {
|
||||
expect(fn () => Query::whereDataContains())->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::whereJsonPathMatches()', function () {
|
||||
test('uses default parameter [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::whereJsonPathMatches())->toBe('jsonb_path_exists(data, :path::jsonpath)');
|
||||
});
|
||||
test('uses provided parameter [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::whereJsonPathMatches(':road'))->toBe('jsonb_path_exists(data, :road::jsonpath)');
|
||||
});
|
||||
test('throws [SQLite]', function () {
|
||||
expect(fn () => Query::whereJsonPathMatches())->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::insert()', function () {
|
||||
test('generates with no auto-ID [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::insert('test_tbl'))->toBe('INSERT INTO test_tbl VALUES (:data)');
|
||||
});
|
||||
test('generates with no auto-ID [SQLite]', function () {
|
||||
expect(Query::insert('test_tbl'))->toBe('INSERT INTO test_tbl VALUES (:data)');
|
||||
});
|
||||
test('generates with auto numeric ID [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::insert('test_tbl', AutoId::Number))
|
||||
->toBe("INSERT INTO test_tbl VALUES (:data::jsonb || ('{\"id\":' "
|
||||
. "|| (SELECT COALESCE(MAX((data->>'id')::numeric), 0) + 1 FROM test_tbl) || '}')::jsonb)");
|
||||
});
|
||||
test('generates with auto numeric ID [SQLite]', function () {
|
||||
expect(Query::insert('test_tbl', AutoId::Number))
|
||||
->toBe("INSERT INTO test_tbl VALUES (json_set(:data, '$.id', "
|
||||
. "(SELECT coalesce(max(data->>'id'), 0) + 1 FROM test_tbl)))");
|
||||
});
|
||||
test('generates with auto UUID [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::insert('test_tbl', AutoId::UUID))
|
||||
->toStartWith("INSERT INTO test_tbl VALUES (:data::jsonb || '{\"id\":\"")
|
||||
->toEndWith("\"}')");
|
||||
});
|
||||
test('generates with auto UUID [SQLite]', function () {
|
||||
expect(Query::insert('test_tbl', AutoId::UUID))
|
||||
->toStartWith("INSERT INTO test_tbl VALUES (json_set(:data, '$.id', '")
|
||||
->toEndWith("'))");
|
||||
});
|
||||
test('generates with auto random string [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
Configuration::$idStringLength = 8;
|
||||
try {
|
||||
$query = Query::insert('test_tbl', AutoId::RandomString);
|
||||
expect($query)
|
||||
->toStartWith("INSERT INTO test_tbl VALUES (:data::jsonb || '{\"id\":\"")
|
||||
->toEndWith("\"}')")
|
||||
->and(str_replace(["INSERT INTO test_tbl VALUES (:data::jsonb || '{\"id\":\"", "\"}')"], '', $query))
|
||||
->toHaveLength(8);
|
||||
} finally {
|
||||
Configuration::$idStringLength = 16;
|
||||
}
|
||||
});
|
||||
test('generates with auto random string [SQLite]', function () {
|
||||
$query = Query::insert('test_tbl', AutoId::RandomString);
|
||||
expect($query)
|
||||
->toStartWith("INSERT INTO test_tbl VALUES (json_set(:data, '$.id', '")
|
||||
->toEndWith("'))")
|
||||
->and(str_replace(["INSERT INTO test_tbl VALUES (json_set(:data, '$.id', '", "'))"], '', $query))
|
||||
->toHaveLength(16);
|
||||
});
|
||||
test('throws when mode not set', function () {
|
||||
Configuration::overrideMode(null);
|
||||
expect(fn () => Query::insert('kaboom'))->toThrow(DocumentException::class);
|
||||
});
|
||||
});
|
||||
|
||||
describe('::save()', function () {
|
||||
test('generates the correct query', function () {
|
||||
expect(Query::save('test_tbl'))
|
||||
->toBe("INSERT INTO test_tbl VALUES (:data) ON CONFLICT ((data->>'id')) DO UPDATE SET data = EXCLUDED.data");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::update()', function () {
|
||||
test('generates the correct query', function () {
|
||||
expect(Query::update('testing'))->toBe("UPDATE testing SET data = :data WHERE data->>'id' = :id");
|
||||
});
|
||||
});
|
||||
|
||||
describe('::orderBy()', function () {
|
||||
test('returns blank for no criteria [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::orderBy([]))->toBeEmpty();
|
||||
});
|
||||
test('returns blank for no criteria [SQLite]', function () {
|
||||
expect(Query::orderBy([]))->toBeEmpty();
|
||||
});
|
||||
test('generates one field with no direction [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::orderBy([Field::named('TestField')]))->toBe(" ORDER BY data->>'TestField'");
|
||||
});
|
||||
test('generates one field with no direction [SQLite]', function () {
|
||||
expect(Query::orderBy([Field::named('TestField')]))->toBe(" ORDER BY data->>'TestField'");
|
||||
});
|
||||
test('generates with one qualified field [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
$field = Field::named('TestField');
|
||||
$field->qualifier = 'qual';
|
||||
expect(Query::orderBy([$field]))->toBe(" ORDER BY qual.data->>'TestField'");
|
||||
});
|
||||
test('generates with one qualified field [SQLite]', function () {
|
||||
$field = Field::named('TestField');
|
||||
$field->qualifier = 'qual';
|
||||
expect(Query::orderBy([$field]))->toBe(" ORDER BY qual.data->>'TestField'");
|
||||
});
|
||||
test('generates with multiple fields and direction [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::orderBy(
|
||||
[Field::named('Nested.Test.Field DESC'), Field::named('AnotherField'), Field::named('It DESC')]))
|
||||
->toBe(" ORDER BY data#>>'{Nested,Test,Field}' DESC, data->>'AnotherField', data->>'It' DESC");
|
||||
});
|
||||
test('generates with multiple fields and direction [SQLite]', function () {
|
||||
expect(Query::orderBy(
|
||||
[Field::named('Nested.Test.Field DESC'), Field::named('AnotherField'), Field::named('It DESC')]))
|
||||
->toBe(" ORDER BY data->'Nested'->'Test'->>'Field' DESC, data->>'AnotherField', data->>'It' DESC");
|
||||
});
|
||||
test('generates with numeric field [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::orderBy([Field::named('n:Test')]))->toBe(" ORDER BY (data->>'Test')::numeric");
|
||||
});
|
||||
test('generates with numeric field [SQLite]', function () {
|
||||
expect(Query::orderBy([Field::named('n:Test')]))->toBe(" ORDER BY data->>'Test'");
|
||||
});
|
||||
test('generates case-insensitive ordering [PostgreSQL]', function () {
|
||||
Configuration::overrideMode(Mode::PgSQL);
|
||||
expect(Query::orderBy([Field::named('i:Test.Field DESC NULLS FIRST')]))
|
||||
->toBe(" ORDER BY LOWER(data#>>'{Test,Field}') DESC NULLS FIRST");
|
||||
});
|
||||
test('generates case-insensitive ordering [SQLite]', function () {
|
||||
expect(Query::orderBy([Field::named('i:Test.Field ASC NULLS LAST')]))
|
||||
->toBe(" ORDER BY data->'Test'->>'Field' COLLATE NOCASE ASC NULLS LAST");
|
||||
});
|
||||
});
|
||||
@@ -1,47 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Count, Field};
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the Count class
|
||||
*/
|
||||
#[TestDox('Count (SQLite integration)')]
|
||||
class CountTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public function testAllSucceeds(): void
|
||||
{
|
||||
$count = Count::all(ThrowawayDb::TABLE);
|
||||
$this->assertEquals(5, $count, 'There should have been 5 matching documents');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsForANumericRange(): void
|
||||
{
|
||||
$count = Count::byFields(ThrowawayDb::TABLE, [Field::BT('num_value', 10, 20)]);
|
||||
$this->assertEquals(3, $count, 'There should have been 3 matching documents');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsForANonNumericRange(): void
|
||||
{
|
||||
$count = Count::byFields(ThrowawayDb::TABLE, [Field::BT('value', 'aardvark', 'apple')]);
|
||||
$this->assertEquals(1, $count, 'There should have been 1 matching document');
|
||||
}
|
||||
}
|
||||
@@ -1,119 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Count, Custom, DocumentException, Query};
|
||||
use BitBadger\PDODocument\Mapper\{CountMapper, DocumentMapper};
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
/**
|
||||
* SQLite Integration tests for the Custom class
|
||||
*/
|
||||
#[TestDox('Custom (SQLite integration)')]
|
||||
class CustomTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
public function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
public function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
}
|
||||
|
||||
public function testRunQuerySucceedsWithAValidQuery()
|
||||
{
|
||||
$stmt = &Custom::runQuery('SELECT data FROM ' . ThrowawayDb::TABLE . ' LIMIT 1', []);
|
||||
try {
|
||||
$this->assertNotNull($stmt, 'The statement should not have been null');
|
||||
} finally {
|
||||
$stmt = null;
|
||||
}
|
||||
}
|
||||
|
||||
public function testRunQueryFailsWithAnInvalidQuery()
|
||||
{
|
||||
$this->expectException(DocumentException::class);
|
||||
$stmt = &Custom::runQuery('GRAB stuff FROM over_there UNTIL done', []);
|
||||
try {
|
||||
$this->assertTrue(false, 'This code should not be reached');
|
||||
} finally {
|
||||
$stmt = null;
|
||||
}
|
||||
}
|
||||
|
||||
public function testListSucceedsWhenDataIsFound()
|
||||
{
|
||||
$list = Custom::list(Query::selectFromTable(ThrowawayDb::TABLE), [], new DocumentMapper(TestDocument::class));
|
||||
$this->assertNotNull($list, 'The document list should not be null');
|
||||
$count = 0;
|
||||
foreach ($list->items() as $ignored) $count++;
|
||||
$this->assertEquals(5, $count, 'There should have been 5 documents in the list');
|
||||
}
|
||||
|
||||
public function testListSucceedsWhenNoDataIsFound()
|
||||
{
|
||||
$list = Custom::list(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'num_value' > :value",
|
||||
[':value' => 100], new DocumentMapper(TestDocument::class));
|
||||
$this->assertNotNull($list, 'The document list should not be null');
|
||||
$this->assertFalse($list->hasItems(), 'There should have been no documents in the list');
|
||||
}
|
||||
|
||||
public function testArraySucceedsWhenDataIsFound()
|
||||
{
|
||||
$array = Custom::array(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'sub' IS NOT NULL", [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
$this->assertNotNull($array, 'The document array should not be null');
|
||||
$this->assertCount(2, $array, 'There should have been 2 documents in the array');
|
||||
}
|
||||
|
||||
public function testArraySucceedsWhenNoDataIsFound()
|
||||
{
|
||||
$array = Custom::array(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'value' = :value",
|
||||
[':value' => 'not there'], new DocumentMapper(TestDocument::class));
|
||||
$this->assertNotNull($array, 'The document array should not be null');
|
||||
$this->assertCount(0, $array, 'There should have been no documents in the array');
|
||||
}
|
||||
|
||||
public function testSingleSucceedsWhenARowIsFound(): void
|
||||
{
|
||||
$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');
|
||||
}
|
||||
|
||||
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');
|
||||
}
|
||||
|
||||
public function testNonQuerySucceedsWhenOperatingOnData()
|
||||
{
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
$remaining = Count::all(ThrowawayDb::TABLE);
|
||||
$this->assertEquals(0, $remaining, 'There should be no documents remaining in the table');
|
||||
}
|
||||
|
||||
public function testNonQuerySucceedsWhenNoDataMatchesWhereClause()
|
||||
{
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE . " WHERE data->>'num_value' > :value", [':value' => 100]);
|
||||
$remaining = Count::all(ThrowawayDb::TABLE);
|
||||
$this->assertEquals(5, $remaining, 'There should be 5 documents remaining in the table');
|
||||
}
|
||||
|
||||
public function testScalarSucceeds()
|
||||
{
|
||||
$value = Custom::scalar("SELECT 5 AS it", [], new CountMapper());
|
||||
$this->assertEquals(5, $value, 'The scalar value was not returned correctly');
|
||||
}
|
||||
}
|
||||
@@ -1,60 +0,0 @@
|
||||
<?php
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Custom, Definition, DocumentException};
|
||||
use BitBadger\PDODocument\Mapper\ExistsMapper;
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the Definition class
|
||||
*/
|
||||
#[TestDox('Definition (SQLite integration)')]
|
||||
class DefinitionTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create(withData: false);
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
/**
|
||||
* Does the given named object exist in the database?
|
||||
*
|
||||
* @param string $name The name of the object whose existence should be verified
|
||||
* @return bool True if the object exists, false if not
|
||||
* @throws DocumentException If any is encountered
|
||||
*/
|
||||
private function itExists(string $name): bool
|
||||
{
|
||||
return Custom::scalar('SELECT EXISTS (SELECT 1 FROM sqlite_master WHERE name = :name)',
|
||||
[':name' => $name], new ExistsMapper());
|
||||
}
|
||||
|
||||
public function testEnsureTableSucceeds()
|
||||
{
|
||||
$this->assertFalse($this->itExists('ensured'), 'The table should not exist already');
|
||||
$this->assertFalse($this->itExists('idx_ensured_key'), 'The key index should not exist already');
|
||||
Definition::ensureTable('ensured');
|
||||
$this->assertTrue($this->itExists('ensured'), 'The table should now exist');
|
||||
$this->assertTrue($this->itExists('idx_ensured_key'), 'The key index should now exist');
|
||||
}
|
||||
|
||||
public function testEnsureFieldIndexSucceeds()
|
||||
{
|
||||
$this->assertFalse($this->itExists('idx_ensured_test'), 'The index should not exist already');
|
||||
Definition::ensureTable('ensured');
|
||||
Definition::ensureFieldIndex('ensured', 'test', ['name', 'age']);
|
||||
$this->assertTrue($this->itExists('idx_ensured_test'), 'The index should now exist');
|
||||
}
|
||||
}
|
||||
@@ -1,59 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Count, Delete, Field};
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the Delete class
|
||||
*/
|
||||
#[TestDox('Delete (SQLite integration)')]
|
||||
class DeleteTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when a document is deleted')]
|
||||
public function testByIdSucceedsWhenADocumentIsDeleted(): void
|
||||
{
|
||||
$this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
|
||||
Delete::byId(ThrowawayDb::TABLE, 'four');
|
||||
$this->assertEquals(4, Count::all(ThrowawayDb::TABLE), 'There should have been 4 documents remaining');
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when a document is not deleted')]
|
||||
public function testByIdSucceedsWhenADocumentIsNotDeleted(): void
|
||||
{
|
||||
$this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
|
||||
Delete::byId(ThrowawayDb::TABLE, 'negative four');
|
||||
$this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents remaining');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenDocumentsAreDeleted(): void
|
||||
{
|
||||
$this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::NE('value', 'purple')]);
|
||||
$this->assertEquals(2, Count::all(ThrowawayDb::TABLE), 'There should have been 2 documents remaining');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenDocumentsAreNotDeleted(): void
|
||||
{
|
||||
$this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents to start');
|
||||
Delete::byFields(ThrowawayDb::TABLE, [Field::EQ('value', 'crimson')]);
|
||||
$this->assertEquals(5, Count::all(ThrowawayDb::TABLE), 'There should have been 5 documents remaining');
|
||||
}
|
||||
}
|
||||
@@ -1,73 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{DocumentList, Query};
|
||||
use BitBadger\PDODocument\Mapper\DocumentMapper;
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the DocumentList class
|
||||
*/
|
||||
#[TestDox('DocumentList (SQLite integration)')]
|
||||
class DocumentListTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public function testCreateSucceeds(): void
|
||||
{
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
$this->assertNotNull($list, 'There should have been a document list created');
|
||||
$list = null;
|
||||
}
|
||||
|
||||
public function testItems(): void
|
||||
{
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE), [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
$this->assertNotNull($list, 'There should have been a document list created');
|
||||
$count = 0;
|
||||
foreach ($list->items() as $item) {
|
||||
$this->assertContains($item->id, ['one', 'two', 'three', 'four', 'five'],
|
||||
'An unexpected document ID was returned');
|
||||
$count++;
|
||||
}
|
||||
$this->assertEquals(5, $count, 'There should have been 5 documents returned');
|
||||
}
|
||||
|
||||
public function testHasItemsSucceedsWithEmptyResults(): void
|
||||
{
|
||||
$list = DocumentList::create(Query::selectFromTable(ThrowawayDb::TABLE) . " WHERE data->>'num_value' < 0", [],
|
||||
new DocumentMapper(TestDocument::class));
|
||||
$this->assertNotNull($list, 'There should have been a document list created');
|
||||
$this->assertFalse($list->hasItems(), 'There should be no items in the list');
|
||||
}
|
||||
|
||||
public function testHasItemsSucceedsWithNonEmptyResults(): 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');
|
||||
foreach ($list->items() as $ignored) {
|
||||
$this->assertTrue($list->hasItems(), 'There should be items remaining in the list');
|
||||
}
|
||||
$this->assertFalse($list->hasItems(), 'There should be no remaining items in the list');
|
||||
}
|
||||
}
|
||||
@@ -1,84 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Document, DocumentException, Find};
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Test\Integration\{SubDocument, TestDocument};
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the Document class
|
||||
*/
|
||||
#[TestDox('Document (SQLite integration)')]
|
||||
class DocumentTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public function testInsertSucceeds(): 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');
|
||||
$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');
|
||||
$this->assertNotNull($doc->sub, 'The sub-document should not have been null');
|
||||
$this->assertEquals('gobble', $doc->sub->foo, 'The sub-document foo property was incorrect');
|
||||
$this->assertEquals('gobble', $doc->sub->bar, 'The sub-document bar property was incorrect');
|
||||
}
|
||||
|
||||
public function testInsertFailsForDuplicateKey(): void
|
||||
{
|
||||
$this->expectException(DocumentException::class);
|
||||
Document::insert(ThrowawayDb::TABLE, new TestDocument('one'));
|
||||
}
|
||||
|
||||
public function testSaveSucceedsWhenADocumentIsInserted(): void
|
||||
{
|
||||
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');
|
||||
}
|
||||
|
||||
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');
|
||||
$this->assertEquals(44, $doc->num_value, 'The numeric value was not updated');
|
||||
$this->assertNull($doc->sub, 'The sub-document should have been null');
|
||||
}
|
||||
|
||||
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');
|
||||
$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');
|
||||
$this->assertEquals('y', $doc->sub->foo, 'The sub-document foo property was incorrect');
|
||||
$this->assertEquals('z', $doc->sub->bar, 'The sub-document bar property was incorrect');
|
||||
}
|
||||
|
||||
public function testUpdateSucceedsWhenNoDocumentIsReplaced(): void
|
||||
{
|
||||
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');
|
||||
}
|
||||
}
|
||||
@@ -1,54 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Exists, Field};
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the Exists class
|
||||
*/
|
||||
#[TestDox('Exists (SQLite integration)')]
|
||||
class ExistsTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when a document exists')]
|
||||
public function testByIdSucceedsWhenADocumentExists(): void
|
||||
{
|
||||
$this->assertTrue(Exists::byId(ThrowawayDb::TABLE, 'three'), 'There should have been an existing document');
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when a document does not exist')]
|
||||
public function testByIdSucceedsWhenADocumentDoesNotExist(): void
|
||||
{
|
||||
$this->assertFalse(Exists::byId(ThrowawayDb::TABLE, 'seven'),
|
||||
'There should not have been an existing document');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenDocumentsExist(): void
|
||||
{
|
||||
$this->assertTrue(Exists::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 10)]),
|
||||
'There should have been existing documents');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenNoMatchingDocumentsExist(): void
|
||||
{
|
||||
$this->assertFalse(Exists::byFields(ThrowawayDb::TABLE, [Field::LT('nothing', 'none')]),
|
||||
'There should not have been any existing documents');
|
||||
}
|
||||
}
|
||||
@@ -1,109 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Custom, Document, Field, Find};
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the Find class
|
||||
*/
|
||||
#[TestDox('Find (SQLite integration)')]
|
||||
class FindTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
public function testAllSucceedsWhenThereIsData(): void
|
||||
{
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class);
|
||||
$this->assertNotNull($docs, 'There should have been a document list returned');
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
$this->assertEquals(5, $count, 'There should have been 5 documents in the list');
|
||||
}
|
||||
|
||||
public function testAllSucceedsWhenThereIsNoData(): void
|
||||
{
|
||||
Custom::nonQuery('DELETE FROM ' . ThrowawayDb::TABLE, []);
|
||||
$docs = Find::all(ThrowawayDb::TABLE, TestDocument::class);
|
||||
$this->assertNotNull($docs, 'There should have been a document list returned');
|
||||
$this->assertFalse($docs->hasItems(), 'There should have been no documents in the list');
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when a document is found')]
|
||||
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');
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when a document is found with numeric ID')]
|
||||
public function testByIdSucceedsWhenADocumentIsFoundWithNumericId(): void
|
||||
{
|
||||
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');
|
||||
}
|
||||
|
||||
#[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');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenDocumentsAreFound(): void
|
||||
{
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::GT('num_value', 15)], TestDocument::class);
|
||||
$this->assertNotNull($docs, 'There should have been a document list returned');
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
$this->assertEquals(2, $count, 'There should have been 2 documents in the list');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenNoDocumentsAreFound(): void
|
||||
{
|
||||
$docs = Find::byFields(ThrowawayDb::TABLE, [Field::GT('num_value', 100)], TestDocument::class);
|
||||
$this->assertNotNull($docs, 'There should have been a document list returned');
|
||||
$count = 0;
|
||||
foreach ($docs->items() as $ignored) $count++;
|
||||
$this->assertFalse($docs->hasItems(), 'There should have been no documents in the list');
|
||||
}
|
||||
|
||||
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');
|
||||
}
|
||||
|
||||
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');
|
||||
}
|
||||
|
||||
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');
|
||||
}
|
||||
}
|
||||
@@ -1,60 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Count, Field, Find, Patch};
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the Patch class
|
||||
*/
|
||||
#[TestDox('Patch (SQLite integration)')]
|
||||
class PatchTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when a document is updated')]
|
||||
public function testByIdSucceedsWhenADocumentIsUpdated(): void
|
||||
{
|
||||
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');
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when no document is updated')]
|
||||
public function testByIdSucceedsWhenNoDocumentIsUpdated(): void
|
||||
{
|
||||
Patch::byId(ThrowawayDb::TABLE, 'forty-seven', ['foo' => 'green']);
|
||||
$this->assertTrue(true, 'The above not throwing an exception is the test');
|
||||
}
|
||||
|
||||
|
||||
public function testByFieldsSucceedsWhenADocumentIsUpdated(): void
|
||||
{
|
||||
Patch::byFields(ThrowawayDb::TABLE, [Field::EQ('value', 'purple')], ['num_value' => 77]);
|
||||
$after = Count::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 77)]);
|
||||
$this->assertEquals(2, $after, 'There should have been 2 documents updated');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenNoDocumentIsUpdated(): void
|
||||
{
|
||||
Patch::byFields(ThrowawayDb::TABLE, [Field::EQ('value', 'burgundy')], ['foo' => 'green']);
|
||||
$this->assertTrue(true, 'The above not throwing an exception is the test');
|
||||
}
|
||||
}
|
||||
@@ -1,74 +0,0 @@
|
||||
<?php declare(strict_types=1);
|
||||
|
||||
namespace Test\Integration\SQLite;
|
||||
|
||||
use BitBadger\PDODocument\{Field, Find, RemoveFields};
|
||||
use PHPUnit\Framework\Attributes\TestDox;
|
||||
use PHPUnit\Framework\TestCase;
|
||||
use Test\Integration\TestDocument;
|
||||
|
||||
/**
|
||||
* SQLite integration tests for the RemoveFields class
|
||||
*/
|
||||
#[TestDox('Remove Fields (SQLite integration)')]
|
||||
class RemoveFieldsTest extends TestCase
|
||||
{
|
||||
/** @var string Database name for throwaway database */
|
||||
private string $dbName;
|
||||
|
||||
protected function setUp(): void
|
||||
{
|
||||
parent::setUp();
|
||||
$this->dbName = ThrowawayDb::create();
|
||||
}
|
||||
|
||||
protected function tearDown(): void
|
||||
{
|
||||
ThrowawayDb::destroy($this->dbName);
|
||||
parent::tearDown();
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when fields are removed')]
|
||||
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');
|
||||
$this->assertEquals('', $doc->value, 'Value should have been blank (its default value)');
|
||||
$this->assertNull($doc->sub, 'Sub-document should have been null');
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when a field is not removed')]
|
||||
public function testByIdSucceedsWhenAFieldIsNotRemoved(): void
|
||||
{
|
||||
RemoveFields::byId(ThrowawayDb::TABLE, 'one', ['a_field_that_does_not_exist']);
|
||||
$this->assertTrue(true, 'The above not throwing an exception is the test');
|
||||
}
|
||||
|
||||
#[TestDox('By ID succeeds when no document is matched')]
|
||||
public function testByIdSucceedsWhenNoDocumentIsMatched(): void
|
||||
{
|
||||
RemoveFields::byId(ThrowawayDb::TABLE, 'fifty', ['sub']);
|
||||
$this->assertTrue(true, 'The above not throwing an exception is the test');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenAFieldIsRemoved(): void
|
||||
{
|
||||
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');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenAFieldIsNotRemoved(): void
|
||||
{
|
||||
RemoveFields::byFields(ThrowawayDb::TABLE, [Field::EQ('num_value', 17)], ['nada']);
|
||||
$this->assertTrue(true, 'The above not throwing an exception is the test');
|
||||
}
|
||||
|
||||
public function testByFieldsSucceedsWhenNoDocumentIsMatched(): void
|
||||
{
|
||||
RemoveFields::byFields(ThrowawayDb::TABLE, [Field::NE('missing', 'nope')], ['value']);
|
||||
$this->assertTrue(true, 'The above not throwing an exception is the test');
|
||||
}
|
||||
}
|
||||
Some files were not shown because too many files have changed in this diff Show More
Reference in New Issue
Block a user