Passed
Push — testing ( 7e7178...300aff )
by Alex
03:03
created

JsonApiAssertions::seeJsonApiCollection()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 12
Code Lines 7

Duplication

Lines 0
Ratio 0 %

Importance

Changes 1
Bugs 0 Features 0
Metric Value
c 1
b 0
f 0
dl 0
loc 12
rs 9.4285
cc 1
eloc 7
nc 1
nop 0
1
<?php
2
3
namespace Huntie\JsonApi\Tests\Support;
4
5
/**
6
 * Extend TestCase with additional JSON API assertions.
7
 *
8
 * @method seeJsonStructure
9
 */
10
trait JsonApiAssertions
11
{
12
    /**
13
     * Assert that a document containing a valid JSON API object is returned.
14
     *
15
     * @return $this
16
     */
17
    public function seeJsonApiObject()
18
    {
19
        return $this->seeJsonStructure([
0 ignored issues
show
Bug introduced by
It seems like seeJsonStructure() 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...
20
            'data' => [
21
                'type',
22
                'id',
23
                'attributes',
24
            ]
25
        ]);
26
    }
27
28
    /**
29
     * Assert that a document containing a valid JSON API collection is returned.
30
     *
31
     * @return $this
32
     */
33
    public function seeJsonApiCollection()
34
    {
35
        return $this->seeJsonStructure([
0 ignored issues
show
Bug introduced by
It seems like seeJsonStructure() 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...
36
            'data' => [
37
                '*' => [
38
                    'type',
39
                    'id',
40
                    'attributes',
41
                ]
42
            ]
43
        ]);
44
    }
45
}
46