chore: New naming scheme for attributes (#12)

.github/workflows/ci.yml

@@ -22,7 +22,7 @@ jobs:
     - name: PHPStan
       run: vendor/bin/phpstan
     - name: PHPUnit
-      run: vendor/bin/phpunit --coverage-clover=coverage.xml
+      run: vendor/bin/phpunit
 
     - name: Upload coverage reports to Codecov
       uses: codecov/[email protected]

.gitignore

@@ -3,4 +3,4 @@
 /.phpunit.cache/
 /var/
 composer.lock
-coverage.xml
+clover.xml

README.md

@@ -14,7 +14,7 @@ You can also use it to map SQL queries to objects, it has no dependency on a par
 
 ### At a glance
 
-Given a DTO such as [AuthorDTO](tests/Examples/Valid/ReferencesArray/AuthorDTO.php)
+Given a DTO such as [AuthorDTO](tests/Examples/Valid/ReferenceArray/AuthorDTO.php)
 
 ```php 
 $result = $flatMapper->map(AuthorDTO::class, $authorRepository->getAuthorsAndTheirBooks());
@@ -77,18 +77,18 @@ This bundle comes with several attributes that you can use to add mapping to you
   - Use it as a Class attribute if you don't intend to use the property yourself ([see example](tests/Examples/Valid/Complex/ProductDTO.php)). It will then only be used internally and not be mapped to your DTO.
   - Use it as a Property attribute if you have some use for it ([see example](tests/Examples/Valid/Complex/CustomerDTO.php)).
   - Specify the mapped property name directly on the attribute ([see example](tests/Examples/Valid/Complex/InvoiceDTO.php)). This is mandatory when used as a Class attribute.
-  - Specify the mapped property name separately with the `InboundProperty` attribute, Doctrine-style ([see example](tests/Examples/Valid/ReferencesArray/AuthorDTO.php)).
-- `#[InboundProperty("mapped_property_name")]`: The name of the key on the associative arrays contained by your result set. This is optional if your DTO's property names are already matching the result set ([see example](tests/Examples/Valid/WithoutAttributeDTO.php)).
-- `#[ReferencesArray(NestedDTO::class)]`: An array of `NestedDTO` will be created using the mapping information contained in `NestedDTO`.
-- `#[ColumnArray("mapped_property_name")]` the column `mapped_property_name` of your result set will be mapped as an array of scalar properties (such as IDs).
+  - Specify the mapped property name separately with the `InboundProperty` attribute, Doctrine-style ([see example](tests/Examples/Valid/ReferenceArray/AuthorDTO.php)).
+- `#[Scalar("mapped_property_name")]`: The name of the key on the associative arrays contained by your result set. This is optional if your DTO's property names are already matching the result set ([see example](tests/Examples/Valid/WithoutAttributeDTO.php)).
+- `#[ReferenceArray(NestedDTO::class)]`: An array of `NestedDTO` will be created using the mapping information contained in `NestedDTO`.
+- `#[ScalarArray("mapped_property_name")]` the column `mapped_property_name` of your result set will be mapped as an array of scalar properties, such as IDs ([see example](tests/Examples/Valid/ScalarArray/ScalarArrayDTO.php)).
 
 <a name="complete_example"></a>
 ### Hydrating nested DTOs
 
 Given:
 
-- [AuthorDTO](tests/Examples/Valid/ReferencesArray/AuthorDTO.php)
-- [BookDTO](tests/Examples/Valid/ReferencesArray/BookDTO.php)
+- [AuthorDTO](tests/Examples/Valid/ReferenceArray/AuthorDTO.php)
+- [BookDTO](tests/Examples/Valid/ReferenceArray/BookDTO.php)
 
 Calling FlatMapper with the following result set:
 
@@ -160,7 +160,7 @@ Array
 
 ### Hydrating Column Arrays
 
-Given [ColumnArrayDTO](tests/Examples/Valid/ColumnArray/ColumnArrayDTO.php)
+Given [ScalarArrayDTO](tests/Examples/Valid/ScalarArray/ScalarArrayDTO.php)
 
 Calling FlatMapper with the following result set:
 ```php
@@ -178,7 +178,7 @@ Will output:
 ```php
 Array
 (
-    [1] => ColumnArrayDTO Object
+    [1] => ScalarArrayDTO Object
         (
             [id] => 1
             [name] => Root 1
@@ -189,7 +189,7 @@ Array
                     [2] => 3
                 )
         )
-    [2] => ColumnArrayDTO Object
+    [2] => ScalarArrayDTO Object
         (
             [id] => 2
             [name] => Root 2
@@ -212,11 +212,11 @@ class CustomerDTO
 {
     public function __construct(
         #[Identifier]
-        #[InboundPropertyName('customer_id')]
+        #[Scalar('customer_id')]
         public int $id,
-        #[InboundPropertyName('customer_name')]
+        #[Scalar('customer_name')]
         public string $name,
-        #[ColumnArray('shopping_list_id')]
+        #[ScalarArray('shopping_list_id')]
         public array $shoppingListIds
     )
 }

phpunit.xml

@@ -23,4 +23,10 @@
             <directory>src/Attributes</directory>
         </exclude>
     </source>
+
+    <coverage>
+        <report>
+            <clover outputFile="clover.xml"/>
+        </report>
+    </coverage>
 </phpunit>

src/FlatMapper.php

@@ -3,12 +3,12 @@
 
 namespace Pixelshaped\FlatMapperBundle;
 
-use Pixelshaped\FlatMapperBundle\Attributes\ColumnArray;
-use Pixelshaped\FlatMapperBundle\Attributes\Identifier;
-use Pixelshaped\FlatMapperBundle\Attributes\InboundPropertyName;
-use Pixelshaped\FlatMapperBundle\Attributes\ReferencesArray;
 use Pixelshaped\FlatMapperBundle\Exception\MappingCreationException;
 use Pixelshaped\FlatMapperBundle\Exception\MappingException;
+use Pixelshaped\FlatMapperBundle\Mapping\Identifier;
+use Pixelshaped\FlatMapperBundle\Mapping\ReferenceArray;
+use Pixelshaped\FlatMapperBundle\Mapping\Scalar;
+use Pixelshaped\FlatMapperBundle\Mapping\ScalarArray;
 use ReflectionClass;
 use Symfony\Contracts\Cache\CacheInterface;
 
@@ -95,11 +95,11 @@ private function createMappingRecursive(string $dtoClassName, array& $objectIden
             $propertyName = $reflectionParameter->getName();
             $isIdentifier = false;
             foreach ($reflectionParameter->getAttributes() as $attribute) {
-                if ($attribute->getName() === ReferencesArray::class) {
+                if ($attribute->getName() === ReferenceArray::class) {
                     $objectsMapping[$dtoClassName][$propertyName] = (string)$attribute->getArguments()[0];
                     $this->createMappingRecursive($attribute->getArguments()[0], $objectIdentifiers, $objectsMapping);
                     continue 2;
-                } else if ($attribute->getName() === ColumnArray::class) {
+                } else if ($attribute->getName() === ScalarArray::class) {
                     $objectsMapping[$dtoClassName][$propertyName] = (string)$attribute->getArguments()[0];
                     continue 2;
                 } else if ($attribute->getName() === Identifier::class) {
@@ -108,7 +108,7 @@ private function createMappingRecursive(string $dtoClassName, array& $objectIden
                     if(isset($attribute->getArguments()[0]) && $attribute->getArguments()[0] !== null) {
                         $propertyName = $attribute->getArguments()[0];
                     }
-                } else if ($attribute->getName() === InboundPropertyName::class) {
+                } else if ($attribute->getName() === Scalar::class) {
                     $propertyName = $attribute->getArguments()[0];
                 }
             }
@@ -158,14 +158,14 @@ public function map(string $dtoClassName, iterable $data): array {
                     foreach ($this->objectsMapping[$dtoClassName][$objectClass] as $objectProperty => $foreignObjectClassOrIdentifier) {
                         if($foreignObjectClassOrIdentifier !== null) {
                             if (isset($this->objectsMapping[$dtoClassName][$foreignObjectClassOrIdentifier])) {
-                                // Handles ReferencesArray attribute
+                                // Handles ReferenceArray attribute
                                 $foreignIdentifier = $this->objectIdentifiers[$dtoClassName][$foreignObjectClassOrIdentifier];
                                 if($row[$foreignIdentifier] !== null) { // As objects are constructed from leafs, this array key has already been tested when the leaf was constructed itself
                                     $referencesMap[$objectClass][$row[$identifier]][$objectProperty][$row[$foreignIdentifier]] = $objectsMap[$foreignObjectClassOrIdentifier][$row[$foreignIdentifier]];
                                 }
                                 $constructorValues[] = [];
                             } else {
-                                // Handles ColumnArray attribute
+                                // Handles ScalarArray attribute
                                 if($row[$foreignObjectClassOrIdentifier] !== null) {
                                     $referencesMap[$objectClass][$row[$identifier]][$objectProperty][] = $row[$foreignObjectClassOrIdentifier];
                                 }

src/Attributes/Identifier.php → src/Mapping/Identifier.php

@@ -1,14 +1,14 @@
 <?php
 declare(strict_types=1);
 
-namespace Pixelshaped\FlatMapperBundle\Attributes;
+namespace Pixelshaped\FlatMapperBundle\Mapping;
 
 use Attribute;
 
 #[Attribute(Attribute::TARGET_PROPERTY | Attribute::TARGET_CLASS)]
 final readonly class Identifier
 {
     public function __construct(
-        public ?string $inboundPropertyName = null
+        public ?string $mappedPropertyName = null
     ) {}
 }

src/Attributes/ReferencesArray.php → src/Mapping/ReferenceArray.php

@@ -1,15 +1,15 @@
 <?php
 declare(strict_types=1);
 
-namespace Pixelshaped\FlatMapperBundle\Attributes;
+namespace Pixelshaped\FlatMapperBundle\Mapping;
 
 use Attribute;
 
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final readonly class ReferencesArray
+final readonly class ReferenceArray
 {
     public function __construct(
         /** @var class-string */
-        public string $className
+        public string $referenceClassName
     ) {}
 }

src/Attributes/ColumnArray.php → src/Mapping/Scalar.php

@@ -1,14 +1,14 @@
 <?php
 declare(strict_types=1);
 
-namespace Pixelshaped\FlatMapperBundle\Attributes;
+namespace Pixelshaped\FlatMapperBundle\Mapping;
 
 use Attribute;
 
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final readonly class ColumnArray
+final readonly class Scalar
 {
     public function __construct(
-        public string $inboundPropertyName
+        public string $mappedPropertyName
     ) {}
 }

src/Attributes/InboundPropertyName.php → src/Mapping/ScalarArray.php

@@ -1,14 +1,14 @@
 <?php
 declare(strict_types=1);
 
-namespace Pixelshaped\FlatMapperBundle\Attributes;
+namespace Pixelshaped\FlatMapperBundle\Mapping;
 
 use Attribute;
 
 #[Attribute(Attribute::TARGET_PROPERTY)]
-final readonly class InboundPropertyName
+final readonly class ScalarArray
 {
     public function __construct(
-        public string $inboundPropertyName
+        public string $mappedPropertyName
     ) {}
 }

tests/Examples/Invalid/LeafDTO.php

@@ -3,18 +3,18 @@
 
 namespace Pixelshaped\FlatMapperBundle\Tests\Examples\Invalid;
 
-use Pixelshaped\FlatMapperBundle\Attributes\Identifier;
-use Pixelshaped\FlatMapperBundle\Attributes\InboundPropertyName;
+use Pixelshaped\FlatMapperBundle\Mapping\Identifier;
+use Pixelshaped\FlatMapperBundle\Mapping\Scalar;
 
 class LeafDTO
 {
     public function __construct(
         #[Identifier]
-        #[InboundPropertyName('object1_id')]
+        #[Scalar('object1_id')]
         public int $id,
-        #[InboundPropertyName('object2_name')]
+        #[Scalar('object2_name')]
         public string $name,
-        #[InboundPropertyName('object2_value')]
+        #[Scalar('object2_value')]
         public string $value,
     ) {}
 }

tests/Examples/Invalid/RootDTO.php

@@ -3,9 +3,9 @@
 
 namespace Pixelshaped\FlatMapperBundle\Tests\Examples\Invalid;
 
-use Pixelshaped\FlatMapperBundle\Attributes\Identifier;
-use Pixelshaped\FlatMapperBundle\Attributes\InboundPropertyName;
-use Pixelshaped\FlatMapperBundle\Attributes\ReferencesArray;
+use Pixelshaped\FlatMapperBundle\Mapping\Identifier;
+use Pixelshaped\FlatMapperBundle\Mapping\ReferenceArray;
+use Pixelshaped\FlatMapperBundle\Mapping\Scalar;
 
 class RootDTO
 {
@@ -14,11 +14,11 @@ class RootDTO
      */
     public function __construct(
         #[Identifier]
-        #[InboundPropertyName('object1_id')]
+        #[Scalar('object1_id')]
         public int $id,
-        #[InboundPropertyName('object1_name')]
+        #[Scalar('object1_name')]
         public string $name,
-        #[ReferencesArray(LeafDTO::class)]
+        #[ReferenceArray(LeafDTO::class)]
         public array $leafs,
     ) {}
 }

tests/Examples/Invalid/RootDTOWithEmptyClassIdentifier.php

@@ -3,9 +3,9 @@
 
 namespace Pixelshaped\FlatMapperBundle\Tests\Examples\Invalid;
 
-use Pixelshaped\FlatMapperBundle\Attributes\Identifier;
-use Pixelshaped\FlatMapperBundle\Attributes\InboundPropertyName;
-use Pixelshaped\FlatMapperBundle\Attributes\ReferencesArray;
+use Pixelshaped\FlatMapperBundle\Mapping\Identifier;
+use Pixelshaped\FlatMapperBundle\Mapping\ReferenceArray;
+use Pixelshaped\FlatMapperBundle\Mapping\Scalar;
 
 #[Identifier]
 class RootDTOWithEmptyClassIdentifier
@@ -14,11 +14,11 @@ class RootDTOWithEmptyClassIdentifier
      * @param array<LeafDTO> $leafs
      */
     public function __construct(
-        #[InboundPropertyName('object1_id')]
+        #[Scalar('object1_id')]
         public int $id,
-        #[InboundPropertyName('object1_name')]
+        #[Scalar('object1_name')]
         public string $name,
-        #[ReferencesArray(LeafDTO::class)]
+        #[ReferenceArray(LeafDTO::class)]
         public array $leafs,
     ) {}
 }

tests/Examples/Invalid/RootDTOWithNoIdentifier.php

@@ -3,20 +3,20 @@
 
 namespace Pixelshaped\FlatMapperBundle\Tests\Examples\Invalid;
 
-use Pixelshaped\FlatMapperBundle\Attributes\InboundPropertyName;
-use Pixelshaped\FlatMapperBundle\Attributes\ReferencesArray;
+use Pixelshaped\FlatMapperBundle\Mapping\ReferenceArray;
+use Pixelshaped\FlatMapperBundle\Mapping\Scalar;
 
 class RootDTOWithNoIdentifier
 {
     /**
      * @param array<LeafDTO> $leafs
      */
     public function __construct(
-        #[InboundPropertyName('object1_id')]
+        #[Scalar('object1_id')]
         public int $id,
-        #[InboundPropertyName('object1_name')]
+        #[Scalar('object1_name')]
         public string $name,
-        #[ReferencesArray(LeafDTO::class)]
+        #[ReferenceArray(LeafDTO::class)]
         public array $leafs,
     ) {}
 }

tests/Examples/Invalid/RootDTOWithTooManyIdentifiers.php

@@ -3,9 +3,9 @@
 
 namespace Pixelshaped\FlatMapperBundle\Tests\Examples\Invalid;
 
-use Pixelshaped\FlatMapperBundle\Attributes\Identifier;
-use Pixelshaped\FlatMapperBundle\Attributes\InboundPropertyName;
-use Pixelshaped\FlatMapperBundle\Attributes\ReferencesArray;
+use Pixelshaped\FlatMapperBundle\Mapping\Identifier;
+use Pixelshaped\FlatMapperBundle\Mapping\ReferenceArray;
+use Pixelshaped\FlatMapperBundle\Mapping\Scalar;
 
 class RootDTOWithTooManyIdentifiers
 {
@@ -14,12 +14,12 @@ class RootDTOWithTooManyIdentifiers
      */
     public function __construct(
         #[Identifier]
-        #[InboundPropertyName('object1_id')]
+        #[Scalar('object1_id')]
         public int $id,
         #[Identifier]
-        #[InboundPropertyName('object1_name')]
+        #[Scalar('object1_name')]
         public string $name,
-        #[ReferencesArray(LeafDTO::class)]
+        #[ReferenceArray(LeafDTO::class)]
         public array $leafs,
     ) {}
 }

tests/Examples/Invalid/RootDTOWithoutConstructor.php

@@ -3,15 +3,15 @@
 
 namespace Pixelshaped\FlatMapperBundle\Tests\Examples\Invalid;
 
-use Pixelshaped\FlatMapperBundle\Attributes\Identifier;
-use Pixelshaped\FlatMapperBundle\Attributes\InboundPropertyName;
+use Pixelshaped\FlatMapperBundle\Mapping\Identifier;
+use Pixelshaped\FlatMapperBundle\Mapping\Scalar;
 
 class RootDTOWithoutConstructor
 {
     #[Identifier]
-    #[InboundPropertyName('object1_id')]
+    #[Scalar('object1_id')]
     public int $id;
 
-    #[InboundPropertyName('object1_name')]
+    #[Scalar('object1_name')]
     public string $name;
 }