VGirol\JsonApiAssert\Asserts\Structure\AssertResourceObject

Complexity

Total Complexity

8

Size/Duplication

Total Lines	151
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

8 Methods

Rating	Name	Duplication	Size	Complexity
A	assertHasValidFields()	0	3	1
A	assertIsNotForbiddenResourceFieldName()	0	3	1
A	assertIsValidResourceObjectCollection()	0	3	1
A	assertResourceIdMember()	0	3	1
A	assertIsValidResourceLinksObject()	0	3	1
A	assertResourceTypeMember()	0	3	1
A	assertResourceObjectHasValidTopLevelStructure()	0	3	1
A	assertIsValidResourceObject()	0	3	1

<?php

declare(strict_types=1);

namespace VGirol\JsonApiAssert\Asserts\Structure;

/**
 * Assertions relating to the resource object
 */
trait AssertResourceObject
{
    /**
     * Asserts that a json fragment is a valid collection of resource objects.
     *
     * It will do the following checks :
     * 1) asserts that the provided resource collection is either an empty array or an array of objects
     * (@see assertIsArrayOfObjects).
     * 2) asserts that the collection of resources is valid (@see assertIsValidResourceObject).
     *
     * @param array|null $json
     * @param boolean    $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidResourceObjectCollection($json, bool $strict): void
    {
        static::askService('validateResourceObjectCollection', $json, $strict);
    }

    /**
     * Asserts that a json fragment is a valid resource.
     *
     * It will do the following checks :
     * 1) asserts that the resource object has valid top-level structure
     * (@see assertResourceObjectHasValidTopLevelStructure).
     * 2) asserts that the resource object has valid "type" and "id" members
     * (@see assertResourceIdMember and @see assertResourceTypeMember).
     * 3) asserts that the resource object has valid fields (@see assertHasValidFields).
     *
     * Optionaly, if presents, it will checks :
     * 4) asserts thats the resource object has valid "attributes" member.
     * 5) asserts thats the resource object has valid "relationships" member.
     * 6) asserts thats the resource object has valid "links" member.
     * 7) asserts thats the resource object has valid "meta" member.
     *
     * @param array   $json
     * @param boolean $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidResourceObject($json, bool $strict): void
    {
        static::askService('validateResourceObject', $json, $strict);
    }

    /**
     * Asserts that a resource object has a valid top-level structure.
     *
     * It will do the following checks :
     * 1) asserts that the resource has an "id" member.
     * 2) asserts that the resource has a "type" member.
     * 3) asserts that the resource contains at least one of the following members :
     * "attributes", "relationships", "links", "meta" (@see assertContainsAtLeastOneMember).
     * 4) asserts that the resource contains only the following allowed members :
     * "id", "type", "meta", "attributes", "links", "relationships" (@see assertContainsOnlyAllowedMembers).
     *
     * @param array $resource
     * @param boolean $strict   If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResourceObjectHasValidTopLevelStructure($resource, bool $strict): void
    {
        static::askService('validateResourceObjectTopLevelStructure', $resource, $strict);
    }

    /**
     * Asserts that a resource id member is valid.
     *
     * It will do the following checks :
     * 1) asserts that the "id" member is not empty.
     * 2) asserts that the "id" member is a string.
     *
     * @param array $resource
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResourceIdMember($resource): void
    {
        static::askService('validateResourceIdMember', $resource);
    }

    /**
     * Asserts that a resource type member is valid.
     *
     * It will do the following checks :
     * 1) asserts that the "type" member is not empty.
     * 2) asserts that the "type" member is a string.
     * 3) asserts that the "type" member has a valid value (@see assertIsValidMemberName).
     *
     * @param array   $resource
     * @param boolean $strict   If true, excludes not safe characters when checking members name
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertResourceTypeMember($resource, bool $strict): void
    {
        static::askService('validateResourceTypeMember', $resource, $strict);
    }

    /**
     * Asserts that a json fragment is a valid resource links object.
     *
     * It will do the following checks :
     * 1) asserts that le links object is valid (@see assertIsValidLinksObject) with only "self" member allowed.
     *
     * @param array   $json
     * @param boolean $strict If true, excludes not safe characters when checking members name
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidResourceLinksObject($json, bool $strict): void
    {
        static::askService('validateResourceLinksObject', $json, $strict);
    }

    /**
     * Asserts that a resource object has valid fields (i.e., resource object’s attributes and its relationships).
     *
     * It will do the following checks :
     * 1) asserts that each attributes member and each relationship name is valid
     * (@see assertIsNotForbiddenResourceFieldName)
     *
     * @param array $resource
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasValidFields($resource): void
    {
        static::askService('validateFields', $resource);
    }

    /**
     * Asserts that a resource field name is not a forbidden name (like "type" or "id").
     *
     * @param string $name
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsNotForbiddenResourceFieldName(string $name): void
    {
        static::askService('isNotForbiddenResourceFieldName', $name);
    }
}