DocumentTest.php

<?php
/**
 *
 *  * This file is part of JSON:API implementation for PHP.
 *  *
 *  * (c) Alexey Karapetov <karapetov@gmail.com>
 *  *
 *  * For the full copyright and license information, please view the LICENSE
 *  * file that was distributed with this source code.
 *
 */

declare(strict_types=1);

namespace JsonApiPhp\JsonApi\Test\Document;

use JsonApiPhp\JsonApi\Document\Document;
use JsonApiPhp\JsonApi\Document\Error;
use JsonApiPhp\JsonApi\Document\Resource\NullData;
use JsonApiPhp\JsonApi\Document\Resource\ResourceId;
use JsonApiPhp\JsonApi\Test\HasAssertEqualsAsJson;
use PHPUnit\Framework\TestCase;

class DocumentTest extends TestCase
{
    use HasAssertEqualsAsJson;

    public function testCanCreateFromMeta()
    {
        $this->assertEqualsAsJson(
            ['meta' => ['foo' => 'bar']],
            Document::fromMeta(['foo' => 'bar'])
        );
    }

    public function testCanCreateFromErrors()
    {
        $this->assertEqualsAsJson(
            ['errors' => []],
            Document::fromErrors()
        );

        $this->assertEqualsAsJson(
            [
                'errors' => [
                    ['id' => 'first'],
                ],
            ],
            $this->createErrorDoc()
        );
    }

    public function testCanCreateNullDocument()
    {
        $this->assertEqualsAsJson(
            ['data' => null],
            $this->createNullDoc()
        );
    }

    public function testCanCreateFromResourceId()
    {
        $this->assertEqualsAsJson(
            [
                'data' => [
                    'type' => 'books',
                    'id' => 'abc123',
                ],
            ],
            Document::fromResource(new ResourceId('books', 'abc123'))
        );
    }

    public function testCanCreateFromMultipleItems()
    {
        $this->assertEqualsAsJson(
            [
                'data' => [],
            ],
            Document::fromResources()
        );

        $this->assertEqualsAsJson(
            [
                'data' => [
                    [
                        'type' => 'books',
                        'id' => '12',
                    ],
                    [
                        'type' => 'carrots',
                        'id' => '42',
                    ],
                ],
            ],
            Document::fromResources(
                new ResourceId('books', '12'),
                new ResourceId('carrots', '42')
            )
        );
    }

    public function testDocumentMayContainVersion()
    {
        $doc = $this->createNullDoc();
        $doc->setApiVersion('1.2.3');
        $doc->setApiMeta(['a' => 'b']);
        $this->assertEqualsAsJson(
            [
                'data' => null,
                'jsonapi' => [
                    'version' => '1.2.3',
                    'meta' => ['a' => 'b'],
                ],
            ],
            $doc
        );
    }

    public function testDocumentMayContainLinks()
    {
        $doc = $this->createNullDoc();
        $doc->setLink('self', 'http://example.com/self');
        $doc->setLink('related', 'http://example.com/rel', ['a' => 'b']);
        $this->assertEqualsAsJson(
            [
                'data' => null,
                'links' => [
                    'self' => 'http://example.com/self',
                    'related' => [
                        'href' => 'http://example.com/rel',
                        'meta' => ['a' => 'b'],
                    ],
                ],
            ],
            $doc
        );
    }

    private function createErrorDoc(): Document
    {
        $e = new Error();
        $e->setId('first');
        return Document::fromErrors($e);
    }

    private function createNullDoc(): Document
    {
        return Document::fromResource(new NullData);
    }
}