Skip to content

Commit cb5a28d

Browse files
WyriHaximusWyriHaximus
committed
Introduce QA settings
These settings support: * PHPStan * PHPCS * Psalm Fixes: * WebHook generation
1 parent 1823967 commit cb5a28d

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

70 files changed

+1419
-559
lines changed

‎composer.json

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
"php": "^8.2",
1313
"api-clients/contracts": "^0.1",
1414
"api-clients/github": "^0.2@dev",
15+
"api-clients/openapi-client-utils": "dev-main",
1516
"ckr/arraymerger": "^3.0",
1617
"codeinc/http-reason-phrase-lookup": "^1.0",
1718
"delight-im/random": "^1.0",

‎composer.lock

Lines changed: 258 additions & 201 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎example/openapi-client-miele.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,9 @@ voter:
3232
- ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery
3333
streamOperation:
3434
- ApiClients\Tools\OpenApiClientGenerator\Voter\StreamOperation\DownloadInOperationId
35+
qa:
36+
phpcs:
37+
enabled: true
38+
phpstan:
39+
enabled: true
40+
configFilePath: etc/phpstan-extension.neon

‎example/openapi-client-one.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,9 @@ voter:
3232
- ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery
3333
streamOperation:
3434
- ApiClients\Tools\OpenApiClientGenerator\Voter\StreamOperation\DownloadInOperationId
35+
qa:
36+
phpcs:
37+
enabled: true
38+
phpstan:
39+
enabled: true
40+
configFilePath: etc/phpstan-extension.neon

‎example/openapi-client-subsplit.yaml

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,9 @@ subSplit:
4747
sectionPackage:
4848
name: github-{{ section }}
4949
repository: git@github.com:php-api-clients/github-{{ section }}.git
50+
qa:
51+
phpcs:
52+
enabled: true
53+
phpstan:
54+
enabled: true
55+
configFilePath: etc/phpstan-extension.neon

‎example/templates/composer.json

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@
1616
{% endfor %}
1717
{% endif %}
1818
"api-clients/contracts": "^0.1",
19+
"api-clients/openapi-client-utils": "dev-main",
1920
"devizzent/cebe-php-openapi": "^1",
2021
"eventsauce/object-hydrator": "^1.1",
2122
"league/openapi-psr7-validator": "^0.21",
@@ -48,6 +49,15 @@
4849
"api-clients/{{ suggest.name }}": "{{ suggest.reason }}"{% if not loop.last %},{% endif %}
4950
{% endfor %}
5051
},
52+
{% endif %}
53+
{% if qa.phpstan.enabled is constant('true') and qa.phpstan.configFilePath is not constant('null') %}
54+
"extra": {
55+
"phpstan": {
56+
"includes": [
57+
"{{ qa.phpstan.configFilePath }}"
58+
]
59+
}
60+
},
5161
{% endif %}
5262
"config": {
5363
"sort-packages": true,

‎example/templates/etc/qa/phpstan.neon

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,3 @@
11
includes:
22
- ../../vendor/wyrihaximus/async-test-utilities/rules.neon
3+
- ../phpstan-extension.neon

‎src/Configuration.php

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@
77
use ApiClients\Tools\OpenApiClientGenerator\Configuration\Destination;
88
use ApiClients\Tools\OpenApiClientGenerator\Configuration\EntryPoints;
99
use ApiClients\Tools\OpenApiClientGenerator\Configuration\Namespace_;
10+
use ApiClients\Tools\OpenApiClientGenerator\Configuration\QA;
1011
use ApiClients\Tools\OpenApiClientGenerator\Configuration\Schemas;
1112
use ApiClients\Tools\OpenApiClientGenerator\Configuration\State;
1213
use ApiClients\Tools\OpenApiClientGenerator\Configuration\SubSplit;
@@ -32,6 +33,7 @@ public function __construct(
3233
public SubSplit|null $subSplit,
3334
public Schemas|null $schemas,
3435
public Voter|null $voter,
36+
public QA|null $qa,
3537
) {
3638
}
3739
}

‎src/Configuration/QA.php

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace ApiClients\Tools\OpenApiClientGenerator\Configuration;
6+
7+
use ApiClients\Tools\OpenApiClientGenerator\Configuration\QA\Tool;
8+
9+
final readonly class QA
10+
{
11+
public function __construct(
12+
public Tool|null $phpcs,
13+
public Tool|null $phpstan,
14+
public Tool|null $psalm,
15+
) {
16+
}
17+
}

‎src/Configuration/QA/Tool.php

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
<?php
2+
3+
declare(strict_types=1);
4+
5+
namespace ApiClients\Tools\OpenApiClientGenerator\Configuration\QA;
6+
7+
use EventSauce\ObjectHydrator\MapFrom;
8+
9+
final readonly class Tool
10+
{
11+
public function __construct(
12+
public bool $enabled,
13+
#[MapFrom('configFilePath')]
14+
public string|null $configFilePath,
15+
) {
16+
}
17+
}

‎src/Gatherer/WebHook.php

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,7 @@ public static function gather(
2424
PathItem $webhook,
2525
SchemaRegistry $schemaRegistry,
2626
): \ApiClients\Tools\OpenApiClientGenerator\Representation\WebHook {
27-
if ($webhook->post?->requestBody === null || ! property_exists($webhook->post->requestBody, 'content')) {
28-
// var_export(json_decode(json_encode($webhook->getSerializableData())));
27+
if ($webhook->post?->requestBody === null && ! property_exists($webhook->post->requestBody, 'content')) {
2928
throw new RuntimeException('Missing request body content to deal with');
3029
}
3130

@@ -45,7 +44,7 @@ public static function gather(
4544
),
4645
$header->schema,
4746
$schemaRegistry,
48-
), ExampleData::determiteType($headerSpec->example));
47+
), ExampleData::determiteType($header->example));
4948
}
5049

5150
return new \ApiClients\Tools\OpenApiClientGenerator\Representation\WebHook(

‎src/Gatherer/WebHookHydrator.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ public static function gather(
2626

2727
return Hydrator::gather(
2828
$baseNamespace,
29-
'Internal\\WebHook\\' . Utils::className($event),
29+
'WebHook\\' . Utils::className($event),
3030
'🪝',
3131
...$schemaClasses,
3232
);

‎src/Generator.php

Lines changed: 12 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,6 +61,7 @@
6161
use function str_replace;
6262
use function strlen;
6363
use function strpos;
64+
use function substr;
6465
use function trim;
6566
use function usleep;
6667
use function WyriHaximus\Twig\render;
@@ -195,7 +196,7 @@ public function generate(string $namespace, string $namespaceTest, string $confi
195196
$codePrinter = new Standard();
196197

197198
foreach ($this->all($configurationLocation) as $file) {
198-
$fileName = $configurationLocation . $this->configuration->destination->root . DIRECTORY_SEPARATOR . $file->pathPrefix . DIRECTORY_SEPARATOR . str_replace('\\', DIRECTORY_SEPARATOR, $file->fqcn) . '.php';
199+
$fileName = $configurationLocation . $this->configuration->destination->root . DIRECTORY_SEPARATOR . $file->pathPrefix . DIRECTORY_SEPARATOR . str_replace('\\', DIRECTORY_SEPARATOR, $file->fqcn) . (strpos($file->fqcn, '.') !== false ? '' : '.php');
199200
if ($file->contents instanceof Node\Stmt\Namespace_) {
200201
array_unshift($file->contents->stmts, ...(static function (array $uses): iterable {
201202
foreach ($uses as $use => $alias) {
@@ -246,7 +247,10 @@ public function generate(string $namespace, string $namespaceTest, string $confi
246247
}
247248
}
248249

249-
include_once $fileName;
250+
if (! (strpos($fileName, DIRECTORY_SEPARATOR . 'Types' . DIRECTORY_SEPARATOR) !== false) && substr($fileName, -4) === '.php') {
251+
include_once $fileName;
252+
}
253+
250254
$existingFiles = array_filter(
251255
$existingFiles,
252256
static fn (string $file): bool => $file !== $fileName,
@@ -510,6 +514,7 @@ private function oneClient(
510514
yield from Client::generate(
511515
$this->configuration,
512516
$this->configuration->destination->source . DIRECTORY_SEPARATOR,
517+
$this->configuration->destination->test . DIRECTORY_SEPARATOR,
513518
$client,
514519
$routers,
515520
);
@@ -600,6 +605,7 @@ private function oneClient(
600605
'operations' => $operations,
601606
'webHooks' => $webHooks,
602607
];
608+
$vars['qa'] = $configuration->qa;
603609

604610
return $vars;
605611
})(
@@ -793,6 +799,7 @@ private function subSplitClient(
793799
yield from Client::generate(
794800
$this->configuration,
795801
$this->configuration->subSplit->subSplitsDestination . DIRECTORY_SEPARATOR . $this->splitPathPrefix($this->configuration->subSplit->rootPackage, '') . $this->configuration->destination->source,
802+
$this->configuration->subSplit->subSplitsDestination . DIRECTORY_SEPARATOR . $this->splitPathPrefix($this->configuration->subSplit->rootPackage, '') . $this->configuration->destination->test,
796803
$client,
797804
$routers,
798805
);
@@ -926,6 +933,7 @@ private function subSplitClient(
926933
}
927934
})($this->configuration->subSplit->sectionPackage->name, ...$splits),
928935
],
936+
'qa' => $this->configuration->qa,
929937
],
930938
);
931939
$this->statusOutput->markStepDone('generating_templates_files_root_package');
@@ -950,6 +958,7 @@ private function subSplitClient(
950958
'version' => $this->configuration->subSplit->targetVersion,
951959
],
952960
],
961+
'qa' => $this->configuration->qa,
953962
],
954963
);
955964
$this->statusOutput->markStepDone('generating_templates_files_common_package');
@@ -981,6 +990,7 @@ private function subSplitClient(
981990
'version' => $this->configuration->subSplit->targetVersion,
982991
],
983992
],
993+
'qa' => $this->configuration->qa,
984994
],
985995
);
986996
$this->statusOutput->advanceStep('generating_templates_files_subsplit_package');

‎src/Generator/Client.php

Lines changed: 48 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,6 +9,8 @@
99
use ApiClients\Tools\OpenApiClientGenerator\Configuration;
1010
use ApiClients\Tools\OpenApiClientGenerator\File;
1111
use ApiClients\Tools\OpenApiClientGenerator\Generator\Client\Methods\ChunkCount;
12+
use ApiClients\Tools\OpenApiClientGenerator\Generator\Client\PHPStan\ClientCallReturnTypes;
13+
use ApiClients\Tools\OpenApiClientGenerator\Generator\Client\PHPStan\ClientCallReturnTypesTest;
1214
use ApiClients\Tools\OpenApiClientGenerator\Generator\Client\Routers;
1315
use ApiClients\Tools\OpenApiClientGenerator\Generator\Client\Routers\RouterClass;
1416
use ApiClients\Tools\OpenApiClientGenerator\Generator\Helper\Operation;
@@ -37,19 +39,22 @@
3739
use function array_shift;
3840
use function array_unique;
3941
use function count;
42+
use function dirname;
4043
use function explode;
4144
use function implode;
45+
use function PHPStan\Testing\assertType;
4246
use function strlen;
4347
use function strpos;
4448
use function trim;
4549
use function ucfirst;
4650

51+
use const DIRECTORY_SEPARATOR;
4752
use const PHP_EOL;
4853

4954
final class Client
5055
{
5156
/** @return iterable<File> */
52-
public static function generate(Configuration $configuration, string $pathPrefix, Representation\Client $client, Routers $routers): iterable
57+
public static function generate(Configuration $configuration, string $pathPrefix, string $pathPrefixTests, Representation\Client $client, Routers $routers): iterable
5358
{
5459
$operations = [];
5560
foreach ($client->paths as $path) {
@@ -515,28 +520,28 @@ public static function generate(Configuration $configuration, string $pathPrefix
515520
$class->addStmt(
516521
$factory->method('call')->makePublic()->setDocComment(
517522
new Doc(implode(PHP_EOL, [
518-
'// phpcs:disable',
523+
...($configuration->qa?->phpcs ? ['// phpcs:disable'] : []),
519524
'/**',
520-
' * @return ' . (static function (array $operations): string {
521-
$count = count($operations);
522-
$lastItem = $count - 1;
523-
$left = '';
524-
$right = '';
525-
for ($i = 0; $i < $count; $i++) {
526-
$returnType = Operation::getDocBlockResultTypeFromOperation($operations[$i]);
527-
if ($i !== $lastItem) {
528-
$left .= '($call is Operation\\' . $operations[$i]->classNameSanitized->relative . '::OPERATION_MATCH ? ' . $returnType . ' : ';
529-
} else {
530-
$left .= $returnType;
531-
}
532-
533-
$right .= ')';
534-
}
535-
536-
return $left . $right;
537-
})($operations),
525+
// ' * @return ' . (static function (array $operations): string {
526+
// $count = count($operations);
527+
// $lastItem = $count - 1;
528+
// $left = '';
529+
// $right = '';
530+
// for ($i = 0; $i < $count; $i++) {
531+
// $returnType = Operation::getDocBlockResultTypeFromOperation($operations[$i]);
532+
// if ($i !== $lastItem) {
533+
// $left .= '($call is "' . $operations[$i]->matchMethod . ' ' . $operations[$i]->path . '" ? ' . $returnType . ' : ';
534+
// } else {
535+
// $left .= $returnType;
536+
// }
537+
//
538+
// $right .= ')';
539+
// }
540+
//
541+
// return $left . $right;
542+
// })($operations),
538543
' */',
539-
'// phpcs:enable',
544+
...($configuration->qa?->phpcs ? ['// phpcs:enable'] : []),
540545
])),
541546
)->addParam((new Param('call'))->setType('string'))->addParam((new Param('params'))->setType('array')->setDefault([]))->setReturnType(
542547
new UnionType(
@@ -661,6 +666,28 @@ public static function generate(Configuration $configuration, string $pathPrefix
661666
}
662667

663668
yield from \ApiClients\Tools\OpenApiClientGenerator\Generator\Routers::generate($configuration, $pathPrefix, $routers);
669+
670+
if (! $configuration->qa?->phpstan) {
671+
return;
672+
}
673+
674+
require_once dirname(__DIR__) . DIRECTORY_SEPARATOR . 'phpstan-assertType-mock.php';
675+
assertType('bool', true);
676+
677+
yield from ClientCallReturnTypes::generate($configuration, $pathPrefix, $client);
678+
yield from ClientCallReturnTypesTest::generate($configuration, $pathPrefixTests, $client);
679+
680+
if ($configuration->qa->phpstan->configFilePath === null) {
681+
return;
682+
}
683+
684+
yield new File($pathPrefix, '../' . $configuration->qa->phpstan->configFilePath, implode(PHP_EOL, [
685+
'services:',
686+
' - class: ' . $configuration->namespace->source . '\PHPStan\ClientCallReturnTypes',
687+
' tags:',
688+
' - phpstan.broker.dynamicMethodReturnTypeExtension',
689+
'',
690+
]));
664691
}
665692

666693
/**

0 commit comments

Comments
 (0)