AssertResourceObject::assertIsNotForbiddenResourceFieldName() - Code Metrics - Inspection of "Many bug fixes (thanks to mutation tests)" - VGirol/JsonApi-Assert - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 1e6084...cf392e )

by Vincent

created 2019-04-03 23:28 UTC

assertIsNotForbiddenResourceFieldName() A

↳ Parent: AssertResourceObject

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	5

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	6
CRAP Score	1

Importance

Changes

Metric	Value
cc	1
eloc	5
nc	1
nop	1
dl	0
loc	7
ccs	6
cts	6
cp	1
crap	1
rs	10
c	0
b	0
f	0

<?php
namespace VGirol\JsonApiAssert\Asserts;

use PHPUnit\Framework\Assert as PHPUnit;
use VGirol\JsonApiAssert\Messages;

trait AssertResourceObject
{
    /**
     * Asserts that a resource has valid structure.
     *
     * @param array $resource
     *
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertIsValidResourceObject($resource, $strict)
    {
        static::assertResourceObjectHasValidTopLevelStructure($resource);
        static::assertResourceIdMember($resource);
        static::assertResourceTypeMember($resource, $strict);

        if (isset($resource['attributes'])) {
            static::assertIsValidAttributesObject($resource['attributes'], $strict);
                    assertIsValidAttributesObject($resource['attributes'], $strict);
        }

        if (isset($resource['relationships'])) {
            static::assertIsValidRelationshipsObject($resource['relationships'], $strict);
                    assertIsValidRelationshipsObject($resource['relationships'], $strict);
        }

        if (isset($resource['links'])) {
            static::assertIsValidResourceLinksObject($resource['links'], $strict);
        }

        if (isset($resource['meta'])) {
            static::assertIsValidMetaObject($resource['meta'], $strict);
                    assertIsValidMetaObject($resource['meta'], $strict);
        }

        static::assertHasValidFields($resource);
    }

    /**
     * Asserts that a resource object has a valid top-level structure.
     *
     * @param array $resource
     *
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertResourceObjectHasValidTopLevelStructure($resource)
    {
        PHPUnit::assertIsArray(
            $resource,
            Messages::RESOURCE_IS_NOT_ARRAY
        );

        PHPUnit::assertArrayHasKey(
            'id',
            $resource,
            Messages::RESOURCE_ID_MEMBER_IS_ABSENT
        );

        PHPUnit::assertArrayHasKey(
            'type',
            $resource,
            Messages::RESOURCE_TYPE_MEMBER_IS_ABSENT
        );

        static::assertContainsAtLeastOneMember(['attributes', 'relationships', 'links', 'meta'], $resource);

        $allowed = ['id', 'type', 'meta', 'attributes', 'links', 'relationships'];
        static::assertContainsOnlyAllowedMembers($allowed, $resource);
    }

    /**
     * Asserts that a resource has a valid id member.
     *
     * @param array $resource
     *
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertResourceIdMember($resource)
    {
        PHPUnit::assertNotEmpty(
            $resource['id'],
            Messages::RESOURCE_ID_MEMBER_IS_EMPTY
        );

        PHPUnit::assertIsString(
            $resource['id'],
            Messages::RESOURCE_ID_MEMBER_IS_NOT_STRING
        );
    }

    /**
     * Asserts that a resource has a valid type member.
     *
     * @param array     $resource
     * @param boolean   $strict         If true, excludes not safe characters when checking members name
     *
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertResourceTypeMember($resource, $strict)
    {
        PHPUnit::assertNotEmpty(
            $resource['type'],
            Messages::RESOURCE_TYPE_MEMBER_IS_EMPTY
        );

        PHPUnit::assertIsString(
            $resource['type'],
            Messages::RESOURCE_TYPE_MEMBER_IS_NOT_STRING
        );

        static::assertIsValidMemberName($resource['type'], $strict);
    }

    /**
     * Asserts that a links object extracted from a resource is valid.
     *
     * @param array     $data
     * @param boolean   $strict         If true, excludes not safe characters when checking members name
     *
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertIsValidResourceLinksObject($data, $strict)
    {
        $allowed = ['self'];
        static::assertIsValidLinksObject($data, $allowed, $strict);
                assertIsValidLinksObject($data, $allowed, $strict);
    }

    /**
     * Asserts that a resource identifier object is valid.
     *
     * @param array     $resource
     * @param boolean   $strict         If true, excludes not safe characters when checking members name
     *
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertIsValidResourceIdentifierObject($resource, $strict)
    {
        PHPUnit::assertIsArray(
            $resource,
            Messages::RESOURCE_IDENTIFIER_IS_NOT_ARRAY
        );

        PHPUnit::assertArrayHasKey(
            'id',
            $resource,
            Messages::RESOURCE_ID_MEMBER_IS_ABSENT
        );
        static::assertResourceIdMember($resource);

        PHPUnit::assertArrayHasKey(
            'type',
            $resource,
            Messages::RESOURCE_TYPE_MEMBER_IS_ABSENT
        );
        static::assertResourceTypeMember($resource, $strict);

        $allowed = ['id', 'type', 'meta'];
        static::assertContainsOnlyAllowedMembers($allowed, $resource);

        if (isset($resource['meta'])) {
            static::assertIsValidMetaObject($resource['meta'], $strict);
        }
    }

    /**
     * Asserts that a resource object has valid fields.
     *
     * @param array $resource
     *
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertHasValidFields($resource)
    {
        $bHasAttributes = false;
        if (isset($resource['attributes'])) {
            $bHasAttributes = true;
            foreach (array_keys($resource['attributes']) as $name) {
                static::assertIsNotForbiddenResourceFieldName($name);
            }
        }

        if (isset($resource['relationships'])) {
            foreach (array_keys($resource['relationships']) as $name) {
                static::assertIsNotForbiddenResourceFieldName($name);

                if ($bHasAttributes) {
                    PHPUnit::assertArrayNotHasKey(
                        $name,
                        $resource['attributes'],
                        Messages::FIELDS_HAVE_SAME_NAME
                    );
                }
            }
        }
    }

    /**
     * Asserts that a field name is not forbidden.
     *
     * @param string $name
     *
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertIsNotForbiddenResourceFieldName($name)
    {
        $forbidden = ['type', 'id'];
        PHPUnit::assertNotContains(
            $name,
            $forbidden,
            Messages::FIELDS_NAME_NOT_ALLOWED
        );
    }
}


VGirol / JsonApi-Assert

Push — master ( 1e6084...cf392e )

assertIsNotForbiddenResourceFieldName() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like