pdo-document/tests/unit/ParametersTest.php

<?php
/**
 * @author Daniel J. Summers <daniel@bitbadger.solutions>
 * @license MIT
 */

declare(strict_types=1);

namespace Test\Unit;

use BitBadger\PDODocument\{Configuration, DocumentException, Field, Mode, Parameters};
use PHPUnit\Framework\Attributes\TestDox;
use PHPUnit\Framework\TestCase;
use stdClass;
use Test\{PjsonDocument, PjsonId};

/**
 * Unit tests for the Parameters class
 */
#[TestDox('Parameters (Unit tests)')]
class ParametersTest extends TestCase
{
    #[TestDox('id() succeeds with string')]
    public function testIdSucceedsWithString(): void
    {
        $this->assertEquals([':id' => 'key'], Parameters::id('key'), 'ID parameter not constructed correctly');
    }

    #[TestDox('id() succeeds with non string')]
    public function testIdSucceedsWithNonString(): void
    {
        $this->assertEquals([':id' => '7'], Parameters::id(7), 'ID parameter not constructed correctly');
    }

    #[TestDox('json() succeeds for array')]
    public function testJsonSucceedsForArray(): void
    {
        $this->assertEquals([':it' => '{"id":18,"url":"https://www.unittest.com"}'],
            Parameters::json(':it', ['id' => 18, 'url' => 'https://www.unittest.com']),
            'JSON parameter not constructed correctly');
    }

    #[TestDox('json() succeeds for array with empty array parameter')]
    public function testJsonSucceedsForArrayWithEmptyArrayParameter(): void
    {
        $this->assertEquals([':it' => '{"id":18,"urls":[]}'], Parameters::json(':it', ['id' => 18, 'urls' => []]),
            'JSON parameter not constructed correctly');
    }

    #[TestDox('json() succeeds for 1D array with empty array parameter')]
    public function testJsonSucceedsFor1DArrayWithEmptyArrayParameter(): void
    {
        $this->assertEquals([':it' => '{"urls":[]}'], Parameters::json(':it', ['urls' => []]),
            'JSON parameter not constructed correctly');
    }

    #[TestDox('json() succeeds for stdClass')]
    public function testJsonSucceedsForStdClass(): void
    {
        $obj      = new stdClass();
        $obj->id  = 19;
        $obj->url = 'https://testhere.info';
        $this->assertEquals([':it' => '{"id":19,"url":"https://testhere.info"}'], Parameters::json(':it', $obj),
            'JSON parameter not constructed correctly');
    }

    #[TestDox('json() succeeds for Pjson class')]
    public function testJsonSucceedsForPjsonClass(): void
    {
        $this->assertEquals([':it' => '{"id":"999","name":"a test","num_value":98}'],
            Parameters::json(':it', new PjsonDocument(new PjsonId('999'), 'a test', 98, 'nothing')),
            'JSON parameter not constructed correctly');
    }

    #[TestDox('json() succeeds for array of Pjson class')]
    public function testJsonSucceedsForArrayOfPjsonClass(): void
    {
        $this->assertEquals([':it' => '{"pjson":[{"id":"997","name":"another test","num_value":94}]}'],
            Parameters::json(':it',
                ['pjson' => [new PjsonDocument(new PjsonId('997'), 'another test', 94, 'nothing')]]),
            'JSON parameter not constructed correctly');
    }

    #[TestDox('nameFields() succeeds')]
    public function testNameFieldsSucceeds(): void
    {
        $named = [Field::equal('it', 17), Field::equal('also', 22, ':also'), Field::equal('other', 24)];
        Parameters::nameFields($named);
        $this->assertCount(3, $named, 'There should be 3 parameters in the array');
        $this->assertEquals(':field0', $named[0]->paramName, 'Parameter 1 not named correctly');
        $this->assertEquals(':also', $named[1]->paramName, 'Parameter 2 not named correctly');
        $this->assertEquals(':field2', $named[2]->paramName, 'Parameter 3 not named correctly');
    }

    #[TestDox('addFields() succeeds')]
    public function testAddFieldsSucceeds(): void
    {
        $this->assertEquals([':a' => 1, ':b' => 'two', ':z' => 18],
            Parameters::addFields([Field::equal('b', 'two', ':b'), Field::equal('z', 18, ':z')], [':a' => 1]),
            'Field parameters not added correctly');
    }

    #[TestDox('fieldNames() succeeds for PostgreSQL')]
    public function testFieldNamesSucceedsForPostgreSQL(): void
    {
        try {
            Configuration::overrideMode(Mode::PgSQL);
            $this->assertEquals([':names' => "{one,two,seven}"],
                Parameters::fieldNames(':names', ['one', 'two', 'seven']), 'Field name parameters not correct');
        } finally {
            Configuration::overrideMode(null);
        }
    }

    #[TestDox('fieldNames() succeeds for SQLite')]
    public function testFieldNamesSucceedsForSQLite(): void
    {
        try {
            Configuration::overrideMode(Mode::SQLite);
            $this->assertEquals([':it0' => '$.test', ':it1' => '$.unit', ':it2' => '$.wow'],
                Parameters::fieldNames(':it', ['test', 'unit', 'wow']), 'Field name parameters not correct');
        } finally {
            Configuration::overrideMode(null);
        }
    }

    #[TestDox('fieldNames() fails when mode not set')]
    public function testFieldNamesFailsWhenModeNotSet(): void
    {
        $this->expectException(DocumentException::class);
        Configuration::overrideMode(null);
        Parameters::fieldNames('', []);
    }
}