Clean up remaining places without context (zircote#985)

DerManoMann · web-flow · commit 55c41b87f31a · 2021-09-16T11:02:21.000+12:00
This paves the way for retiring `Context::detect()`
diff --git a/src/Context.php b/src/Context.php
@@ -38,7 +38,7 @@
  * @property string                           $interface
  * @property bool                             $static      Indicate a static method
  * @property bool                             $nullable    Indicate a nullable value
- * @property bool                             $generated   Indicate the context was generated by a processor
+ * @property bool                             $generated   Indicate the context was generated by a processor or the serializer
  * @property Annotations\AbstractAnnotation   $nested
  * @property Annotations\AbstractAnnotation[] $annotations
  * @property \Psr\Log\LoggerInterface         $logger      Guaranteed to be set when using the `Generator`
diff --git a/src/Processors/ExpandClasses.php b/src/Processors/ExpandClasses.php
@@ -32,7 +32,7 @@ public function __invoke(Analysis $analysis)
                     $anchestorSchema = $analysis->getSchemaForSource($anchestor['context']->fullyQualifiedName($anchestor['class']));
                     if ($anchestorSchema) {
                         $refPath = $anchestorSchema->schema !== Generator::UNDEFINED ? $anchestorSchema->schema : $anchestor['class'];
-                        $this->inheritFrom($schema, $anchestorSchema, $refPath, $anchestor['context']->_context);
+                        $this->inheritFrom($schema, $anchestorSchema, $refPath, $anchestor['context']);
 
                         // one anchestor is enough
                         break;
diff --git a/src/Processors/ExpandInterfaces.php b/src/Processors/ExpandInterfaces.php
@@ -32,7 +32,7 @@ public function __invoke(Analysis $analysis)
                     $interfaceSchema = $analysis->getSchemaForSource($interface['context']->fullyQualifiedName($interface['interface']));
                     if ($interfaceSchema) {
                         $refPath = $interfaceSchema->schema !== Generator::UNDEFINED ? $interfaceSchema->schema : $interface['interface'];
-                        $this->inheritFrom($schema, $interfaceSchema, $refPath, $interface['context']->_context);
+                        $this->inheritFrom($schema, $interfaceSchema, $refPath, $interface['context']);
                     } else {
                         $this->mergeAnnotations($schema, $interface, $existing);
                         $this->mergeMethods($schema, $interface, $existing);
diff --git a/src/Processors/ExpandTraits.php b/src/Processors/ExpandTraits.php
@@ -33,7 +33,7 @@ public function __invoke(Analysis $analysis)
                     $traitSchema = $analysis->getSchemaForSource($trait['context']->fullyQualifiedName($trait['trait']));
                     if ($traitSchema) {
                         $refPath = $traitSchema->schema !== Generator::UNDEFINED ? $traitSchema->schema : $trait['trait'];
-                        $this->inheritFrom($schema, $traitSchema, $refPath, $trait['context']->_context);
+                        $this->inheritFrom($schema, $traitSchema, $refPath, $trait['context']);
                     } else {
                         if ($schema->_context->is('class')) {
                             $this->mergeAnnotations($schema, $trait, $existing);
diff --git a/src/Processors/MergeIntoComponents.php b/src/Processors/MergeIntoComponents.php
@@ -8,6 +8,7 @@
 
 use OpenApi\Analysis;
 use OpenApi\Annotations\Components;
+use OpenApi\Context;
 use OpenApi\Generator;
 
 /**
@@ -19,7 +20,8 @@ public function __invoke(Analysis $analysis)
     {
         $components = $analysis->openapi->components;
         if ($components === Generator::UNDEFINED) {
-            $components = new Components([]);
+            $context = new Context([], $analysis->context);
+            $components = new Components(['_context' => $context]);
             $components->_context->generated = true;
         }
 
diff --git a/src/Serializer.php b/src/Serializer.php
@@ -105,7 +105,7 @@ public function deserializeFile(string $filename, string $className = OA\OpenApi
      */
     protected function doDeserialize(\stdClass $c, string $class)
     {
-        $annotation = new $class([]);
+        $annotation = new $class(['_context' => new Context(['generated' => true])]);
         foreach ((array) $c as $property => $value) {
             if ($property === '$ref') {
                 $property = 'ref';
diff --git a/tests/Annotations/OperationTest.php b/tests/Annotations/OperationTest.php
@@ -45,6 +45,7 @@ public function testSecuritySerialization($security, $dockBlock, $expected)
         // test with Get implementation...
         $operation = new OA\Get([
             'security' => $security,
+            '_context' => $this->getContext(),
         ]);
         $flags = JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE;
         $json = $operation->toJson($flags);
diff --git a/tests/OpenApiTestCase.php b/tests/OpenApiTestCase.php
@@ -167,12 +167,12 @@ protected function createOpenApiWithInfo()
             'info' => new Info([
                 'title' => 'swagger-php Test-API',
                 'version' => 'test',
-                '_context' => $this->getContext(['unittest' => true]),
+                '_context' => $this->getContext(),
             ]),
             'paths' => [
-                new PathItem(['path' => '/test']),
+                new PathItem(['path' => '/test', '_context' => $this->getContext()]),
             ],
-            '_context' => $this->getContext(['unittest' => true]),
+            '_context' => $this->getContext(),
         ]);
     }
 
diff --git a/tests/Processors/BuildPathsTest.php b/tests/Processors/BuildPathsTest.php
@@ -20,10 +20,10 @@ class BuildPathsTest extends OpenApiTestCase
 {
     public function testMergePathsWithSamePath()
     {
-        $openapi = new OpenApi([]);
+        $openapi = new OpenApi(['_context' => $this->getContext()]);
         $openapi->paths = [
-            new PathItem(['path' => '/comments']),
-            new PathItem(['path' => '/comments']),
+            new PathItem(['path' => '/comments', '_context' => $this->getContext()]),
+            new PathItem(['path' => '/comments', '_context' => $this->getContext()]),
         ];
         $analysis = new Analysis([$openapi], $this->getContext());
         $analysis->openapi = $openapi;
@@ -34,12 +34,12 @@ public function testMergePathsWithSamePath()
 
     public function testMergeOperationsWithSamePath()
     {
-        $openapi = new OpenApi([]);
+        $openapi = new OpenApi(['_context' => $this->getContext()]);
         $analysis = new Analysis(
             [
                 $openapi,
-                new Get(['path' => '/comments']),
-                new Post(['path' => '/comments']),
+                new Get(['path' => '/comments', '_context' => $this->getContext()]),
+                new Post(['path' => '/comments', '_context' => $this->getContext()]),
             ],
             $this->getContext()
         );
diff --git a/tests/Processors/ExpandClassesTest.php b/tests/Processors/ExpandClassesTest.php
@@ -27,8 +27,8 @@ class ExpandClassesTest extends OpenApiTestCase
 {
     protected function validate(Analysis $analysis)
     {
-        $analysis->openapi->info = new Info(['title' => 'test', 'version' => '1.0.0']);
-        $analysis->openapi->paths = [new PathItem(['path' => '/test'])];
+        $analysis->openapi->info = new Info(['title' => 'test', 'version' => '1.0.0', '_context' => $this->getContext()]);
+        $analysis->openapi->paths = [new PathItem(['path' => '/test', '_context' => $this->getContext()])];
         $analysis->validate();
     }
 
@@ -244,8 +244,8 @@ public function testPreserveExistingAllOf()
         ]);
         $this->validate($analysis);
 
-        $analysis->openapi->info = new Info(['title' => 'test', 'version' => '1.0.0']);
-        $analysis->openapi->paths = [new PathItem(['path' => '/test'])];
+        $analysis->openapi->info = new Info(['title' => 'test', 'version' => '1.0.0', '_context' => $this->getContext()]);
+        $analysis->openapi->paths = [new PathItem(['path' => '/test', '_context' => $this->getContext()])];
         $analysis->validate();
 
         /* @var Schema[] $schemas */
diff --git a/tests/Processors/MergeIntoComponentsTest.php b/tests/Processors/MergeIntoComponentsTest.php
@@ -17,8 +17,8 @@ class MergeIntoComponentsTest extends OpenApiTestCase
 {
     public function testProcessor()
     {
-        $openapi = new OpenApi([]);
-        $response = new Response(['response' => '2xx']);
+        $openapi = new OpenApi(['_context' => $this->getContext()]);
+        $response = new Response(['response' => '2xx', '_context' => $this->getContext()]);
         $analysis = new Analysis(
             [
                 $openapi,
diff --git a/tests/Processors/MergeIntoOpenApiTest.php b/tests/Processors/MergeIntoOpenApiTest.php
@@ -17,8 +17,8 @@ class MergeIntoOpenApiTest extends OpenApiTestCase
 {
     public function testProcessor()
     {
-        $openapi = new OpenApi([]);
-        $info = new Info([]);
+        $openapi = new OpenApi(['_context' => $this->getContext()]);
+        $info = new Info(['_context' => $this->getContext()]);
         $analysis = new Analysis(
             [
                 $openapi,
diff --git a/tests/RefTest.php b/tests/RefTest.php
@@ -9,7 +9,6 @@
 use OpenApi\Analysis;
 use OpenApi\Annotations\Info;
 use OpenApi\Annotations\Response;
-use OpenApi\Context;
 
 class RefTest extends OpenApiTestCase
 {
@@ -27,7 +26,7 @@ public function testRef()
 END;
         $openapi->merge($this->parseComment($comment));
         $analysis = new Analysis([], $this->getContext());
-        $analysis->addAnnotation($openapi, Context::detect());
+        $analysis->addAnnotation($openapi, $this->getContext());
         $analysis->process();
 
         $analysis->validate();
diff --git a/tests/SerializerTest.php b/tests/SerializerTest.php
@@ -15,56 +15,56 @@ class SerializerTest extends OpenApiTestCase
 {
     private function getExpected()
     {
-        $path = new Annotations\PathItem([]);
+        $path = new Annotations\PathItem(['_context' => $this->getContext()]);
         $path->path = '/products';
-        $path->post = new Annotations\Post([]);
+        $path->post = new Annotations\Post(['_context' => $this->getContext()]);
         $path->post->tags = ['products'];
         $path->post->summary = 's1';
         $path->post->description = 'd1';
-        $path->post->requestBody = new Annotations\RequestBody([]);
-        $mediaType = new Annotations\MediaType([]);
+        $path->post->requestBody = new Annotations\RequestBody(['_context' => $this->getContext()]);
+        $mediaType = new Annotations\MediaType(['_context' => $this->getContext()]);
         $mediaType->mediaType = 'application/json';
-        $mediaType->schema = new Annotations\Schema([]);
+        $mediaType->schema = new Annotations\Schema(['_context' => $this->getContext()]);
         $mediaType->schema->type = 'object';
         $mediaType->schema->additionalProperties = true;
         $path->post->requestBody->content = [$mediaType];
         $path->post->requestBody->description = 'data in body';
         $path->post->requestBody->x = [];
         $path->post->requestBody->x['repository'] = 'def';
 
-        $resp = new Annotations\Response([]);
+        $resp = new Annotations\Response(['_context' => $this->getContext()]);
         $resp->response = '200';
         $resp->description = 'Success';
-        $content = new Annotations\MediaType([]);
+        $content = new Annotations\MediaType(['_context' => $this->getContext()]);
         $content->mediaType = 'application/json';
-        $content->schema = new Annotations\Schema([]);
+        $content->schema = new Annotations\Schema(['_context' => $this->getContext()]);
         $content->schema->ref = '#/components/schemas/Pet';
         $resp->content = [$content];
         $resp->x = [];
         $resp->x['repository'] = 'def';
 
-        $respRange = new Annotations\Response([]);
+        $respRange = new Annotations\Response(['_context' => $this->getContext()]);
         $respRange->response = '4XX';
         $respRange->description = 'Client error response';
 
         $path->post->responses = [$resp, $respRange];
 
-        $expected = new Annotations\OpenApi([]);
+        $expected = new Annotations\OpenApi(['_context' => $this->getContext()]);
         $expected->openapi = '3.0.0';
         $expected->paths = [
             $path,
         ];
 
-        $info = new Annotations\Info([]);
+        $info = new Annotations\Info(['_context' => $this->getContext()]);
         $info->title = 'Pet store';
         $info->version = '1.0';
         $expected->info = $info;
 
-        $schema = new Annotations\Schema([]);
+        $schema = new Annotations\Schema(['_context' => $this->getContext()]);
         $schema->schema = 'Pet';
         $schema->required = ['name', 'photoUrls'];
 
-        $expected->components = new Annotations\Components([]);
+        $expected->components = new Annotations\Components(['_context' => $this->getContext()]);
         $expected->components->schemas = [$schema];
 
         return $expected;

Original file line number	Diff line number	Diff line change
`@@ -8,6 +8,7 @@`
`8`	`8`
`9`	`9`	`use OpenApi\Analysis;`
`10`	`10`	`use OpenApi\Annotations\Components;`
	`11`	`+use OpenApi\Context;`
`11`	`12`	`use OpenApi\Generator;`
`12`	`13`
`13`	`14`	`/**`
`@@ -19,7 +20,8 @@ public function __invoke(Analysis $analysis)`
`19`	`20`	`{`
`20`	`21`	`$components = $analysis->openapi->components;`
`21`	`22`	`if ($components === Generator::UNDEFINED) {`
`22`		`- $components = new Components([]);`
	`23`	`+ $context = new Context([], $analysis->context);`
	`24`	`+ $components = new Components(['_context' => $context]);`
`23`	`25`	`$components->_context->generated = true;`
`24`	`26`	`}`
`25`	`27`
Original file line number	Diff line number	Diff line change
`@@ -105,7 +105,7 @@ public function deserializeFile(string $filename, string $className = OA\OpenApi`
`105`	`105`	`*/`
`106`	`106`	`protected function doDeserialize(\stdClass $c, string $class)`
`107`	`107`	`{`
`108`		`- $annotation = new $class([]);`
	`108`	`+ $annotation = new $class(['_context' => new Context(['generated' => true])]);`
`109`	`109`	`foreach ((array) $c as $property => $value) {`
`110`	`110`	`if ($property === '$ref') {`
`111`	`111`	`$property = 'ref';`
Original file line number	Diff line number	Diff line change
`@@ -27,8 +27,8 @@ class ExpandClassesTest extends OpenApiTestCase`
`27`	`27`	`{`
`28`	`28`	`protected function validate(Analysis $analysis)`
`29`	`29`	`{`
`30`		`- $analysis->openapi->info = new Info(['title' => 'test', 'version' => '1.0.0']);`
`31`		`- $analysis->openapi->paths = [new PathItem(['path' => '/test'])];`
	`30`	`+ $analysis->openapi->info = new Info(['title' => 'test', 'version' => '1.0.0', '_context' => $this->getContext()]);`
	`31`	`+ $analysis->openapi->paths = [new PathItem(['path' => '/test', '_context' => $this->getContext()])];`
`32`	`32`	`$analysis->validate();`
`33`	`33`	`}`
`34`	`34`
`@@ -244,8 +244,8 @@ public function testPreserveExistingAllOf()`
`244`	`244`	`]);`
`245`	`245`	`$this->validate($analysis);`
`246`	`246`
`247`		`- $analysis->openapi->info = new Info(['title' => 'test', 'version' => '1.0.0']);`
`248`		`- $analysis->openapi->paths = [new PathItem(['path' => '/test'])];`
	`247`	`+ $analysis->openapi->info = new Info(['title' => 'test', 'version' => '1.0.0', '_context' => $this->getContext()]);`
	`248`	`+ $analysis->openapi->paths = [new PathItem(['path' => '/test', '_context' => $this->getContext()])];`
`249`	`249`	`$analysis->validate();`
`250`	`250`
`251`	`251`	`/* @var Schema[] $schemas */`