Merge branch 'master' into DidierLmn-master

ApiDocGenerator.php

@@ -20,6 +20,7 @@
 use OpenApi\Analysis;
 use OpenApi\Annotations\OpenApi;
 use OpenApi\Generator;
+use OpenApi\Processors\ProcessorInterface;
 use Psr\Cache\CacheItemPoolInterface;
 use Psr\Log\LoggerAwareTrait;
 
@@ -52,16 +53,20 @@ final class ApiDocGenerator
      */
     private $openApiVersion = null;
 
+    /** @var Generator */
+    private $generator;
+
     /**
      * @param DescriberInterface[]|iterable      $describers
      * @param ModelDescriberInterface[]|iterable $modelDescribers
      */
-    public function __construct($describers, $modelDescribers, CacheItemPoolInterface $cacheItemPool = null, string $cacheItemId = null)
+    public function __construct($describers, $modelDescribers, CacheItemPoolInterface $cacheItemPool = null, string $cacheItemId = null, Generator $generator = null)
     {
         $this->describers = $describers;
         $this->modelDescribers = $modelDescribers;
         $this->cacheItemPool = $cacheItemPool;
         $this->cacheItemId = $cacheItemId;
+        $this->generator = $generator ?? new Generator($this->logger);
     }
 
     public function setAlternativeNames(array $alternativeNames)
@@ -92,19 +97,13 @@ public function generate(): OpenApi
             }
         }
 
-        $generator = new Generator($this->logger);
         if ($this->openApiVersion) {
-            $generator->setVersion($this->openApiVersion);
+            $this->generator->setVersion($this->openApiVersion);
         }
 
-        // Remove OperationId processor as we use a lot of generated annotations which do not have enough information in their context
-        // to generate these ids properly.
-        // @see https://github.com/zircote/swagger-php/issues/1153
-        $generator->setProcessors(array_filter($generator->getProcessors(), function ($processor) {
-            return !$processor instanceof \OpenApi\Processors\OperationId;
-        }));
+        $this->generator->setProcessors($this->getProcessors($this->generator));
 
-        $context = Util::createContext(['version' => $generator->getVersion()]);
+        $context = Util::createContext(['version' => $this->generator->getVersion()]);
 
         $this->openApi = new OpenApi(['_context' => $context]);
         $modelRegistry = new ModelRegistry($this->modelDescribers, $this->openApi, $this->alternativeNames);
@@ -129,7 +128,7 @@ public function generate(): OpenApi
         // Calculate the associated schemas
         $modelRegistry->registerSchemas();
 
-        $analysis->process($generator->getProcessors());
+        $analysis->process($this->generator->getProcessors());
         $analysis->validate();
 
         if (isset($item)) {
@@ -138,4 +137,28 @@ public function generate(): OpenApi
 
         return $this->openApi;
     }
+
+    /**
+     * Get an array of processors that will be used to process the OpenApi object.
+     *
+     * @param Generator $generator The generator instance to get the standard processors from
+     *
+     * @return array<ProcessorInterface|callable> The array of processors
+     */
+    private function getProcessors(Generator $generator): array
+    {
+        // Get the standard processors from the generator.
+        $processors = $generator->getProcessors();
+
+        // Remove OperationId processor as we use a lot of generated annotations which do not have enough information in their context
+        // to generate these ids properly.
+        // @see \Nelmio\ApiDocBundle\OpenApiPhp\Util::createContext
+        foreach ($processors as $key => $processor) {
+            if ($processor instanceof \OpenApi\Processors\OperationId) {
+                unset($processors[$key]);
+            }
+        }
+
+        return $processors;
+    }
 }

CONTRIBUTING.md

@@ -11,7 +11,7 @@ You MUST follow the [PSR-1](http://www.php-fig.org/psr/psr-1/) and
 should really read the recommendations. Can't wait? Use the [PHP-CS-Fixer
 tool](http://cs.sensiolabs.org/).
 
-You MUST run the test suite (run `composer update`, and then execute `vendor/bin/simple-phpunit`).
+You MUST run the test suite (run `composer update`, and then execute `composer run phpunit`).
 
 You MUST write (or update) unit tests.
 

DependencyInjection/Compiler/CustomProcessorPass.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the NelmioApiDocBundle package.
+ *
+ * (c) Nelmio
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Nelmio\ApiDocBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Reference;
+
+/**
+ * Compiler Pass to identify and register custom processors.
+ *  *
+ * @internal
+ */
+final class CustomProcessorPass implements CompilerPassInterface
+{
+    /**
+     * Process services tagged as 'swagger.processor'.
+     *
+     * @param ContainerBuilder $container The container builder
+     */
+    public function process(ContainerBuilder $container): void
+    {
+        // Find the OpenAPI generator service.
+        $definition = $container->findDefinition('nelmio_api_doc.open_api.generator');
+
+        foreach ($container->findTaggedServiceIds('nelmio_api_doc.swagger.processor') as $id => $tags) {
+            /**
+             * Before which processor should this processor be run?
+             *
+             * @var string|null
+             */
+            $before = null;
+
+            // See if the processor has a 'before' attribute.
+            foreach ($tags as $tag) {
+                if (isset($tag['before'])) {
+                    $before = $tag['before'];
+                }
+            }
+
+            $definition->addMethodCall('addProcessor', [new Reference($id), $before]);
+        }
+    }
+}

DependencyInjection/NelmioApiDocExtension.php

@@ -22,6 +22,7 @@
 use Nelmio\ApiDocBundle\ModelDescriber\JMSModelDescriber;
 use Nelmio\ApiDocBundle\ModelDescriber\ModelDescriberInterface;
 use Nelmio\ApiDocBundle\Routing\FilteredRouteCollectionBuilder;
+use OpenApi\Generator;
 use Symfony\Component\Config\FileLocator;
 use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -68,6 +69,11 @@ public function load(array $configs, ContainerBuilder $container): void
         $container->setParameter('nelmio_api_doc.areas', array_keys($config['areas']));
         $container->setParameter('nelmio_api_doc.media_types', $config['media_types']);
         $container->setParameter('nelmio_api_doc.use_validation_groups', $config['use_validation_groups']);
+
+        // Register the OpenAPI Generator as a service.
+        $container->register('nelmio_api_doc.open_api.generator', Generator::class)
+            ->setPublic(false);
+
         foreach ($config['areas'] as $area => $areaConfig) {
             $nameAliases = $this->findNameAliases($config['models']['names'], $area);
             $container->register(sprintf('nelmio_api_doc.generator.%s', $area), ApiDocGenerator::class)
@@ -80,6 +86,9 @@ public function load(array $configs, ContainerBuilder $container): void
                 ->setArguments([
                     new TaggedIteratorArgument(sprintf('nelmio_api_doc.describer.%s', $area)),
                     new TaggedIteratorArgument('nelmio_api_doc.model_describer'),
+                    null,
+                    null,
+                    new Reference('nelmio_api_doc.open_api.generator'),
                 ]);
 
             $container->register(sprintf('nelmio_api_doc.describers.route.%s', $area), RouteDescriber::class)

ModelDescriber/Annotations/SymfonyConstraintAnnotationReader.php

@@ -42,7 +42,7 @@ class SymfonyConstraintAnnotationReader
      */
     private $useValidationGroups;
 
-    public function __construct(?Reader $annotationsReader, bool $useValidationGroups=false)
+    public function __construct(?Reader $annotationsReader, bool $useValidationGroups = false)
     {
         $this->annotationsReader = $annotationsReader;
         $this->useValidationGroups = $useValidationGroups;
@@ -84,7 +84,7 @@ private function processPropertyAnnotations($reflection, OA\Property $property,
                     return;
                 }
 
-                $existingRequiredFields =  Generator::UNDEFINED !== $this->schema->required ? $this->schema->required : [];
+                $existingRequiredFields = Generator::UNDEFINED !== $this->schema->required ? $this->schema->required : [];
                 $existingRequiredFields[] = $propertyName;
 
                 $this->schema->required = array_values(array_unique($existingRequiredFields));

ModelDescriber/FormModelDescriber.php

@@ -228,7 +228,7 @@ private function findFormType(FormConfigInterface $config, OA\Schema $property)
             }
 
             if ('checkbox' === $blockPrefix) {
-                $property->type= 'boolean';
+                $property->type = 'boolean';
 
                 break;
             }

NelmioApiDocBundle.php

@@ -12,6 +12,7 @@
 namespace Nelmio\ApiDocBundle;
 
 use Nelmio\ApiDocBundle\DependencyInjection\Compiler\ConfigurationPass;
+use Nelmio\ApiDocBundle\DependencyInjection\Compiler\CustomProcessorPass;
 use Nelmio\ApiDocBundle\DependencyInjection\Compiler\PhpDocExtractorPass;
 use Nelmio\ApiDocBundle\DependencyInjection\Compiler\TagDescribersPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
@@ -27,5 +28,6 @@ public function build(ContainerBuilder $container): void
         $container->addCompilerPass(new ConfigurationPass());
         $container->addCompilerPass(new TagDescribersPass());
         $container->addCompilerPass(new PhpDocExtractorPass());
+        $container->addCompilerPass(new CustomProcessorPass());
     }
 }

OpenApiPhp/Util.php

@@ -155,8 +155,6 @@ public static function getOperationParameter(OA\Operation $operation, $name, $in
      * it is expected to be a string nested property.
      *
      * @see OA\AbstractAnnotation::$_nested
-     *
-     * @param $class
      */
     public static function getChild(OA\AbstractAnnotation $parent, $class, array $properties = []): OA\AbstractAnnotation
     {

Tests/ApiDocGeneratorTest.php

@@ -13,6 +13,7 @@
 
 use Nelmio\ApiDocBundle\ApiDocGenerator;
 use Nelmio\ApiDocBundle\Describer\DefaultDescriber;
+use OpenApi\Generator;
 use PHPUnit\Framework\TestCase;
 use Symfony\Component\Cache\Adapter\ArrayAdapter;
 
@@ -21,15 +22,15 @@ class ApiDocGeneratorTest extends TestCase
     public function testCache()
     {
         $adapter = new ArrayAdapter();
-        $generator = new ApiDocGenerator([new DefaultDescriber()], [], $adapter);
+        $generator = new ApiDocGenerator([new DefaultDescriber()], [], $adapter, null, new Generator());
 
         $this->assertEquals(json_encode($generator->generate()), json_encode($adapter->getItem('openapi_doc')->get()));
     }
 
     public function testCacheWithCustomId()
     {
         $adapter = new ArrayAdapter();
-        $generator = new ApiDocGenerator([new DefaultDescriber()], [], $adapter, 'custom_id');
+        $generator = new ApiDocGenerator([new DefaultDescriber()], [], $adapter, 'custom_id', new Generator());
 
         $this->assertEquals(json_encode($generator->generate()), json_encode($adapter->getItem('custom_id')->get()));
     }

Tests/Functional/TestKernel.php

@@ -20,6 +20,7 @@
 use Nelmio\ApiDocBundle\NelmioApiDocBundle;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\BazingaUser;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\JMSComplex80;
+use Nelmio\ApiDocBundle\Tests\Functional\Entity\JMSComplex81;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\NestedGroup\JMSPicture;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\PrivateProtectedExposure;
 use Nelmio\ApiDocBundle\Tests\Functional\Entity\SymfonyConstraintsWithValidationGroups;
@@ -254,7 +255,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
             $models = array_merge($models, [
                 [
                 'alias' => 'JMSComplex',
-                'type' => \Nelmio\ApiDocBundle\Tests\Functional\Entity\JMSComplex81::class,
+                'type' => JMSComplex81::class,
                 'groups' => [
                     'list',
                     'details',
@@ -263,7 +264,7 @@ protected function configureContainer(ContainerBuilder $c, LoaderInterface $load
                 ],
                 [
                     'alias' => 'JMSComplexDefault',
-                    'type' => \Nelmio\ApiDocBundle\Tests\Functional\Entity\JMSComplex81::class,
+                    'type' => JMSComplex81::class,
                     'groups' => null,
                 ],
             ]);

composer.json

@@ -90,5 +90,11 @@
         "branch-alias": {
             "dev-master": "4.x-dev"
         }
+    },
+    "scripts-descriptions": {
+        "phpunit": "Run phpunit"
+    },
+    "scripts": {
+        "phpunit": "phpunit"
     }
 }