VGirol\JsonApiAssert\Asserts\Content\AssertLinks

Complexity

Total Complexity

5

Size/Duplication

Total Lines	56
Duplicated Lines	0 %

Importance

Changes	1
Bugs	0	Features	0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	assertLinksObjectEquals()	0	5	2
A	linkEqualsConstraint()	0	3	1
A	assertLinksObjectContains()	0	4	1
A	assertLinkObjectEquals()	0	3	1

<?php

declare(strict_types=1);

namespace VGirol\JsonApiAssert\Asserts\Content;

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

/**
 * Assertions relating to the pagination
 */
trait AssertLinks
{
    /**
     * Asserts that a links object equals an expected links array.
     *
     * @param array $expected
     * @param array $links
     * @return void
     * @throws \PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertLinksObjectEquals($expected, $links): void
    {
        PHPUnit::assertEquals(count($expected), count($links));
        foreach ($expected as $name => $value) {
            static::assertLinksObjectContains($name, $value, $links);
        }
    }

    /**
     * Asserts that a links object contains an expected link.
     *
     * @param string $name
     * @param array $expected
     * @param array $links
     * @return void
     * @throws \PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertLinksObjectContains($name, $expected, $links): void
    {
        static::assertHasMember($name, $links);
        static::assertLinkObjectEquals($expected, $links[$name]);

$expected of type array is incompatible with the type null|string expected by parameter $expected of VGirol\JsonApiAssert\Asserts\Content\AssertLinks::assertLinkObjectEquals().

    }

    /**
     * Asserts that a link object equals an expected value.
     *
     * @param string|null $expected
     * @param array $link
     * @return void
     * @throws \PHPUnit\Framework\ExpectationFailedException
     */
    public static function assertLinkObjectEquals($expected, $link, string $message = ''): void
    {
        PHPUnit::assertThat($link, self::linkEqualsConstraint($expected), $message);
    }

    /**
     * Returns a new instance of the \VGirol\JsonApiAssert\Constraint\LinkEqualsConstraint class.
     *
     * @param string|null $expected   The expected link
     *
     * @return \VGirol\JsonApiAssert\Constraint\LinkEqualsConstraint
     */
    private static function linkEqualsConstraint($expected): LinkEqualsConstraint
    {
        return new LinkEqualsConstraint($expected);
    }
}