Introduce Generator settings

Generator settings are following the same pattern as processor config and are stored under the key `'generator'`.

`Generator::getSetting()` provides a shortcut to access generator settings.

Author: DerManoMann

bin/openapi

@@ -218,6 +218,7 @@ foreach ($options["processor"] as $processor) {
 }
 
 $analyser = new ReflectionAnalyser([new DocBlockAnnotationFactory(), new AttributeAnnotationFactory()]);
+$analyser->setGenerator($generator);
 
 $openapi = $generator
     ->setVersion($options['version'])

src/Analysers/AnalyserInterface.php

@@ -8,11 +8,8 @@
 
 use OpenApi\Analysis;
 use OpenApi\Context;
-use OpenApi\Generator;
 
-interface AnalyserInterface
+interface AnalyserInterface extends GeneratorAwareInterface
 {
-    public function setGenerator(Generator $generator): void;
-
     public function fromFile(string $filename, Context $context): Analysis;
 }

src/Analysers/AnnotationFactoryInterface.php

@@ -10,14 +10,14 @@
 use OpenApi\Context;
 use OpenApi\Generator;
 
-interface AnnotationFactoryInterface
+interface AnnotationFactoryInterface extends GeneratorAwareInterface
 {
     /**
      * Checks if this factory is supported by the current runtime.
      */
     public function isSupported(): bool;
 
-    public function setGenerator(Generator $generator): void;
+    public function setGenerator(Generator $generator);
 
     /**
      * @return array<OA\AbstractAnnotation> top level annotations

src/Analysers/AttributeAnnotationFactory.php

@@ -36,13 +36,17 @@ public function build(\Reflector $reflector, Context $context): array
         /** @var OA\AbstractAnnotation[] $annotations */
         $annotations = [];
         try {
-            foreach ($reflector->getAttributes() as $attribute) {
+            $attributeArgs = $this->generator->getSetting('ignoreOtherAttributes')
+                ? [OA\AbstractAnnotation::class, \ReflectionAttribute::IS_INSTANCEOF]
+                : [];
+
+            foreach ($reflector->getAttributes(...$attributeArgs) as $attribute) {
                 if (class_exists($attribute->getName())) {
                     $instance = $attribute->newInstance();
                     if ($instance instanceof OA\AbstractAnnotation) {
                         $annotations[] = $instance;
                     } else {
-                        if ($context->is('other') === false) {
+                        if (false === $context->is('other')) {
                             $context->other = [];
                         }
                         $context->other[] = $instance;

src/Analysers/DocBlockAnnotationFactory.php

@@ -26,11 +26,13 @@ public function isSupported(): bool
         return DocBlockParser::isEnabled();
     }
 
-    public function setGenerator(Generator $generator): void
+    public function setGenerator(Generator $generator)
     {
         $this->generator = $generator;
 
         $this->docBlockParser->setAliases($generator->getAliases());
+
+        return $this;
     }
 
     public function build(\Reflector $reflector, Context $context): array

src/Analysers/GeneratorAwareInterface.php

@@ -0,0 +1,14 @@
+<?php declare(strict_types=1);
+
+/**
+ * @license Apache 2.0
+ */
+
+namespace OpenApi\Analysers;
+
+use OpenApi\Generator;
+
+interface GeneratorAwareInterface
+{
+    public function setGenerator(Generator $generator);
+}

src/Analysers/GeneratorAwareTrait.php

@@ -12,8 +12,10 @@ trait GeneratorAwareTrait
 {
     protected ?Generator $generator = null;
 
-    public function setGenerator(Generator $generator): void
+    public function setGenerator(Generator $generator)
     {
         $this->generator = $generator;
+
+        return $this;
     }
 }

src/Analysers/ReflectionAnalyser.php

@@ -42,13 +42,15 @@ public function __construct(array $annotationFactories = [])
         }
     }
 
-    public function setGenerator(Generator $generator): void
+    public function setGenerator(Generator $generator)
     {
         $this->generator = $generator;
 
         foreach ($this->annotationFactories as $annotationFactory) {
             $annotationFactory->setGenerator($generator);
         }
+
+        return $this;
     }
 
     public function fromFile(string $filename, Context $context): Analysis

src/Generator.php

@@ -135,6 +135,9 @@ public function setAnalyser(?AnalyserInterface $analyser): Generator
         return $this;
     }
 
+    /**
+     * @deprecated
+     */
     public function getDefaultConfig(): array
     {
         return [
@@ -146,7 +149,19 @@ public function getDefaultConfig(): array
 
     public function getConfig(): array
     {
-        return $this->config + $this->getDefaultConfig();
+        return $this->config + $this->getDefaultConfig() + [
+                'generator' => [
+                    'ignoreOtherAttributes' => false,
+                ],
+            ];
+    }
+
+    /**
+     * Get the value of a `Generator` setting.
+     */
+    public function getSetting(string $name)
+    {
+        return $this->getConfig()['generator'][$name] ?? null;
     }
 
     protected function normaliseConfig(array $config): array

tests/Analysers/AttributeAnnotationFactoryTest.php

@@ -7,6 +7,7 @@
 namespace OpenApi\Tests\Analysers;
 
 use OpenApi\Analysers\AttributeAnnotationFactory;
+use OpenApi\Generator;
 use OpenApi\Tests\Fixtures\UsingAttributes;
 use OpenApi\Tests\Fixtures\InvalidPropertyAttribute;
 use OpenApi\Tests\OpenApiTestCase;
@@ -16,11 +17,22 @@
  */
 class AttributeAnnotationFactoryTest extends OpenApiTestCase
 {
-    public function testReturnedAnnotationsCout(): void
+    protected function getFactory(?array $config = null): AttributeAnnotationFactory
+    {
+        $generator = new Generator();
+        if (null !== $config) {
+            $generator->setConfig($config);
+        }
+
+        return (new AttributeAnnotationFactory())
+            ->setGenerator($generator);
+    }
+
+    public function testReturnedAnnotationsCount(): void
     {
         $rc = new \ReflectionClass(UsingAttributes::class);
 
-        $annotations = (new AttributeAnnotationFactory())->build($rc, $this->getContext());
+        $annotations = $this->getFactory()->build($rc, $this->getContext());
         $this->assertCount(1, $annotations);
     }
 
@@ -32,6 +44,18 @@ public function testErrorOnInvalidAttribute(): void
         $this->expectException(\TypeError::class);
         $this->expectExceptionMessage('OpenApi\Attributes\Property::__construct(): Argument #8 ($required) must be of type ?array');
 
-        (new AttributeAnnotationFactory())->build($rm, $this->getContext());
+        $this->getFactory()->build($rm, $this->getContext());
+    }
+
+    public function testIgnoreOtherAttributes(): void
+    {
+        $rc = new \ReflectionClass(UsingAttributes::class);
+
+        $this->getFactory()->build($rc, $context = $this->getContext());
+        $this->assertIsArray($context->other);
+        $this->assertCount(1, $context->other);
+
+        $this->getFactory(['generator' => ['ignoreOtherAttributes' => true]])->build($rc, $context = $this->getContext());
+        $this->assertNull($context->other);
     }
 }