ArrayAssertsTrait::assertSameArray() - Code Metrics - Inspection of "Added Support for asserting on indexed arrays." - chadicus/test-helpers - Measure and Improve Code Quality continuously with Scrutinizer

Failed Conditions

Pull Request — master (#8)

unknown

created 2017-03-30 15:17 UTC

ArrayAssertsTrait::assertSameArray() B

↳ Parent: ArrayAssertsTrait

Complexity

Conditions	5
Paths	4

Size

Total Lines	58
Code Lines	35

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	58
rs	8.7274
c	0
b	0
f	0
cc	5
eloc	35
nc	4
nop	3

How to fix Long Method

<?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);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
                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

     *
     * @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 = '');
}


1			<?php
2
3			namespace Chadicus;
4
5			/**
6			* Trait for adding asserts for arrays
7			*/
8			trait ArrayAssertsTrait
9			{
10			/**
11			* Asserts the given $actual array is the same as the $expected array disregarding index order
12			*
13			* @param array $expected The expected array.
14			* @param mixed $actual The actual array.
15			* @param string\|null $prefix Prefix to use with error messages. Useful for nested arrays.
16			*
17			* @return void
18			*/
19			public function assertSameArray(array $expected, $actual, $prefix = null)
20			{
21			//assert that the actual value is an array
22			$this->assertInternalType('array', $actual, '$actual was not an array');
23
24			$expectedKeys = array_keys($expected);
25			$actualKeys = array_keys($actual);
26
27			//find any keys in the expected array that are not present in the actual array
28			$missingExpectedKeys = array_diff($expectedKeys, $actualKeys);
29			$this->assertCount(
30			0,
31			$missingExpectedKeys,
32			sprintf(
33			'$actual array is missing %d keys: %s',
34			count($missingExpectedKeys),
35			implode(', ', $missingExpectedKeys)
36			)
37			);
38
39			//find any keys in the actual array that are not expected in the expected array
40			$unexpectedKeys = array_diff($actualKeys, $expectedKeys);
41			$this->assertCount(
42			0,
43			$unexpectedKeys,
44			sprintf(
45			'$actual array contains %d unexpected keys: %s',
46			count($unexpectedKeys),
47			implode(', ', $unexpectedKeys)
48			)
49			);
50
51			//Assert all values are the same value and type.
52			//Recursively call assertSameArray on array values
53			foreach ($expected as $key => $value) {
54			//If a sub array is indexed numerically we just want to ensure all the values are present and not their keys.
55			if (is_array($value) && self::isIndexed($value)) {
56			$difference = array_diff($value, $actual[$key]);
57			$this->assertEquals(count($difference), 0);
			0 ignored issues – show Bug introduced 2017-03-30 15:20 UTC by Report Bug Copy Issue Report It seems like `assertEquals()` must be provided by classes using this trait. How about adding it as abstract method to this trait? This check looks for methods that are used by a trait but not required by it. To illustrate, let’s look at the following code example trait Idable { public function equalIds(Idable $other) { return $this->getId() === $other->getId(); } } The trait `Idable` provides a method `equalsId` that in turn relies on the method `getId()`. If this method does not exist on a class mixing in this trait, the method will fail. Adding the `getId()` as an abstract method to the trait will make sure it is available. Loading history...
58			continue;
59			}
60
61			if (is_array($value)) {
62			$this->assertSameArray($value, $actual[$key], "{$prefix}{$key}.");
63			continue;
64			}
65
66			$this->assertSame(
67			$value,
68			$actual[$key],
69			sprintf(
70			"{$prefix}{$key} value is not correct expected %s\nfound %s",
71			var_export($value, 1),
72			var_export($actual[$key], 1)
73			)
74			);
75			}
76			}
77
78			/**
79			* Determines if an array is an indexed array i.e. an array with numeric and sequential keys
80			*
81			* @param array $subject The array to check if indexed
			0 ignored issues – show Coding Style Documentation introduced 2017-03-30 15:20 UTC by Report Bug Copy Issue Report Parameter comment must end with a full stop Loading history...
82			*
83			* @return bool
			0 ignored issues – show Coding Style introduced 2017-03-30 15:20 UTC by Report Bug Copy Issue Report Expected "boolean" but found "bool" for function return type Loading history...
84			*/
85			private function isIndexed(array $subject) : bool {
86			$nonNumericKeyCount = count(array_filter(array_keys($subject), 'is_string'));
87			if ($nonNumericKeyCount > 0) {
88			return false;
89			}
90
91			//If the array keys are from 0 to N they are sequential and therefore numerically indexed.
92			return array_keys($subject) === range(0, count($subject) -1);
93			}
94
95			/**
96			* Asserts the number of elements of an array, Countable or Traversable.
97			*
98			* Ensures this method must be provided by classes using this trait.
99			*
100			* @param integer $expectedCount The expected number of items in $haystack.
101			* @param mixed $haystack The array, countable or traversable object containing items.
102			* @param string $message Optional error message to give upon failure.
103			*
104			* @return void
105			*/
106			abstract public function assertCount($expectedCount, $haystack, $message = '');
107
108			/**
109			* Asserts that a variable is of a given type.
110			*
111			* Ensures this method must be provided by classes using this trait.
112			*
113			* @param string $expected The expected internal type.
114			* @param mixed $actual The variable to verify.
115			* @param string $message Optional error message to give upon failure.
116			*
117			* @return void
118			*/
119			abstract public function assertInternalType($expected, $actual, $message = '');
120
121			/**
122			* Asserts that two variables have the same type and value. Used on objects, it asserts that two variables reference
123			* the same object.
124			*
125			* Ensures this method must be provided by classes using this trait.
126			*
127			* @param string $expected The expected value.
128			* @param mixed $actual The actual value.
129			* @param string $message Optional error message to give upon failure.
130			*
131			* @return void
132			*/
133			abstract public function assertSame($expected, $actual, $message = '');
134			}
135

chadicus / test-helpers

Pull Request — master (#8)

ArrayAssertsTrait::assertSameArray() B

Complexity

Size

Duplication

Importance

How to fix Long Method

Long Method

Duplication Side-by-Side

Filter issues like