Merge pull request #33 from sunrise-php/release/v3.6.0

v3.6.0
sunrise-php · Nov 21, 2023 · 25077e5 · 25077e5
2 parents e716354 + 28e93e6
commit 25077e5
Show file tree

Hide file tree

Showing 6 changed files with 75 additions and 24 deletions.
diff --git a/README.md b/README.md
@@ -31,7 +31,7 @@ composer require sunrise/hydrator
 * * [Timestamp](#timestamp)
 * * [Timezone](#timezone)
 * * [Enumeration](#enumeration)
-* * [UUID](#uid)
+* * [UUID](#uuid)
 * * [Relationship](#relationship)
 * * [Custom type](#support-for-custom-types)
 * [Ignored property](#ignored-property)
@@ -293,6 +293,16 @@ In general, remember that regardless of whether arrays or collections are used,
 public readonly array $value;
 ```
 
+Sometimes, there is a need to map a typed list to a collection. It's a relatively simple task; just use the example below:
+
+```php
+use Sunrise\Hydrator\Type;
+
+$data = [...];
+
+$collection = $hydrator->castValue($data, Type::fromName(SomeDtoCollection::class));
+```
+
 This property has no any additional behavior and only accepts arrays.
 
 ### Timestamp

diff --git a/src/AnnotationReader/BuiltinAnnotationReader.php b/src/AnnotationReader/BuiltinAnnotationReader.php
@@ -16,6 +16,8 @@
 use Generator;
 use LogicException;
 use ReflectionAttribute;
+use ReflectionParameter;
+use ReflectionProperty;
 use Sunrise\Hydrator\AnnotationReaderInterface;
 
 use function sprintf;
@@ -56,6 +58,11 @@ public function getAnnotations(string $name, $holder): Generator
             return;
         } // @codeCoverageIgnoreEnd
 
+        if (! $holder instanceof ReflectionProperty &&
+            ! $holder instanceof ReflectionParameter) {
+            return;
+        }
+
         $attributes = $holder->getAttributes($name, ReflectionAttribute::IS_INSTANCEOF);
         foreach ($attributes as $attribute) {
             yield $attribute->newInstance();

diff --git a/src/AnnotationReaderInterface.php b/src/AnnotationReaderInterface.php
@@ -14,8 +14,6 @@
 namespace Sunrise\Hydrator;
 
 use Generator;
-use ReflectionParameter;
-use ReflectionProperty;
 
 /**
  * @since 3.1.0
@@ -27,7 +25,7 @@ interface AnnotationReaderInterface
      * Gets annotations by the given name from the given holder
      *
      * @param class-string<T> $name
-     * @param ReflectionParameter|ReflectionProperty $holder
+     * @param mixed $holder
      *
      * @return Generator<mixed, T>
      *

diff --git a/src/Exception/InvalidObjectException.php b/src/Exception/InvalidObjectException.php
@@ -48,11 +48,20 @@ final public static function uninstantiableObject(string $className): self
      */
     final public static function unsupportedType(Type $type): self
     {
+        /** @var mixed $holder */
         $holder = $type->getHolder();
 
-        return $holder instanceof ReflectionProperty ?
-            self::unsupportedPropertyType($type, $holder) :
-            self::unsupportedParameterType($type, $holder);
+        if ($holder instanceof ReflectionProperty) {
+            return self::unsupportedPropertyType($type, $holder);
+        }
+        if ($holder instanceof ReflectionParameter) {
+            return self::unsupportedParameterType($type, $holder);
+        }
+
+        return new self(sprintf(
+            'The type {%s} is not supported.',
+            $type->getName(),
+        ));
     }
 
     /**

diff --git a/src/Type.php b/src/Type.php
@@ -27,7 +27,7 @@ final class Type
     /**
      * The type holder
      *
-     * @var ReflectionParameter|ReflectionProperty
+     * @var mixed
      */
     private $holder;
 
@@ -48,7 +48,7 @@ final class Type
     /**
      * Constructor of the class
      *
-     * @param ReflectionParameter|ReflectionProperty $holder
+     * @param mixed $holder
      * @param string $name
      * @param bool $allowsNull
      */
@@ -60,26 +60,18 @@ public function __construct($holder, string $name, bool $allowsNull)
     }
 
     /**
-     * Creates a new type from the given property
+     * Creates a new type from the given name
      *
-     * @param ReflectionProperty $property
+     * @param string $name
+     * @param bool $allowsNull
      *
      * @return self
      *
-     * @since 3.4.0
+     * @since 3.6.0
      */
-    public static function fromProperty(ReflectionProperty $property): self
+    public static function fromName(string $name, bool $allowsNull = false): self
     {
-        $type = $property->getType();
-        if ($type === null) {
-            return new Type($property, BuiltinType::MIXED, true);
-        }
-
-        if ($type instanceof ReflectionNamedType) {
-            return new Type($property, $type->getName(), $type->allowsNull());
-        }
-
-        return new Type($property, (string) $type, $type->allowsNull());
+        return new Type(null, $name, $allowsNull);
     }
 
     /**
@@ -105,10 +97,33 @@ public static function fromParameter(ReflectionParameter $parameter): self
         return new Type($parameter, (string) $type, $type->allowsNull());
     }
 
+    /**
+     * Creates a new type from the given property
+     *
+     * @param ReflectionProperty $property
+     *
+     * @return self
+     *
+     * @since 3.4.0
+     */
+    public static function fromProperty(ReflectionProperty $property): self
+    {
+        $type = $property->getType();
+        if ($type === null) {
+            return new Type($property, BuiltinType::MIXED, true);
+        }
+
+        if ($type instanceof ReflectionNamedType) {
+            return new Type($property, $type->getName(), $type->allowsNull());
+        }
+
+        return new Type($property, (string) $type, $type->allowsNull());
+    }
+
     /**
      * Gets the type holder
      *
-     * @return ReflectionParameter|ReflectionProperty
+     * @return mixed
      */
     public function getHolder()
     {

diff --git a/tests/HydratorTest.php b/tests/HydratorTest.php
@@ -26,6 +26,7 @@
 use Sunrise\Hydrator\Exception\InvalidObjectException;
 use Sunrise\Hydrator\Hydrator;
 use Sunrise\Hydrator\HydratorInterface;
+use Sunrise\Hydrator\Tests\Stub\BooleanCollection;
 use Sunrise\Hydrator\Type;
 use Sunrise\Hydrator\TypeConverter\TimestampTypeConverter;
 
@@ -2602,6 +2603,17 @@ public function testSymfonyViolations(): void
         $this->assertSame('value', $violations->get(0)->getPropertyPath());
     }
 
+    /**
+     * @dataProvider strictBooleanProvider
+     * @dataProvider nonStrictBooleanProvider
+     */
+    public function testSourcelessType($element, bool $expected): void
+    {
+        $type = Type::fromName(BuiltinType::BOOL);
+
+        $this->assertSame($expected, $this->createHydrator()->castValue($element, $type));
+    }
+
     public function strictNullProvider(): Generator
     {
         yield [null, null];