Merge branch 'hotfix/37'

Close #37
Fixes #34

CHANGELOG.md

@@ -4,7 +4,7 @@ All notable changes to this project will be documented in this file, in reverse
 
 Versions prior to 0.4.0 were released as the package "weierophinney/hal".
 
-## 1.0.2 - TBD
+## 1.0.2 - 2018-04-04
 
 ### Added
 
@@ -24,7 +24,11 @@ Versions prior to 0.4.0 were released as the package "weierophinney/hal".
 
 ### Fixed
 
-- Nothing.
+- [#37](https://github.com/zendframework/zend-expressive-hal/pull/37) modifies
+  `HalResource` to no longer treat empty arrays as embedded collections when
+  passed via the constructor or `withElement()`. If an empty embedded collection
+  is required, use `embed()` with a boolean third argument to force
+  representation as an array of resources.
 
 ## 1.0.1 - 2018-03-28
 

src/HalResource.php

@@ -61,7 +61,9 @@ 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 +150,9 @@ 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 testWithElementDoesNotProxyToEmbedIfAnEmptyArrayValueIsProvided()
+    {
+        $resource = new HalResource(['foo' => 'bar']);
+        $new = $resource->withElement('bar', []);
+
+        $representation = $new->toArray();
+        $this->assertEquals(['foo' => 'bar', 'bar' => []], $representation);
+    }
+
     /**
      * @dataProvider invalidElementNames
      */