[5.x] Add whereInId to EntryRepository (#11668)

Co-authored-by: Jason Varga <[email protected]>

Author: nadinengland

src/Contracts/Entries/EntryRepository.php

@@ -10,6 +10,8 @@ public function whereCollection(string $handle);
 
     public function whereInCollection(array $handles);
 
+    // public function whereInId(array $ids);
+
     public function find($id);
 
     public function findOrFail($id);

src/Stache/Repositories/EntryRepository.php

@@ -96,6 +96,19 @@ public function findByUri(string $uri, ?string $site = null): ?Entry
             : $entry;
     }
 
+    public function whereInId($ids): EntryCollection
+    {
+        $entries = $this->query()->whereIn('id', $ids)->get();
+        $entriesById = $entries->keyBy->id();
+
+        $ordered = collect($ids)
+            ->map(fn ($id) => $entriesById->get($id))
+            ->filter()
+            ->values();
+
+        return EntryCollection::make($ordered);
+    }
+
     public function save($entry)
     {
         if (! $entry->id()) {

tests/Stache/Repositories/EntryRepositoryTest.php

@@ -190,6 +190,27 @@ public function it_gets_entry_by_structure_uri()
         $this->assertEquals('Directors', $entry->title());
     }
 
+    #[Test]
+    #[DataProvider('entriesByIdsProvider')]
+    public function it_gets_entries_by_ids($ids, $expected)
+    {
+        $actual = $this->repo->whereInId($ids);
+
+        $this->assertInstanceOf(EntryCollection::class, $actual);
+        $this->assertEquals($expected, $actual->map->get('title')->all());
+    }
+
+    public static function entriesByIdsProvider()
+    {
+        return [
+            'no ids' => [[], []],
+            'single' => [['numeric-one'], ['One']],
+            'multiple' => [['numeric-one', 'numeric-two', 'numeric-three'], ['One', 'Two', 'Three']],
+            'missing' => [['numeric-one', 'unknown', 'numeric-three'], ['One', 'Three']],
+            'ordered' => [['numeric-three', 'numeric-one', 'numeric-two'], ['Three', 'One', 'Two']],
+        ];
+    }
+
     #[Test]
     public function it_saves_an_entry_to_the_stache_and_to_a_file()
     {