SerializerTest.php

<?php

namespace MixerApi\CollectionView\Test\TestCase;

use Cake\Datasource\FactoryLocator;
use Cake\Datasource\Paging\PaginatedResultSet;
use Cake\Event\EventList;
use Cake\Event\EventManager;
use Cake\Http\Response;
use Cake\Http\ServerRequest;
use Cake\Routing\RouteBuilder;
use Cake\Routing\Router;
use Cake\TestSuite\TestCase;
use Cake\View\Helper\PaginatorHelper;
use MixerApi\CollectionView\Configuration;
use MixerApi\CollectionView\View\JsonCollectionView;
use MixerApi\CollectionView\Serializer;
use SimpleXMLElement;

class SerializerTest extends TestCase
{
    /**
     * @inheritdoc
     */
    public array $fixtures = [
        'plugin.MixerApi/CollectionView.Actors',
    ];

    public function setUp(): void
    {
        parent::setUp();
        (new Configuration())->default();
    }

    public function test_as_json(): void
    {
        EventManager::instance()->trackEvents(true)->setEventList(new EventList());

        $actor = FactoryLocator::get('Table')->get('Actors');

        $result = new PaginatedResultSet($actor->find()->limit(1)->all(), [
            'sort' => null,
            'direction' => null,
            'perPage' => 20,
            'requestedPage' => 1,
            'alias' => 'Actors',
            'scope' => null,
            'limit' => null,
            'count' => 20,
            'totalCount' => 60,
            'pageCount' => 1,
            'currentPage' => 1,
            'start' => 1,
            'end' => 3,
            'hasPrevPage' => false,
            'hasNextPage' => true,
        ]);

        $request = (new ServerRequest([
            'url' => '/',
            'params' => [
                'plugin' => null,
                'controller' => 'Actor',
                'action' => 'index',
            ],
        ]))->withEnv('HTTP_ACCEPT', 'application/json');

        Router::createRouteBuilder('/')->scope('/', function (RouteBuilder $builder) {
            $builder->setExtensions(['json']);
            $builder->connect('/', ['controller' => 'Actors', 'action' => 'index']);
            $builder->connect('/{controller}/{action}/*');
            $builder->connect('/{plugin}/{controller}/{action}/*');
        });
        Router::setRequest($request);

        $paginator = new PaginatorHelper(
            new JsonCollectionView($request, new Response()),
            ['templates' => 'MixerApi/CollectionView.paginator-template']
        );
        $paginator->setPaginated($result);

        $jsonSerializer = new Serializer($result, $request, $paginator);

        $json = $jsonSerializer->asJson(JSON_PRETTY_PRINT);
        $this->assertIsString($json);
        $this->assertIsArray($jsonSerializer->getData());

        $obj = json_decode($json);
        $this->assertIsObject($obj);
        $this->assertEventFired(Serializer::BEFORE_SERIALIZE_EVENT);
        $this->assertEventFired(Serializer::AFTER_SERIALIZE_EVENT);
        $this->assertEquals(20, $obj->collection->count);
        $this->assertEquals(60, $obj->collection->total);
        $this->assertEquals('/', $obj->collection->url);
        $this->assertCount(1, (array) $obj->data);
    }

    public function test_as_xml(): void
    {
        EventManager::instance()->trackEvents(true)->setEventList(new EventList());
        $actor = FactoryLocator::get('Table')->get('Actors');

        $result = new PaginatedResultSet($actor->find()->limit(1)->all(), [
            'sort' => null,
            'direction' => null,
            'perPage' => 20,
            'requestedPage' => 1,
            'alias' => 'Actors',
            'scope' => null,
            'limit' => null,
            'count' => 20,
            'totalCount' => 60,
            'pageCount' => 1,
            'currentPage' => 1,
            'start' => 1,
            'end' => 3,
            'hasPrevPage' => false,
            'hasNextPage' => true,
        ]);

        $request = (new ServerRequest([
            'url' => '/',
            'params' => [
                'plugin' => null,
                'controller' => 'Actor',
                'action' => 'index',
            ],
        ]))->withEnv('HTTP_ACCEPT', 'application/xml');

        Router::createRouteBuilder('/')->scope('/', function (RouteBuilder $builder) {
            $builder->setExtensions(['json']);
            $builder->connect('/', ['controller' => 'Actors', 'action' => 'index']);
            $builder->connect('/{controller}/{action}/*');
            $builder->connect('/{plugin}/{controller}/{action}/*');
        });
        Router::setRequest($request);

        $paginator = new PaginatorHelper(
            new JsonCollectionView($request, new Response()),
            ['templates' => 'MixerApi/CollectionView.paginator-template']
        );
        $paginator->setPaginated($result);

        $jsonSerializer = new Serializer($result, $request, $paginator);

        $xml = $jsonSerializer->asXml(['pretty' => true]);
        $this->assertIsString($xml);

        $simpleXml = simplexml_load_string($xml);
        $this->assertEventFired(Serializer::BEFORE_SERIALIZE_EVENT);
        $this->assertEventFired(Serializer::AFTER_SERIALIZE_EVENT);
        $this->assertInstanceOf(SimpleXMLElement::class, $simpleXml);
        $this->assertEquals('/', $simpleXml->collection->url);
        $this->assertInstanceOf(SimpleXMLElement::class, $simpleXml->data);
    }

    public function test_as_json_throws_run_time_exception(): void
    {
        $this->expectException(\RuntimeException::class);
        (new Serializer(NAN))->asJson(0);
    }
}