Merge remote-tracking branch 'origin/master' into extra-field-validations

vsouz4 · vsouz4 · commit f63d641639e1 · 2021-04-06T12:33:26.000-03:00
diff --git a/.php_cs.php b/.php_cs.php
@@ -13,6 +13,7 @@
     'array_syntax'                              => ['syntax' => 'short'],
     'no_multiline_whitespace_before_semicolons' => true,
     'no_short_echo_tag'                         => true,
+    'no_unused_imports'                         => true,
     'not_operator_with_successor_space'         => true,
     'no_useless_else'                           => true,
     'ordered_imports'                           => [
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -5,13 +5,17 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
 
-## [5.1.0] - 2021-04-01
+## [5.2.0] - 2021-04-06
 ### Added
  - Support for `minimum`, `maximum`, `exclusiveMinimum`, `exclusiveMaximum`, `minItems`, `maxItems`, `pattern`, `maxLength`, `minLength` validations
 
 ### Changed
  - Example generated with 7.4
 
+## [5.1.0] - 2021-04-02
+### Changed
+ - Only content type serializers which are used are included
+
 ## [5.0.0] - 2021-02-15
 ### Changed
  - By default, the PHP version used in the generated client is 7.4.
diff --git a/src/Application.php b/src/Application.php
@@ -3,7 +3,6 @@
 namespace DoclerLabs\ApiClientGenerator;
 
 use DoclerLabs\ApiClientGenerator\Command\GenerateCommand;
-use DoclerLabs\ApiClientGenerator\Output\WarningFormatter;
 use Pimple\Container;
 use Symfony\Component\Console\Application as BaseApplication;
 
diff --git a/src/Command/GenerateCommand.php b/src/Command/GenerateCommand.php
@@ -10,12 +10,16 @@
 use DoclerLabs\ApiClientGenerator\Input\Parser;
 use DoclerLabs\ApiClientGenerator\Input\Specification;
 use DoclerLabs\ApiClientGenerator\MetaTemplateFacade;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\FormUrlencodedContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\JsonContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\XmlContentTypeSerializer;
 use DoclerLabs\ApiClientGenerator\Output\Meta\MetaFileCollection;
 use DoclerLabs\ApiClientGenerator\Output\MetaFilePrinter;
 use DoclerLabs\ApiClientGenerator\Output\Php\PhpFileCollection;
 use DoclerLabs\ApiClientGenerator\Output\PhpFilePrinter;
 use DoclerLabs\ApiClientGenerator\Output\StaticPhpFileCopier;
 use DoclerLabs\ApiClientGenerator\Output\WarningFormatter;
+use ReflectionClass;
 use Symfony\Component\Console\Command\Command;
 use Symfony\Component\Console\Input\InputInterface;
 use Symfony\Component\Console\Output\OutputInterface;
@@ -89,7 +93,7 @@ public function execute(InputInterface $input, OutputInterface $output): int
         $this->generatePhpFiles($ss, $specification);
         $this->copySpecification($ss);
         $this->generateMetaFiles($ss, $specification);
-        $this->copyStaticPhpFiles($ss);
+        $this->copyStaticPhpFiles($ss, $specification);
 
         return Command::SUCCESS;
     }
@@ -137,9 +141,10 @@ private function generateMetaFiles(StyleInterface $ss, Specification $specificat
         $ss->progressFinish();
     }
 
-    private function copyStaticPhpFiles(StyleInterface $ss): void
+    private function copyStaticPhpFiles(StyleInterface $ss, Specification $specification): void
     {
-        $originalFiles = $this->fileFinder
+        $blacklistedFiles = $this->getBlacklistedFiles($specification);
+        $originalFiles    = $this->fileFinder
             ->files()
             ->name('*.php')
             ->in(Configuration::STATIC_PHP_FILE_DIRECTORY);
@@ -149,17 +154,19 @@ private function copyStaticPhpFiles(StyleInterface $ss): void
 
         $ss->progressStart($originalFiles->count());
         foreach ($originalFiles as $originalFile) {
-            $destinationPath = sprintf(
-                '%s/%s/%s',
-                $this->configuration->getOutputDirectory(),
-                $this->configuration->getSourceDirectory(),
-                $originalFile->getRelativePathname()
-            );
+            if (empty($blacklistedFiles[$originalFile->getBasename()])) {
+                $destinationPath = sprintf(
+                    '%s/%s/%s',
+                    $this->configuration->getOutputDirectory(),
+                    $this->configuration->getSourceDirectory(),
+                    $originalFile->getRelativePathname()
+                );
 
-            $this->staticPhpPrinter->copy(
-                $destinationPath,
-                $originalFile
-            );
+                $this->staticPhpPrinter->copy(
+                    $destinationPath,
+                    $originalFile
+                );
+            }
 
             $ss->progressAdvance();
         }
@@ -195,4 +202,24 @@ static function (): bool {
             set_error_handler($this->warningFormatter, E_USER_WARNING);
         }
     }
+
+    private function getBlacklistedFiles(Specification $specification): array
+    {
+        $contentTypeMapping = [
+            XmlContentTypeSerializer::MIME_TYPE            => XmlContentTypeSerializer::class,
+            FormUrlencodedContentTypeSerializer::MIME_TYPE => FormUrlencodedContentTypeSerializer::class,
+            JsonContentTypeSerializer::MIME_TYPE           => JsonContentTypeSerializer::class,
+        ];
+
+        $allContentTypes = $specification->getAllContentTypes();
+
+        return array_flip(array_map(
+            fn ($class) => basename((string)(new ReflectionClass($class))->getFileName()),
+            array_filter(
+                $contentTypeMapping,
+                fn ($key) => !in_array($key, $allContentTypes),
+                ARRAY_FILTER_USE_KEY
+            )
+        ));
+    }
 }
diff --git a/src/Generator/ServiceProviderGenerator.php b/src/Generator/ServiceProviderGenerator.php
@@ -5,6 +5,7 @@
 use DoclerLabs\ApiClientException\Factory\ResponseExceptionFactory;
 use DoclerLabs\ApiClientGenerator\Ast\Builder\CodeBuilder;
 use DoclerLabs\ApiClientGenerator\Entity\Field;
+use DoclerLabs\ApiClientGenerator\Entity\Operation;
 use DoclerLabs\ApiClientGenerator\Generator\Implementation\ContainerImplementationStrategy;
 use DoclerLabs\ApiClientGenerator\Generator\Implementation\HttpMessageImplementationStrategy;
 use DoclerLabs\ApiClientGenerator\Input\Specification;
@@ -63,7 +64,7 @@ public function generate(Specification $specification, PhpFileCollection $fileRe
 
         $classBuilder = $this->builder
             ->class('ServiceProvider')
-            ->addStmt($this->generateRegisterMethod($compositeFields));
+            ->addStmt($this->generateRegisterMethod($specification, $compositeFields));
 
         foreach ($this->containerImplementation->getContainerRegisterImports() as $import) {
             $this->addImport($import);
@@ -72,8 +73,10 @@ public function generate(Specification $specification, PhpFileCollection $fileRe
         $this->registerFile($fileRegistry, $classBuilder);
     }
 
-    public function generateRegisterMethod(array $compositeFields): ClassMethod
-    {
+    private function generateRegisterMethod(
+        Specification $specification,
+        array $compositeFields
+    ): ClassMethod {
         $statements = [];
 
         $param = $this->builder
@@ -115,7 +118,7 @@ public function generateRegisterMethod(array $compositeFields): ClassMethod
         $statements[] = $this->containerImplementation->registerClosure(
             $containerVariable,
             $this->builder->classConstFetch('BodySerializer', 'class'),
-            $this->generateBodySerializerClosure()
+            $this->generateBodySerializerClosure($specification)
         );
         $statements[] = $this->containerImplementation->registerClosure(
             $containerVariable,
@@ -180,33 +183,44 @@ private function generateQuerySerializerClosure(): Closure
         );
     }
 
-    private function generateBodySerializerClosure(): Closure
+    private function generateBodySerializerClosure(Specification $specification): Closure
     {
-        $jsonSerializerInit = $this->builder->methodCall(
-            $this->builder->new('BodySerializer'),
-            'add',
-            [
-                $this->builder->new('JsonContentTypeSerializer'),
-            ]
-        );
+        $initialStatement = $this->builder->new('BodySerializer');
+        $allContentTypes  = $specification->getAllContentTypes();
 
-        $formEncodedSerializerInit = $this->builder->methodCall(
-            $jsonSerializerInit,
-            'add',
-            [
-                $this->builder->new('FormUrlencodedContentTypeSerializer'),
-            ]
-        );
+        if (in_array(JsonContentTypeSerializer::MIME_TYPE, $allContentTypes, true)) {
+            $jsonSerializerInit = $this->builder->methodCall(
+                $initialStatement,
+                'add',
+                [
+                    $this->builder->new('JsonContentTypeSerializer'),
+                ]
+            );
+        }
 
-        $xmlSerializerInit = $this->builder->methodCall(
-            $formEncodedSerializerInit,
-            'add',
-            [
-                $this->builder->new('XmlContentTypeSerializer'),
-            ]
-        );
+        if (in_array(FormUrlencodedContentTypeSerializer::MIME_TYPE, $allContentTypes, true)) {
+            $formEncodedSerializerInit = $this->builder->methodCall(
+                $jsonSerializerInit ?? $initialStatement,
+                'add',
+                [
+                    $this->builder->new('FormUrlencodedContentTypeSerializer'),
+                ]
+            );
+        }
+
+        if (in_array(XmlContentTypeSerializer::MIME_TYPE, $allContentTypes, true)) {
+            $xmlSerializerInit = $this->builder->methodCall(
+                $formEncodedSerializerInit ?? $jsonSerializerInit ?? $initialStatement,
+                'add',
+                [
+                    $this->builder->new('XmlContentTypeSerializer'),
+                ]
+            );
+        }
 
-        $registerBodySerializerClosureStatements[] = $this->builder->return($xmlSerializerInit);
+        $registerBodySerializerClosureStatements[] = $this
+            ->builder
+            ->return($xmlSerializerInit ?? $formEncodedSerializerInit ?? $jsonSerializerInit ?? $initialStatement);
 
         return $this->builder->closure(
             $registerBodySerializerClosureStatements,
diff --git a/src/Input/Specification.php b/src/Input/Specification.php
@@ -4,7 +4,11 @@
 
 use cebe\openapi\spec\OpenApi;
 use DoclerLabs\ApiClientGenerator\Entity\FieldCollection;
+use DoclerLabs\ApiClientGenerator\Entity\Operation;
 use DoclerLabs\ApiClientGenerator\Entity\OperationCollection;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\FormUrlencodedContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\JsonContentTypeSerializer;
+use DoclerLabs\ApiClientGenerator\Output\Copy\Serializer\ContentType\XmlContentTypeSerializer;
 
 class Specification
 {
@@ -59,4 +63,22 @@ public function getCompositeResponseFields(): FieldCollection
     {
         return $this->compositeResponseFields;
     }
+
+    public function getAllContentTypes(): array
+    {
+        $allContentTypes = [
+            XmlContentTypeSerializer::MIME_TYPE            => false,
+            FormUrlencodedContentTypeSerializer::MIME_TYPE => false,
+            JsonContentTypeSerializer::MIME_TYPE           => false,
+        ];
+
+        /** @var Operation $operation */
+        foreach ($this->getOperations() as $operation) {
+            foreach ($operation->getRequest()->getBodyContentTypes() as $contentType) {
+                $allContentTypes[$contentType] = true;
+            }
+        }
+
+        return array_keys(array_filter($allContentTypes));
+    }
 }
diff --git a/test/suite/functional/Generator/ServiceProvider/ServiceProviderPhp70.php b/test/suite/functional/Generator/ServiceProvider/ServiceProviderPhp70.php
@@ -17,17 +17,15 @@
 use Test\Schema\Mapper\PetCollectionMapper;
 use Test\Schema\Mapper\PetMapper;
 use Test\Serializer\BodySerializer;
-use Test\Serializer\ContentType\FormUrlencodedContentTypeSerializer;
 use Test\Serializer\ContentType\JsonContentTypeSerializer;
-use Test\Serializer\ContentType\XmlContentTypeSerializer;
 use Test\Serializer\QuerySerializer;
 
 class ServiceProvider
 {
     public function register(Container $container): void
     {
         $container[BodySerializer::class] = static function (): BodySerializer {
-            return (new BodySerializer())->add(new JsonContentTypeSerializer())->add(new FormUrlencodedContentTypeSerializer())->add(new XmlContentTypeSerializer());
+            return (new BodySerializer())->add(new JsonContentTypeSerializer());
         };
         $container[QuerySerializer::class] = static function (): QuerySerializer {
             return new QuerySerializer();
diff --git a/test/suite/functional/Generator/ServiceProvider/ServiceProviderPhp72.php b/test/suite/functional/Generator/ServiceProvider/ServiceProviderPhp72.php
@@ -17,17 +17,15 @@
 use Test\Schema\Mapper\PetCollectionMapper;
 use Test\Schema\Mapper\PetMapper;
 use Test\Serializer\BodySerializer;
-use Test\Serializer\ContentType\FormUrlencodedContentTypeSerializer;
 use Test\Serializer\ContentType\JsonContentTypeSerializer;
-use Test\Serializer\ContentType\XmlContentTypeSerializer;
 use Test\Serializer\QuerySerializer;
 
 class ServiceProvider
 {
     public function register(Container $container): void
     {
         $container[BodySerializer::class] = static function (): BodySerializer {
-            return (new BodySerializer())->add(new JsonContentTypeSerializer())->add(new FormUrlencodedContentTypeSerializer())->add(new XmlContentTypeSerializer());
+            return (new BodySerializer())->add(new JsonContentTypeSerializer());
         };
         $container[QuerySerializer::class] = static function (): QuerySerializer {
             return new QuerySerializer();
diff --git a/test/suite/functional/Meta/ReadmeMdTemplateTest.php b/test/suite/functional/Meta/ReadmeMdTemplateTest.php
@@ -2,14 +2,11 @@
 
 namespace DoclerLabs\ApiClientGenerator\Test\Functional\Meta;
 
-use DoclerLabs\ApiClientGenerator\Generator\SchemaGenerator;
 use DoclerLabs\ApiClientGenerator\Input\Configuration;
-use DoclerLabs\ApiClientGenerator\Meta\ComposerJsonTemplate;
 use DoclerLabs\ApiClientGenerator\Meta\ReadmeMdTemplate;
 use DoclerLabs\ApiClientGenerator\Meta\Template\TwigExtension;
 use DoclerLabs\ApiClientGenerator\Meta\TemplateInterface;
 use DoclerLabs\ApiClientGenerator\Test\Functional\ConfigurationBuilder;
-use Pimple\Container;
 use Twig\Environment;
 use Twig\Loader\FilesystemLoader;
 
