VGirol\JsonApiAssert\Laravel\Asserts\Content\AssertPagination

Complexity

Total Complexity

8

Size/Duplication

Total Lines	122
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

6 Methods

Rating	Name	Duplication	Size	Complexity
A	assertResponseHasPagination()	0	4	1
A	assertResponseHasNoPaginationMeta()	0	13	2
A	assertResponseHasPaginationLinks()	0	8	1
A	assertResponseHasPaginationMeta()	0	15	1
A	assertResponseHasNoPaginationLinks()	0	13	2
A	assertResponseHasNoPagination()	0	4	1

<?php

namespace VGirol\JsonApiAssert\Laravel\Asserts\Content;

use Illuminate\Testing\TestResponse;
use PHPUnit\Framework\Assert as PHPUnit;
use VGirol\JsonApiAssert\Laravel\Messages;
use VGirol\JsonApiConstant\Members;

/**
 * This trait adds the ability to test pagination informations (links and meta).
 */
trait AssertPagination
{
    /**
     * Asserts that a document have no pagination links.
     *
     * @param TestResponse $response
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResponseHasNoPaginationLinks(TestResponse $response): void
    {
        // Decode JSON response
        $json = $response->json();

        if (!isset($json[Members::LINKS])) {
            static::assertNotHasMember(Members::LINKS, $json);

            return;
        }

        $links = $json[Members::LINKS];
        static::assertHasNoPaginationLinks($links);
    }

    /**
     * Asserts that a document have the expected pagination links.
     *
     * @param TestResponse $response
     * @param array        $expected
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResponseHasPaginationLinks(TestResponse $response, $expected)
    {
        // Decode JSON response
        $json = $response->json();

        static::assertHasLinks($json);
        $links = $json[Members::LINKS];
        static::assertPaginationLinksEquals($expected, $links);
    }

    /**
     * Asserts that a document have no pagination meta.
     *
     * @param TestResponse $response
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResponseHasNoPaginationMeta(TestResponse $response): void
    {
        // Decode JSON response
        $json = $response->json();

        if (!isset($json[Members::META])) {
            static::assertNotHasMember(Members::META, $json);

            return;
        }

        $meta = $json[Members::META];
        static::assertHasNoPaginationMeta($meta);
    }

    /**
     * Asserts that a document have pagination meta.
     *
     * @param TestResponse $response
     * @param array        $expected
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResponseHasPaginationMeta(TestResponse $response, $expected)
    {
        // Decode JSON response
        $json = $response->json();

        static::assertHasMeta($json);
        $meta = $json[Members::META];

        static::assertHasMember(Members::META_PAGINATION, $meta);

        $pagination = $meta[Members::META_PAGINATION];
        PHPUnit::assertEquals(
            $expected,
            $pagination,
            Messages::PAGINATION_META_IS_NOT_AS_EXPECTED
        );
    }

    /**
     * Asserts that a document have no pagination informations (links and meta).
     *
     * @param TestResponse $response
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResponseHasNoPagination(TestResponse $response)
    {
        static::assertResponseHasNoPaginationLinks($response);
        static::assertResponseHasNoPaginationMeta($response);
    }

    /**
     * Asserts that a document have pagination informations (links and meta).
     *
     * @param TestResponse $response
     * @param array        $expectedLinks
     * @param array        $expectedMeta
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResponseHasPagination(TestResponse $response, $expectedLinks, $expectedMeta)
    {
        static::assertResponseHasPaginationLinks($response, $expectedLinks);
        static::assertResponseHasPaginationMeta($response, $expectedMeta);
    }
}