Merge pull request #120 from apisearch-io/feature/added-optional-repository-reference-to-item

Added optional repository reference to item

Author: mmoreram

Model/Item.php

@@ -16,6 +16,7 @@
 namespace Apisearch\Model;
 
 use Apisearch\Exception\InvalidFormatException;
+use Apisearch\Repository\RepositoryReference;
 
 /**
  * Class Item.
@@ -99,6 +100,11 @@ class Item implements HttpTransportable, UUIDReference
      */
     private $score;
 
+    /**
+     * @var RepositoryReference
+     */
+    private $repositoryReference;
+
     /**
      * Item constructor.
      *
@@ -489,6 +495,22 @@ public function setScore(float $score)
         return $this;
     }
 
+    /**
+     * @return RepositoryReference|null
+     */
+    public function getRepositoryReference():? RepositoryReference
+    {
+        return $this->repositoryReference;
+    }
+
+    /**
+     * @param RepositoryReference $repositoryReference
+     */
+    public function setRepositoryReference(RepositoryReference $repositoryReference)
+    {
+        $this->repositoryReference = $repositoryReference;
+    }
+
     /**
      * To array.
      *
@@ -510,6 +532,9 @@ public function toArray(): array
             'highlights' => $this->highlights,
             'is_promoted' => !$this->promoted ? null : true,
             'score' => $this->score,
+            'repository_reference' => $this->repositoryReference instanceof RepositoryReference
+                ? $this->repositoryReference->compose()
+                : null,
         ], function ($element) {
             return
             !(
@@ -577,6 +602,10 @@ public static function createFromArray(array $array): self
             $item->setScore((float) $array['score']);
         }
 
+        if (isset($array['repository_reference']) && !is_null($array['repository_reference'])) {
+            $item->setRepositoryReference(RepositoryReference::createFromComposed($array['repository_reference']));
+        }
+
         return $item;
     }
 

Tests/Model/ItemTest.php

@@ -15,9 +15,12 @@
 
 namespace Apisearch\Tests\Model;
 
+use Apisearch\Model\AppUUID;
 use Apisearch\Model\Coordinate;
+use Apisearch\Model\IndexUUID;
 use Apisearch\Model\Item;
 use Apisearch\Model\ItemUUID;
+use Apisearch\Repository\RepositoryReference;
 use PHPUnit\Framework\TestCase;
 
 /**
@@ -426,4 +429,33 @@ public function testScore()
         $this->assertEquals(5.5, $item->toArray()['score']);
         $this->assertEquals(5.5, Item::createFromArray($item->toArray())->getScore());
     }
+
+    /**
+     * Test index and app UUID
+     */
+    public function testIndexAndAppUUID()
+    {
+        $appUUID = AppUUID::createById('app1');
+        $indexUUID = IndexUUID::createById('index1');
+        $repositoryReference = RepositoryReference::create($appUUID, $indexUUID);
+
+        $item = Item::create(ItemUUID::createByComposedUUID('1~item'));
+        $this->assertNull($item->getRepositoryReference());
+        $item = Item::createFromArray($item->toArray());
+        $this->assertNull($item->getRepositoryReference());
+
+
+
+        $item = Item::create(ItemUUID::createByComposedUUID('1~item'));
+        $item->setRepositoryReference($repositoryReference);
+        $this->assertEquals(
+            $repositoryReference,
+            $item->getRepositoryReference()
+        );
+        $item = Item::createFromArray($item->toArray());
+        $this->assertEquals(
+            $repositoryReference,
+            $item->getRepositoryReference()
+        );
+    }
 }