Skip to content

Commit af085c6

Browse files
williamdeswilliamdes
committed
Merge branch 'v5.5.x'
2 parents 6fa8c9f + daad190 commit af085c6

13 files changed

+179
-30
lines changed

‎.github/workflows/tests.yml

+8-7
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
continue-on-error: ${{ matrix.experimental }}
1515
strategy:
1616
matrix:
17-
php-version: ["7.2", "7.3", "7.4", "8.0", "8.1", "8.2"]
17+
php-version: ["7.2", "7.3", "7.4", "8.0", "8.1", "8.2", "8.3"]
1818
os: [ubuntu-latest]
1919
experimental: [false]
2020
composer-options: ['']
@@ -51,7 +51,7 @@ jobs:
5151
strategy:
5252
fail-fast: false
5353
matrix:
54-
php-version: ["7.2", "7.3", "7.4", "8.0", "8.1", "8.2"]
54+
php-version: ["7.2", "7.3", "7.4", "8.0", "8.1", "8.2", "8.3"]
5555
os: [ubuntu-latest]
5656
experimental: [false]
5757
composer-options: ['']
@@ -66,13 +66,14 @@ jobs:
6666
- name: Cache module
6767
uses: actions/cache@v3
6868
with:
69-
path: ~/v2.1.8.tar.gz
69+
path: ~/shunit2_2.1.8-4_all.deb
7070
key: shunit2-cache
7171
- name: Setup shunit 2
72-
run: ./tests/phar/install-tests.sh
72+
run: |
73+
wget http://ftp.debian.org/debian/pool/main/s/shunit2/shunit2_2.1.8-4_all.deb -O ~/shunit2_2.1.8-4.deb
74+
sudo apt install -y ~/shunit2_2.1.8-4.deb
7375
- name: Run phar tests
7476
run: |
75-
export PATH="$PATH:$HOME/shunit2-2.1.8/"
7677
COMPOSER_BIN="/bin/composer" COMPOSER_OPTIONS="${{ matrix.composer-options }}" ./tests/phar/tests.sh
7778
7879
test-resume-from-parse:
@@ -82,7 +83,7 @@ jobs:
8283
strategy:
8384
fail-fast: false
8485
matrix:
85-
php-version: ["7.2", "7.3", "7.4", "8.0", "8.1", "8.2"]
86+
php-version: ["7.2", "7.3", "7.4", "8.0", "8.1", "8.2", "8.3"]
8687
os: [ubuntu-latest]
8788
experimental: [false]
8889
composer-options: ['']
@@ -116,7 +117,7 @@ jobs:
116117
strategy:
117118
fail-fast: false
118119
matrix:
119-
php-version: ["7.2", "7.3", "7.4", "8.0", "8.1", "8.2"]
120+
php-version: ["7.2", "7.3", "7.4", "8.0", "8.1", "8.2", "8.3"]
120121
os: [ubuntu-latest]
121122
experimental: [false]
122123
composer-options: ['']

‎phpstan-baseline.neon

+5-5
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,11 @@ parameters:
190190
count: 1
191191
path: src/Parser/Node/DocBlockNode.php
192192

193+
-
194+
message: "#^Call to an undefined method PhpParser\\\\Node\\\\ComplexType\\|PhpParser\\\\Node\\\\Identifier\\|PhpParser\\\\Node\\\\Name\\:\\:__toString\\(\\)\\.$#"
195+
count: 1
196+
path: src/Parser/NodeVisitor.php
197+
193198
-
194199
message: "#^Call to an undefined method PhpParser\\\\Node\\\\Identifier\\|PhpParser\\\\Node\\\\IntersectionType\\|PhpParser\\\\Node\\\\Name\\:\\:__toString\\(\\)\\.$#"
195200
count: 1
@@ -305,11 +310,6 @@ parameters:
305310
count: 1
306311
path: src/Parser/NodeVisitor.php
307312

308-
-
309-
message: "#^Parameter \\#1 \\$type of method Doctum\\\\Parser\\\\NodeVisitor\\:\\:typeToString\\(\\) expects PhpParser\\\\Node\\\\Identifier\\|PhpParser\\\\Node\\\\Name\\|PhpParser\\\\Node\\\\NullableType\\|PhpParser\\\\Node\\\\UnionType\\|null, PhpParser\\\\Node\\\\ComplexType\\|PhpParser\\\\Node\\\\Identifier\\|PhpParser\\\\Node\\\\Name\\|null given\\.$#"
310-
count: 4
311-
path: src/Parser/NodeVisitor.php
312-
313313
-
314314
message: "#^Property Doctum\\\\Parser\\\\NodeVisitor\\:\\:\\$context has no type specified\\.$#"
315315
count: 1

‎phpstan.neon.dist

+2
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,8 @@ parameters:
88
- tests/phar/data/*
99
- scripts/generate-twig-cache.php
1010
- scripts/update-po-files.php
11+
- scripts/phar-utils-timestamps.php
12+
- scripts/phar-generator-script.php
1113
paths:
1214
- src/
1315
- scripts/

‎scripts/update-release.sh

+1-1
Original file line numberDiff line numberDiff line change
@@ -95,7 +95,7 @@ if [ ${IS_LTS_MODE} = "0" ]; then
9595
updateLatestFolders "./releases/${VERSION}"
9696
else
9797
echo 'LTS mode !'
98-
read -r -p "Make it the latest version ? [Y/n]" response
98+
read -r -p "Make it the latest (${VERSION_ENV}) version ? [Y/n]" response
9999
response=${response,,} # tolower
100100
if [[ $response =~ ^(yes|y| ) ]] || [[ -z $response ]]; then
101101
updateLatestFolders "./releases/${VERSION}"

‎src/Doctum.php

+3-1
Original file line numberDiff line numberDiff line change
@@ -195,6 +195,8 @@ class Doctum implements ArrayAccess
195195
private $base_url = null;
196196
/** @var string|null */
197197
private $favicon = null;
198+
/** @var string */
199+
private $language = 'en';
198200

199201
/**
200202
* @var array<string,string>|null
@@ -362,7 +364,7 @@ public function offsetGet($offset)
362364
private function getLanguageFromConfig(): string
363365
{
364366
/** @var string $language */
365-
$language = $this->config['language'] ?? 'en';
367+
$language = $this->config['language'] ?? $this->language;
366368
return $language;
367369
}
368370

‎src/Parser/NodeVisitor.php

+3
Original file line numberDiff line numberDiff line change
@@ -353,6 +353,9 @@ protected function addMethod(ClassMethodNode $node)
353353
}
354354
}
355355

356+
/**
357+
* @param FunctionReflection|MethodReflection|PropertyReflection $methodOrFunctionOrProperty
358+
*/
356359
protected function addTagFromCommentToMethod(
357360
string $tagName,
358361
DocBlockNode $comment,

‎src/Reflection/FunctionReflection.php

+2
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,9 @@ public function getClass()
8585

8686
public function setClass(ClassReflection $class)
8787
{
88+
// phpcs:disable Squiz.PHP.NonExecutableCode.ReturnNotRequired
8889
return; // No op
90+
// phpcs:enable
8991
}
9092

9193
/**

‎tests/phar/data/absolute_1.out

+19-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ Version main
55

66

77
Parsing Foo\Foo total: 62 errors
8+
Parsing Head total: 62 errors
9+
Parsing Body total: 62 errors
10+
Parsing Footer total: 62 errors
11+
Parsing IntersectionDocument total: 62 errors
812
Parsing Models\LaravelModel total: 62 errors
13+
Parsing RoundaboutIntersection\Foo total: 62 errors
14+
Parsing RoundaboutIntersection\Bar total: 62 errors
15+
Parsing RoundaboutIntersection\FooAndBar total: 62 errors
16+
Parsing RoundaboutIntersection\Baz total: 62 errors
917
Parsing IPv4Address total: 62 errors
1018
Parsing MyContainer total: 63 errors
1119
Parsing Collection total: 63 errors
@@ -34,27 +42,35 @@ Rendering Namespace Illuminate
3442
Rendering Namespace Illuminate\Database
3543
Rendering Namespace Illuminate\Database\Eloquent
3644
Rendering Namespace Models
45+
Rendering Namespace RoundaboutIntersection
3746
Rendering Namespace SuperCoolLibrary
3847
Rendering Class Bar
48+
Rendering Class Body
3949
Rendering Class Cat
4050
Rendering Class Collection
4151
Rendering Class DogCollection
4252
Rendering Class Foo
4353
Rendering Class Foo\Foo
54+
Rendering Class Footer
55+
Rendering Class Head
4456
Rendering Class IPv4Address
4557
Rendering Class Illuminate\Database\Eloquent\Builder
58+
Rendering Class IntersectionDocument
4659
Rendering Class Models\LaravelModel
4760
Rendering Class MyContainer
4861
Rendering Class Net_Sample
4962
Rendering Class PersistentCollection
63+
Rendering Class RoundaboutIntersection\Bar
64+
Rendering Class RoundaboutIntersection\Baz
65+
Rendering Class RoundaboutIntersection\Foo
66+
Rendering Class RoundaboutIntersection\FooAndBar
5067
Rendering Class SuperCoolLibrary\Meta
5168
Rendering done
5269

5370

5471
Version Updated C Removed C
55-
main 13 0
72+
main 21 0
5673

5774

5875
Version Updated C Updated N Removed C Removed N
59-
main 13 7 0 0
60-
76+
main 21 8 0 0

‎tests/phar/data/absolute_fr_1.out

+76
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,76 @@
1+
Updating project
2+
3+
Version main
4+
------------
5+
6+
7+
Parsing Foo\Foo total: 62 errors
8+
Parsing Head total: 62 errors
9+
Parsing Body total: 62 errors
10+
Parsing Footer total: 62 errors
11+
Parsing IntersectionDocument total: 62 errors
12+
Parsing Models\LaravelModel total: 62 errors
13+
Parsing RoundaboutIntersection\Foo total: 62 errors
14+
Parsing RoundaboutIntersection\Bar total: 62 errors
15+
Parsing RoundaboutIntersection\FooAndBar total: 62 errors
16+
Parsing RoundaboutIntersection\Baz total: 62 errors
17+
Parsing IPv4Address total: 62 errors
18+
Parsing MyContainer total: 63 errors
19+
Parsing Collection total: 63 errors
20+
Parsing DogCollection total: 63 errors
21+
Parsing PersistentCollection total: 63 errors
22+
Parsing Cat total: 63 errors
23+
Parsing Foo total: 63 errors
24+
Parsing Bar total: 63 errors
25+
Parsing SuperCoolLibrary\Meta total: 63 errors
26+
Parsing Net_Sample total: 63 errors
27+
Parsing done
28+
29+
Rendering Global index.html
30+
Rendering Global doc-index.html
31+
Rendering Global namespaces.html
32+
Rendering Global classes.html
33+
Rendering Global interfaces.html
34+
Rendering Global traits.html
35+
Rendering Global opensearch.xml
36+
Rendering Global search.html
37+
Rendering Global doctum.js
38+
Rendering Global doctum-search.json
39+
Rendering Namespace [Global Namespace]
40+
Rendering Namespace Foo
41+
Rendering Namespace Illuminate
42+
Rendering Namespace Illuminate\Database
43+
Rendering Namespace Illuminate\Database\Eloquent
44+
Rendering Namespace Models
45+
Rendering Namespace RoundaboutIntersection
46+
Rendering Namespace SuperCoolLibrary
47+
Rendering Class Bar
48+
Rendering Class Body
49+
Rendering Class Cat
50+
Rendering Class Collection
51+
Rendering Class DogCollection
52+
Rendering Class Foo
53+
Rendering Class Foo\Foo
54+
Rendering Class Footer
55+
Rendering Class Head
56+
Rendering Class IPv4Address
57+
Rendering Class Illuminate\Database\Eloquent\Builder
58+
Rendering Class IntersectionDocument
59+
Rendering Class Models\LaravelModel
60+
Rendering Class MyContainer
61+
Rendering Class Net_Sample
62+
Rendering Class PersistentCollection
63+
Rendering Class RoundaboutIntersection\Bar
64+
Rendering Class RoundaboutIntersection\Baz
65+
Rendering Class RoundaboutIntersection\Foo
66+
Rendering Class RoundaboutIntersection\FooAndBar
67+
Rendering Class SuperCoolLibrary\Meta
68+
Rendering done
69+
70+
71+
Version Updated C Removed C
72+
main 21 0
73+
74+
75+
Version Updated C Updated N Removed C Removed N
76+
main 21 8 0 0

‎tests/phar/data/doctum-absolute-fr.conf.php

+27
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
<?php
2+
3+
declare(strict_types = 1);
4+
5+
use Doctum\Doctum;
6+
use Symfony\Component\Finder\Finder;
7+
8+
$rootDir = __DIR__ . '/src';
9+
$iterator = Finder::create()
10+
->files()
11+
->sortByName()
12+
->name('*.php')
13+
->in($rootDir);
14+
15+
return new Doctum(
16+
$iterator,
17+
[
18+
'theme' => 'default',
19+
'title' => 'API Documentation',
20+
'build_dir' => __DIR__ . '/build/html',
21+
'cache_dir' => __DIR__ . '/cache/html',
22+
'insert_todos' => true,
23+
'language' => 'fr',
24+
'base_url' => 'http://8.1.local/@code-lts/doctum/tests/phar/data/build/html/',
25+
'favicon' => 'https://williamdes.eu/assets/logo/williamdes_x64.png',
26+
]
27+
);

‎tests/phar/data/relative_1.out

+19-3
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,15 @@ Version main
55

66

77
Parsing Foo\Foo total: 62 errors
8+
Parsing Head total: 62 errors
9+
Parsing Body total: 62 errors
10+
Parsing Footer total: 62 errors
11+
Parsing IntersectionDocument total: 62 errors
812
Parsing Models\LaravelModel total: 62 errors
13+
Parsing RoundaboutIntersection\Foo total: 62 errors
14+
Parsing RoundaboutIntersection\Bar total: 62 errors
15+
Parsing RoundaboutIntersection\FooAndBar total: 62 errors
16+
Parsing RoundaboutIntersection\Baz total: 62 errors
917
Parsing IPv4Address total: 62 errors
1018
Parsing MyContainer total: 63 errors
1119
Parsing Collection total: 63 errors
@@ -34,27 +42,35 @@ Rendering Namespace Illuminate
3442
Rendering Namespace Illuminate\Database
3543
Rendering Namespace Illuminate\Database\Eloquent
3644
Rendering Namespace Models
45+
Rendering Namespace RoundaboutIntersection
3746
Rendering Namespace SuperCoolLibrary
3847
Rendering Class Bar
48+
Rendering Class Body
3949
Rendering Class Cat
4050
Rendering Class Collection
4151
Rendering Class DogCollection
4252
Rendering Class Foo
4353
Rendering Class Foo\Foo
54+
Rendering Class Footer
55+
Rendering Class Head
4456
Rendering Class IPv4Address
4557
Rendering Class Illuminate\Database\Eloquent\Builder
58+
Rendering Class IntersectionDocument
4659
Rendering Class Models\LaravelModel
4760
Rendering Class MyContainer
4861
Rendering Class Net_Sample
4962
Rendering Class PersistentCollection
63+
Rendering Class RoundaboutIntersection\Bar
64+
Rendering Class RoundaboutIntersection\Baz
65+
Rendering Class RoundaboutIntersection\Foo
66+
Rendering Class RoundaboutIntersection\FooAndBar
5067
Rendering Class SuperCoolLibrary\Meta
5168
Rendering done
5269

5370

5471
Version Updated C Removed C
55-
main 13 0
72+
main 21 0
5673

5774

5875
Version Updated C Updated N Removed C Removed N
59-
main 13 7 0 0
60-
76+
main 21 8 0 0

‎tests/phar/install-tests.sh

-10
This file was deleted.

‎tests/phar/tests.sh

+14
Original file line numberDiff line numberDiff line change
@@ -20,13 +20,27 @@ testPharVersionCommand() {
2020
testPharAbsoluteFiles() {
2121
cd $(dirname $0)/data/
2222
ABSOLUTE_OUTPUT=$(COLUMNS=200 ${PHAR_PATH} update --ignore-parse-errors --no-progress --no-ansi --force ./doctum-absolute.conf.php 2>&1)
23+
# Un-comment to update the test data
24+
# echo "${ABSOLUTE_OUTPUT}" > absolute_1.out
2325
assertSame "The output must be the same" "$(cat absolute_1.out)" "${ABSOLUTE_OUTPUT}"
2426
cd - > /dev/null
2527
}
2628

29+
testPharAbsoluteFilesFrench() {
30+
cd $(dirname $0)/data/
31+
ABSOLUTE_OUTPUT=$(COLUMNS=200 ${PHAR_PATH} update --ignore-parse-errors --no-progress --no-ansi --force ./doctum-absolute-fr.conf.php 2>&1)
32+
# Un-comment to update the test data
33+
# echo "${ABSOLUTE_OUTPUT}" > absolute_fr_1.out
34+
assertSame "The output must be the same" "$(cat absolute_fr_1.out)" "${ABSOLUTE_OUTPUT}"
35+
assertSame "The output must be the same" "Afficher le menu</span" "$(grep -F "Afficher le menu" ./build/html/doc-index.html | cut -d '>' -f 2)"
36+
cd - > /dev/null
37+
}
38+
2739
testPharRelativeFiles() {
2840
cd $(dirname $0)/data/
2941
RELATIVE_OUTPUT=$(COLUMNS=200 ${PHAR_PATH} update --ignore-parse-errors --no-progress --no-ansi --force ./doctum-relative.conf.php 2>&1)
42+
# Un-comment to update the test data
43+
# echo "${RELATIVE_OUTPUT}" > relative_1.out
3044
assertSame "The output must be the same" "$(cat relative_1.out)" "${RELATIVE_OUTPUT}"
3145
cd - > /dev/null
3246
}

0 commit comments

Comments
 (0)