[Serializer] Replace "annotation" wording by "attribute"

nicolas-grekas · nicolas-grekas · commit 9c80b221764f · 2023-10-19T11:39:15.000+02:00
diff --git a/Annotation/Context.php b/Annotation/Context.php
@@ -39,14 +39,14 @@ public function __construct(
         string|array $groups = [],
     ) {
         if (!$context && !$normalizationContext && !$denormalizationContext) {
-            throw new InvalidArgumentException(sprintf('At least one of the "context", "normalizationContext", or "denormalizationContext" options of annotation "%s" must be provided as a non-empty array.', static::class));
+            throw new InvalidArgumentException(sprintf('At least one of the "context", "normalizationContext", or "denormalizationContext" options must be provided as a non-empty array to "%s".', static::class));
         }
 
         $this->groups = (array) $groups;
 
         foreach ($this->groups as $group) {
             if (!\is_string($group)) {
-                throw new InvalidArgumentException(sprintf('Parameter "groups" of annotation "%s" must be a string or an array of strings. Got "%s".', static::class, get_debug_type($group)));
+                throw new InvalidArgumentException(sprintf('Parameter "groups" given to "%s" must be a string or an array of strings, "%s" given.', static::class, get_debug_type($group)));
             }
         }
     }
diff --git a/Annotation/DiscriminatorMap.php b/Annotation/DiscriminatorMap.php
@@ -30,11 +30,11 @@ public function __construct(
         private readonly array $mapping,
     ) {
         if (empty($typeProperty)) {
-            throw new InvalidArgumentException(sprintf('Parameter "typeProperty" of annotation "%s" cannot be empty.', static::class));
+            throw new InvalidArgumentException(sprintf('Parameter "typeProperty" given to "%s" cannot be empty.', static::class));
         }
 
         if (empty($mapping)) {
-            throw new InvalidArgumentException(sprintf('Parameter "mapping" of annotation "%s" cannot be empty.', static::class));
+            throw new InvalidArgumentException(sprintf('Parameter "mapping" given to "%s" cannot be empty.', static::class));
         }
     }
 
diff --git a/Annotation/Groups.php b/Annotation/Groups.php
@@ -38,12 +38,12 @@ public function __construct(string|array $groups)
         $this->groups = (array) $groups;
 
         if (!$this->groups) {
-            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', static::class));
+            throw new InvalidArgumentException(sprintf('Parameter given to "%s" cannot be empty.', static::class));
         }
 
         foreach ($this->groups as $group) {
             if (!\is_string($group) || '' === $group) {
-                throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a string or an array of non-empty strings.', static::class));
+                throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a string or an array of non-empty strings.', static::class));
             }
         }
     }
diff --git a/Annotation/MaxDepth.php b/Annotation/MaxDepth.php
@@ -28,7 +28,7 @@ class MaxDepth
     public function __construct(private readonly int $maxDepth)
     {
         if ($maxDepth <= 0) {
-            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a positive integer.', static::class));
+            throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a positive integer.', static::class));
         }
     }
 
diff --git a/Annotation/SerializedName.php b/Annotation/SerializedName.php
@@ -28,7 +28,7 @@ final class SerializedName
     public function __construct(private readonly string $serializedName)
     {
         if ('' === $serializedName) {
-            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a non-empty string.', self::class));
+            throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a non-empty string.', self::class));
         }
     }
 
diff --git a/Annotation/SerializedPath.php b/Annotation/SerializedPath.php
@@ -34,7 +34,7 @@ public function __construct(string $serializedPath)
         try {
             $this->serializedPath = new PropertyPath($serializedPath);
         } catch (InvalidPropertyPathException $pathException) {
-            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a valid property path.', self::class));
+            throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a valid property path.', self::class));
         }
     }
 
diff --git a/NameConverter/MetadataAwareNameConverter.php b/NameConverter/MetadataAwareNameConverter.php
@@ -80,7 +80,7 @@ private function getCacheValueForNormalization(string $propertyName, string $cla
         }
 
         if (null !== $attributesMetadata[$propertyName]->getSerializedName() && null !== $attributesMetadata[$propertyName]->getSerializedPath()) {
-            throw new LogicException(sprintf('Found SerializedName and SerializedPath annotations on property "%s" of class "%s".', $propertyName, $class));
+            throw new LogicException(sprintf('Found SerializedName and SerializedPath attributes on property "%s" of class "%s".', $propertyName, $class));
         }
 
         return $attributesMetadata[$propertyName]->getSerializedName() ?? null;
@@ -124,7 +124,7 @@ private function getCacheValueForAttributesMetadata(string $class, array $contex
             }
 
             if (null !== $metadata->getSerializedName() && null !== $metadata->getSerializedPath()) {
-                throw new LogicException(sprintf('Found SerializedName and SerializedPath annotations on property "%s" of class "%s".', $name, $class));
+                throw new LogicException(sprintf('Found SerializedName and SerializedPath attributes on property "%s" of class "%s".', $name, $class));
             }
 
             $metadataGroups = $metadata->getGroups();
diff --git a/Normalizer/AbstractObjectNormalizer.php b/Normalizer/AbstractObjectNormalizer.php
@@ -349,7 +349,7 @@ public function denormalize(mixed $data, string $type, string $format = null, ar
                 $notConverted = $attribute;
                 $attribute = $this->nameConverter->denormalize($attribute, $resolvedClass, $format, $context);
                 if (isset($nestedData[$notConverted]) && !isset($originalNestedData[$attribute])) {
-                    throw new LogicException(sprintf('Duplicate values for key "%s" found. One value is set via the SerializedPath annotation: "%s", the other one is set via the SerializedName annotation: "%s".', $notConverted, implode('->', $nestedAttributes[$notConverted]->getElements()), $attribute));
+                    throw new LogicException(sprintf('Duplicate values for key "%s" found. One value is set via the SerializedPath attribute: "%s", the other one is set via the SerializedName attribute: "%s".', $notConverted, implode('->', $nestedAttributes[$notConverted]->getElements()), $attribute));
                 }
             }
 
@@ -756,7 +756,7 @@ private function isUninitializedValueError(\Error $e): bool
     }
 
     /**
-     * Returns all attributes with a SerializedPath annotation and the respective path.
+     * Returns all attributes with a SerializedPath attribute and the respective path.
      */
     private function getNestedAttributes(string $class): array
     {
diff --git a/Tests/Annotation/ContextTest.php b/Tests/Annotation/ContextTest.php
@@ -32,15 +32,15 @@ protected function setUp(): void
     public function testThrowsOnEmptyContext()
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('At least one of the "context", "normalizationContext", or "denormalizationContext" options of annotation "Symfony\Component\Serializer\Annotation\Context" must be provided as a non-empty array.');
+        $this->expectExceptionMessage('At least one of the "context", "normalizationContext", or "denormalizationContext" options must be provided as a non-empty array to "Symfony\Component\Serializer\Annotation\Context".');
 
         new Context();
     }
 
     public function testInvalidGroupOption()
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage(sprintf('Parameter "groups" of annotation "%s" must be a string or an array of strings. Got "stdClass"', Context::class));
+        $this->expectExceptionMessage(sprintf('Parameter "groups" given to "%s" must be a string or an array of strings, "stdClass" given', Context::class));
 
         new Context(context: ['foo' => 'bar'], groups: ['fine', new \stdClass()]);
     }
diff --git a/Tests/Annotation/MaxDepthTest.php b/Tests/Annotation/MaxDepthTest.php
@@ -27,7 +27,7 @@ class MaxDepthTest extends TestCase
     public function testNotAnIntMaxDepthParameter(int $value)
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Parameter of annotation "Symfony\Component\Serializer\Annotation\MaxDepth" must be a positive integer.');
+        $this->expectExceptionMessage('Parameter given to "Symfony\Component\Serializer\Annotation\MaxDepth" must be a positive integer.');
         new MaxDepth($value);
     }
 
diff --git a/Tests/Annotation/SerializedNameTest.php b/Tests/Annotation/SerializedNameTest.php
@@ -23,7 +23,7 @@ class SerializedNameTest extends TestCase
     public function testNotAStringSerializedNameParameter()
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Parameter of annotation "Symfony\Component\Serializer\Annotation\SerializedName" must be a non-empty string.');
+        $this->expectExceptionMessage('Parameter given to "Symfony\Component\Serializer\Annotation\SerializedName" must be a non-empty string.');
 
         new SerializedName('');
     }
diff --git a/Tests/Annotation/SerializedPathTest.php b/Tests/Annotation/SerializedPathTest.php
@@ -24,7 +24,7 @@ class SerializedPathTest extends TestCase
     public function testEmptyStringSerializedPathParameter()
     {
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Parameter of annotation "Symfony\Component\Serializer\Annotation\SerializedPath" must be a valid property path.');
+        $this->expectExceptionMessage('Parameter given to "Symfony\Component\Serializer\Annotation\SerializedPath" must be a valid property path.');
 
         new SerializedPath('');
     }
diff --git a/Tests/NameConverter/MetadataAwareNameConverterTest.php b/Tests/NameConverter/MetadataAwareNameConverterTest.php
@@ -168,7 +168,7 @@ public function testDenormalizeWithNestedPathAndName()
         $classMetadataFactory = new ClassMetadataFactory(new AttributeLoader());
         $nameConverter = new MetadataAwareNameConverter($classMetadataFactory);
         $this->expectException(LogicException::class);
-        $this->expectExceptionMessage('Found SerializedName and SerializedPath annotations on property "foo" of class "Symfony\Component\Serializer\Tests\NameConverter\NestedPathAndName".');
+        $this->expectExceptionMessage('Found SerializedName and SerializedPath attributes on property "foo" of class "Symfony\Component\Serializer\Tests\NameConverter\NestedPathAndName".');
         $nameConverter->denormalize('foo', NestedPathAndName::class);
     }
 
@@ -177,7 +177,7 @@ public function testNormalizeWithNestedPathAndName()
         $classMetadataFactory = new ClassMetadataFactory(new AttributeLoader());
         $nameConverter = new MetadataAwareNameConverter($classMetadataFactory);
         $this->expectException(LogicException::class);
-        $this->expectExceptionMessage('Found SerializedName and SerializedPath annotations on property "foo" of class "Symfony\Component\Serializer\Tests\NameConverter\NestedPathAndName".');
+        $this->expectExceptionMessage('Found SerializedName and SerializedPath attributes on property "foo" of class "Symfony\Component\Serializer\Tests\NameConverter\NestedPathAndName".');
         $nameConverter->normalize('foo', NestedPathAndName::class);
     }
 }
diff --git a/Tests/Normalizer/AbstractObjectNormalizerTest.php b/Tests/Normalizer/AbstractObjectNormalizerTest.php
@@ -187,7 +187,7 @@ public function testDenormalizeWithNestedAttributes()
     public function testDenormalizeWithNestedAttributesDuplicateKeys()
     {
         $this->expectException(LogicException::class);
-        $this->expectExceptionMessage('Duplicate values for key "quux" found. One value is set via the SerializedPath annotation: "one->four", the other one is set via the SerializedName annotation: "notquux".');
+        $this->expectExceptionMessage('Duplicate values for key "quux" found. One value is set via the SerializedPath attribute: "one->four", the other one is set via the SerializedName attribute: "notquux".');
         $normalizer = new AbstractObjectNormalizerWithMetadata();
         $data = [
             'one' => [

Original file line number	Diff line number	Diff line change
`@@ -39,14 +39,14 @@ public function __construct(`
`39`	`39`	`string\|array $groups = [],`
`40`	`40`	`) {`
`41`	`41`	`if (!$context && !$normalizationContext && !$denormalizationContext) {`
`42`		`- throw new InvalidArgumentException(sprintf('At least one of the "context", "normalizationContext", or "denormalizationContext" options of annotation "%s" must be provided as a non-empty array.', static::class));`
	`42`	`+ throw new InvalidArgumentException(sprintf('At least one of the "context", "normalizationContext", or "denormalizationContext" options must be provided as a non-empty array to "%s".', static::class));`
`43`	`43`	`}`
`44`	`44`
`45`	`45`	`$this->groups = (array) $groups;`
`46`	`46`
`47`	`47`	`foreach ($this->groups as $group) {`
`48`	`48`	`if (!\is_string($group)) {`
`49`		`- throw new InvalidArgumentException(sprintf('Parameter "groups" of annotation "%s" must be a string or an array of strings. Got "%s".', static::class, get_debug_type($group)));`
	`49`	`+ throw new InvalidArgumentException(sprintf('Parameter "groups" given to "%s" must be a string or an array of strings, "%s" given.', static::class, get_debug_type($group)));`
`50`	`50`	`}`
`51`	`51`	`}`
`52`	`52`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,11 +30,11 @@ public function __construct(`
`30`	`30`	`private readonly array $mapping,`
`31`	`31`	`) {`
`32`	`32`	`if (empty($typeProperty)) {`
`33`		`- throw new InvalidArgumentException(sprintf('Parameter "typeProperty" of annotation "%s" cannot be empty.', static::class));`
	`33`	`+ throw new InvalidArgumentException(sprintf('Parameter "typeProperty" given to "%s" cannot be empty.', static::class));`
`34`	`34`	`}`
`35`	`35`
`36`	`36`	`if (empty($mapping)) {`
`37`		`- throw new InvalidArgumentException(sprintf('Parameter "mapping" of annotation "%s" cannot be empty.', static::class));`
	`37`	`+ throw new InvalidArgumentException(sprintf('Parameter "mapping" given to "%s" cannot be empty.', static::class));`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -38,12 +38,12 @@ public function __construct(string\|array $groups)`
`38`	`38`	`$this->groups = (array) $groups;`
`39`	`39`
`40`	`40`	`if (!$this->groups) {`
`41`		`- throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', static::class));`
	`41`	`+ throw new InvalidArgumentException(sprintf('Parameter given to "%s" cannot be empty.', static::class));`
`42`	`42`	`}`
`43`	`43`
`44`	`44`	`foreach ($this->groups as $group) {`
`45`	`45`	`if (!\is_string($group) \|\| '' === $group) {`
`46`		`- throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a string or an array of non-empty strings.', static::class));`
	`46`	`+ throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a string or an array of non-empty strings.', static::class));`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ class MaxDepth`
`28`	`28`	`public function __construct(private readonly int $maxDepth)`
`29`	`29`	`{`
`30`	`30`	`if ($maxDepth <= 0) {`
`31`		`- throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a positive integer.', static::class));`
	`31`	`+ throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a positive integer.', static::class));`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ final class SerializedName`
`28`	`28`	`public function __construct(private readonly string $serializedName)`
`29`	`29`	`{`
`30`	`30`	`if ('' === $serializedName) {`
`31`		`- throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a non-empty string.', self::class));`
	`31`	`+ throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a non-empty string.', self::class));`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function __construct(string $serializedPath)`
`34`	`34`	`try {`
`35`	`35`	`$this->serializedPath = new PropertyPath($serializedPath);`
`36`	`36`	`} catch (InvalidPropertyPathException $pathException) {`
`37`		`- throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a valid property path.', self::class));`
	`37`	`+ throw new InvalidArgumentException(sprintf('Parameter given to "%s" must be a valid property path.', self::class));`
`38`	`38`	`}`
`39`	`39`	`}`
`40`	`40`
Original file line number	Diff line number	Diff line change
`@@ -80,7 +80,7 @@ private function getCacheValueForNormalization(string $propertyName, string $cla`
`80`	`80`	`}`
`81`	`81`
`82`	`82`	`if (null !== $attributesMetadata[$propertyName]->getSerializedName() && null !== $attributesMetadata[$propertyName]->getSerializedPath()) {`
`83`		`- throw new LogicException(sprintf('Found SerializedName and SerializedPath annotations on property "%s" of class "%s".', $propertyName, $class));`
	`83`	`+ throw new LogicException(sprintf('Found SerializedName and SerializedPath attributes on property "%s" of class "%s".', $propertyName, $class));`
`84`	`84`	`}`
`85`	`85`
`86`	`86`	`return $attributesMetadata[$propertyName]->getSerializedName() ?? null;`
`@@ -124,7 +124,7 @@ private function getCacheValueForAttributesMetadata(string $class, array $contex`
`124`	`124`	`}`
`125`	`125`
`126`	`126`	`if (null !== $metadata->getSerializedName() && null !== $metadata->getSerializedPath()) {`
`127`		`- throw new LogicException(sprintf('Found SerializedName and SerializedPath annotations on property "%s" of class "%s".', $name, $class));`
	`127`	`+ throw new LogicException(sprintf('Found SerializedName and SerializedPath attributes on property "%s" of class "%s".', $name, $class));`
`128`	`128`	`}`
`129`	`129`
`130`	`130`	`$metadataGroups = $metadata->getGroups();`
Original file line number	Diff line number	Diff line change
`@@ -349,7 +349,7 @@ public function denormalize(mixed $data, string $type, string $format = null, ar`
`349`	`349`	`$notConverted = $attribute;`
`350`	`350`	`$attribute = $this->nameConverter->denormalize($attribute, $resolvedClass, $format, $context);`
`351`	`351`	`if (isset($nestedData[$notConverted]) && !isset($originalNestedData[$attribute])) {`
`352`		`- throw new LogicException(sprintf('Duplicate values for key "%s" found. One value is set via the SerializedPath annotation: "%s", the other one is set via the SerializedName annotation: "%s".', $notConverted, implode('->', $nestedAttributes[$notConverted]->getElements()), $attribute));`
	`352`	`+ throw new LogicException(sprintf('Duplicate values for key "%s" found. One value is set via the SerializedPath attribute: "%s", the other one is set via the SerializedName attribute: "%s".', $notConverted, implode('->', $nestedAttributes[$notConverted]->getElements()), $attribute));`
`353`	`353`	`}`
`354`	`354`	`}`
`355`	`355`
`@@ -756,7 +756,7 @@ private function isUninitializedValueError(\Error $e): bool`
`756`	`756`	`}`
`757`	`757`
`758`	`758`	`/**`
`759`		`- * Returns all attributes with a SerializedPath annotation and the respective path.`
	`759`	`+ * Returns all attributes with a SerializedPath attribute and the respective path.`
`760`	`760`	`*/`
`761`	`761`	`private function getNestedAttributes(string $class): array`
`762`	`762`	`{`
Original file line number	Diff line number	Diff line change
`@@ -32,15 +32,15 @@ protected function setUp(): void`
`32`	`32`	`public function testThrowsOnEmptyContext()`
`33`	`33`	`{`
`34`	`34`	`$this->expectException(InvalidArgumentException::class);`
`35`		`- $this->expectExceptionMessage('At least one of the "context", "normalizationContext", or "denormalizationContext" options of annotation "Symfony\Component\Serializer\Annotation\Context" must be provided as a non-empty array.');`
	`35`	`+ $this->expectExceptionMessage('At least one of the "context", "normalizationContext", or "denormalizationContext" options must be provided as a non-empty array to "Symfony\Component\Serializer\Annotation\Context".');`
`36`	`36`
`37`	`37`	`new Context();`
`38`	`38`	`}`
`39`	`39`
`40`	`40`	`public function testInvalidGroupOption()`
`41`	`41`	`{`
`42`	`42`	`$this->expectException(InvalidArgumentException::class);`
`43`		`- $this->expectExceptionMessage(sprintf('Parameter "groups" of annotation "%s" must be a string or an array of strings. Got "stdClass"', Context::class));`
	`43`	`+ $this->expectExceptionMessage(sprintf('Parameter "groups" given to "%s" must be a string or an array of strings, "stdClass" given', Context::class));`
`44`	`44`
`45`	`45`	`new Context(context: ['foo' => 'bar'], groups: ['fine', new \stdClass()]);`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -27,7 +27,7 @@ class MaxDepthTest extends TestCase`
`27`	`27`	`public function testNotAnIntMaxDepthParameter(int $value)`
`28`	`28`	`{`
`29`	`29`	`$this->expectException(InvalidArgumentException::class);`
`30`		`- $this->expectExceptionMessage('Parameter of annotation "Symfony\Component\Serializer\Annotation\MaxDepth" must be a positive integer.');`
	`30`	`+ $this->expectExceptionMessage('Parameter given to "Symfony\Component\Serializer\Annotation\MaxDepth" must be a positive integer.');`
`31`	`31`	`new MaxDepth($value);`
`32`	`32`	`}`
`33`	`33`