JsonApiAssertions::assertArrayHasAll() - Code Metrics - Inspection of "Test namespace refactoring, make helpers available" - huntie/laravel-simple-jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — develop (#15)

by Alex

created 2017-03-10 10:40 UTC

JsonApiAssertions::assertArrayHasAll() A

↳ Parent: JsonApiAssertions

Complexity

Conditions	3
Paths	3

Size

Total Lines	8
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	8
rs	9.4285
c	0
b	0
f	0
cc	3
eloc	4
nc	3
nop	2

<?php

namespace Huntie\JsonApi\Testing;

/**
 * Extend TestCase with additional JSON API related assertions.
 */
trait JsonApiAssertions
{
    /**
     * Assert that all given keys are set in an associative array. Nested
     * members may be specified using dot notation.
     *
     * @param array $keys
     * @param array $array
     *
     * @throws PHPUnit_Framework_AssertionFailedError
     */
    public function assertArrayHasAll(array $keys, array $array)
    {
        foreach ($keys as $key) {
            if (!array_has($array, $key)) {
                $this->fail('Failed asserting that key "' . $key . '" exists in input array.');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
            }
        }
    }

    /**
     * Assert that an array contains a valid JSON API resource identifier.
     *
     * @param array $array
     *
     * @throws PHPUnit_Framework_AssertionFailedError
     */
    public function assertJsonApiResourceIdentifier(array $array)
    {
        $this->assertArrayHasAll(['data.type', 'data.id'], $array);
    }

    /**
     * Assert that an array contains a valid JSON API resource object.
     *
     * @param array $array
     *
     * @throws PHPUnit_Framework_AssertionFailedError
     */
    public function assertJsonApiResourceObject(array $array)
    {
        $this->assertArrayHasAll(['data.type', 'data.id', 'data.attributes'], $array);
    }

    /**
     * Assert that an array contains a valid JSON API resource identifier
     * object collection.
     *
     * @param array $array
     * @param int   $count
     *
     * @throws PHPUnit_Framework_AssertionFailedError
     */
    public function assertJsonApiIdentifierCollection(array $array, $count = null)

    {
        $this->assertArrayHasKey('data', $array, 'No data key for collection');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        foreach ($array['data'] as $identifier) {
            $this->assertArrayHasAll(['type', 'id'], (array) $identifier);
        }

        $this->assertCount($count, $array['data'], 'Incorrect object count returned in collection');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * Assert that an array contains a valid JSON API resource object collection.
     *
     * @param array $array
     * @param int   $count
     *
     * @throws PHPUnit_Framework_AssertionFailedError
     */
    public function assertJsonApiObjectCollection(array $array, $count = null)

    {
        $this->assertArrayHasKey('data', $array, 'No data key for collection');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}

        foreach ($array['data'] as $object) {
            $this->assertArrayHasAll(['type', 'id', 'attributes'], (array) $object);
        }

        $this->assertCount($count, $array['data'], 'Incorrect object count returned in collection');
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }
}


1		<?php
2
3		namespace Huntie\JsonApi\Testing;
4
5		/**
6		* Extend TestCase with additional JSON API related assertions.
7		*/
8		trait JsonApiAssertions
9		{
10		/**
11		* Assert that all given keys are set in an associative array. Nested
12		* members may be specified using dot notation.
13		*
14		* @param array $keys
15		* @param array $array
16		*
17		* @throws PHPUnit_Framework_AssertionFailedError
18		*/
19		public function assertArrayHasAll(array $keys, array $array)
20		{
21		foreach ($keys as $key) {
22		if (!array_has($array, $key)) {
23		$this->fail('Failed asserting that key "' . $key . '" exists in input array.');
		0 ignored issues – show Bug introduced 2017-03-10 10:50 UTC by Report Bug Copy Issue Report It seems like `fail()` 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...
24		}
25		}
26		}
27
28		/**
29		* Assert that an array contains a valid JSON API resource identifier.
30		*
31		* @param array $array
32		*
33		* @throws PHPUnit_Framework_AssertionFailedError
34		*/
35		public function assertJsonApiResourceIdentifier(array $array)
36		{
37		$this->assertArrayHasAll(['data.type', 'data.id'], $array);
38		}
39
40		/**
41		* Assert that an array contains a valid JSON API resource object.
42		*
43		* @param array $array
44		*
45		* @throws PHPUnit_Framework_AssertionFailedError
46		*/
47		public function assertJsonApiResourceObject(array $array)
48		{
49		$this->assertArrayHasAll(['data.type', 'data.id', 'data.attributes'], $array);
50		}
51
52		/**
53		* Assert that an array contains a valid JSON API resource identifier
54		* object collection.
55		*
56		* @param array $array
57		* @param int $count
58		*
59		* @throws PHPUnit_Framework_AssertionFailedError
60		*/
61	View Code Duplication	public function assertJsonApiIdentifierCollection(array $array, $count = null)
		0 ignored issues – show Duplication introduced 2017-03-10 10:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
62		{
63		$this->assertArrayHasKey('data', $array, 'No data key for collection');
		0 ignored issues – show Bug introduced 2017-03-10 10:50 UTC by Report Bug Copy Issue Report It seems like `assertArrayHasKey()` 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...
64
65		foreach ($array['data'] as $identifier) {
66		$this->assertArrayHasAll(['type', 'id'], (array) $identifier);
67		}
68
69		$this->assertCount($count, $array['data'], 'Incorrect object count returned in collection');
		0 ignored issues – show Bug introduced 2017-03-10 10:50 UTC by Report Bug Copy Issue Report It seems like `assertCount()` 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...
70		}
71
72		/**
73		* Assert that an array contains a valid JSON API resource object collection.
74		*
75		* @param array $array
76		* @param int $count
77		*
78		* @throws PHPUnit_Framework_AssertionFailedError
79		*/
80	View Code Duplication	public function assertJsonApiObjectCollection(array $array, $count = null)
		0 ignored issues – show Duplication introduced 2017-03-10 10:50 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
81		{
82		$this->assertArrayHasKey('data', $array, 'No data key for collection');
		0 ignored issues – show Bug introduced 2017-03-10 10:50 UTC by Report Bug Copy Issue Report It seems like `assertArrayHasKey()` 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...
83
84		foreach ($array['data'] as $object) {
85		$this->assertArrayHasAll(['type', 'id', 'attributes'], (array) $object);
86		}
87
88		$this->assertCount($count, $array['data'], 'Incorrect object count returned in collection');
		0 ignored issues – show Bug introduced 2017-03-10 10:50 UTC by Report Bug Copy Issue Report It seems like `assertCount()` 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...
89		}
90		}
91

huntie / laravel-simple-jsonapi

Pull Request — develop (#15)

JsonApiAssertions::assertArrayHasAll() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like