Merge pull request #6 from sunrise-php/release/v1.3.0

v1.3.0
sunrise-php · Jul 29, 2021 · b206924 · b206924
2 parents 5a77c75 + 93a85dd
commit b206924
Show file tree

Hide file tree

Showing 7 changed files with 176 additions and 4 deletions.
diff --git a/composer.json b/composer.json
@@ -40,7 +40,7 @@
     "scripts": {
         "test": [
             "phpcs",
-            "phpunit --colors=always --coverage-text"
+            "XDEBUG_MODE=coverage phpunit --colors=always --coverage-text"
         ]
     }
 }
diff --git a/src/Hydrator/Hydrator.php b/src/Hydrator/Hydrator.php
@@ -27,15 +27,25 @@
 use function array_key_exists;
 use function class_exists;
 use function constant;
+use function ctype_digit;
 use function defined;
 use function in_array;
 use function is_array;
+use function is_int;
 use function is_scalar;
 use function is_string;
 use function is_subclass_of;
+use function json_decode;
+use function json_last_error;
+use function json_last_error_msg;
 use function sprintf;
 use function strtotime;
 
+/**
+ * Import constants
+ */
+use const JSON_ERROR_NONE;
+
 /**
  * Hydrator
  */
@@ -172,6 +182,11 @@ private function hydrateProperty(
             return;
         }
 
+        if (is_subclass_of($type->getName(), JsonableObjectInterface::class)) {
+            $this->hydratePropertyWithJsonOneToOneAssociation($object, $class, $property, $type, $value);
+            return;
+        }
+
         if (is_subclass_of($type->getName(), HydrableObjectInterface::class)) {
             $this->hydratePropertyWithOneToOneAssociation($object, $class, $property, $type, $value);
             return;
@@ -329,14 +344,19 @@ private function hydratePropertyWithEnumerableValue(
         ReflectionNamedType $type,
         $value
     ) : void {
-        if (!is_string($value)) {
+        if (!is_int($value) && !is_string($value)) {
             throw new Exception\InvalidValueException(sprintf(
-                'The <%s.%s> property only accepts a string.',
+                'The <%s.%s> property only accepts an integer or a string.',
                 $class->getShortName(),
                 $property->getName(),
             ));
         }
 
+        // support for integer cases...
+        if (is_int($value) || ctype_digit($value)) {
+            $value = '_' . $value;
+        }
+
         $enum = $type->getName();
         $constant = sprintf('%s::%s', $enum, $value);
         if (!defined($constant)) {
@@ -385,6 +405,49 @@ private function hydratePropertyWithDateTime(
         $property->setValue($object, $dateTime);
     }
 
+    /**
+     * Hydrates the given property with the given JSON one-to-one value
+     *
+     * @param HydrableObjectInterface $object
+     * @param ReflectionClass $class
+     * @param ReflectionProperty $property
+     * @param ReflectionNamedType $type
+     * @param mixed $value
+     *
+     * @return void
+     *
+     * @throws Exception\InvalidValueException
+     *         If the given value isn't valid.
+     */
+    public function hydratePropertyWithJsonOneToOneAssociation(
+        HydrableObjectInterface $object,
+        ReflectionClass $class,
+        ReflectionProperty $property,
+        ReflectionNamedType $type,
+        $value
+    ) : void {
+        if (!is_string($value)) {
+            throw new Exception\InvalidValueException(sprintf(
+                'The <%s.%s> property only accepts a string.',
+                $class->getShortName(),
+                $property->getName(),
+            ));
+        }
+
+        json_decode(''); // reset previous error...
+        $value = (array) json_decode($value, true);
+        if (JSON_ERROR_NONE <> json_last_error()) {
+            throw new Exception\InvalidValueException(sprintf(
+                'The <%s.%s> property only accepts valid JSON data (%s).',
+                $class->getShortName(),
+                $property->getName(),
+                json_last_error_msg(),
+            ));
+        }
+
+        $this->hydratePropertyWithOneToOneAssociation($object, $class, $property, $type, $value);
+    }
+
     /**
      * Hydrates the given property with the given one-to-one value
      *

diff --git a/src/Hydrator/JsonableObjectInterface.php b/src/Hydrator/JsonableObjectInterface.php
@@ -0,0 +1,19 @@
+<?php declare(strict_types=1);
+
+/**
+ * It's free open-source software released under the MIT License.
+ *
+ * @author Anatoly Fenric <[email protected]>
+ * @copyright Copyright (c) 2021, Anatoly Fenric
+ * @license https://github.com/sunrise-php/hydrator/blob/master/LICENSE
+ * @link https://github.com/sunrise-php/hydrator
+ */
+
+namespace Sunrise\Hydrator;
+
+/**
+ * JsonableObjectInterface
+ */
+interface JsonableObjectInterface extends HydrableObjectInterface
+{
+}
diff --git a/tests/Hydrator/Fixture/TestEnum.php b/tests/Hydrator/Fixture/TestEnum.php
@@ -15,4 +15,8 @@ final class TestEnum extends EnumerableObject
     public const A = 'A:value';
     public const B = 'B:value';
     public const C = 'C:value';
+
+    public const _0 = '0:value';
+    public const _1 = '1:value';
+    public const _2 = '2:value';
 }
diff --git a/tests/Hydrator/Fixture/TestJsonDto.php b/tests/Hydrator/Fixture/TestJsonDto.php
@@ -0,0 +1,16 @@
+<?php declare(strict_types=1);
+
+namespace Sunrise\Hydrator\Tests\Fixture;
+
+/**
+ * Import classes
+ */
+use Sunrise\Hydrator\HydrableObjectInterface;
+
+/**
+ * TestJsonDto
+ */
+final class TestJsonDto implements HydrableObjectInterface
+{
+    public TestJsonableObject $json;
+}
diff --git a/tests/Hydrator/Fixture/TestJsonableObject.php b/tests/Hydrator/Fixture/TestJsonableObject.php
@@ -0,0 +1,17 @@
+<?php declare(strict_types=1);
+
+namespace Sunrise\Hydrator\Tests\Fixture;
+
+/**
+ * Import classes
+ */
+use Sunrise\Hydrator\JsonableObjectInterface;
+
+/**
+ * TestJsonableObject
+ */
+final class TestJsonableObject implements JsonableObjectInterface
+{
+    public string $foo;
+    public string $bar;
+}
diff --git a/tests/Hydrator/HydratorTest.php b/tests/Hydrator/HydratorTest.php
@@ -83,6 +83,41 @@ public function testHydrate() : void
         $this->assertSame($data['alias'], $object->hidden);
     }
 
+    /**
+     * @return void
+     */
+    public function testJson() : void
+    {
+        $json = '{"foo":"foo:value","bar":"bar:value"}';
+
+        $object = (new Hydrator)->hydrate(new Fixture\TestJsonDto(), ['json' => $json]);
+
+        $this->assertSame('foo:value', $object->json->foo);
+        $this->assertSame('bar:value', $object->json->bar);
+    }
+
+    /**
+     * @return void
+     */
+    public function testInvalidSyntaxJson() : void
+    {
+        $this->expectException(Exception\InvalidValueException::class);
+        $this->expectExceptionMessage('The <TestJsonDto.json> property only accepts valid JSON data (Syntax error).');
+
+        (new Hydrator)->hydrate(new Fixture\TestJsonDto(), ['json' => '{']);
+    }
+
+    /**
+     * @return void
+     */
+    public function testInvalidJsonType() : void
+    {
+        $this->expectException(Exception\InvalidValueException::class);
+        $this->expectExceptionMessage('The <TestJsonDto.json> property only accepts a string.');
+
+        (new Hydrator)->hydrate(new Fixture\TestJsonDto(), ['json' => []]);
+    }
+
     /**
      * @return void
      */
@@ -257,6 +292,24 @@ public function testEnumerableValue() : void
 
         $object = (new Hydrator)->hydrate(new Fixture\TestEnumDto(), ['foo' => 'C']);
         $this->assertSame('C:value', $object->foo->getValue());
+
+        $object = (new Hydrator)->hydrate(new Fixture\TestEnumDto(), ['foo' => '0']);
+        $this->assertSame('0:value', $object->foo->getValue());
+
+        $object = (new Hydrator)->hydrate(new Fixture\TestEnumDto(), ['foo' => '1']);
+        $this->assertSame('1:value', $object->foo->getValue());
+
+        $object = (new Hydrator)->hydrate(new Fixture\TestEnumDto(), ['foo' => '2']);
+        $this->assertSame('2:value', $object->foo->getValue());
+
+        $object = (new Hydrator)->hydrate(new Fixture\TestEnumDto(), ['foo' => 0]);
+        $this->assertSame('0:value', $object->foo->getValue());
+
+        $object = (new Hydrator)->hydrate(new Fixture\TestEnumDto(), ['foo' => 1]);
+        $this->assertSame('1:value', $object->foo->getValue());
+
+        $object = (new Hydrator)->hydrate(new Fixture\TestEnumDto(), ['foo' => 2]);
+        $this->assertSame('2:value', $object->foo->getValue());
     }
 
     public function testUnknownEnumerableValue() : void
@@ -270,7 +323,7 @@ public function testUnknownEnumerableValue() : void
     public function testInvalidEnumerableValue() : void
     {
         $this->expectException(Exception\InvalidValueException::class);
-        $this->expectExceptionMessage('The <TestEnumDto.foo> property only accepts a string.');
+        $this->expectExceptionMessage('The <TestEnumDto.foo> property only accepts an integer or a string.');
 
         (new Hydrator)->hydrate(new Fixture\TestEnumDto(), ['foo' => []]);
     }