chadicus / test-helpers

src/ArrayAssertsTrait.php

<?php

namespace Chadicus;

/**
 * Trait for adding asserts for arrays
 */
trait ArrayAssertsTrait
{
    /**
     * Asserts the given $actual array is the same as the $expected array disregarding index order
     *
     * @param array       $expected The expected array.
     * @param mixed       $actual   The actual array.
     * @param string|null $prefix   Prefix to use with error messages. Useful for nested arrays.
     *
     * @return void
     */
    public function assertSameArray(array $expected, $actual, $prefix = null)
    {
        //assert that the actual value is an array
        $this->assertInternalType('array', $actual, '$actual was not an array');

        $expectedKeys = array_keys($expected);
        $actualKeys = array_keys($actual);

        //find any keys in the expected array that are not present in the actual array
        $missingExpectedKeys = array_diff($expectedKeys, $actualKeys);
        $this->assertCount(
            0,
            $missingExpectedKeys,
            sprintf(
                '$actual array is missing %d keys: %s',
                count($missingExpectedKeys),
                implode(', ', $missingExpectedKeys)
            )
        );

        //find any keys in the actual array that are not expected in the expected array
        $unexpectedKeys = array_diff($actualKeys, $expectedKeys);
        $this->assertCount(
            0,
            $unexpectedKeys,
            sprintf(
                '$actual array contains %d unexpected keys: %s',
                count($unexpectedKeys),
                implode(', ', $unexpectedKeys)
            )
        );

        //Assert all values are the same value and type.
        //Recursively call assertSameArray on array values
        foreach ($expected as $key => $value) {
            //If a sub array is indexed numerically we just want to ensure all the values are present and not their keys.
            if (is_array($value) && self::isIndexed($value)) {
                $difference = array_diff($value, $actual[$key]);
                $this->assertEquals(count($difference), 0);
                continue;
            }

            if (is_array($value)) {
                $this->assertSameArray($value, $actual[$key], "{$prefix}{$key}.");
                continue;
            }

            $this->assertSame(
                $value,
                $actual[$key],
                sprintf(
                    "{$prefix}{$key} value is not correct expected %s\nfound %s",
                    var_export($value, 1),
                    var_export($actual[$key], 1)
                )
            );
        }
    }

    /**
     * Determines if an array is an indexed array i.e. an array with numeric and sequential keys
     *
     * @param array $subject The array to check if indexed

Parameter comment must end with a full stop

     *
     * @return bool
     */
    private function isIndexed(array $subject) : bool {
        $nonNumericKeyCount = count(array_filter(array_keys($subject), 'is_string'));
        if ($nonNumericKeyCount > 0) {
            return false;
        }
        
        //If the array keys are from 0 to N they are sequential and therefore numerically indexed.
        return array_keys($subject) === range(0, count($subject) -1);
    }

    /**
     * Asserts the number of elements of an array, Countable or Traversable.
     *
     * Ensures this method must be provided by classes using this trait.
     *
     * @param integer $expectedCount The expected number of items in $haystack.
     * @param mixed   $haystack      The array, countable or traversable object containing items.
     * @param string  $message       Optional error message to give upon failure.
     *
     * @return void
     */
    abstract public function assertCount($expectedCount, $haystack, $message = '');

    /**
     * Asserts that a variable is of a given type.
     *
     * Ensures this method must be provided by classes using this trait.
     *
     * @param string $expected The expected internal type.
     * @param mixed  $actual   The variable to verify.
     * @param string $message  Optional error message to give upon failure.
     *
     * @return void
     */
    abstract public function assertInternalType($expected, $actual, $message = '');

    /**
     * Asserts that two variables have the same type and value. Used on objects, it asserts that two variables reference
     * the same object.
     *
     * Ensures this method must be provided by classes using this trait.
     *
     * @param string $expected The expected value.
     * @param mixed  $actual   The actual value.
     * @param string $message  Optional error message to give upon failure.
     *
     * @return void
     */
    abstract public function assertSame($expected, $actual, $message = '');
}