1
|
|
|
<?php |
2
|
|
|
|
3
|
|
|
namespace GuilleGF\PHPTools\Collection\Helper; |
4
|
|
|
|
5
|
|
|
use GuilleGF\PHPTools\Collection\EntityCollection; |
6
|
|
|
|
7
|
|
|
/** |
8
|
|
|
* Class EntityCollectionTester |
9
|
|
|
* @package GuilleGF\PHPTools\Collection\Helper |
10
|
|
|
*/ |
11
|
|
|
trait EntityCollectionTester |
12
|
|
|
{ |
13
|
|
|
/** |
14
|
|
|
* @return string |
15
|
|
|
*/ |
16
|
|
|
abstract protected function entityCollectionClass(): string; |
17
|
|
|
|
18
|
|
|
/** |
19
|
|
|
* @test |
20
|
|
|
*/ |
21
|
|
|
public function emptyConstructor() |
22
|
|
|
{ |
23
|
|
|
/** @var EntityCollection $entityCollectionClass */ |
24
|
|
|
$entityCollectionClass = $this->entityCollectionClass(); |
25
|
|
|
$exception = $entityCollectionClass::customEmptyException(); |
26
|
|
|
|
27
|
|
|
$this->expectException(get_class($exception)); |
|
|
|
|
28
|
|
|
$this->expectExceptionMessage($exception->getMessage()); |
|
|
|
|
29
|
|
|
|
30
|
|
|
new $entityCollectionClass([]); |
31
|
|
|
} |
32
|
|
|
|
33
|
|
|
/** |
34
|
|
|
* @test |
35
|
|
|
* @dataProvider invalidEntities |
36
|
|
|
* @param array $elements |
37
|
|
|
*/ |
38
|
|
|
public function invalidElementByConstructor(array $elements) |
39
|
|
|
{ |
40
|
|
|
/** @var EntityCollection $entityCollectionClass */ |
41
|
|
|
$entityCollectionClass = $this->entityCollectionClass(); |
42
|
|
|
$exception = $entityCollectionClass::customInvalidEntityException(); |
43
|
|
|
|
44
|
|
|
$this->expectException(get_class($exception)); |
|
|
|
|
45
|
|
|
$this->expectExceptionMessage($exception->getMessage()); |
|
|
|
|
46
|
|
|
|
47
|
|
|
new $entityCollectionClass($elements); |
48
|
|
|
} |
49
|
|
|
|
50
|
|
|
/** |
51
|
|
|
* @return array |
52
|
|
|
*/ |
53
|
|
|
public function invalidEntities() |
54
|
|
|
{ |
55
|
|
|
return [ |
56
|
|
|
[[1]], |
57
|
|
|
[['element']], |
58
|
|
|
[[new \stdClass()]], |
59
|
|
|
[[new \stdClass(), new \stdClass()]], |
60
|
|
|
[[null]], |
61
|
|
|
[[false]] |
62
|
|
|
]; |
63
|
|
|
} |
64
|
|
|
|
65
|
|
|
/** |
66
|
|
|
* @test |
67
|
|
|
*/ |
68
|
|
|
public function invalidAddElement() |
69
|
|
|
{ |
70
|
|
|
/** @var EntityCollection $entityCollectionClass */ |
71
|
|
|
$entityCollectionClass = $this->entityCollectionClass(); |
72
|
|
|
$exception = $entityCollectionClass::customInvalidEntityException(); |
73
|
|
|
|
74
|
|
|
$this->expectException(get_class($exception)); |
|
|
|
|
75
|
|
|
$this->expectExceptionMessage($exception->getMessage()); |
|
|
|
|
76
|
|
|
|
77
|
|
|
/** @var EntityCollection $collection */ |
78
|
|
|
$collection = new $entityCollectionClass([$this->prophesize($entityCollectionClass::entityClass())->reveal()], true); |
|
|
|
|
79
|
|
|
$collection->add([]); |
80
|
|
|
} |
81
|
|
|
|
82
|
|
|
/** |
83
|
|
|
* @test |
84
|
|
|
*/ |
85
|
|
|
public function invalidSetElement() |
86
|
|
|
{ |
87
|
|
|
/** @var EntityCollection $entityCollectionClass */ |
88
|
|
|
$entityCollectionClass = $this->entityCollectionClass(); |
89
|
|
|
$exception = $entityCollectionClass::customInvalidEntityException(); |
90
|
|
|
|
91
|
|
|
$this->expectException(get_class($exception)); |
|
|
|
|
92
|
|
|
$this->expectExceptionMessage($exception->getMessage()); |
|
|
|
|
93
|
|
|
|
94
|
|
|
/** @var EntityCollection $collection */ |
95
|
|
|
$collection = new $entityCollectionClass([$this->prophesize($entityCollectionClass::entityClass())->reveal()], true); |
|
|
|
|
96
|
|
|
$collection->set('key', []); |
97
|
|
|
} |
98
|
|
|
|
99
|
|
|
/** |
100
|
|
|
* @test |
101
|
|
|
*/ |
102
|
|
|
public function validChildrenElementByConstructor() |
103
|
|
|
{ |
104
|
|
|
/** @var EntityCollection $entityCollectionClass */ |
105
|
|
|
$entityCollectionClass = $this->entityCollectionClass(); |
106
|
|
|
$exception = $entityCollectionClass::customInvalidEntityException(); |
107
|
|
|
|
108
|
|
|
$this->expectException(get_class($exception)); |
|
|
|
|
109
|
|
|
$this->expectExceptionMessage($exception->getMessage()); |
|
|
|
|
110
|
|
|
|
111
|
|
|
new $entityCollectionClass([$this->prophesize($entityCollectionClass::entityClass())->reveal()]); |
|
|
|
|
112
|
|
|
} |
113
|
|
|
|
114
|
|
|
/** |
115
|
|
|
* @test |
116
|
|
|
*/ |
117
|
|
|
public function validElementByConstructor() |
118
|
|
|
{ |
119
|
|
|
/** @var EntityCollection $entityCollectionClass */ |
120
|
|
|
$entityCollectionClass = $this->entityCollectionClass(); |
121
|
|
|
|
122
|
|
|
/** @var EntityCollection $collection */ |
123
|
|
|
$collection = new $entityCollectionClass([$this->prophesize($entityCollectionClass::entityClass())->reveal()], true); |
|
|
|
|
124
|
|
|
|
125
|
|
|
$this->assertSame(1, $collection->count()); |
|
|
|
|
126
|
|
|
$this->assertInstanceOf($entityCollectionClass::entityClass(), $collection->current()); |
|
|
|
|
127
|
|
|
} |
128
|
|
|
|
129
|
|
|
/** |
130
|
|
|
* @test |
131
|
|
|
*/ |
132
|
|
|
public function addTwoValidElement() |
133
|
|
|
{ |
134
|
|
|
/** @var EntityCollection $entityCollectionClass */ |
135
|
|
|
$entityCollectionClass = $this->entityCollectionClass(); |
136
|
|
|
|
137
|
|
|
/** @var EntityCollection $collection */ |
138
|
|
|
$collection = new $entityCollectionClass([$this->prophesize($entityCollectionClass::entityClass())->reveal()], true); |
|
|
|
|
139
|
|
|
|
140
|
|
|
|
141
|
|
|
/** @var \Prophecy\Prophecy\ObjectProphecy $entity */ |
142
|
|
|
$entity = $this->prophesize($entityCollectionClass::entityClass()); |
|
|
|
|
143
|
|
|
$collection->add($entity->reveal()); |
144
|
|
|
$collection->set('key', $entity->reveal()); |
145
|
|
|
|
146
|
|
|
$this->assertSame(3, $collection->count()); |
|
|
|
|
147
|
|
|
foreach ($collection as $element) { |
148
|
|
|
$this->assertInstanceOf($entityCollectionClass::entityClass(), $element); |
|
|
|
|
149
|
|
|
} |
150
|
|
|
} |
151
|
|
|
} |
152
|
|
|
|
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
The trait
Idable
provides a methodequalsId
that in turn relies on the methodgetId()
. 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.