Skip to content

Commit 61ec985

Browse files
committed
Manage Embedded Fields with NO BC Breaks in master
1 parent d0dc684 commit 61ec985

20 files changed

+1621
-506
lines changed

features/bootstrap/FeatureContext.php

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -20,6 +20,8 @@
2020
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCar;
2121
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyCarColor;
2222
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\DummyFriend;
23+
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\EmbeddableDummy;
24+
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\EmbeddedDummy;
2325
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\FileConfigDummy;
2426
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Node;
2527
use ApiPlatform\Core\Tests\Fixtures\TestBundle\Entity\Question;
@@ -124,6 +126,25 @@ public function thereIsDummyObjects($nb)
124126
$this->manager->flush();
125127
}
126128

129+
/**
130+
* @Given there are :nb embedded dummy objects
131+
*/
132+
public function thereIsEmbeddedDummyObjects($nb)
133+
{
134+
for ($i = 1; $i <= $nb; ++$i) {
135+
$dummy = new EmbeddedDummy();
136+
$dummy->setName('Dummy #'.$i);
137+
138+
$embeddableDummy = new EmbeddableDummy();
139+
$embeddableDummy->setDummyName('Dummy #'.$i);
140+
$dummy->setEmbeddedDummy($embeddableDummy);
141+
142+
$this->manager->persist($dummy);
143+
}
144+
145+
$this->manager->flush();
146+
}
147+
127148
/**
128149
* @Given there is :nb dummy objects with relatedDummy
129150
*/
@@ -145,6 +166,25 @@ public function thereIsDummyObjectsWithRelatedDummy($nb)
145166
$this->manager->flush();
146167
}
147168

169+
/**
170+
* @Given there is :nb dummy objects with embeddedDummy
171+
*/
172+
public function thereIsDummyObjectsWithEmbeddedDummy($nb)
173+
{
174+
for ($i = 1; $i <= $nb; ++$i) {
175+
$embeddableDummy = new EmbeddableDummy();
176+
$embeddableDummy->setDummyName('EmbeddedDummy #'.$i);
177+
178+
$dummy = new EmbeddedDummy();
179+
$dummy->setName('Dummy #'.$i);
180+
$dummy->setEmbeddedDummy($embeddableDummy);
181+
182+
$this->manager->persist($dummy);
183+
}
184+
185+
$this->manager->flush();
186+
}
187+
148188
/**
149189
* @Given there is :nb dummy objects having each :nbrelated relatedDummies
150190
*/
@@ -259,6 +299,32 @@ public function thereIsDummyObjectsWithDummyDateAndRelatedDummy($nb)
259299
$this->manager->flush();
260300
}
261301

302+
/**
303+
* @Given there is :nb embedded dummy objects with dummyDate and embeddedDummy
304+
*/
305+
public function thereIsDummyObjectsWithDummyDateAndEmbeddedDummy($nb)
306+
{
307+
for ($i = 1; $i <= $nb; ++$i) {
308+
$date = new \DateTime(sprintf('2015-04-%d', $i), new \DateTimeZone('UTC'));
309+
310+
$embeddableDummy = new EmbeddableDummy();
311+
$embeddableDummy->setDummyName('Embeddable #'.$i);
312+
$embeddableDummy->setDummyDate($date);
313+
314+
$dummy = new EmbeddedDummy();
315+
$dummy->setName('Dummy #'.$i);
316+
$dummy->setEmbeddedDummy($embeddableDummy);
317+
// Last Dummy has a null date
318+
if ($nb !== $i) {
319+
$dummy->setDummyDate($date);
320+
}
321+
322+
$this->manager->persist($dummy);
323+
}
324+
325+
$this->manager->flush();
326+
}
327+
262328
/**
263329
* @Given there is :nb dummy objects with dummyPrice
264330
*/
@@ -308,6 +374,66 @@ public function thereIsDummyObjectsWithDummyBoolean($nb, $bool)
308374
$this->manager->flush();
309375
}
310376

377+
/**
378+
* @Given there is :nb embedded dummy objects with embeddedDummy.dummyBoolean :bool
379+
*/
380+
public function thereIsDummyObjectsWithEmbeddedDummyBoolean($nb, $bool)
381+
{
382+
if (in_array($bool, ['true', '1', 1], true)) {
383+
$bool = true;
384+
} elseif (in_array($bool, ['false', '0', 0], true)) {
385+
$bool = false;
386+
} else {
387+
$expected = ['true', 'false', '1', '0'];
388+
throw new InvalidArgumentException(sprintf('Invalid boolean value for "%s" property, expected one of ( "%s" )', $bool, implode('" | "', $expected)));
389+
}
390+
391+
for ($i = 1; $i <= $nb; ++$i) {
392+
$dummy = new EmbeddedDummy();
393+
$dummy->setName('Embedded Dummy #'.$i);
394+
$embeddableDummy = new EmbeddableDummy();
395+
$embeddableDummy->setDummyName('Embedded Dummy #'.$i);
396+
$embeddableDummy->setDummyBoolean($bool);
397+
$dummy->setEmbeddedDummy($embeddableDummy);
398+
$this->manager->persist($dummy);
399+
}
400+
401+
$this->manager->flush();
402+
}
403+
404+
/**
405+
* @Given there is :nb embedded dummy objects with relatedDummy.embeddedDummy.dummyBoolean :bool
406+
*/
407+
public function thereIsDummyObjectsWithRelationEmbeddedDummyBoolean($nb, $bool)
408+
{
409+
if (in_array($bool, ['true', '1', 1], true)) {
410+
$bool = true;
411+
} elseif (in_array($bool, ['false', '0', 0], true)) {
412+
$bool = false;
413+
} else {
414+
$expected = ['true', 'false', '1', '0'];
415+
throw new InvalidArgumentException(sprintf('Invalid boolean value for "%s" property, expected one of ( "%s" )', $bool, implode('" | "', $expected)));
416+
}
417+
418+
for ($i = 1; $i <= $nb; ++$i) {
419+
$dummy = new EmbeddedDummy();
420+
$dummy->setName('Embedded Dummy #'.$i);
421+
$embeddableDummy = new EmbeddableDummy();
422+
$embeddableDummy->setDummyName('Embedded Dummy #'.$i);
423+
$embeddableDummy->setDummyBoolean($bool);
424+
425+
$relationDummy = new RelatedDummy();
426+
$relationDummy->setEmbeddedDummy($embeddableDummy);
427+
428+
$dummy->setRelatedDummy($relationDummy);
429+
430+
$this->manager->persist($relationDummy);
431+
$this->manager->persist($dummy);
432+
}
433+
434+
$this->manager->flush();
435+
}
436+
311437
/**
312438
* @Given there is a RelationEmbedder object
313439
*/

features/doctrine/boolean_filter.feature

Lines changed: 204 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -166,6 +166,210 @@ Feature: Boolean filter on collections
166166
"""
167167
And the JSON node "hydra:totalItems" should be equal to 10
168168

169+
Scenario: Get collection by embeddedDummy.dummyBoolean true
170+
Given there is "15" embedded dummy objects with embeddedDummy.dummyBoolean true
171+
And there is "10" embedded dummy objects with embeddedDummy.dummyBoolean false
172+
When I send a "GET" request to "/embedded_dummies?embeddedDummy.dummyBoolean=true"
173+
Then the response status code should be 200
174+
And the response should be in JSON
175+
And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
176+
And the JSON should be valid according to this schema:
177+
"""
178+
{
179+
"type": "object",
180+
"properties": {
181+
"@context": {"pattern": "^/contexts/EmbeddedDummy$"},
182+
"@id": {"pattern": "^/embedded_dummies$"},
183+
"@type": {"pattern": "^hydra:Collection$"},
184+
"hydra:member": {
185+
"type": "array",
186+
"items": {
187+
"type": "object",
188+
"properties": {
189+
"@id": {
190+
"oneOf": [
191+
{"pattern": "^/embedded_dummies/1$"},
192+
{"pattern": "^/embedded_dummies/2$"},
193+
{"pattern": "^/embedded_dummies/3$"}
194+
]
195+
}
196+
}
197+
}
198+
},
199+
"hydra:view": {
200+
"type": "object",
201+
"properties": {
202+
"@id": {"pattern": "^/embedded_dummies\\?embeddedDummy\\.dummyBoolean=true"},
203+
"@type": {"pattern": "^hydra:PartialCollectionView$"}
204+
}
205+
}
206+
}
207+
}
208+
"""
209+
And the JSON node "hydra:totalItems" should be equal to 15
210+
211+
Scenario: Get collection by embeddedDummy.dummyBoolean true
212+
When I send a "GET" request to "/embedded_dummies?embeddedDummy.dummyBoolean=1"
213+
Then the response status code should be 200
214+
And the response should be in JSON
215+
And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
216+
And the JSON should be valid according to this schema:
217+
"""
218+
{
219+
"type": "object",
220+
"properties": {
221+
"@context": {"pattern": "^/contexts/EmbeddedDummy$"},
222+
"@id": {"pattern": "^/embedded_dummies$"},
223+
"@type": {"pattern": "^hydra:Collection$"},
224+
"hydra:member": {
225+
"type": "array",
226+
"items": {
227+
"type": "object",
228+
"properties": {
229+
"@id": {
230+
"oneOf": [
231+
{"pattern": "^/embedded_dummies/1$"},
232+
{"pattern": "^/embedded_dummies/2$"},
233+
{"pattern": "^/embedded_dummies/3$"}
234+
]
235+
}
236+
}
237+
}
238+
},
239+
"hydra:view": {
240+
"type": "object",
241+
"properties": {
242+
"@id": {"pattern": "^/embedded_dummies\\?embeddedDummy\\.dummyBoolean=1"},
243+
"@type": {"pattern": "^hydra:PartialCollectionView$"}
244+
}
245+
}
246+
}
247+
}
248+
"""
249+
And the JSON node "hydra:totalItems" should be equal to 15
250+
251+
Scenario: Get collection by embeddedDummy.dummyBoolean false
252+
When I send a "GET" request to "/embedded_dummies?embeddedDummy.dummyBoolean=false"
253+
Then the response status code should be 200
254+
And the response should be in JSON
255+
And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
256+
And the JSON should be valid according to this schema:
257+
"""
258+
{
259+
"type": "object",
260+
"properties": {
261+
"@context": {"pattern": "^/contexts/EmbeddedDummy$"},
262+
"@id": {"pattern": "^/embedded_dummies$"},
263+
"@type": {"pattern": "^hydra:Collection$"},
264+
"hydra:member": {
265+
"type": "array",
266+
"items": {
267+
"type": "object",
268+
"properties": {
269+
"@id": {
270+
"oneOf": [
271+
{"pattern": "^/embedded_dummies/16$"},
272+
{"pattern": "^/embedded_dummies/17$"},
273+
{"pattern": "^/embedded_dummies/18$"}
274+
]
275+
}
276+
}
277+
}
278+
},
279+
"hydra:view": {
280+
"type": "object",
281+
"properties": {
282+
"@id": {"pattern": "^/embedded_dummies\\?embeddedDummy\\.dummyBoolean=false"},
283+
"@type": {"pattern": "^hydra:PartialCollectionView$"}
284+
}
285+
}
286+
}
287+
}
288+
"""
289+
And the JSON node "hydra:totalItems" should be equal to 10
290+
291+
Scenario: Get collection by embeddedDummy.dummyBoolean false
292+
When I send a "GET" request to "/embedded_dummies?embeddedDummy.dummyBoolean=0"
293+
Then the response status code should be 200
294+
And the response should be in JSON
295+
And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
296+
And the JSON should be valid according to this schema:
297+
"""
298+
{
299+
"type": "object",
300+
"properties": {
301+
"@context": {"pattern": "^/contexts/EmbeddedDummy$"},
302+
"@id": {"pattern": "^/embedded_dummies$"},
303+
"@type": {"pattern": "^hydra:Collection$"},
304+
"hydra:member": {
305+
"type": "array",
306+
"items": {
307+
"type": "object",
308+
"properties": {
309+
"@id": {
310+
"oneOf": [
311+
{"pattern": "^/embedded_dummies/16$"},
312+
{"pattern": "^/embedded_dummies/17$"},
313+
{"pattern": "^/embedded_dummies/18$"}
314+
]
315+
}
316+
}
317+
}
318+
},
319+
"hydra:view": {
320+
"type": "object",
321+
"properties": {
322+
"@id": {"pattern": "^/embedded_dummies\\?embeddedDummy\\.dummyBoolean=0"},
323+
"@type": {"pattern": "^hydra:PartialCollectionView$"}
324+
}
325+
}
326+
}
327+
}
328+
"""
329+
And the JSON node "hydra:totalItems" should be equal to 10
330+
331+
Scenario: Get collection by association with embed relatedDummy.embeddedDummy.dummyBoolean true
332+
Given there is "15" embedded dummy objects with relatedDummy.embeddedDummy.dummyBoolean true
333+
And there is "10" embedded dummy objects with relatedDummy.embeddedDummy.dummyBoolean false
334+
When I send a "GET" request to "/embedded_dummies?relatedDummy.embeddedDummy.dummyBoolean=true"
335+
Then the response status code should be 200
336+
And the response should be in JSON
337+
And the header "Content-Type" should be equal to "application/ld+json; charset=utf-8"
338+
And the JSON should be valid according to this schema:
339+
"""
340+
{
341+
"type": "object",
342+
"properties": {
343+
"@context": {"pattern": "^/contexts/EmbeddedDummy$"},
344+
"@id": {"pattern": "^/embedded_dummies$"},
345+
"@type": {"pattern": "^hydra:Collection$"},
346+
"hydra:member": {
347+
"type": "array",
348+
"items": {
349+
"type": "object",
350+
"properties": {
351+
"@id": {
352+
"oneOf": [
353+
{"pattern": "^/embedded_dummies/26$"},
354+
{"pattern": "^/embedded_dummies/27$"},
355+
{"pattern": "^/embedded_dummies/28$"}
356+
]
357+
}
358+
}
359+
}
360+
},
361+
"hydra:view": {
362+
"type": "object",
363+
"properties": {
364+
"@id": {"pattern": "^/embedded_dummies\\?relatedDummy.embeddedDummy\\.dummyBoolean=true"},
365+
"@type": {"pattern": "^hydra:PartialCollectionView$"}
366+
}
367+
}
368+
}
369+
}
370+
"""
371+
And the JSON node "hydra:totalItems" should be equal to 15
372+
169373
@dropSchema
170374
Scenario: Get collection ordered by a non valid properties
171375
When I send a "GET" request to "/dummies?unknown=0"

0 commit comments

Comments
 (0)