Merge pull request #37 from MaSpeng/allow-empty-array-in-data

Allow empty array in data

Author: weierophinney

CHANGELOG.md

@@ -24,7 +24,9 @@ Versions prior to 0.4.0 were released as the package "weierophinney/hal".
 
 ### Fixed
 
-- Nothing.
+- [#34](https://github.com/zendframework/zend-expressive-hal/pull/37) adds ability
+  to provide _empty_ values eg. empty array as element data and avoids addition of
+  of empty data as **embedded** element.
 
 ## 1.0.1 - 2018-03-28
 

src/HalResource.php

@@ -61,7 +61,7 @@ public function __construct(array $data = [], array $links = [], array $embedded
         $context = __CLASS__;
         array_walk($data, function ($value, $name) use ($context) {
             $this->validateElementName($name, $context);
-            if ($value instanceof self || $this->isResourceCollection($value, $name, $context)) {
+            if (! empty($value) && ($value instanceof self || $this->isResourceCollection($value, $name, $context))) {
                 $this->embedded[$name] = $value;
                 return;
             }
@@ -148,7 +148,7 @@ public function withElement(string $name, $value) : HalResource
     {
         $this->validateElementName($name, __METHOD__);
 
-        if ($value instanceof self || $this->isResourceCollection($value, $name, __METHOD__)) {
+        if (! empty($value) && ($value instanceof self || $this->isResourceCollection($value, $name, __METHOD__))) {
             return $this->embed($name, $value);
         }
 

test/HalResourceTest.php

@@ -92,6 +92,14 @@ public function testNonResourceOrCollectionItemsRaiseExceptionDuringConstruction
         $resource = new HalResource([], [], ['foo' => 'bar']);
     }
 
+    public function testEmptyArrayAsDataWillNotBeEmbeddedDuringConstruction()
+    {
+        $resource = new HalResource(['bar' => []]);
+        $this->assertEquals(['bar' => []], $resource->getElements());
+        $representation = $resource->toArray();
+        $this->assertArrayNotHasKey('_embeded', $representation);
+    }
+
     /**
      * @dataProvider invalidElementNames
      */
@@ -222,6 +230,15 @@ public function testWithElementProxiesToEmbedIfResourceCollectionValueProvided()
         $this->assertEquals(['foo' => $collection], $new->getElements());
     }
 
+    public function testWithElementNotProxiesToEmbededIfEmptyArrayValueProvided()
+    {
+        $resource = new HalResource(['foo' => 'bar']);
+        $new = $resource->withElement('bar', []);
+
+        $representation = $new->toArray();
+        $this->assertEquals(['foo' => 'bar', 'bar' => []], $representation);
+    }
+
     /**
      * @dataProvider invalidElementNames
      */