Merge pull request #27 from swisnl/bugfix/item-document-builder-with-id-0

Allow '0' as id in ItemDocumentBuilder

Author: JaZo

src/ItemDocumentBuilder.php

@@ -22,15 +22,15 @@ public function __construct(ItemHydrator $itemHydrator)
     /**
      * @param \Swis\JsonApi\Client\Interfaces\ItemInterface $item
      * @param array                                         $attributes
-     * @param string                                        $id
+     * @param string|null                                   $id
      *
      * @return \Swis\JsonApi\Client\ItemDocument
      */
     public function build(ItemInterface $item, array $attributes, $id = null)
     {
         $this->itemHydrator->hydrate($item, $attributes);
 
-        if ($id) {
+        if ($id !== null && $id !== '') {
             $item->setId($id);
         }
 

tests/ItemDocumentBuilderTest.php

@@ -20,11 +20,59 @@ public function it_fills_items_from_id_and_attributes()
         $itemHydrator = new ItemHydrator($typeMapper);
         $itemDocumentBuilder = new ItemDocumentBuilder($itemHydrator);
 
-        $itemDocument = $itemDocumentBuilder->build(new Item(), $data, 123);
+        $itemDocument = $itemDocumentBuilder->build(new Item(), $data, '123');
 
         $item = $itemDocument->getData();
         static::assertInstanceOf(Item::class, $item);
+        static::assertEquals($item->getId(), '123');
         static::assertEquals($item->key1, $data['key1']);
         static::assertEquals($item->key2, $data['key2']);
     }
+
+    /**
+     * @test
+     */
+    public function it_fills_items_without_id()
+    {
+        $typeMapper = new TypeMapper();
+        $itemHydrator = new ItemHydrator($typeMapper);
+        $itemDocumentBuilder = new ItemDocumentBuilder($itemHydrator);
+
+        $itemDocument = $itemDocumentBuilder->build(new Item(), []);
+
+        $item = $itemDocument->getData();
+        static::assertInstanceOf(Item::class, $item);
+        static::assertNull($item->getId());
+    }
+
+    /**
+     * @test
+     * @dataProvider provideIdArguments
+     *
+     * @param $givenId
+     * @param $expectedId
+     */
+    public function it_fills_the_id_when_not_null_or_empty_string($givenId, $expectedId)
+    {
+        $typeMapper = new TypeMapper();
+        $itemHydrator = new ItemHydrator($typeMapper);
+        $itemDocumentBuilder = new ItemDocumentBuilder($itemHydrator);
+
+        $itemDocument = $itemDocumentBuilder->build(new Item(), [], $givenId);
+
+        $item = $itemDocument->getData();
+        static::assertInstanceOf(Item::class, $item);
+        static::assertSame($item->getId(), $expectedId);
+    }
+
+    public function provideIdArguments(): array
+    {
+        return [
+            ['0', '0'],
+            ['12', '12'],
+            ['foo-bar', 'foo-bar'],
+            [null, null],
+            ['', null],
+        ];
+    }
 }