Merge pull request #207 from php-api-clients/introduce-qa-settings

Introduce QA settings

Author: WyriHaximus

composer.json

@@ -12,6 +12,7 @@
         "php": "^8.2",
         "api-clients/contracts": "^0.1",
         "api-clients/github": "^0.2@dev",
+        "api-clients/openapi-client-utils": "dev-main",
         "ckr/arraymerger": "^3.0",
         "codeinc/http-reason-phrase-lookup": "^1.0",
         "delight-im/random": "^1.0",

composer.lock

@@ -32,3 +32,9 @@ voter:
     - ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery
   streamOperation:
     - ApiClients\Tools\OpenApiClientGenerator\Voter\StreamOperation\DownloadInOperationId
+qa:
+  phpcs:
+    enabled: true
+  phpstan:
+    enabled: true
+    configFilePath: etc/phpstan-extension.neon

example/openapi-client-miele.yaml

@@ -32,3 +32,9 @@ voter:
     - ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery
   streamOperation:
     - ApiClients\Tools\OpenApiClientGenerator\Voter\StreamOperation\DownloadInOperationId
+qa:
+  phpcs:
+    enabled: true
+  phpstan:
+    enabled: true
+    configFilePath: etc/phpstan-extension.neon

example/openapi-client-one.yaml

@@ -47,3 +47,9 @@ subSplit:
   sectionPackage:
     name: github-{{ section }}
     repository: [email protected]:php-api-clients/github-{{ section }}.git
+qa:
+  phpcs:
+    enabled: true
+  phpstan:
+    enabled: true
+    configFilePath: etc/phpstan-extension.neon

example/openapi-client-subsplit.yaml

@@ -16,6 +16,7 @@
 {% endfor %}
 {% endif %}
     "api-clients/contracts": "^0.1",
+    "api-clients/openapi-client-utils": "dev-main",
     "devizzent/cebe-php-openapi": "^1",
     "eventsauce/object-hydrator": "^1.1",
     "league/openapi-psr7-validator": "^0.21",
@@ -48,6 +49,15 @@
 "api-clients/{{ suggest.name }}": "{{ suggest.reason }}"{% if not loop.last %},{% endif %}
 {% endfor %}
 },
+{% endif %}
+{% if qa.phpstan.enabled is constant('true') and qa.phpstan.configFilePath is not constant('null') %}
+  "extra": {
+    "phpstan": {
+      "includes": [
+        "{{ qa.phpstan.configFilePath }}"
+      ]
+    }
+  },
 {% endif %}
   "config": {
     "sort-packages": true,

example/templates/composer.json

@@ -1,2 +1,3 @@
 includes:
 	- ../../vendor/wyrihaximus/async-test-utilities/rules.neon
+	- ../phpstan-extension.neon

example/templates/etc/qa/phpstan.neon

@@ -7,6 +7,7 @@
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\Destination;
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\EntryPoints;
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\Namespace_;
+use ApiClients\Tools\OpenApiClientGenerator\Configuration\QA;
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\Schemas;
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\State;
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\SubSplit;
@@ -32,6 +33,7 @@ public function __construct(
         public SubSplit|null $subSplit,
         public Schemas|null $schemas,
         public Voter|null $voter,
+        public QA|null $qa,
     ) {
     }
 }

src/Configuration.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Tools\OpenApiClientGenerator\Configuration;
+
+use ApiClients\Tools\OpenApiClientGenerator\Configuration\QA\Tool;
+
+final readonly class QA
+{
+    public function __construct(
+        public Tool|null $phpcs,
+        public Tool|null $phpstan,
+        public Tool|null $psalm,
+    ) {
+    }
+}

src/Configuration/QA.php

@@ -0,0 +1,17 @@
+<?php
+
+declare(strict_types=1);
+
+namespace ApiClients\Tools\OpenApiClientGenerator\Configuration\QA;
+
+use EventSauce\ObjectHydrator\MapFrom;
+
+final readonly class Tool
+{
+    public function __construct(
+        public bool $enabled,
+        #[MapFrom('configFilePath')]
+        public string|null $configFilePath,
+    ) {
+    }
+}

src/Configuration/QA/Tool.php

@@ -24,8 +24,7 @@ public static function gather(
         PathItem $webhook,
         SchemaRegistry $schemaRegistry,
     ): \ApiClients\Tools\OpenApiClientGenerator\Representation\WebHook {
-        if ($webhook->post?->requestBody === null || ! property_exists($webhook->post->requestBody, 'content')) {
-//            var_export(json_decode(json_encode($webhook->getSerializableData())));
+        if ($webhook->post?->requestBody === null && ! property_exists($webhook->post->requestBody, 'content')) {
             throw new RuntimeException('Missing request body content to deal with');
         }
 
@@ -45,7 +44,7 @@ public static function gather(
                 ),
                 $header->schema,
                 $schemaRegistry,
-            ), ExampleData::determiteType($headerSpec->example));
+            ), ExampleData::determiteType($header->example));
         }
 
         return new \ApiClients\Tools\OpenApiClientGenerator\Representation\WebHook(

src/Gatherer/WebHook.php

@@ -26,7 +26,7 @@ public static function gather(
 
         return Hydrator::gather(
             $baseNamespace,
-            'Internal\\WebHook\\' . Utils::className($event),
+            'WebHook\\' . Utils::className($event),
             '🪝',
             ...$schemaClasses,
         );