VGirol\JsonApiAssert\Asserts\Structure\AssertMemberName

Complexity

Total Complexity

2

Size/Duplication

Total Lines	33
Duplicated Lines	0 %

Test Coverage

Coverage

100%

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	memberNameConstraint()	0	3	1
A	assertIsValidMemberName()	0	3	1

<?php

declare(strict_types=1);

namespace VGirol\JsonApiAssert\Asserts\Structure;

use PHPUnit\Framework\Assert as PHPUnit;
use VGirol\JsonApiAssert\Constraint\MemberNameConstraint;

/**
 * Assertions relating to the member name
 */
trait AssertMemberName
{
    /**
     * Asserts that a member name is valid.
     *
     * It will do the following checks :
     * 1) asserts that the name is a string with at least one character.
     * 2) asserts that the name has only allowed characters.
     * 3) asserts that it starts and ends with a globally allowed character.
     *
     * @link https://jsonapi.org/format/#document-member-names-allowed-characters
     *
     * @param string  $name
     * @param boolean $strict If true, unsafe characters are not allowed when checking members name.
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertIsValidMemberName($name, bool $strict): void
    {
        PHPUnit::assertThat($name, self::memberNameConstraint($strict));
    }

    /**
     * Returns a new instance of the \VGirol\JsonApiAssert\Constraint\MemberNameConstraint class.
     *
     * @param bool $strict
     *
     * @return \VGirol\JsonApiAssert\Constraint\MemberNameConstraint
     */
    private static function memberNameConstraint(bool $strict): MemberNameConstraint
    {
        return new MemberNameConstraint($strict);
    }
}