chore: cleanup property path classes

CHANGELOG.md

@@ -11,6 +11,7 @@
 * feat: property path support in `Map` attributes
 * fix: writing using property path
 * fix: data collector output for property path
+* chore: cleanup property path classes
 
 ## 1.8.0
 

psalm.xml

@@ -72,14 +72,14 @@
             <errorLevel type="suppress">
                 <file name="src/Transformer/ObjectToObjectMetadata/Implementation/ObjectToObjectMetadataFactory.php" />
                 <file name="src/Util/ClassUtil.php" />
-                <file name="src/Transformer/ObjectToObjectMetadata/Implementation/Util/PropertyMetadataResolver.php" />
+                <file name="src/Transformer/ObjectToObjectMetadata/Implementation/Util/PropertyMetadataFactory.php" />
             </errorLevel>
         </InternalMethod>
         <InternalClass>
             <errorLevel type="suppress">
                 <file name="src/Transformer/ObjectToObjectMetadata/Implementation/ObjectToObjectMetadataFactory.php" />
                 <file name="src/Util/ClassUtil.php" />
-                <file name="src/Transformer/ObjectToObjectMetadata/Implementation/Util/PropertyMetadataResolver.php" />
+                <file name="src/Transformer/ObjectToObjectMetadata/Implementation/Util/PropertyMetadataFactory.php" />
             </errorLevel>
         </InternalClass>
         <UndefinedClass>

src/Transformer/Exception/PropertyPathResolverException.php → src/Transformer/Exception/PropertyPathAwarePropertyTypeExtractorException.php

@@ -18,11 +18,8 @@
 /**
  * @internal
  */
-class PropertyPathResolverException extends \LogicException implements ExceptionInterface
+class PropertyPathAwarePropertyTypeExtractorException extends \LogicException implements ExceptionInterface
 {
-    /**
-     * @param class-string $class
-     */
     public function __construct(string $message, string $class, string $propertyPath)
     {
         $message = \sprintf('%s, root class: "%s", property path: "%s"', $message, $class, $propertyPath);

src/Transformer/ObjectToObjectMetadata/Implementation/ObjectToObjectMetadataFactory.php

@@ -21,7 +21,7 @@
 use Rekalogika\Mapper\Transformer\Exception\InternalClassUnsupportedException;
 use Rekalogika\Mapper\Transformer\Exception\SourceClassNotInInheritanceMapException;
 use Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\Implementation\Util\PropertyMappingResolver;
-use Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\Implementation\Util\PropertyMetadataResolver;
+use Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\Implementation\Util\PropertyMetadataFactory;
 use Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\ObjectToObjectMetadata;
 use Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\ObjectToObjectMetadataFactoryInterface;
 use Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\PropertyMapping;
@@ -38,7 +38,8 @@
  */
 final readonly class ObjectToObjectMetadataFactory implements ObjectToObjectMetadataFactoryInterface
 {
-    private PropertyMetadataResolver $propertyMetadataResolver;
+    private PropertyMetadataFactory $propertyMetadataFactory;
+
     private PropertyMappingResolver $propertyMappingResolver;
 
     public function __construct(
@@ -51,7 +52,7 @@ public function __construct(
         private ProxyFactoryInterface $proxyFactory,
         TypeResolverInterface $typeResolver,
     ) {
-        $this->propertyMetadataResolver = new PropertyMetadataResolver(
+        $this->propertyMetadataFactory = new PropertyMetadataFactory(
             propertyReadInfoExtractor: $propertyReadInfoExtractor,
             propertyWriteInfoExtractor: $propertyWriteInfoExtractor,
             propertyTypeExtractor: $propertyTypeExtractor,
@@ -192,14 +193,14 @@ public function createObjectToObjectMetadata(
 
             // generate source & target property metadata
 
-            $sourcePropertyMetadata = $this->propertyMetadataResolver
+            $sourcePropertyMetadata = $this->propertyMetadataFactory
                 ->createSourcePropertyMetadata(
                     class: $sourceClass,
                     property: $sourceProperty,
                     allowsDynamicProperties: $sourceAllowsDynamicProperties,
                 );
 
-            $targetPropertyMetadata = $this->propertyMetadataResolver
+            $targetPropertyMetadata = $this->propertyMetadataFactory
                 ->createTargetPropertyMetadata(
                     class: $targetClass,
                     property: $targetProperty,

src/Transformer/ObjectToObjectMetadata/Implementation/Util/PropertyMetadataResolver.php → src/Transformer/ObjectToObjectMetadata/Implementation/Util/PropertyMetadataFactory.php

@@ -33,18 +33,18 @@
 /**
  * @internal
  */
-final readonly class PropertyMetadataResolver
+final readonly class PropertyMetadataFactory
 {
-    private PropertyPathResolver $propertyPathResolver;
+    private PropertyTypeExtractorInterface $propertyTypeExtractor;
 
     public function __construct(
         private PropertyReadInfoExtractorInterface $propertyReadInfoExtractor,
         private PropertyWriteInfoExtractorInterface $propertyWriteInfoExtractor,
-        private PropertyTypeExtractorInterface $propertyTypeExtractor,
+        PropertyTypeExtractorInterface $propertyTypeExtractor,
         private TypeResolverInterface $typeResolver,
     ) {
-        $this->propertyPathResolver = new PropertyPathResolver(
-            propertyTypeExtractor: $propertyTypeExtractor,
+        $this->propertyTypeExtractor = new PropertyPathAwarePropertyTypeExtractor(
+            decorated: $propertyTypeExtractor,
         );
     }
 
@@ -57,10 +57,7 @@ public function createSourcePropertyMetadata(
         bool $allowsDynamicProperties,
     ): SourcePropertyMetadata {
         if ($this->isPropertyPath($property)) {
-            $types = $this->propertyPathResolver->resolvePropertyPath(
-                class: $class,
-                propertyPath: $property,
-            );
+            $types = array_values($this->propertyTypeExtractor->getTypes($class, $property) ?? []);
 
             return new SourcePropertyMetadata(
                 readMode: ReadMode::PropertyPath,
@@ -106,10 +103,7 @@ public function createTargetPropertyMetadata(
         bool $allowsDynamicProperties,
     ): TargetPropertyMetadata {
         if ($this->isPropertyPath($property)) {
-            $types = $this->propertyPathResolver->resolvePropertyPath(
-                class: $class,
-                propertyPath: $property,
-            );
+            $types = array_values($this->propertyTypeExtractor->getTypes($class, $property) ?? []);
 
             return new TargetPropertyMetadata(
                 readMode: ReadMode::PropertyPath,
@@ -318,7 +312,6 @@ private function processPropertyWriteInfo(
 
     /**
      * @param class-string $class
-     * @return boolean
      */
     private function sourceAllowsTargetDelete(
         string $class,
@@ -347,7 +340,6 @@ class: $class,
 
     /**
      * @param class-string $class
-     * @return boolean
      */
     private function targetAllowsDelete(
         string $class,

src/Transformer/ObjectToObjectMetadata/Implementation/Util/PropertyPathResolver.php → src/Transformer/ObjectToObjectMetadata/Implementation/Util/PropertyPathAwarePropertyTypeExtractor.php

@@ -13,30 +13,49 @@
 
 namespace Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\Implementation\Util;
 
-use Rekalogika\Mapper\Transformer\Exception\PropertyPathResolverException;
+use Rekalogika\Mapper\Transformer\Exception\PropertyPathAwarePropertyTypeExtractorException;
 use Symfony\Component\PropertyAccess\PropertyPath;
 use Symfony\Component\PropertyAccess\PropertyPathIteratorInterface;
 use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
 use Symfony\Component\PropertyInfo\Type;
+use Symfony\Component\TypeInfo\Type as TypeInfoType;
 
 /**
  * @internal
  */
-final readonly class PropertyPathResolver
+final readonly class PropertyPathAwarePropertyTypeExtractor implements PropertyTypeExtractorInterface
 {
     public function __construct(
-        private PropertyTypeExtractorInterface $propertyTypeExtractor,
+        private PropertyTypeExtractorInterface $decorated,
     ) {}
 
     /**
-     * @param class-string $class
-     * @return list<Type>
+     * @param array<string,mixed> $context
+     * @return TypeInfoType
      */
-    public function resolvePropertyPath(
+    public function getType(
         string $class,
-        string $propertyPath,
-    ): array {
-        $propertyPathObject = new PropertyPath($propertyPath);
+        string $property,
+        array $context = [],
+    ) {
+        throw new \BadMethodCallException('Not implemented');
+    }
+
+    /**
+     * @param array<array-key,mixed> $context
+     * @return null|array<array-key,Type>
+     */
+    #[\Override]
+    public function getTypes(
+        string $class,
+        string $property,
+        array $context = [],
+    ): ?array {
+        if (!$this->isPropertyPath($property)) {
+            return $this->decorated->getTypes($class, $property, $context);
+        }
+
+        $propertyPathObject = new PropertyPath($property);
 
         /** @var \Iterator&PropertyPathIteratorInterface */
         $iterator = $propertyPathObject->getIterator();
@@ -55,10 +74,10 @@
 
             if ($types !== null) {
                 if (\count($types) > 1) {
-                    throw new PropertyPathResolverException(
+                    throw new PropertyPathAwarePropertyTypeExtractorException(
                         message: \sprintf('Cannot proceed because property "%s" has multiple types in class "%s"', $propertyPathPart, $currentClass ?? 'unknown'),
                         class: $class,
-                        propertyPath: $propertyPath,
+                        propertyPath: $property,
                     );
                 }
 
@@ -71,33 +90,38 @@
                 $types = $currentType?->getCollectionValueTypes();
             } else {
                 if ($currentClass === null) {
-                    throw new PropertyPathResolverException(
+                    throw new PropertyPathAwarePropertyTypeExtractorException(
                         message: \sprintf('Trying to resolve path "%s", but the current node is not an object', $propertyPathPart),
                         class: $class,
-                        propertyPath: $propertyPath,
+                        propertyPath: $property,
                     );
                 }
 
                 $currentPath .= '.' . $propertyPathPart;
-                $types = $this->propertyTypeExtractor
-                    ->getTypes($currentClass, $propertyPathPart);
+                $types = $this->decorated
+                    ->getTypes($currentClass, $propertyPathPart, $context);
             }
 
             if ($types === null) {
-                throw new PropertyPathResolverException(
+                throw new PropertyPathAwarePropertyTypeExtractorException(
                     message: \sprintf('Property "%s" not found in class "%s"', $propertyPathPart, $currentClass ?? 'unknown'),
                     class: $class,
-                    propertyPath: $propertyPath,
+                    propertyPath: $property,
                 );
             } elseif (\count($types) === 0) {
-                throw new PropertyPathResolverException(
+                throw new PropertyPathAwarePropertyTypeExtractorException(
                     message: \sprintf('Cannot determine the type of property "%s" in class "%s"', $propertyPathPart, $currentClass ?? 'unknown'),
                     class: $class,
-                    propertyPath: $propertyPath,
+                    propertyPath: $property,
                 );
             }
         }
 
         return array_values($types ?? []);
     }
+
+    private function isPropertyPath(string $property): bool
+    {
+        return str_contains($property, '.') || str_contains($property, '[');
+    }
 }

tests/src/Fixtures/MapPropertyPath/Book.php

@@ -23,7 +23,7 @@ final class Book
     /**
      * @var Collection<int,Chapter>
      */
-    private Collection $chapters;
+    private readonly Collection $chapters;
 
     public function __construct()
     {
@@ -70,8 +70,4 @@ public function getParts(): Collection
     {
         return new ArrayCollection();
     }
-
-    public function addPart(Chapter|Section $chapter): void {}
-
-    public function removePart(Chapter|Section $chapter): void {}
 }

tests/src/Fixtures/MapPropertyPath/Library.php

@@ -21,7 +21,7 @@ final class Library
     /**
      * @var Collection<int,Shelf>
      */
-    private Collection $shelves;
+    private readonly Collection $shelves;
 
     private ?string $name = null;
 

tests/src/Fixtures/MapPropertyPath/Shelf.php

@@ -23,7 +23,7 @@ final class Shelf
     /**
      * @var Collection<int,Book>
      */
-    private Collection $books;
+    private readonly Collection $books;
 
     private ?int $number = null;
 

tests/src/IntegrationTest/MapPropertyPathTest.php

@@ -23,8 +23,8 @@
 use Rekalogika\Mapper\Tests\Fixtures\MapPropertyPath\Shelf;
 use Rekalogika\Mapper\Tests\Fixtures\MapPropertyPathDto\BookDto;
 use Rekalogika\Mapper\Tests\Fixtures\MapPropertyPathDto\ChapterDto;
-use Rekalogika\Mapper\Transformer\Exception\PropertyPathResolverException;
-use Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\Implementation\Util\PropertyPathResolver;
+use Rekalogika\Mapper\Transformer\Exception\PropertyPathAwarePropertyTypeExtractorException;
+use Rekalogika\Mapper\Transformer\ObjectToObjectMetadata\Implementation\Util\PropertyPathAwarePropertyTypeExtractor;
 use Symfony\Component\PropertyInfo\PropertyTypeExtractorInterface;
 use Symfony\Component\PropertyInfo\Type;
 
@@ -33,9 +33,9 @@ class MapPropertyPathTest extends FrameworkTestCase
     /**
      * @param class-string $class
      * @param list<Type>|class-string<ExceptionInterface> $expected
-     * @dataProvider propertyPathResolverDataProvider
+     * @dataProvider propertyPathAwarePropertyTypeExtractorDataProvider
      */
-    public function testPropertyPathResolver(
+    public function testPropertyPathAwarePropertyTypeExtractor(
         string $class,
         string $path,
         array|string $expected,
@@ -44,8 +44,7 @@ public function testPropertyPathResolver(
             $this->expectException($expected);
         }
 
-        $propertyTypeExtractor = $this->get(PropertyTypeExtractorInterface::class);
-        $propertyPathResolver = new PropertyPathResolver($propertyTypeExtractor);
+        $propertyTypeExtractor = new PropertyPathAwarePropertyTypeExtractor($this->get(PropertyTypeExtractorInterface::class));
 
         $chapter = new Chapter();
 
@@ -58,15 +57,15 @@ public function testPropertyPathResolver(
         $library = new Library();
         $library->addShelf($shelf);
 
-        $type = $propertyPathResolver->resolvePropertyPath($class, $path);
+        $type = $propertyTypeExtractor->getTypes($class, $path);
 
         $this->assertEquals($expected, $type);
     }
 
     /**
      * @return iterable<int|string,array{class-string,string,list<Type>|class-string<ExceptionInterface>}>
      */
-    public static function propertyPathResolverDataProvider(): iterable
+    public static function propertyPathAwarePropertyTypeExtractorDataProvider(): iterable
     {
         yield [
             Book::class,
@@ -141,7 +140,7 @@ class: Chapter::class,
         yield [
             Chapter::class,
             'book.shelf.library.foo',
-            PropertyPathResolverException::class,
+            PropertyPathAwarePropertyTypeExtractorException::class,
         ];
 
         yield [