JsonApiAssertions::assertJsonApiResourceIdentifier() - Code Metrics - huntie/laravel-simple-jsonapi - Measure and Improve Code Quality continuously with Scrutinizer

assertJsonApiResourceIdentifier() A
last analyzed 2017-09-21 19:05 UTC

↳ Parent: JsonApiAssertions

Complexity

Conditions	3
Paths	4

Size

Total Lines	12
Code Lines	6

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?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
     * @param string|null $type
     * @param mixed       $id
     *
     * @throws PHPUnit_Framework_AssertionFailedError
     */
    public function assertJsonApiResourceIdentifier(array $array, string $type = null, $id = null)
    {
        $this->assertArrayHasAll(['data.type', 'data.id'], $array);

        if ($type) {
''   == false // true
''   == null  // true
'ab' == false // false
'ab' == null  // false

// It is often better to use strict comparison
'' === false // false
'' === null  // false
            $this->assertEquals(array_get($array, 'data.type'), $type);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }

        if ($id) {
            $this->assertEquals(array_get($array, 'data.id'), $id);
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
        }
    }

    /**
     * Assert that an array contains a valid JSON API resource object.
     *
     * @param array       $array
     * @param string|null $type
     * @param mixed       $id
     *
     * @throws PHPUnit_Framework_AssertionFailedError
     */
    public function assertJsonApiResourceObject(array $array, string $type = null, $id = null)
    {
        $this->assertJsonApiResourceIdentifier($array, $type, $id);
        $this->assertInternalType('array', array_get($array, 'data.attributes'));
trait Idable {
    public function equalIds(Idable $other) {
        return $this->getId() === $other->getId();
    }
}
    }

    /**
     * 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);
        }

        if (!is_null($count)) {
            $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		* @param string\|null $type
33		* @param mixed $id
34		*
35		* @throws PHPUnit_Framework_AssertionFailedError
36		*/
37		public function assertJsonApiResourceIdentifier(array $array, string $type = null, $id = null)
38		{
39		$this->assertArrayHasAll(['data.type', 'data.id'], $array);
40
41		if ($type) {
		0 ignored issues – show Bug Best Practice introduced 2017-09-21 18:39 UTC by Report Bug Copy Issue Report The expression `$type` of type `null\|string` is loosely compared to `true`; this is ambiguous if the string can be empty. You might want to explicitly use `!== null` instead. In PHP, under loose comparison (like `==`, or `!=`, or `switch` conditions), values of different types might be equal. For `string` values, the empty string `''` is a special case, in particular the following results might be unexpected: '' == false // true '' == null // true 'ab' == false // false 'ab' == null // false // It is often better to use strict comparison '' === false // false '' === null // false Loading history...
42		$this->assertEquals(array_get($array, 'data.type'), $type);
		0 ignored issues – show Bug introduced 2017-09-21 18:39 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...
43		}
44
45		if ($id) {
46		$this->assertEquals(array_get($array, 'data.id'), $id);
		0 ignored issues – show Bug introduced 2017-09-21 18:39 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...
47		}
48		}
49
50		/**
51		* Assert that an array contains a valid JSON API resource object.
52		*
53		* @param array $array
54		* @param string\|null $type
55		* @param mixed $id
56		*
57		* @throws PHPUnit_Framework_AssertionFailedError
58		*/
59		public function assertJsonApiResourceObject(array $array, string $type = null, $id = null)
60		{
61		$this->assertJsonApiResourceIdentifier($array, $type, $id);
62		$this->assertInternalType('array', array_get($array, 'data.attributes'));
		0 ignored issues – show Bug introduced 2017-09-21 18:39 UTC by Report Bug Copy Issue Report It seems like `assertInternalType()` 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...
63		}
64
65		/**
66		* Assert that an array contains a valid JSON API resource identifier
67		* object collection.
68		*
69		* @param array $array
70		* @param int $count
71		*
72		* @throws PHPUnit_Framework_AssertionFailedError
73		*/
74	View Code Duplication	public function assertJsonApiIdentifierCollection(array $array, $count = null)
		0 ignored issues – show Duplication introduced 2017-08-03 10:14 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...
75		{
76		$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...
77
78		foreach ($array['data'] as $identifier) {
79		$this->assertArrayHasAll(['type', 'id'], (array) $identifier);
80		}
81
82		$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...
83		}
84
85		/**
86		* Assert that an array contains a valid JSON API resource object collection.
87		*
88		* @param array $array
89		* @param int $count
90		*
91		* @throws PHPUnit_Framework_AssertionFailedError
92		*/
93	View Code Duplication	public function assertJsonApiObjectCollection(array $array, $count = null)
		0 ignored issues – show Duplication introduced 2017-08-03 10:14 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...
94		{
95		$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...
96
97		foreach ($array['data'] as $object) {
98		$this->assertArrayHasAll(['type', 'id', 'attributes'], (array) $object);
99		}
100
101		if (!is_null($count)) {
102		$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...
103		}
104		}
105		}
106

huntie / laravel-simple-jsonapi

assertJsonApiResourceIdentifier() A last analyzed 2017-09-21 19:05 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

assertJsonApiResourceIdentifier() A
last analyzed 2017-09-21 19:05 UTC