Skip to content

Commit 96625a2

Browse files
SMillerDevSMillerDev
committed
General: Stabilize twig template usage
Signed-off-by: Sean Molenaar <sean@seanmolenaar.eu>
1 parent ff63909 commit 96625a2

22 files changed

+264
-158
lines changed

‎.github/workflows/test.yml‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ jobs:
7575
run: echo "::add-matcher::${{ runner.tool_cache }}/phpunit.json"
7676

7777
- name: Run test suite
78-
run: composer run-script test
78+
run: ./vendor/bin/phpunit --configuration tests/phpunit.xml --coverage-clover=coverage.xml --exclude-group twig
7979

8080
- name: PHPStan
81-
run: phpstan analyse --level=5 src/
81+
run: ./vendor/bin/phpstan analyse --level=5 src/
8282

8383
- name: PHPCS
8484
run: phpcs --standard=tests/phpcs.xml --ignore=\*Minifier.php src/ | cs2pr
@@ -110,7 +110,7 @@ jobs:
110110
run: composer update --no-interaction --no-suggest
111111

112112
- name: Run test suite
113-
run: composer run-script test-sonar
113+
run: ./vendor/bin/phpunit --configuration tests/phpunit.xml --exclude-group twig --coverage-clover=./var/coverage/clover.xml
114114

115115
- name: Code coverage Scan
116116
uses: codecov/codecov-action@v1

‎composer.json‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -38,12 +38,6 @@
3838
"phpstan/phpstan": "^0.12.17"
3939
},
4040
"scripts": {
41-
"test": [
42-
"vendor/bin/phpunit --configuration tests/phpunit.xml --coverage-clover=coverage.xml"
43-
],
44-
"test-sonar": [
45-
"vendor/bin/phpunit --configuration tests/phpunit.xml --coverage-clover=./var/coverage/clover.xml"
46-
],
4741
"phar": [
4842
"vendor/bin/phing phar",
4943
"sha256sum build/out/*"

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212

1313
namespace PHPDraft\Model\Elements;
1414

15+
use Michelf\MarkdownExtra;
16+
1517
/**
1618
* Class ArrayStructureElement.
1719
*/
@@ -58,7 +60,7 @@ public function __toString(): string
5860
if (is_string($this->value)) {
5961
$type = $this->get_element_as_html($this->element);
6062

61-
return '<tr><td>' . $this->key . '</td><td>' . $type . '</td><td>' . $this->description . '</td></tr>';
63+
return '<tr><td>' . $this->key . '</td><td>' . $type . '</td><td>' . MarkdownExtra::defaultTransform($this->description) . '</td></tr>';
6264
}
6365

6466
$return = '';

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ protected function parse_common(object $object, array &$dependencies): void
117117
$this->description = htmlentities($object->meta->description);
118118
}
119119
if ($this->description !== null) {
120-
$encoded = htmlentities($this->description, ENT_COMPAT, null, false);
120+
$encoded = htmlentities($this->description, ENT_COMPAT, 'ISO-8859-1', false);
121121
$this->description = $encoded;
122122
}
123123

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212

1313
namespace PHPDraft\Model\Elements;
1414

15+
use Michelf\MarkdownExtra;
16+
1517
class EnumStructureElement extends BasicStructureElement
1618
{
1719
/**
@@ -80,7 +82,7 @@ public function __toString(): string
8082
if (is_string($this->value)) {
8183
$type = $this->get_element_as_html($this->element);
8284

83-
return '<tr><td>' . $this->key->value . '</td><td>' . $type . '</td><td>' . $this->description . '</td></tr>';
85+
return '<tr><td>' . $this->key->value . '</td><td>' . $type . '</td><td>' . MarkdownExtra::defaultTransform($this->description) . '</td></tr>';
8486
}
8587

8688
$return = '';

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

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@
1212

1313
namespace PHPDraft\Model\Elements;
1414

15+
use Michelf\MarkdownExtra;
16+
1517
/**
1618
* Class ObjectStructureElement.
1719
*/
@@ -20,7 +22,7 @@ class ObjectStructureElement extends BasicStructureElement
2022

2123
/**
2224
* Object representation before parsing
23-
* @var \stdClass
25+
* @var \stdClass|null
2426
*/
2527
private $object;
2628

@@ -212,7 +214,7 @@ protected function construct_string_return(string $value): string
212214
'<td>' . '<span>' . $this->key->value . '</span>' . $variable . '</td>' .
213215
'<td>' . $type . '</td>' .
214216
'<td> <span class="status">' . $this->status . '</span></td>' .
215-
'<td>' . $this->description . '</td>' .
217+
'<td>' . MarkdownExtra::defaultTransform($this->description) . '</td>' .
216218
'<td>' . $value . '</td>' .
217219
'</tr>';
218220
}

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ public function testToStringWithString(): void
7777
$this->class->key->value = 'key';
7878
$this->class->element = 'string';
7979
$return = $this->class->__toString();
80-
$this->assertSame('<tr><td>key</td><td><code>string</code></td><td></td></tr>', $return);
80+
$this->assertSame('<tr><td>key</td><td><code>string</code></td><td>' . PHP_EOL . '</td></tr>', $return);
8181
}
8282

8383
/**
@@ -91,7 +91,7 @@ public function testToStringWithStringComplex(): void
9191
$this->class->key->value = 'key';
9292
$this->class->element = 'Car';
9393
$return = $this->class->__toString();
94-
$this->assertSame('<tr><td>key</td><td><a class="code" title="Car" href="#object-car">Car</a></td><td></td></tr>', $return);
94+
$this->assertSame('<tr><td>key</td><td><a class="code" title="Car" href="#object-car">Car</a></td><td>' . PHP_EOL . '</td></tr>', $return);
9595
}
9696

9797
/**

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

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -360,7 +360,7 @@ public function testToStringArray(): void
360360
$val->value = 'stuff';
361361
$this->class->value = [$val];
362362
$return = $this->class->__toString();
363-
$this->assertSame('<table class="table table-striped mdl-data-table mdl-js-data-table "><tr><td></td><td><a class="code" title="things" href="#object-things">things</a></td><td></td></tr></table>', $return);
363+
$this->assertSame('<table class="table table-striped mdl-data-table mdl-js-data-table "><tr><td></td><td><a class="code" title="things" href="#object-things">things</a></td><td>' . PHP_EOL . '</td></tr></table>', $return);
364364
}
365365

366366
/**
@@ -374,7 +374,7 @@ public function testToStringNullValue(): void
374374
$this->class->key->value = 'hello';
375375
$this->class->type = 'mixed';
376376
$return = $this->class->__toString();
377-
$this->assertSame('<tr><td><span>hello</span></td><td><a class="code" title="mixed" href="#object-mixed">mixed</a></td><td> <span class="status"></span></td><td></td><td></td></tr>', $return);
377+
$this->assertSame('<tr><td><span>hello</span></td><td><a class="code" title="mixed" href="#object-mixed">mixed</a></td><td> <span class="status"></span></td><td>' . PHP_EOL . '</td><td></td></tr>', $return);
378378
}
379379

380380
/**
@@ -389,7 +389,7 @@ public function testToStringObjectValue(): void
389389
$this->class->value = new ObjectStructureElement();
390390
$this->class->type = 'object';
391391
$return = $this->class->__toString();
392-
$this->assertSame('<tr><td><span>hello</span></td><td><code>object</code></td><td> <span class="status"></span></td><td></td><td><div class="sub-struct"><span class="example-value pull-right">{ }</span></div></td></tr>', $return);
392+
$this->assertSame('<tr><td><span>hello</span></td><td><code>object</code></td><td> <span class="status"></span></td><td>' . PHP_EOL . '</td><td><div class="sub-struct"><span class="example-value pull-right">{ }</span></div></td></tr>', $return);
393393
}
394394

395395
/**
@@ -406,7 +406,7 @@ public function testToStringArrayValue(): void
406406
$this->class->value->value = 'value';
407407
$this->class->type = 'array';
408408
$return = $this->class->__toString();
409-
$this->assertSame('<tr><td><span>hello</span></td><td><code>array</code></td><td> <span class="status"></span></td><td></td><td><div class="array-struct"><tr><td></td><td><a class="code" title="value" href="#object-value">value</a></td><td></td></tr></div></td></tr>', $return);
409+
$this->assertSame('<tr><td><span>hello</span></td><td><code>array</code></td><td> <span class="status"></span></td><td>' . PHP_EOL . '</td><td><div class="array-struct"><tr><td></td><td><a class="code" title="value" href="#object-value">value</a></td><td>' . PHP_EOL . '</td></tr></div></td></tr>', $return);
410410
}
411411

412412
/**
@@ -426,7 +426,7 @@ public function testToStringEnumValue(): void
426426
$this->class->value->key->value = 'key';
427427
$this->class->value->type = 'enum';
428428
$return = $this->class->__toString();
429-
$this->assertSame('<div class="enum-struct"><tr><td>key</td><td><a class="code" title="value" href="#object-value">value</a></td><td></td></tr></div>', $return);
429+
$this->assertSame('<div class="enum-struct"><tr><td>key</td><td><a class="code" title="value" href="#object-value">value</a></td><td>' . PHP_EOL . '</td></tr></div>', $return);
430430
}
431431

432432
/**
@@ -441,7 +441,7 @@ public function testToStringBoolValue(): void
441441
$this->class->value = true;
442442
$this->class->type = 'boolean';
443443
$return = $this->class->__toString();
444-
$this->assertSame('<tr><td><span>hello</span></td><td><code>boolean</code></td><td> <span class="status"></span></td><td></td><td><span class="example-value pull-right">true</span></td></tr>', $return);
444+
$this->assertSame('<tr><td><span>hello</span></td><td><code>boolean</code></td><td> <span class="status"></span></td><td>' . PHP_EOL . '</td><td><span class="example-value pull-right">true</span></td></tr>', $return);
445445
}
446446

447447
/**
@@ -456,7 +456,7 @@ public function testToStringOtherValue(): void
456456
$this->class->value = 'world';
457457
$this->class->type = 'Cow';
458458
$return = $this->class->__toString();
459-
$this->assertSame('<tr><td><span>hello</span></td><td><a class="code" title="Cow" href="#object-cow">Cow</a></td><td> <span class="status"></span></td><td></td><td><span class="example-value pull-right">world</span></td></tr>', $return);
459+
$this->assertSame('<tr><td><span>hello</span></td><td><a class="code" title="Cow" href="#object-cow">Cow</a></td><td> <span class="status"></span></td><td>' . PHP_EOL . '</td><td><span class="example-value pull-right">world</span></td></tr>', $return);
460460
}
461461

462462
/**
@@ -471,6 +471,6 @@ public function testToStringOtherValueTypeKnown(): void
471471
$this->class->key->value = 'hello';
472472
$this->class->value = 'world';
473473
$return = $this->class->__toString();
474-
$this->assertSame('<tr><td><span>hello</span></td><td><code>string</code></td><td> <span class="status"></span></td><td></td><td><span class="example-value pull-right">world</span></td></tr>', $return);
474+
$this->assertSame('<tr><td><span>hello</span></td><td><code>string</code></td><td> <span class="status"></span></td><td>' . PHP_EOL . '</td><td><span class="example-value pull-right">world</span></td></tr>', $return);
475475
}
476476
}

‎src/PHPDraft/Out/HTML/default/main.css‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -225,4 +225,24 @@ span.HEAD {
225225
}
226226
span.PATCH {
227227
color: var(--patch-color);
228+
}
229+
230+
h1.media-heading {
231+
max-width: 80%;
232+
word-break: break-word;
233+
}
234+
235+
.host-information {
236+
position: absolute;
237+
top: 0;
238+
right: 0;
239+
}
240+
241+
.host-information label.host-dropdown {
242+
}
243+
244+
.host-information label.host-dropdown select {
245+
border: 0 none rgba(0,0,0,0);
246+
display: inherit;
247+
width: auto;
228248
}

‎src/PHPDraft/Out/HTML/default/main.twig‎

Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
<title>{{ data.TITLE }}</title>
55
<meta charset="utf-8">
66
<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
7-
<link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/css/bootstrap.min.css" integrity="sha384-9aIt2nRpC12Uk9gS9baDl411NQApFmC26EwAOH8WgZl5MYYxFfc+NcPb1dKGj7Sk" crossorigin="anonymous">
8-
<link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.13.0/css/all.css" integrity="sha384-Bfad6CLCknfcloXFOyFnlgtENryhrpZCe29RTifKEixXQZ38WheV+i/6YWSzkz3V" crossorigin="anonymous">
7+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/css/bootstrap.min.css" integrity="sha512-P5MgMn1jBN01asBgU0z60Qk4QxiXo86+wlFahKrsQf37c9cro517WzVSPPV1tDKzhku2iJ2FVgL67wG03SGnNA==" crossorigin="anonymous" />
8+
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.3/css/all.min.css" integrity="sha512-iBBXm8fW90+nuLcSKlbmrPcLa0OT92xO1BIsZ+ywDWZCvqsWgccV3gFoRBv0z+8dLJgyAHIhR35VZc2oM/gI1w==" crossorigin="anonymous" />
99
{% for style in css %}
1010
<link rel="stylesheet" href="{{ style }}">
1111
{% endfor %}
@@ -15,9 +15,10 @@
1515
<div class="container-fluid">
1616
<div class="media">
1717
<div class="media-body">
18-
<h1 class="media-heading">{{ data.TITLE|raw }}
18+
<h1 class="media-heading">{{ data.TITLE|raw }}</h1>
19+
<section class="host-information">
1920
{% if data.ALT_HOST %}
20-
<label>
21+
<label class="host-dropdown">
2122
Host:
2223
<select class="form-control">
2324
<option selected>{{ data.HOST }}</option>
@@ -27,9 +28,9 @@
2728
</select>
2829
</label>
2930
{%- else %}
30-
<small>{{ data.HOST }}</small>
31+
<label class="host-dropdown">Host: {{ data.HOST }}</label>
3132
{% endif %}
32-
</h1>
33+
</section>
3334
{% if data.DESC %}
3435
{{ data.DESC|markdown_to_html }}
3536
{% endif %}
@@ -73,10 +74,10 @@
7374
<script src="{{ script }}"></script>
7475
{% endfor %}
7576
<!-- JS, Popper.js, and jQuery -->
76-
<script src="https://code.jquery.com/jquery-3.5.1.slim.min.js" integrity="sha384-DfXdz2htPH0lsSSs5nCTpuj/zy4C+OGpamoFVy38MVBnE+IbbVYUew+OrCXaRkfj" crossorigin="anonymous"></script>
77-
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.2.2/anchor.min.js" integrity="sha256-E4RlfxwyJVmkkk0szw7LYJxuPlp6evtPSBDlWHsYYL8=" crossorigin="anonymous"></script>
78-
<script src="https://cdn.jsdelivr.net/npm/popper.js@1.16.0/dist/umd/popper.min.js" integrity="sha384-Q6E9RHvbIyZFJoft+2mJbHaEWldlvI9IOYy5n3zV9zzTtmI3UksdQRVvoxMfooAo" crossorigin="anonymous"></script>
79-
<script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.0/js/bootstrap.min.js" integrity="sha384-OgVRvuATP1z7JjHLkuOU7Xw704+h835Lr+6QL9UvYjZE3Ipu6Tp75j7Bh/kR0JKI" crossorigin="anonymous"></script>
77+
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.slim.js" integrity="sha512-HNbo1d4BaJjXh+/e6q4enTyezg5wiXvY3p/9Vzb20NIvkJghZxhzaXeffbdJuuZSxFhJP87ORPadwmU9aN3wSA==" crossorigin="anonymous"></script>
78+
<script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.3.1/anchor.min.js" integrity="sha512-zPB79j2C+3sFS9zcA3vg/z6bVKzJVEyu9pY5w89akQRys76zpAT2t6S3wZKla3QQ14O5l/Yt0RUQ/DHXx82Y5g==" crossorigin="anonymous"></script>
79+
<script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
80+
<script src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.6.0/js/bootstrap.min.js" integrity="sha512-XKa9Hemdy1Ui3KSGgJdgMyYlUg1gM+QhL6cnlyTe2qzMCYm4nAZ1PsVerQzTTXzonUR+dmswHqgJPuwCq1MaAg==" crossorigin="anonymous"></script>
8081
<script>{{ template_js|minify_js|raw }}</script>
8182
</body>
8283
</html>

0 commit comments

Comments
 (0)