VGirol\JsonApiAssert\Asserts\AssertErrorsObject

Complexity

Total Complexity

14

Size/Duplication

Total Lines	135
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	assertIsValidErrorLinksObject()	0	4	1
A	assertIsValidErrorsObject()	0	9	2
A	assertIsValidErrorSourceObject()	0	28	3
B	assertIsValidErrorObject()	0	56	8

<?php
namespace VGirol\JsonApiAssert\Asserts;

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

trait AssertErrorsObject
{
    /**
     * Asserts that an errors object is valid.
     *
     * @param array $errors
     * 
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertIsValidErrorsObject($errors)
    {
        static::assertIsArrayOfObjects(
            $errors,
            Messages::ERRORS_OBJECT_NOT_ARRAY
        );

        foreach ($errors as $error) {
            static::assertIsValidErrorObject($error);
        }
    }

    /**
     * Asserts that an error object is valid.
     *
     * @param array $error
     * 
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertIsValidErrorObject($error)
    {
        PHPUnit::assertIsArray(
            $error,
            Messages::ERROR_OBJECT_NOT_ARRAY
        );

        PHPUnit::assertNotEmpty(
            $error,
            Messages::ERROR_OBJECT_NOT_EMPTY
        );

        $allowed = ['id', 'links', 'status', 'code', 'title', 'details', 'source', 'meta'];
        static::assertContainsOnlyAllowedMembers(
            $allowed,
            $error
        );

        if (isset($error['status'])) {
            PHPUnit::assertIsString(
                $error['status'],
                Messages::ERROR_STATUS_IS_NOT_STRING
            );
        }

        if (isset($error['code'])) {
            PHPUnit::assertIsString(
                $error['code'],
                Messages::ERROR_CODE_IS_NOT_STRING
            );
        }

        if (isset($error['title'])) {
            PHPUnit::assertIsString(
                $error['title'],
                Messages::ERROR_TITLE_IS_NOT_STRING
            );
        }

        if (isset($error['details'])) {
            PHPUnit::assertIsString(
                $error['details'],
                Messages::ERROR_DETAILS_IS_NOT_STRING
            );
        }

        if (isset($error['source'])) {
            static::assertIsValidErrorSourceObject($error['source']);
        }

        if (isset($error['links'])) {
            static::assertIsValidErrorLinksObject($error['links']);
        }

        if (isset($error['meta'])) {
            static::assertIsValidMetaObject($error['meta']);

The method assertIsValidMetaObject() does not exist on VGirol\JsonApiAssert\Asserts\AssertErrorsObject. Did you maybe mean assertIsValidErrorObject()?

        }
    }

    /**
     * Asserts that an error links object is valid.
     *
     * @param array $links
     * 
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertIsValidErrorLinksObject($links)
    {
        $allowed = ['about'];
        static::assertIsValidLinksObject($links, $allowed);

The method assertIsValidLinksObject() does not exist on VGirol\JsonApiAssert\Asserts\AssertErrorsObject. Did you maybe mean assertIsValidErrorLinksObject()?

    }

    /**
     * Asserts that an error source object is valid.
     *
     * @param array $source
     * 
     * @throws PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertIsValidErrorSourceObject($source)
    {
        PHPUnit::assertIsArray(
            $source,
            Messages::ERROR_SOURCE_OBJECT_NOT_ARRAY
        );

        // foreach (array_keys($source) as $name) {
        //     static::assertIsValidMemberName($name);
        //     static::assertIsNotForbiddenMemberName($name);
        // }

        if (isset($source['pointer'])) {
            PHPUnit::assertIsString(
                $source['pointer'],
                Messages::ERROR_SOURCE_POINTER_IS_NOT_STRING
            );
            PHPUnit::assertStringStartsWith(
                '/',
                $source['pointer'],
                Messages::ERROR_SOURCE_POINTER_START
            );
        }

        if (isset($source['parameter'])) {
            PHPUnit::assertIsString(
                $source['parameter'],
                Messages::ERROR_SOURCE_PARAMETER_IS_NOT_STRING
            );
        }
    }
}