Merge pull request #51 from rebuy-de/attribute-support

Add attribute support, remove deprecations, unify `JMSParser`

Author: dbu

CHANGELOG.md

@@ -10,6 +10,8 @@
 * `JMSTypeParser::getTraversableClass` returns `Traversable::class` instead of `Doctrine\Common\Collections\Collection` for general traversable properties.
 * Dropped support for PHP 7
 * Adjusted code to not trigger warnings with PHP 8.4
+* Removed deprecated `getDeserializeFormat` method from date time
+* Add attribute support for the `@Preferred` annotation 
 
 # Version 1.x
 

composer.json

@@ -16,7 +16,7 @@
     "require": {
         "php": "^8.0",
         "ext-json": "*",
-        "doctrine/annotations": "^1.13 || ^2.0.1",
+        "doctrine/annotations": "^2.0.1",
         "psr/log": "^1|^2|^3"
     },
     "require-dev": {

src/Annotation/Preferred.php

@@ -13,6 +13,7 @@
  * @Annotation
  * @Target({"METHOD", "PROPERTY"})
  */
+#[\Attribute(\Attribute::TARGET_METHOD | \Attribute::TARGET_PROPERTY)]
 final class Preferred
 {
 }

src/Metadata/DateTimeOptions.php

@@ -29,13 +29,13 @@ final class DateTimeOptions implements \JsonSerializable
     /**
      * @note Passing a string for $deserializeFormats is deprecated, please pass an array instead
      *
-     * @param string[]|string|null $deserializeFormats
+     * @param string[]|null $deserializeFormats
      */
-    public function __construct(?string $format, ?string $zone, $deserializeFormats)
+    public function __construct(?string $format, ?string $zone, ?array $deserializeFormats)
     {
         $this->format = $format;
         $this->zone = $zone;
-        $this->deserializeFormats = \is_string($deserializeFormats) ? [$deserializeFormats] : $deserializeFormats;
+        $this->deserializeFormats = $deserializeFormats;
     }
 
     public function getFormat(): ?string
@@ -48,18 +48,6 @@ public function getZone(): ?string
         return $this->zone;
     }
 
-    /**
-     * @deprecated Please use {@see getDeserializeFormats}
-     */
-    public function getDeserializeFormat(): ?string
-    {
-        foreach ($this->deserializeFormats ?? [] as $format) {
-            return $format;
-        }
-
-        return null;
-    }
-
     public function getDeserializeFormats(): ?array
     {
         return $this->deserializeFormats;
@@ -70,7 +58,6 @@ public function jsonSerialize(): array
         return array_filter([
             'format' => $this->format,
             'zone' => $this->zone,
-            'deserialize_format' => $this->getDeserializeFormat(),
             'deserialize_formats' => $this->deserializeFormats,
         ]);
     }

src/Metadata/PropertyTypeDateTime.php

@@ -58,18 +58,6 @@ public function getZone(): ?string
         return null;
     }
 
-    /**
-     * @deprecated Please prefer {@link getDeserializeFormats}
-     */
-    public function getDeserializeFormat(): ?string
-    {
-        if ($this->dateTimeOptions) {
-            return $this->dateTimeOptions->getDeserializeFormat();
-        }
-
-        return null;
-    }
-
     public function getDeserializeFormats(): ?array
     {
         if ($this->dateTimeOptions) {

src/ModelParser/JMSParser.php

@@ -52,7 +52,7 @@
  *
  * @internal
  */
-abstract class BaseJMSParser implements ModelParserInterface
+final class JMSParser implements ModelParserInterface
 {
     private const ACCESS_ORDER_CUSTOM = 'custom';
 
@@ -69,7 +69,7 @@ abstract class BaseJMSParser implements ModelParserInterface
     /**
      * @var JMSTypeParser
      */
-    protected $jmsTypeParser;
+    private $jmsTypeParser;
 
     public function __construct(Reader $annotationsReader)
     {
@@ -228,22 +228,9 @@ private function gatherClassAnnotations(\ReflectionClass $reflectionClass): arra
         return $map;
     }
 
-    /**
-     * If the annotation is about readonly information, update the $property accordingly and return true.
-     *
-     * This check is extracted to have different implementations for PHP 8.1 and newer, and for older PHP versions.
-     * If the method returns true, we don't try to match the annotation type.
-     *
-     * @return bool whether $annotation was a readonly information
-     */
-    abstract protected function parsePropertyAnnotationsReadOnly(object $annotation, PropertyVariationMetadata $property): bool;
-
     private function parsePropertyAnnotations(RawClassMetadata $classMetadata, PropertyVariationMetadata $property, array $annotations): void
     {
         foreach ($annotations as $annotation) {
-            if ($this->parsePropertyAnnotationsReadOnly($annotation, $property)) {
-                continue;
-            }
             switch (true) {
                 case $annotation instanceof Type:
                     if (null === $annotation->name) {
@@ -289,6 +276,10 @@ private function parsePropertyAnnotations(RawClassMetadata $classMetadata, Prope
                     $property->setVersionRange($property->getVersionRange()->withUntil($annotation->version));
                     break;
 
+                case $annotation instanceof ReadOnlyProperty:
+                    $property->setReadOnly(true);
+                    break;
+
                 case $annotation instanceof MaxDepth:
                     $property->setMaxDepth($annotation->depth);
                     break;
@@ -430,24 +421,3 @@ private function getMethodName(array $annotations, \ReflectionMethod $reflMethod
         return $name;
     }
 }
-
-if (\PHP_VERSION_ID > 80100) {
-    /**
-     * Version for PHP 8.1+ without the ReadOnly annotation.
-     */
-    final class JMSParser extends BaseJMSParser
-    {
-        protected function parsePropertyAnnotationsReadOnly(object $annotation, PropertyVariationMetadata $property): bool
-        {
-            if ($annotation instanceof ReadOnlyProperty) {
-                $property->setReadOnly($annotation->readOnly);
-
-                return true;
-            }
-
-            return false;
-        }
-    }
-} else {
-    require 'JMSParserLegacy.php';
-}

src/ModelParser/JMSParserLegacy.php

@@ -21,10 +21,7 @@
  */
 final class LiipMetadataAnnotationParser implements ModelParserInterface
 {
-    /**
-     * @var Reader
-     */
-    private $annotationsReader;
+    private Reader $annotationsReader;
 
     public function __construct(Reader $annotationsReader)
     {
@@ -54,11 +51,7 @@ private function parseProperties(\ReflectionClass $reflClass, RawClassMetadata $
                 continue;
             }
 
-            try {
-                $annotations = $this->annotationsReader->getPropertyAnnotations($reflProperty);
-            } catch (AnnotationException $e) {
-                throw ParseException::propertyError((string) $classMetadata, $reflProperty->getName(), $e);
-            }
+            $annotations = $this->getPropertyAnnotations($classMetadata, $reflProperty);
 
             $property = $classMetadata->getPropertyVariation($reflProperty->getName());
             $this->parsePropertyAnnotations($classMetadata, $property, $annotations);
@@ -79,11 +72,7 @@ private function parseMethods(\ReflectionClass $reflClass, RawClassMetadata $cla
                 continue;
             }
 
-            try {
-                $annotations = $this->annotationsReader->getMethodAnnotations($reflMethod);
-            } catch (AnnotationException $e) {
-                throw ParseException::propertyError((string) $classMetadata, $reflMethod->getName(), $e);
-            }
+            $annotations = $this->getMethodAnnotations($classMetadata, $reflMethod);
 
             $property = $classMetadata->getPropertyVariation($this->getMethodName($reflMethod));
             $this->parsePropertyAnnotations($classMetadata, $property, $annotations);
@@ -117,4 +106,38 @@ private function getMethodName(\ReflectionMethod $reflMethod): string
 
         return $name;
     }
+
+    private function getMethodAnnotations(RawClassMetadata $classMetadata, \ReflectionMethod $reflectionMethod): array
+    {
+        try {
+            $annotations = $this->annotationsReader->getMethodAnnotations($reflectionMethod);
+        } catch (AnnotationException $e) {
+            throw ParseException::propertyError((string) $classMetadata, $reflectionMethod->getName(), $e);
+        }
+
+        $attributes = $reflectionMethod->getAttributes();
+        $attributes = array_map(
+            static fn (\ReflectionAttribute $attribute) => $attribute->newInstance(),
+            $attributes
+        );
+
+        return array_merge($attributes, $annotations);
+    }
+
+    private function getPropertyAnnotations(RawClassMetadata $classMetadata, \ReflectionProperty $reflectionProperty): array
+    {
+        try {
+            $annotations = $this->annotationsReader->getPropertyAnnotations($reflectionProperty);
+        } catch (AnnotationException $e) {
+            throw ParseException::propertyError((string) $classMetadata, $reflectionProperty->getName(), $e);
+        }
+
+        $attributes = $reflectionProperty->getAttributes();
+        $attributes = array_map(
+            static fn (\ReflectionAttribute $attribute) => $attribute->newInstance(),
+            $attributes
+        );
+
+        return array_merge($attributes, $annotations);
+    }
 }