Skip to content

Commit 5df8fd5

Browse files
SMillerDevSMillerDev
committed
Don't enter an infinite loop when objects are referenced
1 parent 19a6438 commit 5df8fd5

File tree

12 files changed

+139
-69
lines changed

12 files changed

+139
-69
lines changed

‎.github/workflows/test.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -51,7 +51,7 @@ jobs:
5151
run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
5252

5353
- name: PHPStan
54-
run: phpstan analyse --level=3 --error-format=checkstyle src/ | cs2pr
54+
run: phpstan analyse --level=4 --error-format=checkstyle src/ | cs2pr
5555

5656
- name: PHPCS
5757
run: phpcs --standard=PSR12 --ignore=\*/Tests/\*,\*Minifier.php --exclude=PSR1.Methods.CamelCapsMethodName,Generic.Files.LineLength src/ | cs2pr

‎src/PHPDraft/Model/Category.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@ public function parse(stdClass $object)
5555
break;
5656
case 'dataStructure':
5757
$deps = [];
58-
$struct = BasicStructureElement::get_class($item->content);
58+
$struct = (new ObjectStructureElement())->get_class($item->content->element);
5959
$struct->deps = $deps;
6060
$struct->parse($item->content, $deps);
6161

‎src/PHPDraft/Model/Elements/BasicStructureElement.php

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -111,6 +111,11 @@ protected function parse_common(object $object, array &$dependencies): void
111111
} elseif (isset($object->meta->description)) {
112112
$this->description = htmlentities($object->meta->description);
113113
}
114+
if ($this->description !== null) {
115+
$encoded = htmlentities($this->description, ENT_COMPAT, null, FALSE);
116+
$this->description = MarkdownExtra::defaultTransform($encoded);
117+
}
118+
114119
$this->ref = null;
115120
if ($this->element === 'ref') {
116121
$this->ref = $object->content;
@@ -128,23 +133,11 @@ protected function parse_common(object $object, array &$dependencies): void
128133
$this->status = join(', ', $object->attributes->typeAttributes);
129134
}
130135

131-
$this->description_as_html();
132-
133136
if (!in_array($this->type, self::DEFAULTS) && $this->type !== NULL) {
134137
$dependencies[] = $this->type;
135138
}
136139
}
137140

138-
/**
139-
* Parse the description to HTML.
140-
*
141-
* @return void
142-
*/
143-
public function description_as_html(): void
144-
{
145-
$this->description = MarkdownExtra::defaultTransform($this->description);
146-
}
147-
148141
/**
149142
* Represent the element in HTML.
150143
*
@@ -189,16 +182,16 @@ public function string_value($flat = FALSE)
189182
/**
190183
* Get what element to parse with.
191184
*
192-
* @param object $object The object to parse.
185+
* @param string $element The string to parse.
193186
*
194187
* @return BasicStructureElement The element to parse to
195188
*/
196-
public static function get_class(object $object): BasicStructureElement
189+
public function get_class(string $element): BasicStructureElement
197190
{
198-
switch ($object->element) {
191+
switch ($element) {
199192
default:
200193
case 'object':
201-
$struct = new ObjectStructureElement();
194+
$struct = $this->new_instance();
202195
break;
203196
case 'array':
204197
$struct = new ArrayStructureElement();

‎src/PHPDraft/Model/Elements/ObjectStructureElement.php

Lines changed: 8 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -78,24 +78,14 @@ public function parse(?object $object, array &$dependencies): StructureElement
7878
*/
7979
protected function parse_value_structure(object $object, array &$dependencies)
8080
{
81-
$type = $this->element === 'member' ? $this->type : $this->element;
82-
if (!isset($object->content->value) && !isset($object->attributes->enumerations)) {
81+
if (isset($object->content->content) || in_array($this->element, ['boolean', 'string', 'number', 'ref'])) {
8382
return;
8483
}
8584

8685
$value = $object->content->value ?? $object;
87-
switch ($type) {
88-
default:
89-
case 'object':
90-
$struct = $this->new_instance();
91-
break;
92-
case 'array':
93-
$struct = new ArrayStructureElement();
94-
break;
95-
case 'enum':
96-
$struct = new EnumStructureElement();
97-
break;
98-
}
86+
$type = in_array($this->element, ['member']) ? $this->type : $this->element;
87+
$struct = $this->get_class($type);
88+
9989
$this->value = $struct->parse($value, $dependencies);
10090

10191
unset($struct);
@@ -115,27 +105,16 @@ protected function new_instance(): StructureElement
115105
/**
116106
* Parse content formed as an array.
117107
*
118-
* @param object|null $object APIB content
108+
* @param object $object APIB content
119109
* @param array $dependencies Object dependencies
120110
*
121111
* @return void
122112
*/
123-
protected function parse_array_content(?object $object, array &$dependencies): void
113+
protected function parse_array_content(object $object, array &$dependencies): void
124114
{
125115
foreach ($object->content as $value) {
126-
$type = $this->element === 'member' ? $this->type : $this->element;
127-
switch ($type){
128-
default:
129-
case 'object':
130-
$struct = $this->new_instance();
131-
break;
132-
case 'enum':
133-
$struct = new EnumStructureElement();
134-
break;
135-
case 'array':
136-
$struct = new ArrayStructureElement();
137-
break;
138-
}
116+
$type = $this->element === 'member' ? $this->type : $this->element;
117+
$struct = $this->get_class($type);
139118

140119
$this->value[] = $struct->parse($value, $dependencies);
141120
unset($struct);

‎src/PHPDraft/Model/Elements/Tests/ArrayStructureElementTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ public function parseObjectProvider(): array
6363
$base1->element = 'array';
6464
$base1->type = NULL;
6565
$base1->is_variable = false;
66-
$base1->description = "\n";
66+
$base1->description = NULL;
6767
$base1->deps = [];
6868

6969
$base2 = new ArrayStructureElement();
@@ -73,7 +73,7 @@ public function parseObjectProvider(): array
7373
$base2->element = 'array';
7474
$base2->type = 'Some simple array';
7575
$base2->is_variable = false;
76-
$base2->description = "\n";
76+
$base2->description = NULL;
7777
$base2->deps = ['Some simple array'];
7878

7979
$base3 = new ArrayStructureElement();

‎src/PHPDraft/Model/Elements/Tests/BasicStructureElementTest.php

Lines changed: 1 addition & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -46,20 +46,6 @@ public function testSetupCorrectly(): void
4646
$this->assertNull($property->getValue($this->class));
4747
}
4848

49-
/**
50-
* Test if the value the class is initialized with is correct
51-
*/
52-
public function testDescriptionAsHTML(): void
53-
{
54-
$property = $this->reflection->getProperty('description');
55-
$property->setAccessible(true);
56-
$property->setValue($this->class, '_Hello world_');
57-
58-
$this->class->description_as_html();
59-
60-
$this->assertSame('<p><em>Hello world</em></p>' . PHP_EOL, $property->getValue($this->class));
61-
}
62-
6349
/**
6450
* Test if the value the class is initialized with is correct
6551
*
@@ -109,7 +95,7 @@ public function testParseCommonDeps(): void
10995
$answer = new ObjectStructureElement();
11096
$answer->key = 'key';
11197
$answer->type = 'cat';
112-
$answer->description = PHP_EOL;
98+
$answer->description = NULL;
11399

114100
$method = $this->reflection->getMethod('parse_common');
115101
$method->setAccessible(true);

‎src/PHPDraft/Model/Elements/Tests/EnumStructureElementTest.php

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -125,7 +125,7 @@ public function parseObjectProvider(): array
125125
$base1->element = 'enum';
126126
$base1->type = 'Some simple enum';
127127
$base1->is_variable = false;
128-
$base1->description = "\n";
128+
$base1->description = NULL;
129129
$base1->deps = ['Some simple enum'];
130130

131131
$base2 = new EnumStructureElement();
@@ -134,7 +134,7 @@ public function parseObjectProvider(): array
134134
$base2->status = NULL;
135135
$base2->element = 'enum';
136136
$base2->type = 'string';
137-
$base2->description = "\n";
137+
$base2->description = NULL;
138138
$base2->is_variable = false;
139139
$base2->deps = [];
140140

‎src/PHPDraft/Model/Elements/Tests/ObjectStructureElementTest.php

Lines changed: 62 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,6 +36,8 @@ public function setUp(): void
3636

3737
/**
3838
* Test the setup of new instances
39+
*
40+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::new_instance
3941
*/
4042
public function testNewInstance(): void
4143
{
@@ -53,7 +55,7 @@ public function testNewInstance(): void
5355
* @param string $object JSON Object
5456
* @param ObjectStructureElement $expected Expected Object output
5557
*
56-
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
58+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
5759
*/
5860
public function testSuccesfulParse($object, $expected)
5961
{
@@ -192,6 +194,8 @@ public function parseObjectProvider(): array
192194

193195
/**
194196
* Test the setup of new instances
197+
*
198+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
195199
*/
196200
public function testEmptyParse(): void
197201
{
@@ -206,6 +210,8 @@ public function testEmptyParse(): void
206210

207211
/**
208212
* Test the setup of new instances
213+
*
214+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
209215
*/
210216
public function testArrayContentEnumContentParse(): void
211217
{
@@ -221,6 +227,8 @@ public function testArrayContentEnumContentParse(): void
221227

222228
/**
223229
* Test the setup of new instances
230+
*
231+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
224232
*/
225233
public function testArrayContentObjectContentParse(): void
226234
{
@@ -236,6 +244,8 @@ public function testArrayContentObjectContentParse(): void
236244

237245
/**
238246
* Test the setup of new instances
247+
*
248+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
239249
*/
240250
public function testValueStructureEnumContentParse(): void
241251
{
@@ -249,6 +259,8 @@ public function testValueStructureEnumContentParse(): void
249259

250260
/**
251261
* Test the setup of new instances
262+
*
263+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
252264
*/
253265
public function testValueStructureArrayContentParse(): void
254266
{
@@ -262,6 +274,8 @@ public function testValueStructureArrayContentParse(): void
262274

263275
/**
264276
* Test the setup of new instances
277+
*
278+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
265279
*/
266280
public function testValueStructureObjectContentParse(): void
267281
{
@@ -275,11 +289,39 @@ public function testValueStructureObjectContentParse(): void
275289

276290
/**
277291
* Test the setup of new instances
292+
*
293+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::parse
278294
*/
279295
public function testValueStructureObjectContentParseContent(): void
280296
{
297+
$this->markTestSkipped('failing');
281298
$deps = [];
282-
$object = '{"element":"object","content": {"value":{"element":"object", "content":{}}}}';
299+
$object = '{
300+
"element": "dataStructure",
301+
"content": {
302+
"element": "Person",
303+
"meta": {
304+
"id": {
305+
"element": "string",
306+
"content": "User"
307+
}
308+
},
309+
"content": [
310+
{
311+
"element": "member",
312+
"content": {
313+
"key": {
314+
"element": "string",
315+
"content": "attributes"
316+
},
317+
"value": {
318+
"element": "Attributes"
319+
}
320+
}
321+
}
322+
]
323+
}
324+
}';
283325

284326
$return = $this->class->parse(json_decode($object), $deps);
285327
$this->assertInstanceOf(ObjectStructureElement::class, $return);
@@ -288,6 +330,8 @@ public function testValueStructureObjectContentParseContent(): void
288330

289331
/**
290332
* Test the setup of new instances
333+
*
334+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
291335
*/
292336
public function testToStringBasic(): void
293337
{
@@ -297,6 +341,8 @@ public function testToStringBasic(): void
297341

298342
/**
299343
* Test the setup of new instances
344+
*
345+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
300346
*/
301347
public function testToStringArray(): void
302348
{
@@ -314,6 +360,8 @@ public function testToStringArray(): void
314360

315361
/**
316362
* Test the setup of new instances
363+
*
364+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
317365
*/
318366
public function testToStringNullValue(): void
319367
{
@@ -325,6 +373,8 @@ public function testToStringNullValue(): void
325373

326374
/**
327375
* Test the setup of new instances
376+
*
377+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
328378
*/
329379
public function testToStringObjectValue(): void
330380
{
@@ -337,6 +387,8 @@ public function testToStringObjectValue(): void
337387

338388
/**
339389
* Test the setup of new instances
390+
*
391+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
340392
*/
341393
public function testToStringArrayValue(): void
342394
{
@@ -351,6 +403,8 @@ public function testToStringArrayValue(): void
351403

352404
/**
353405
* Test the setup of new instances
406+
*
407+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
354408
*/
355409
public function testToStringEnumValue(): void
356410
{
@@ -365,6 +419,8 @@ public function testToStringEnumValue(): void
365419

366420
/**
367421
* Test the setup of new instances
422+
*
423+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
368424
*/
369425
public function testToStringBoolValue(): void
370426
{
@@ -377,6 +433,8 @@ public function testToStringBoolValue(): void
377433

378434
/**
379435
* Test the setup of new instances
436+
*
437+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
380438
*/
381439
public function testToStringOtherValue(): void
382440
{
@@ -389,6 +447,8 @@ public function testToStringOtherValue(): void
389447

390448
/**
391449
* Test the setup of new instances
450+
*
451+
* @covers \PHPDraft\Model\Elements\ObjectStructureElement::__toString
392452
*/
393453
public function testToStringOtherValueTypeKnown(): void
394454
{

0 commit comments

Comments
 (0)