Merge pull request #140 from php-api-clients/content-type-configuration

Content type configuration

Author: WyriHaximus

example/openapi-client-one.yaml

@@ -15,6 +15,9 @@ templates:
 schemas:
   allowDuplication: true
   useAliasesForDuplication: true
+contentType:
+  - ApiClients\Tools\OpenApiClientGenerator\ContentType\Json
+  - ApiClients\Tools\OpenApiClientGenerator\ContentType\Raw
 voter:
   listOperation:
     - ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery

example/openapi-client-subsplit.yaml

@@ -14,6 +14,9 @@ templates:
 schemas:
   allowDuplication: true
   useAliasesForDuplication: true
+contentType:
+  - ApiClients\Tools\OpenApiClientGenerator\ContentType\Json
+  - ApiClients\Tools\OpenApiClientGenerator\ContentType\Raw
 voter:
   listOperation:
     - ApiClients\Tools\OpenApiClientGenerator\Voter\ListOperation\PageAndPerPageInQuery

example/templates/Makefile

@@ -44,7 +44,7 @@ psalm: ## Run static analysis (Psalm)
 	$(DOCKER_RUN) vendor/bin/psalm --threads=$(shell nproc) --shepherd --stats --config=./etc/qa/psalm.xml
 
 unit-testing: ## Run tests
-	$(DOCKER_RUN) vendor/bin/phpunit --colors=always -c ./etc/qa/phpunit.xml --coverage-text --coverage-html ./var/tests-unit-coverage-html --coverage-clover ./var/tests-unit-clover-coverage.xml
+	$(DOCKER_RUN) vendor/bin/phpunit --colors=always -c ./etc/qa/phpunit.xml
 	$(DOCKER_RUN) test -n "$(COVERALLS_REPO_TOKEN)" && test -n "$(COVERALLS_RUN_LOCALLY)" && test -f ./var/tests-unit-clover-coverage.xml && vendor/bin/php-coveralls -v --coverage_clover ./build/logs/clover.xml --json_path ./var/tests-unit-clover-coverage-upload.json || true
 
 mutation-testing: ## Run mutation testing

src/Configuration.php

@@ -8,15 +8,21 @@
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\Templates;
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\Voter;
 use ApiClients\Tools\OpenApiClientGenerator\Configuration\Schemas;
+use ApiClients\Tools\OpenApiClientGenerator\Contract\ContentType;
 use EventSauce\ObjectHydrator\MapFrom;
 
 final readonly class Configuration
 {
+    /**
+     * @param array<class-string<ContentType>>|null $contentType
+     */
     public function __construct(
         public string $spec,
         public Templates $templates,
         public Namespace_ $namespace,
         public Destination $destination,
+        #[MapFrom('contentType')]
+        public ?array $contentType,
         #[MapFrom('subSplit')]
         public ?SubSplit $subSplit,
         public ?Schemas $schemas,

src/ContentType/Json.php

@@ -0,0 +1,30 @@
+<?php
+
+namespace ApiClients\Tools\OpenApiClientGenerator\ContentType;
+
+use ApiClients\Tools\OpenApiClientGenerator\Contract\ContentType;
+use PhpParser\Node\Expr;
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+
+final class Json implements ContentType
+{
+    public static function contentType(): iterable
+    {
+        yield 'application/json';
+    }
+
+    public static function parse(Expr $expr): Expr {
+        return new Node\Expr\FuncCall(
+            new Node\Name('json_decode'),
+            [
+                new Arg(
+                    $expr,
+                ),
+                new Node\Expr\ConstFetch(
+                    new Node\Name('true'),
+                )
+            ],
+        );
+    }
+}

src/ContentType/Raw.php

@@ -0,0 +1,22 @@
+<?php
+
+namespace ApiClients\Tools\OpenApiClientGenerator\ContentType;
+
+use ApiClients\Tools\OpenApiClientGenerator\Contract\ContentType;
+use PhpParser\Node\Expr;
+use PhpParser\Node;
+use PhpParser\Node\Arg;
+
+final class Raw implements ContentType
+{
+    public static function contentType(): iterable
+    {
+        yield 'text/plain';
+        yield 'text/x-markdown';
+        yield 'text/html';
+    }
+
+    public static function parse(Expr $expr): Expr {
+        return $expr;
+    }
+}

src/Contract/ContentType.php

@@ -0,0 +1,17 @@
+<?php
+
+namespace ApiClients\Tools\OpenApiClientGenerator\Contract;
+
+use ApiClients\Tools\OpenApiClientGenerator\Representation\Path;
+use ApiClients\Tools\OpenApiClientGenerator\Representation\WebHook;
+use PhpParser\Node\Expr;
+
+interface ContentType
+{
+    /**
+     * @return iterable<string>
+     */
+    public static function contentType(): iterable;
+
+    public static function parse(Expr $expr): Expr;
+}

src/Generator.php

@@ -174,6 +174,7 @@ private function oneClient(string $namespace, string $namespaceTest, string $con
                     $operation,
                     $path->hydrator,
                     $throwableSchemaRegistry,
+                    $configuration,
                 );
                 yield from OperationTest::generate(
                     $configuration->destination->test . DIRECTORY_SEPARATOR,
@@ -182,6 +183,7 @@ private function oneClient(string $namespace, string $namespaceTest, string $con
                     $operation,
                     $path->hydrator,
                     $throwableSchemaRegistry,
+                    $configuration,
                 );
             }
         }
@@ -282,6 +284,7 @@ private function subSplitClient(string $namespace, string $namespaceTest, string
                     $operation,
                     $path->hydrator,
                     $throwableSchemaRegistry,
+                    $configuration,
                 );
                 yield from OperationTest::generate(
                     $configuration->subSplit->subSplitsDestination . DIRECTORY_SEPARATOR . $this->splitPathPrefix($configuration->subSplit->sectionPackage, $split) . $configuration->destination->test,
@@ -290,6 +293,7 @@ private function subSplitClient(string $namespace, string $namespaceTest, string
                     $operation,
                     $path->hydrator,
                     $throwableSchemaRegistry,
+                    $configuration,
                 );
             }
         }