pdo-document/tests/unit/Mapper/DocumentMapperTest.php

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

declare(strict_types=1);

namespace Test\Unit\Mapper;

use BitBadger\PDODocument\{DocumentException, Field};
use BitBadger\PDODocument\Mapper\DocumentMapper;
use PHPUnit\Framework\Attributes\TestDox;
use PHPUnit\Framework\TestCase;
use Test\{PjsonDocument, PjsonId};

// ** Test class hierarchy for serialization **

class SubDocument
{
    public function __construct(public int $id = 0, public string $name = '') { }
}

class TestDocument
{
    public function __construct(public int $id = 0, public SubDocument $subDoc = new SubDocument()) { }
}

/**
 * Unit tests for the DocumentMapper class
 */
#[TestDox('Document Mapper (Unit tests)')]
class DocumentMapperTest extends TestCase
{
    public function testConstructorSucceedsWithDefaultField(): void
    {
        $mapper = new DocumentMapper(Field::class);
        $this->assertEquals('data', $mapper->fieldName, 'Default field name should have been "data"');
    }

    public function testConstructorSucceedsWithSpecifiedField(): void
    {
        $mapper = new DocumentMapper(Field::class, 'json');
        $this->assertEquals('json', $mapper->fieldName, 'Field name not recorded correctly');
    }

    #[TestDox('map() succeeds with valid JSON')]
    public function testMapSucceedsWithValidJSON(): void
    {
        $doc = (new DocumentMapper(TestDocument::class))->map(['data' => '{"id":7,"subDoc":{"id":22,"name":"tester"}}']);
        $this->assertNotNull($doc, 'The document should not have been null');
        $this->assertEquals(7, $doc->id, 'ID not filled correctly');
        $this->assertNotNull($doc->subDoc, 'The sub-document should not have been null');
        $this->assertEquals(22, $doc->subDoc->id, 'Sub-document ID not filled correctly');
        $this->assertEquals('tester', $doc->subDoc->name, 'Sub-document name not filled correctly');
    }

    #[TestDox('map() succeeds with valid JSON for Pjson class')]
    public function testMapSucceedsWithValidJSONForPjsonClass(): void
    {
        $doc = (new DocumentMapper(PjsonDocument::class))->map(['data' => '{"id":"seven","name":"bob","num_value":8}']);
        $this->assertNotNull($doc, 'The document should not have been null');
        $this->assertEquals(new PjsonId('seven'), $doc->id, 'ID not filled correctly');
        $this->assertEquals('bob', $doc->name, 'Name not filled correctly');
        $this->assertEquals(8, $doc->numValue, 'Numeric value not filled correctly');
        $this->assertFalse(isset($doc->skipped), 'Non-JSON field has not been set');
    }

    #[TestDox('map() fails with invalid JSON')]
    public function testMapFailsWithInvalidJSON(): void
    {
        $this->expectException(DocumentException::class);
        (new DocumentMapper(TestDocument::class))->map(['data' => 'this is not valid']);
    }

    #[TestDox('map() fails with invalid JSON for Pjson class')]
    public function testMapFailsWithInvalidJSONForPjsonClass(): void
    {
        $this->expectException(DocumentException::class);
        (new DocumentMapper(PjsonDocument::class))->map(['data' => 'not even close']);
    }
}