Add hasIndex and dropIndexIfExists methods

Author: simonschaufi

src/Jenssegers/Mongodb/Schema/Blueprint.php

@@ -99,6 +99,48 @@ public function dropIndexIfExists($indexOrColumns = null)
         return $this;
     }
 
+    /**
+     * Check whether the given index exists.
+     *
+     * @param  string|array  $indexOrColumns
+     * @return bool
+     */
+    public function hasIndex($indexOrColumns = null)
+    {
+        $indexOrColumns = $this->transformColumns($indexOrColumns);
+        foreach ($this->collection->listIndexes() as $index) {
+            if (is_array($indexOrColumns) && in_array($index->getName(), $indexOrColumns)) {
+                return true;
+            }
+
+            if (is_string($indexOrColumns) && $index->getName() == $indexOrColumns) {
+                return true;
+            }
+        }
+        return false;
+    }
+
+    /**
+     * @param  string|array  $indexOrColumns
+     * @return string
+     */
+    protected function transformColumns($indexOrColumns)
+    {
+        if (is_array($indexOrColumns)) {
+            $indexOrColumns = $this->fluent($indexOrColumns);
+
+            // Transform the columns to the index name.
+            $transform = [];
+
+            foreach ($indexOrColumns as $column) {
+                $transform[$column] = $column . '_1';
+            }
+
+            $indexOrColumns = implode('_', $transform);
+        }
+        return $indexOrColumns;
+    }
+
     /**
      * @inheritdoc
      */
@@ -238,41 +280,6 @@ public function sparse_and_unique($columns = null, $options = [])
         return $this;
     }
 
-    /**
-     * Check whether the given index exists.
-     *
-     * @param  string|array  $indexOrColumns
-     * @return bool
-     */
-    public function hasIndex($indexOrColumns = null)
-    {
-        $indexOrColumns = $this->transformColumns($indexOrColumns);
-        foreach ($this->collection->listIndexes() as $index) {
-            if ($index->getName() == $indexOrColumns) {
-                return true;
-            }
-        }
-        return false;
-    }
-
-    /**
-     * @param  string|array  $indexOrColumns
-     * @return string|array
-     */
-    private function transformColumns($indexOrColumns)
-    {
-        if (is_array($indexOrColumns)) {
-            $indexOrColumns = $this->fluent($indexOrColumns);
-            // Transform the columns to the index name.
-            $transform = [];
-            foreach ($indexOrColumns as $column) {
-                $transform[$column] = $column . '_1';
-            }
-            $indexOrColumns = join('_', $transform);
-        }
-        return $indexOrColumns;
-    }
-
     /**
      * Allow fluent columns.
      *

tests/SchemaTest.php

@@ -1,5 +1,7 @@
 <?php
 
+use Jenssegers\Mongodb\Schema\Blueprint;
+
 class SchemaTest extends TestCase
 {
     public function tearDown(): void
@@ -144,6 +146,76 @@ public function testDropIndex()
         $this->assertFalse($index);
     }
 
+    public function testDropIndexIfExists()
+    {
+        Schema::collection('newcollection', function (Blueprint $collection) {
+            $collection->unique('uniquekey');
+            $collection->dropIndexIfExists('uniquekey_1');
+        });
+
+        $index = $this->getIndex('newcollection', 'uniquekey');
+        $this->assertEquals(null, $index);
+
+        Schema::collection('newcollection', function (Blueprint $collection) {
+            $collection->unique('uniquekey');
+            $collection->dropIndexIfExists(['uniquekey']);
+        });
+
+        $index = $this->getIndex('newcollection', 'uniquekey');
+        $this->assertEquals(null, $index);
+
+        Schema::collection('newcollection', function (Blueprint $collection) {
+            $collection->index(['field_a', 'field_b']);
+        });
+
+        $index = $this->getIndex('newcollection', 'field_a_1_field_b_1');
+        $this->assertNotNull($index);
+
+        Schema::collection('newcollection', function (Blueprint $collection) {
+            $collection->dropIndexIfExists(['field_a', 'field_b']);
+        });
+
+        $index = $this->getIndex('newcollection', 'field_a_1_field_b_1');
+        $this->assertFalse($index);
+
+        Schema::collection('newcollection', function (Blueprint $collection) {
+            $collection->index(['field_a', 'field_b'], 'custom_index_name');
+        });
+
+        $index = $this->getIndex('newcollection', 'custom_index_name');
+        $this->assertNotNull($index);
+
+        Schema::collection('newcollection', function (Blueprint $collection) {
+            $collection->dropIndexIfExists('custom_index_name');
+        });
+
+        $index = $this->getIndex('newcollection', 'custom_index_name');
+        $this->assertFalse($index);
+    }
+
+    public function testHasIndex()
+    {
+        $instance = $this;
+
+        Schema::collection('newcollection', function (Blueprint $collection) use ($instance) {
+            $collection->index('myhaskey1');
+            $instance->assertTrue($collection->hasIndex('myhaskey1_1'));
+            $instance->assertFalse($collection->hasIndex('myhaskey1'));
+        });
+
+        Schema::collection('newcollection', function (Blueprint $collection) use ($instance) {
+            $collection->index('myhaskey2');
+            $instance->assertTrue($collection->hasIndex(['myhaskey2']));
+            $instance->assertFalse($collection->hasIndex(['myhaskey2_1']));
+        });
+
+        Schema::collection('newcollection', function (Blueprint $collection) use ($instance) {
+            $collection->index(['field_a', 'field_b']);
+            $instance->assertTrue($collection->hasIndex(['field_a_1_field_b']));
+            $instance->assertFalse($collection->hasIndex(['field_a_1_field_b_1']));
+        });
+    }
+
     public function testBackground()
     {
         Schema::collection('newcollection', function ($collection) {