PHPORM-139 Implement Model::createOrFirst using findOneAndUpdate operation

Author: GromNaN

src/Eloquent/Builder.php

@@ -7,9 +7,11 @@
 use Illuminate\Database\ConnectionInterface;
 use Illuminate\Database\Eloquent\Builder as EloquentBuilder;
 use MongoDB\Driver\Cursor;
+use MongoDB\Laravel\Collection;
 use MongoDB\Laravel\Helpers\QueriesRelationships;
 use MongoDB\Model\BSONDocument;
 
+use function array_intersect_key;
 use function array_key_exists;
 use function array_merge;
 use function collect;
@@ -183,6 +185,22 @@ public function raw($value = null)
         return $results;
     }
 
+    public function createOrFirst(array $attributes = [], array $values = [])
+    {
+        // Apply casting and default values to the attributes
+        $instance = $this->newModelInstance($values + $attributes);
+        $values = $instance->getAttributes();
+        $attributes = array_intersect_key($attributes, $values);
+
+        return $this->raw(function (Collection $collection) use ($attributes, $values) {
+            return $collection->findOneAndUpdate(
+                $attributes,
+                ['$setOnInsert' => $values],
+                ['upsert' => true, 'new' => true],
+            );
+        });
+    }
+
     /**
      * Add the "updated at" column to an array of values.
      * TODO Remove if https://github.com/laravel/framework/commit/6484744326531829341e1ff886cc9b628b20d73e

tests/ModelTest.php

@@ -45,7 +45,7 @@ class ModelTest extends TestCase
 {
     public function tearDown(): void
     {
-        User::truncate();
+        User::raw(fn(Collection $collection) => $collection->drop());
         Soft::truncate();
         Book::truncate();
         Item::truncate();
@@ -1044,4 +1044,43 @@ public function testNumericFieldName(): void
         $this->assertInstanceOf(User::class, $found);
         $this->assertEquals([3 => 'two.three'], $found[2]);
     }
+
+    public function testCreateOrFirst()
+    {
+        // Create index unique on "email" and "name"
+        User::raw(fn (Collection $collection) => $collection->createIndex(['email' => 1], ['unique' => true]));
+        User::raw(fn (Collection $collection) => $collection->createIndex(['name' => 1], ['unique' => true]));
+
+        $user1 = User::createOrFirst(['email' => '[email protected]']);
+
+        $this->assertSame('[email protected]', $user1->email);
+        $this->assertNull($user1->name);
+
+        $user2 = User::createOrFirst(
+            ['email' => '[email protected]'],
+            ['name' => 'Taylor Otwell', 'birthday' => new DateTime('1987-05-28')],
+        );
+
+        $this->assertEquals($user1->id, $user2->id);
+        $this->assertSame('[email protected]', $user2->email);
+        $this->assertNull($user2->name);
+        $this->assertNull($user2->birthday);
+
+        $user3 = User::createOrFirst(
+            ['email' => '[email protected]'],
+            ['name' => 'Abigail Otwell', 'birthday' => new DateTime('1987-05-28')],
+        );
+
+        $this->assertNotEquals($user3->id, $user1->id);
+        $this->assertSame('[email protected]', $user3->email);
+        $this->assertSame('Abigail Otwell', $user3->name);
+        $this->assertEquals(new DateTime('1987-05-28'), $user3->birthday);
+
+        $user4 = User::createOrFirst(
+            ['name' => 'Dries Vints'],
+            ['name' => 'Nuno Maduro', 'email' => '[email protected]'],
+        );
+
+        $this->assertSame('Nuno Maduro', $user4->name);
+    }
 }