Merge pull request #16 from event-engine/feature/get_partial_doc

Add method to retrieve a single partial doc

Author: Alexander Miertsch

src/DocumentStore.php

@@ -126,6 +126,14 @@ public function deleteMany(string $collectionName, Filter $filter): void;
      */
     public function getDoc(string $collectionName, string $docId): ?array;
 
+    /**
+     * @param string $collectionName
+     * @param PartialSelect $partialSelect
+     * @param string $docId
+     * @return array|null
+     */
+    public function getPartialDoc(string $collectionName, PartialSelect $partialSelect, string $docId): ?array;
+
     /**
      * @deprecated use findDocs instead
      *

src/InMemoryDocumentStore.php

@@ -287,6 +287,20 @@ public function getDoc(string $collectionName, string $docId): ?array
         return $this->inMemoryConnection['documents'][$collectionName][$docId] ?? null;
     }
 
+    /**
+     * @inheritDoc
+     */
+    public function getPartialDoc(string $collectionName, PartialSelect $partialSelect, string $docId): ?array
+    {
+        $doc = $this->inMemoryConnection['documents'][$collectionName][$docId] ?? null;
+
+        if(null === $doc) {
+            return null;
+        }
+
+        return $this->transformToPartialDoc($doc, $partialSelect);
+    }
+
     /**
      * @inheritDoc
      */

tests/InMemoryDocumentStoreTest.php

@@ -242,6 +242,68 @@ public function it_filters_partial_docs()
         ], $result['c']);
     }
 
+    /**
+     * @test
+     */
+    public function it_gets_partial_doc_by_id()
+    {
+        $this->store->addCollection('test');
+
+        $docA = [
+            'some' => [
+                'prop' => 'foo',
+                'other' => [
+                    'nested' => 42
+                ]
+            ],
+            'baz' => 'bat',
+        ];
+        $this->store->addDoc('test', 'a', $docA);
+
+        $docB = [
+            'some' => [
+                'prop' => 'bar',
+                'other' => [
+                    'nested' => 43
+                ],
+                //'baz' => 'bat', missing so should be null
+            ],
+        ];
+        $this->store->addDoc('test', 'b', $docB);
+
+        $docC = [
+            'some' => [
+                'prop' => 'foo',
+                'other' => [
+                    //'nested' => 42, missing, so should be null
+                    'ignoredNested' => 'value'
+                ]
+            ],
+            'baz' => 'bat',
+        ];
+        $this->store->addDoc('test', 'c', $docC);
+
+        $partialSelect = new PartialSelect([
+            'some.alias' => 'some.prop', // Nested alias <- Nested field
+            'magicNumber' => 'some.other.nested', // Top level alias <- Nested Field
+            'baz', // Top level field
+        ]);
+
+        $docA = $this->store->getPartialDoc('test', $partialSelect, 'a');
+
+        $this->assertEquals([
+            'some' => [
+                'alias' => 'foo',
+            ],
+            'magicNumber' => 42,
+            'baz' => 'bat'
+        ], $docA);
+
+        $docD = $this->store->getPartialDoc('test', $partialSelect, 'd');
+
+        $this->assertNull($docD);
+    }
+
     /**
      * @test
      */