Move routePrefix to attributes

Author: Toflar

src/Annotation/ApiResource.php

@@ -38,11 +38,6 @@ final class ApiResource
      */
     public $iri;
 
-    /**
-     * @var string
-     */
-    public $routePrefix;
-
     /**
      * @var array
      */

src/Bridge/Symfony/Routing/ApiLoader.php

@@ -198,7 +198,7 @@ private function addRoute(RouteCollection $routeCollection, string $resourceClas
             }
         }
 
-        $path = $resourceMetadata->getRoutePrefix() ?: '';
+        $path = $resourceMetadata->getAttribute('routePrefix', '');
         $path .= $this->operationPathResolver->resolveOperationPath($resourceShortName, $operation, $operationType, $operationName);
 
         $route = new Route(

src/Metadata/Extractor/XmlExtractor.php

@@ -51,7 +51,6 @@ protected function extractPath(string $path)
                 'graphql' => $this->getOperations($resource, 'operation'),
                 'attributes' => $this->getAttributes($resource, 'attribute') ?: null,
                 'properties' => $this->getProperties($resource) ?: null,
-                'routePrefix' => $this->phpize($resource, 'routePrefix', 'string'),
             ];
         }
     }

src/Metadata/Extractor/YamlExtractor.php

@@ -70,7 +70,6 @@ private function extractResources(array $resourcesYaml, string $path)
                 'subresourceOperations' => $resourceYaml['subresourceOperations'] ?? null,
                 'graphql' => $resourceYaml['graphql'] ?? null,
                 'attributes' => $resourceYaml['attributes'] ?? null,
-                'routePrefix' => $this->phpize($resourceYaml, 'routePrefix', 'string'),
             ];
 
             if (!isset($resourceYaml['properties'])) {

src/Metadata/Resource/Factory/AnnotationResourceMetadataFactory.php

@@ -87,13 +87,12 @@ private function createMetadata(ApiResource $annotation, ResourceMetadata $paren
                 $annotation->collectionOperations,
                 $annotation->attributes,
                 $annotation->subresourceOperations,
-                $annotation->graphql,
-                $annotation->routePrefix
+                $annotation->graphql
             );
         }
 
         $resourceMetadata = $parentResourceMetadata;
-        foreach (['shortName', 'description', 'iri', 'itemOperations', 'collectionOperations', 'subresourceOperations', 'graphql', 'attributes', 'routePrefix'] as $property) {
+        foreach (['shortName', 'description', 'iri', 'itemOperations', 'collectionOperations', 'subresourceOperations', 'graphql', 'attributes'] as $property) {
             $resourceMetadata = $this->createWith($resourceMetadata, $property, $annotation->$property);
         }
 

src/Metadata/Resource/ResourceMetadata.php

@@ -23,14 +23,13 @@ final class ResourceMetadata
     private $shortName;
     private $description;
     private $iri;
-    private $routePrefix;
     private $itemOperations;
     private $collectionOperations;
     private $subresourceOperations;
     private $graphql;
     private $attributes;
 
-    public function __construct(string $shortName = null, string $description = null, string $iri = null, array $itemOperations = null, array $collectionOperations = null, array $attributes = null, array $subresourceOperations = null, array $graphql = null, string $routePrefix = null)
+    public function __construct(string $shortName = null, string $description = null, string $iri = null, array $itemOperations = null, array $collectionOperations = null, array $attributes = null, array $subresourceOperations = null, array $graphql = null)
     {
         $this->shortName = $shortName;
         $this->description = $description;
@@ -40,7 +39,6 @@ public function __construct(string $shortName = null, string $description = null
         $this->subresourceOperations = $subresourceOperations;
         $this->graphql = $graphql;
         $this->attributes = $attributes;
-        $this->routePrefix = $routePrefix;
     }
 
     /**
@@ -322,25 +320,4 @@ public function withGraphql(array $graphql): self
 
         return $metadata;
     }
-
-    /**
-     * Gets the route prefix.
-     *
-     * @return string|null
-     */
-    public function getRoutePrefix()
-    {
-        return $this->routePrefix;
-    }
-
-    /**
-     * Returns a new instance with the given route prefix.
-     */
-    public function withRoutePrefix(string $routePrefix): self
-    {
-        $metadata = clone $this;
-        $metadata->routePrefix = $routePrefix;
-
-        return $metadata;
-    }
 }

tests/Annotation/AnnotatedClass.php

@@ -23,8 +23,7 @@
  *     itemOperations={"foo":{"bar"}},
  *     collectionOperations={"bar":{"foo"}},
  *     graphql={"query"={"normalization_context"={"groups"={"foo", "bar"}}}},
- *     attributes={"foo":"bar"},
- *     routePrefix="/whatever"
+ *     attributes={"foo":"bar", "routePrefix"="/whatever"},
  * )
  *
  * @author Marcus Speight <marcus@pmconnect.co.uk>

tests/Annotation/ApiResourceTest.php

@@ -32,15 +32,13 @@ public function testAssignation()
         $resource->collectionOperations = ['bar' => ['foo']];
         $resource->graphql = ['query' => ['normalization_context' => ['groups' => ['foo', 'bar']]]];
         $resource->attributes = ['foo' => 'bar'];
-        $resource->routePrefix = '/prefix';
 
         $this->assertSame('shortName', $resource->shortName);
         $this->assertSame('description', $resource->description);
         $this->assertSame('http://example.com/res', $resource->iri);
         $this->assertSame(['bar' => ['foo']], $resource->collectionOperations);
         $this->assertSame(['query' => ['normalization_context' => ['groups' => ['foo', 'bar']]]], $resource->graphql);
         $this->assertSame(['foo' => 'bar'], $resource->attributes);
-        $this->assertSame('/prefix', $resource->routePrefix);
     }
 
     public function testApiResourceAnnotation()
@@ -53,7 +51,6 @@ public function testApiResourceAnnotation()
         $this->assertSame('http://example.com/res', $resource->iri);
         $this->assertSame(['bar' => ['foo']], $resource->collectionOperations);
         $this->assertSame(['query' => ['normalization_context' => ['groups' => ['foo', 'bar']]]], $resource->graphql);
-        $this->assertSame(['foo' => 'bar'], $resource->attributes);
-        $this->assertSame('/whatever', $resource->routePrefix);
+        $this->assertSame(['foo' => 'bar', 'routePrefix' => '/whatever'], $resource->attributes);
     }
 }

tests/Bridge/Symfony/Routing/ApiLoaderTest.php

@@ -106,7 +106,7 @@ public function testApiLoaderWithPrefix()
             'put' => ['method' => 'PUT'],
             'delete' => ['method' => 'DELETE'],
         ]);
-        $resourceMetadata = $resourceMetadata->withRoutePrefix('/foobar-prefix');
+        $resourceMetadata = $resourceMetadata->withAttributes(['routePrefix' => '/foobar-prefix']);
 
         $routeCollection = $this->getApiLoaderWithResourceMetadata($resourceMetadata)->load(null);
 

tests/Metadata/Resource/Factory/AnnotationResourceMetadataFactoryTest.php

@@ -43,9 +43,8 @@ public function testCreate(ProphecyInterface $reader, ProphecyInterface $decorat
         $this->assertEquals(['foo' => ['bar' => true]], $metadata->getItemOperations());
         $this->assertEquals(['baz' => ['tab' => false]], $metadata->getCollectionOperations());
         $this->assertEquals(['sub' => ['bus' => false]], $metadata->getSubresourceOperations());
-        $this->assertEquals(['a' => 1], $metadata->getAttributes());
+        $this->assertEquals(['a' => 1, 'routePrefix' => '/foobar'], $metadata->getAttributes());
         $this->assertEquals(['foo' => 'bar'], $metadata->getGraphql());
-        $this->assertEquals('/foobar', $metadata->getRoutePrefix());
     }
 
     public function getCreateDependencies()
@@ -57,9 +56,8 @@ public function getCreateDependencies()
         $annotation->itemOperations = ['foo' => ['bar' => true]];
         $annotation->collectionOperations = ['baz' => ['tab' => false]];
         $annotation->subresourceOperations = ['sub' => ['bus' => false]];
-        $annotation->attributes = ['a' => 1];
+        $annotation->attributes = ['a' => 1, 'routePrefix' => '/foobar'];
         $annotation->graphql = ['foo' => 'bar'];
-        $annotation->routePrefix = '/foobar';
 
         $reader = $this->prophesize(Reader::class);
         $reader->getClassAnnotation(Argument::type(\ReflectionClass::class), ApiResource::class)->willReturn($annotation)->shouldBeCalled();