Merge pull request #116 from apisearch-io/feature/added-index-config-metadata

Added metadata in config

Author: mmoreram

Config/Config.php

@@ -71,24 +71,32 @@ class Config implements HttpTransportable
      */
     private $replicas;
 
+    /**
+     * @var array
+     */
+    private $metadata;
+
     /**
      * Config constructor.
      *
      * @param string|null $language
      * @param bool        $storeSearchableMetadata
      * @param int         $shards
      * @param int         $replicas
+     * @param array       $metadata
      */
     public function __construct(
         ?string $language = null,
         bool $storeSearchableMetadata = true,
         int $shards = self::DEFAULT_SHARDS,
-        int $replicas = self::DEFAULT_REPLICAS
+        int $replicas = self::DEFAULT_REPLICAS,
+        array $metadata = []
     ) {
         $this->language = $language;
         $this->storeSearchableMetadata = $storeSearchableMetadata;
         $this->shards = $shards;
         $this->replicas = $replicas;
+        $this->metadata = $metadata;
     }
 
     /**
@@ -155,6 +163,29 @@ public function getReplicas(): int
         return $this->replicas;
     }
 
+    /**
+     * @param string $key
+     * @param $value
+     *
+     * @return Config
+     */
+    public function addMetadataValue(
+        string $key,
+        $value
+    ): Config {
+        $this->metadata[$key] = $value;
+
+        return $this;
+    }
+
+    /**
+     * @return array
+     */
+    public function getMetadata(): array
+    {
+        return $this->metadata;
+    }
+
     /**
      * To array.
      *
@@ -170,6 +201,7 @@ public function toArray(): array
             }, $this->synonyms),
             'shards' => $this->shards,
             'replicas' => $this->replicas,
+            'metadata' => $this->metadata,
         ], function ($element) {
             return
             !(
@@ -198,6 +230,7 @@ public static function createFromArray(array $array): self
         }, $array['synonyms'] ?? []);
         $config->shards = (int) ($array['shards'] ?? self::DEFAULT_SHARDS);
         $config->replicas = (int) ($array['replicas'] ?? self::DEFAULT_REPLICAS);
+        $config->metadata = $array['metadata'] ?? [];
 
         return $config;
     }

Model/Index.php

@@ -103,7 +103,7 @@ public function __construct(
         IndexUUID $uuid,
         AppUUID $appUUID,
         bool $isOK,
-        int $docCount = 0,
+        int $docCount,
         string $size,
         int $shards,
         int $replicas,
@@ -209,6 +209,18 @@ public function getMetadata(): array
         return $this->metadata;
     }
 
+    /**
+     * Get Metadata value.
+     *
+     * @param string $key
+     *
+     * @return mixed|null
+     */
+    public function getMetadataValue(string $key)
+    {
+        return $this->metadata[$key] ?? null;
+    }
+
     /**
      * To array.
      *

Tests/Config/ConfigTest.php

@@ -34,6 +34,7 @@ public function testCreate()
         $this->assertTrue($config->shouldSearchableMetadataBeStored());
         $this->assertEquals(Config::DEFAULT_SHARDS, $config->getShards());
         $this->assertEquals(Config::DEFAULT_REPLICAS, $config->getReplicas());
+        $this->assertEmpty($config->getMetadata());
     }
 
     /**
@@ -156,4 +157,28 @@ public function testShardsAndReplicas()
         $this->assertEquals(5, $config->getShards());
         $this->assertEquals(10, $config->getReplicas());
     }
+
+    /**
+     * Test metadata.
+     */
+    public function testMetadata()
+    {
+        $config = new Config('es', true, 6, 3, [
+            'key1' => 'val1',
+            'key2' => 'val2',
+        ]);
+        $config->addMetadataValue('key3', 'val3');
+
+        $this->assertEquals('val1', $config->getMetadata()['key1']);
+        $this->assertEquals('val2', $config->getMetadata()['key2']);
+        $this->assertEquals('val3', $config->getMetadata()['key3']);
+        $this->assertFalse(array_key_exists('key4', $config->getMetadata()));
+
+        $newConfig = Config::createFromArray($config->toArray());
+
+        $this->assertEquals('val1', $newConfig->getMetadata()['key1']);
+        $this->assertEquals('val2', $newConfig->getMetadata()['key2']);
+        $this->assertEquals('val3', $config->getMetadata()['key3']);
+        $this->assertFalse(array_key_exists('key4', $config->getMetadata()));
+    }
 }

Transformer/ItemTransformed.php

@@ -16,28 +16,30 @@
 namespace Apisearch\Transformer;
 
 use Apisearch\Model\Item;
-use Symfony\Contracts\EventDispatcher\Event as ContractEvent;
 use Symfony\Component\EventDispatcher\Event as ComponentEvent;
+use Symfony\Contracts\EventDispatcher\Event as ContractEvent;
 
-/**
+/*
  * This code adds usability with Symfony 3.4 -> 5.0
  */
 if (class_exists("Symfony\Contracts\EventDispatcher\Event")) {
-
     /**
      * Class BaseTransformed.
      */
-    class BaseTransformed extends ContractEvent {}
+    class BaseTransformed extends ContractEvent
+    {
+    }
 } else {
-
     /**
      * Class BaseTransformed.
      */
-    class BaseTransformed extends ComponentEvent {}
+    class BaseTransformed extends ComponentEvent
+    {
+    }
 }
 
 /**
- * Class ItemTransformed
+ * Class ItemTransformed.
  */
 class ItemTransformed extends BaseTransformed
 {

Transformer/Transformer.php

@@ -166,7 +166,6 @@ public function toItem($object): ? Item
                         );
                 }
 
-
                 return $item;
             }
         }