Move index payloads onto value objects

Author: stevebauman

src/Indices/Alias.php

@@ -45,4 +45,24 @@ public function routing(): ?string
     {
         return $this->routing;
     }
+
+    /**
+     * Get the OpenSearch alias body payload.
+     *
+     * @return array<string, mixed>
+     */
+    public function toArray(): array
+    {
+        $body = [];
+
+        if ($this->routing) {
+            $body['routing'] = $this->routing;
+        }
+
+        if ($this->filter) {
+            $body['filter'] = $this->filter;
+        }
+
+        return $body;
+    }
 }

src/Indices/IndexBlueprint.php

@@ -41,4 +41,26 @@ public function settings(): ?Settings
     {
         return $this->settings;
     }
+
+    /**
+     * Get the OpenSearch create index payload.
+     *
+     * @return array<string, mixed>
+     */
+    public function toArray(): array
+    {
+        $params = [
+            'index' => $this->name,
+        ];
+
+        if ($mapping = $this->mapping?->toArray()) {
+            $params['body']['mappings'] = $mapping;
+        }
+
+        if ($settings = $this->settings?->toArray()) {
+            $params['body']['settings'] = $settings;
+        }
+
+        return $params;
+    }
 }

src/Indices/IndexManager.php

@@ -65,19 +65,7 @@ public function exists(string $indexName): bool
      */
     public function create(IndexBlueprint $index): self
     {
-        $params = [
-            'index' => $index->name(),
-        ];
-
-        if ($mapping = $index->mapping()?->toArray()) {
-            $params['body']['mappings'] = $mapping;
-        }
-
-        if ($settings = $index->settings()?->toArray()) {
-            $params['body']['settings'] = $settings;
-        }
-
-        $this->indices->create($params);
+        $this->indices->create($index->toArray());
 
         return $this;
     }
@@ -158,12 +146,8 @@ public function putAlias(string $indexName, Alias $alias): self
             'name' => $alias->name(),
         ];
 
-        if ($alias->routing()) {
-            $params['body']['routing'] = $alias->routing();
-        }
-
-        if ($alias->filter()) {
-            $params['body']['filter'] = $alias->filter();
+        if ($body = $alias->toArray()) {
+            $params['body'] = $body;
         }
 
         $this->indices->putAlias($params);

tests/Unit/Indices/AliasTest.php

@@ -11,3 +11,22 @@
     $this->assertSame(['term' => ['year' => 2030]], $alias->filter());
     $this->assertSame('year', $alias->routing());
 });
+
+test('array casting without filter and routing', function () {
+    $alias = new Alias('2030');
+
+    $this->assertSame([], $alias->toArray());
+});
+
+test('array casting with filter and routing', function () {
+    $alias = new Alias('2030', ['term' => ['year' => 2030]], 'year');
+
+    $this->assertSame([
+        'routing' => 'year',
+        'filter' => [
+            'term' => [
+                'year' => 2030,
+            ],
+        ],
+    ], $alias->toArray());
+});

tests/Unit/Indices/IndexBlueprintTest.php

@@ -22,3 +22,37 @@
     $this->assertSame($mapping, $index->mapping());
     $this->assertSame($settings, $index->settings());
 });
+
+test('array casting without mapping and settings', function () {
+    $index = new IndexBlueprint('foo');
+
+    $this->assertSame([
+        'index' => 'foo',
+    ], $index->toArray());
+});
+
+test('array casting with mapping and settings', function () {
+    $index = new IndexBlueprint(
+        'foo',
+        (new Mapping)->text('title'),
+        (new Settings)->index(['number_of_replicas' => 2])
+    );
+
+    $this->assertSame([
+        'index' => 'foo',
+        'body' => [
+            'mappings' => [
+                'properties' => [
+                    'title' => [
+                        'type' => 'text',
+                    ],
+                ],
+            ],
+            'settings' => [
+                'index' => [
+                    'number_of_replicas' => 2,
+                ],
+            ],
+        ],
+    ], $index->toArray());
+});