test

Author: Maxcastel

src/Metadata/Resource/Factory/ParameterResourceMetadataCollectionFactory.php

@@ -490,9 +490,9 @@ private function createParametersFromAttributes(Operation $operation): Parameter
                     $parameter = $parameter->withProperty($propertyName);
                 } elseif ($parameterPropertyName !== $propertyName) {
                     throw new RuntimeException(\sprintf('Parameter attribute on property "%s" must target itself or have no explicit property. Got "property: \'%s\'" instead.', $propertyName, $parameterPropertyName));
-                } 
+                }
 
-                if (null === $parameterProperties = $parameter->getProperties()) {
+                if (null === ($parameterProperties = $parameter->getProperties()) || \in_array($propertyName, $parameterProperties, true)) {
                     $parameter = $parameter->withProperties([$propertyName]);
                 } elseif (!\in_array($propertyName, $parameterProperties, true)) {
                     throw new RuntimeException(\sprintf('Parameter attribute on property "%s" must target itself or have no explicit properties. Got "properties: [%s]" instead.', $propertyName, implode(', ', $parameterProperties)));

src/Metadata/Tests/Resource/Factory/ParameterResourceMetadataCollectionFactoryTest.php

@@ -376,6 +376,100 @@ public function testQueryParameterFromPropertyAttributeThrowsExceptionWhenProper
         $parameterFactory->create(ParameterOnPropertiesMismatchPropertiesException::class);
     }
 
+    public function testQueryParameterFromPropertyAttributeThrowsExceptionWhenPropertiesHasMultipleWithoutSelf(): void
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Parameter attribute on property "name" must target itself or have no explicit properties. Got "properties: [description, active]" instead.');
+
+        $nameCollection = $this->createStub(PropertyNameCollectionFactoryInterface::class);
+        $nameCollection->method('create')->willReturn(new PropertyNameCollection(['id', 'name', 'description', 'active']));
+
+        $propertyMetadata = $this->createStub(PropertyMetadataFactoryInterface::class);
+        $propertyMetadata->method('create')->willReturn(
+            new ApiProperty(readable: true),
+        );
+
+        $filterLocator = $this->createStub(ContainerInterface::class);
+        $filterLocator->method('has')->willReturn(false);
+
+        $parameterFactory = new ParameterResourceMetadataCollectionFactory(
+            $nameCollection,
+            $propertyMetadata,
+            new AttributesResourceMetadataCollectionFactory(),
+            $filterLocator
+        );
+
+        $parameterFactory->create(ParameterOnPropertiesMismatchMultiplePropertiesException::class);
+    }
+
+    public function testQueryParameterFromPropertyAttributePropertiesSingleCorrectProperty(): void
+    {
+        $nameCollection = $this->createStub(PropertyNameCollectionFactoryInterface::class);
+        $nameCollection->method('create')->willReturn(new PropertyNameCollection(['id', 'name', 'description']));
+
+        $propertyMetadata = $this->createStub(PropertyMetadataFactoryInterface::class);
+        $propertyMetadata->method('create')->willReturn(
+            new ApiProperty(readable: true),
+        );
+
+        $filterLocator = $this->createStub(ContainerInterface::class);
+        $filterLocator->method('has')->willReturn(false);
+
+        $parameterFactory = new ParameterResourceMetadataCollectionFactory(
+            $nameCollection,
+            $propertyMetadata,
+            new AttributesResourceMetadataCollectionFactory(),
+            $filterLocator
+        );
+
+        $resourceMetadataCollection = $parameterFactory->create(ParameterOnPropertiesSingleCorrectProperty::class);
+        $operation = $resourceMetadataCollection->getOperation(forceCollection: true);
+        $parameters = $operation->getParameters();
+
+        $this->assertInstanceOf(Parameters::class, $parameters);
+
+        $this->assertTrue($parameters->has('search'));
+        $searchParam = $parameters->get('search', QueryParameter::class);
+        $this->assertInstanceOf(QueryParameter::class, $searchParam);
+        $this->assertSame('search', $searchParam->getKey());
+        $this->assertSame('name', $searchParam->getProperty());
+        $this->assertSame(['name'], $searchParam->getProperties());
+    }
+
+    public function testQueryParameterFromPropertyAttributePropertiesHasMultipleIncludingSelf(): void
+    {
+        $nameCollection = $this->createStub(PropertyNameCollectionFactoryInterface::class);
+        $nameCollection->method('create')->willReturn(new PropertyNameCollection(['id', 'name', 'description']));
+
+        $propertyMetadata = $this->createStub(PropertyMetadataFactoryInterface::class);
+        $propertyMetadata->method('create')->willReturn(
+            new ApiProperty(readable: true),
+        );
+
+        $filterLocator = $this->createStub(ContainerInterface::class);
+        $filterLocator->method('has')->willReturn(false);
+
+        $parameterFactory = new ParameterResourceMetadataCollectionFactory(
+            $nameCollection,
+            $propertyMetadata,
+            new AttributesResourceMetadataCollectionFactory(),
+            $filterLocator
+        );
+
+        $resourceMetadataCollection = $parameterFactory->create(ParameterOnPropertiesMultiplePropertiesIncludingSelf::class);
+        $operation = $resourceMetadataCollection->getOperation(forceCollection: true);
+        $parameters = $operation->getParameters();
+
+        $this->assertInstanceOf(Parameters::class, $parameters);
+
+        $this->assertTrue($parameters->has('search'));
+        $searchParam = $parameters->get('search', QueryParameter::class);
+        $this->assertInstanceOf(QueryParameter::class, $searchParam);
+        $this->assertSame('search', $searchParam->getKey());
+        $this->assertSame('name', $searchParam->getProperty());
+        $this->assertSame(['name'], $searchParam->getProperties());
+    }
+
     public function testNestedPropertyWithNameConverter(): void
     {
         $nameCollection = $this->createStub(PropertyNameCollectionFactoryInterface::class);
@@ -660,4 +754,31 @@ class ParameterOnPropertiesMismatchPropertiesException
     public string $description = '';
 }
 
+#[ApiResource]
+class ParameterOnPropertiesMismatchMultiplePropertiesException
+{
+    #[QueryParameter(key: 'search', properties: ['description', 'active'])]
+    public string $name = '';
+
+    public string $description = '';
+
+    public bool $active = true;
+}
+
+#[ApiResource]
+class ParameterOnPropertiesSingleCorrectProperty
+{
+    #[QueryParameter(key: 'search', properties: ['name'])]
+    public string $name = '';
+
+    public string $description = '';
+}
 
+#[ApiResource]
+class ParameterOnPropertiesMultiplePropertiesIncludingSelf
+{
+    #[QueryParameter(key: 'search', properties: ['description', 'name'])]
+    public string $name = '';
+
+    public string $description = '';
+}