Merge pull request #9 from emulgeator/special-character-handling

Handing special characters in key names

Author: emulgeator

CHANGELOG.md

@@ -5,6 +5,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/)
 and this project adheres to [Semantic Versioning](http://semver.org/).
 
+## [0.2.0] - 2024-03-05
+
+### Added
+- When a key in the input array has a special character, the library will try to find the property by removing the special characters
+
 ## [0.1.4] - 2023-11-16
 
 ### Fixed

src/Mapper.php

@@ -1,4 +1,5 @@
 <?php
+
 declare(strict_types=1);
 
 namespace Emul\ArrayToClassMapper;
@@ -27,6 +28,11 @@ public function addCustomMapper(string $type, Closure $mapper)
         $this->customMappers[$type] = $mapper;
     }
 
+    public function removeSpecialCharacters(string $key): string
+    {
+        return preg_replace('#[^A-Za-z0-9_]#', '', $key);
+    }
+
     public function getCustomMapper(string $type): ?Closure
     {
         $type = $this->formatCustomTypeName($type);
@@ -40,10 +46,11 @@ public function map(array $input, string $className)
     {
         $object          = (new ReflectionClass($className))->newInstanceWithoutConstructor();
         $reflectionClass = (new ReflectionClass($object));
-
         $classProperties = $reflectionClass->getProperties();
 
         foreach ($input as $key => $value) {
+            $key = $this->removeSpecialCharacters($key);
+
             foreach ($classProperties as $property) {
                 if ($key !== $property->getName()) {
                     continue;
@@ -55,37 +62,9 @@ public function map(array $input, string $className)
                 $type         = $property->getType();
 
                 if (!empty($type)) {
-                    if ($type->isBuiltin()) {
-                        if ($type->getName() === 'array') {
-                            if (empty($docBlockType)) {
-                                $property->setValue($object, $value);
-                            } else {
-                                $valueCasted = is_null($value) ? null : $this->castArray($value, $docBlockType);
-                                $property->setValue($object, $valueCasted);
-                            }
-                        } else {
-                            $property->setValue($object, $value);
-                        }
-                    } else {
-                        $this->setCustomValue($object, $property, $type->getName(), $value);
-                    }
+                    $this->setValueByPhpType($type, $docBlockType, $property, $object, $value);
                 } else {
-                    if (empty($docBlockType)) {
-                        $property->setValue($object, $value);
-                    } else {
-                        if ($docBlockType->isBuiltIn()) {
-                            if ($docBlockType->getName() === 'array') {
-                                $property->setValue($object, $this->castArray($value, $docBlockType));
-                            } else {
-                                settype($value, $docBlockType->getName());
-                                $property->setValue($object, $value);
-                            }
-                        } elseif (!$docBlockType->isSingle()) {
-                            $property->setValue($object, $this->castArray($value, $docBlockType));
-                        } else {
-                            $this->setCustomValue($object, $property, $docBlockType->getName(), $value);
-                        }
-                    }
+                    $this->setValueByDocBlock($docBlockType, $property, $object, $value);
                 }
             }
         }
@@ -100,8 +79,7 @@ private function setCustomValue($object, \ReflectionProperty $property, string $
             && empty($this->getCustomMapper($typeName))
         ) {
             $property->setValue($object, null);
-        }
-        else {
+        } else {
             $property->setValue($object, $this->castCustom($value, $typeName));
         }
     }
@@ -146,4 +124,42 @@ private function formatCustomTypeName(string $type): string
     {
         return ltrim($type, '\\');
     }
+
+    private function setValueByPhpType(\ReflectionNamedType $type, ?DocBlockType $docBlockType, \ReflectionProperty $property, $object, $value): void
+    {
+        if ($type->isBuiltin()) {
+            if ($type->getName() === 'array') {
+                if (empty($docBlockType)) {
+                    $property->setValue($object, $value);
+                } else {
+                    $valueCasted = is_null($value) ? null : $this->castArray($value, $docBlockType);
+                    $property->setValue($object, $valueCasted);
+                }
+            } else {
+                $property->setValue($object, $value);
+            }
+        } else {
+            $this->setCustomValue($object, $property, $type->getName(), $value);
+        }
+    }
+
+    private function setValueByDocBlock(?DocBlockType $docBlockType, \ReflectionProperty $property, $object, $value): void
+    {
+        if (empty($docBlockType)) {
+            $property->setValue($object, $value);
+        } else {
+            if ($docBlockType->isBuiltIn()) {
+                if ($docBlockType->getName() === 'array') {
+                    $property->setValue($object, $this->castArray($value, $docBlockType));
+                } else {
+                    settype($value, $docBlockType->getName());
+                    $property->setValue($object, $value);
+                }
+            } elseif (!$docBlockType->isSingle()) {
+                $property->setValue($object, $this->castArray($value, $docBlockType));
+            } else {
+                $this->setCustomValue($object, $property, $docBlockType->getName(), $value);
+            }
+        }
+    }
 }

test/Unit/MapperTest.php

@@ -41,6 +41,17 @@ public function testMapWhenNullGiven_shouldSet()
         $this->assertNull($result->getInt());
     }
 
+    public function testMapWhenKeyContainsSpecialCharacter_shouldSetByRemovingSpecialChars()
+    {
+        $mapper = $this->getMapper();
+        $input  = ['@int' => 12];
+
+        /** @var ScalarTypedStub $result */
+        $result = $mapper->map($input, ScalarTypedStub::class);
+
+        $this->assertSame(12, $result->getInt());
+    }
+
     public function testMapWhenBuiltInTypedPropertyGiven_shouldCast()
     {
         $mapper = $this->getMapper();