VGirol\JsonApiAssert\Laravel\Asserts\Response\AssertFetchedCollection

Complexity

Total Complexity

1

Size/Duplication

Total Lines	35
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes	1
Bugs	0	Features	0

1 Method

Rating	Name	Duplication	Size	Complexity
A	assertFetchedResourceCollectionResponse()	0	23	1

<?php

namespace VGirol\JsonApiAssert\Laravel\Asserts\Response;

use Illuminate\Testing\TestResponse;
use VGirol\JsonApiAssert\Laravel\HttpHeader;
use VGirol\JsonApiConstant\Members;

/**
 * This trait adds the ability to test fetching collection response.
 */
trait AssertFetchedCollection
{
    /**
     * Asserts that the response has "200 Ok" status code and valid content.
     *
     * @param TestResponse $response
     * @param array        $expected The expected collection of resource objects.
     * @param boolean      $strict   If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertFetchedResourceCollectionResponse(TestResponse $response, $expected, bool $strict)
    {
        $response->assertStatus(200);
        $response->assertHeader(
            HttpHeader::HEADER_NAME,
            HttpHeader::MEDIA_TYPE
        );

        // Decode JSON response
        $json = $response->json();

        // Checks response structure
        static::assertHasValidStructure(
            $json,
            $strict
        );

        // Checks data member
        static::assertHasData($json);
        $data = $json[Members::DATA];
        static::assertResourceCollectionEquals(
            $expected,
            $data
        );
    }
}