Merge pull request #57 from xp-forge/feature/document-create

Add Document::create() which creates a document with an object ID

Author: thekid

src/main/php/com/mongodb/Document.class.php

@@ -10,6 +10,14 @@ class Document implements Value, ArrayAccess, IteratorAggregate {
   /** @param [:var] */
   public function __construct($properties= []) { $this->properties= $properties; }
 
+  /** @param [:var]|self $from */
+  public static function create($from= []): self {
+    return new self(['_id' => ObjectId::create()] + ($from instanceof self
+      ? $from->properties
+      : (array)$from
+    ));
+  }
+
   /** @return string|com.mongodb.ObjectId */
   public function id() { return $this->properties['_id'] ?: null; }
 

src/test/php/com/mongodb/unittest/DocumentTest.class.php

@@ -114,4 +114,35 @@ public function set_offset_array_key() {
     $fixture['properties']['price']= 12.99;
     Assert::equals(['color' => 'green', 'price' => 12.99], $fixture['properties']);
   }
+
+  #[Test]
+  public function create() {
+    Assert::instance(ObjectId::class, Document::create()->id());
+  }
+
+  #[Test]
+  public function create_with_properties() {
+    $fixture= Document::create(['test' => true]);
+
+    Assert::instance(ObjectId::class, $fixture->id());
+    Assert::true($fixture['test']);
+  }
+
+  #[Test]
+  public function create_passed_id_is_overwritten() {
+    $id= new ObjectId(self::OID);
+    $fixture= Document::create(['_id' => $id]);
+
+    Assert::notEquals($id, $fixture->id());
+  }
+
+  #[Test]
+  public function create_copies_document() {
+    $original= new Document(['_id' => new ObjectId(self::OID), 'test' => true]);
+    $fixture= Document::create($original);
+    $original['test']= false;
+
+    Assert::notEquals($original->id(), $fixture->id());
+    Assert::true($fixture['test']);
+  }
 }