Support renaming columns in migrations (mongodb#2682)

Author: hans-thomas

src/Schema/Blueprint.php

@@ -5,6 +5,7 @@
 namespace MongoDB\Laravel\Schema;
 
 use Illuminate\Database\Connection;
+use Illuminate\Database\Schema\Blueprint as SchemaBlueprint;
 use MongoDB\Laravel\Collection;
 
 use function array_flip;
@@ -15,7 +16,7 @@
 use function is_string;
 use function key;
 
-class Blueprint extends \Illuminate\Database\Schema\Blueprint
+class Blueprint extends SchemaBlueprint
 {
     /**
      * The MongoConnection object for this blueprint.
@@ -280,6 +281,14 @@ public function drop()
         return $this;
     }
 
+    /** @inheritdoc */
+    public function renameColumn($from, $to)
+    {
+        $this->collection->updateMany([$from => ['$exists' => true]], ['$rename' => [$from => $to]]);
+
+        return $this;
+    }
+
     /** @inheritdoc */
     public function addColumn($type, $name, array $parameters = [])
     {

tests/SchemaTest.php

@@ -337,6 +337,46 @@ public function testSparseUnique(): void
         $this->assertEquals(1, $index['unique']);
     }
 
+    public function testRenameColumn(): void
+    {
+        DB::connection()->collection('newcollection')->insert(['test' => 'value']);
+        DB::connection()->collection('newcollection')->insert(['test' => 'value 2']);
+        DB::connection()->collection('newcollection')->insert(['column' => 'column value']);
+
+        $check = DB::connection()->collection('newcollection')->get();
+        $this->assertCount(3, $check);
+
+        $this->assertArrayHasKey('test', $check[0]);
+        $this->assertArrayNotHasKey('newtest', $check[0]);
+
+        $this->assertArrayHasKey('test', $check[1]);
+        $this->assertArrayNotHasKey('newtest', $check[1]);
+
+        $this->assertArrayHasKey('column', $check[2]);
+        $this->assertArrayNotHasKey('test', $check[2]);
+        $this->assertArrayNotHasKey('newtest', $check[2]);
+
+        Schema::collection('newcollection', function (Blueprint $collection) {
+            $collection->renameColumn('test', 'newtest');
+        });
+
+        $check2 = DB::connection()->collection('newcollection')->get();
+        $this->assertCount(3, $check2);
+
+        $this->assertArrayHasKey('newtest', $check2[0]);
+        $this->assertArrayNotHasKey('test', $check2[0]);
+        $this->assertSame($check[0]['test'], $check2[0]['newtest']);
+
+        $this->assertArrayHasKey('newtest', $check2[1]);
+        $this->assertArrayNotHasKey('test', $check2[1]);
+        $this->assertSame($check[1]['test'], $check2[1]['newtest']);
+
+        $this->assertArrayHasKey('column', $check2[2]);
+        $this->assertArrayNotHasKey('test', $check2[2]);
+        $this->assertArrayNotHasKey('newtest', $check2[2]);
+        $this->assertSame($check[2]['column'], $check2[2]['column']);
+    }
+
     protected function getIndex(string $collection, string $name)
     {
         $collection = DB::getCollection($collection);