VGirol\JsonApiAssert\Asserts\Structure\AssertMembers

Complexity

Total Complexity

18

Size/Duplication

Total Lines	265
Duplicated Lines	0 %

Test Coverage

Coverage

94.34%

Importance

Changes

0

18 Methods

Rating	Name	Duplication	Size	Complexity
A	assertHasMembers()	0	3	1
A	assertNotHasMembers()	0	3	1
A	containsAtLeastOneMember()	0	5	1
A	containsAtLeastOneMemberConstraint()	0	3	1
A	assertHasRelationships()	0	3	1
A	containsOnlyAllowedMembersConstraint()	0	3	1
A	assertHasAttributes()	0	3	1
A	assertHasData()	0	3	1
A	assertHasMeta()	0	3	1
A	assertHasIncluded()	0	3	1
A	assertContainsAtLeastOneMember()	0	3	1
A	assertHasErrors()	0	3	1
A	assertHasJsonapi()	0	3	1
A	assertHasLinks()	0	3	1
A	assertContainsOnlyAllowedMembers()	0	4	1
A	assertHasOnlyMembers()	0	3	1
A	assertNotHasMember()	0	3	1
A	assertHasMember()	0	3	1

<?php

declare(strict_types=1);

namespace VGirol\JsonApiAssert\Asserts\Structure;

use PHPUnit\Framework\Assert as PHPUnit;
use VGirol\JsonApiAssert\Constraint\ContainsAtLeastOneConstraint;
use VGirol\JsonApiAssert\Constraint\ContainsOnlyAllowedMembersConstraint;
use VGirol\JsonApiAssert\Messages;

/**
 * Assertions relating to the object's members
 */
trait AssertMembers
{
    /**
     * Asserts that a json object has an expected member.
     *
     * @param string $expected
     * @param array  $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     * @throws \PHPUnit\Framework\Exception
     */
    public static function assertHasMember($expected, $json): void
    {
        static::askService('hasMember', $expected, $json);
    }

    /**
     * Asserts that a json object has expected members.
     *
     * @param array<string> $expected
     * @param array         $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     * @throws \PHPUnit\Framework\Exception
     */
    public static function assertHasMembers($expected, $json): void
    {
        static::askService('hasMembers', $expected, $json);
    }

    /**
     * Asserts that a json object has only expected members.
     *
     * @param array<string> $expected
     * @param array         $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     * @throws \PHPUnit\Framework\Exception
     */
    public static function assertHasOnlyMembers($expected, $json): void
    {
        static::askService('hasOnlyMembers', $expected, $json);
    }

    /**
     * Asserts that a json object not has an unexpected member.
     *
     * @param string $expected
     * @param array  $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     * @throws \PHPUnit\Framework\Exception
     */
    public static function assertNotHasMember($expected, $json): void
    {
        static::askService('notHasMember', $expected, $json);
    }

    /**
     * Asserts that a json object not has unexpected members.
     *
     * @param array<string> $expected
     * @param array         $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     * @throws \PHPUnit\Framework\Exception
     */
    public static function assertNotHasMembers($expected, $json): void
    {
        static::askService('notHasMembers', $expected, $json);
    }

    /**
     * Asserts that a json object has a "data" member.
     *
     * @see assertHasMember
     *
     * @param array $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasData($json): void
    {
        static::askService('hasData', $json);
    }

    /**
     * Asserts that a json object has an "attributes" member.
     *
     * @see assertHasMember
     *
     * @param array $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasAttributes($json): void
    {
        static::askService('hasAttributes', $json);
    }

    /**
     * Asserts that a json object has a "links" member.
     *
     * @see assertHasMember
     *
     * @param array $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasLinks($json): void
    {
        static::askService('hasLinks', $json);
    }

    /**
     * Asserts that a json object has a "meta" member.
     *
     * @see assertHasMember
     *
     * @param array $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasMeta($json): void
    {
        static::askService('hasMeta', $json);
    }

    /**
     * Asserts that a json object has an "included" member.
     *
     * @see assertHasMember
     *
     * @param array $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasIncluded($json): void
    {
        static::askService('hasIncluded', $json);
    }

    /**
     * Asserts that a json object has a "relationships" member.
     *
     * @see assertHasMember
     *
     * @param array $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasRelationships($json): void
    {
        static::askService('hasRelationships', $json);
    }

    /**
     * Asserts that a json object has an "errors" member.
     *
     * @see assertHasMember
     *
     * @param array $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasErrors($json): void
    {
        static::askService('hasErrors', $json);
    }

    /**
     * Asserts that a json object has a "jsonapi" member.
     *
     * @see assertHasMember
     *
     * @param array $json
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertHasJsonapi($json): void
    {
        static::askService('hasJsonapi', $json);
    }

    /**
     * Asserts that a json object contains at least one member from the provided list.
     *
     * @param array<string> $expected The expected members
     * @param array         $json     The json object
     * @param string        $message  An optional message to explain why the test failed
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertContainsAtLeastOneMember($expected, $json, string $message = ''): void
    {
        PHPUnit::assertThat($json, self::containsAtLeastOneMemberConstraint($expected), $message);
    }

    /**
     * Returns a new instance of the \VGirol\JsonApiAssert\Constraint\ContainsAtLeastOneConstraint class.
     *
     * @param array $expected The expected members
     *
     * @return \VGirol\JsonApiAssert\Constraint\ContainsAtLeastOneConstraint
     */
    private static function containsAtLeastOneMemberConstraint($expected): ContainsAtLeastOneConstraint
    {
        return new ContainsAtLeastOneConstraint($expected);
    }

    /**
     * Check if a json object contains at least one member from the list provided.
     *
     * @param array $expected The expected members
     * @param array $json     The json object
     *
     * @return boolean
     */
    private static function containsAtLeastOneMember($expected, $json): bool
    {
        $constraint = static::containsAtLeastOneMemberConstraint($expected);

        return $constraint->check($json);
    }

    /**
     * Asserts that a json object contains only members from the provided list.
     *
     * @param array<string> $expected The expected members
     * @param array         $json     The json object
     * @param string        $message  An optional message to explain why the test failed
     *
     * @return void
     * @throws \PHPUnit\Framework\AssertionFailedError
     */
    public static function assertContainsOnlyAllowedMembers($expected, $json, string $message = ''): void
    {
        $message = Messages::ONLY_ALLOWED_MEMBERS . "\n" . $message;
        PHPUnit::assertThat($json, self::containsOnlyAllowedMembersConstraint($expected), $message);
    }

    /**
     * Returns a new instance of the \VGirol\JsonApiAssert\Constraint\ContainsOnlyAllowedMembersConstraint class.
     *
     * @param array $expected The expected members
     *
     * @return \VGirol\JsonApiAssert\Constraint\ContainsOnlyAllowedMembersConstraint
     */
    private static function containsOnlyAllowedMembersConstraint($expected): ContainsOnlyAllowedMembersConstraint
    {
        return new ContainsOnlyAllowedMembersConstraint($expected);
    }
}