Ability to exclude searchable from 'searchables' => 'all'

Author: duncanmcclean

src/Search/ProvidesSearchables.php

@@ -18,4 +18,6 @@ public function provide(): Collection|LazyCollection;
     public function contains($searchable): bool;
 
     public function find(array $keys): Collection;
+
+    public function includedInAll(): bool;
 }

src/Search/Searchables.php

@@ -30,7 +30,9 @@ private function makeProviders()
         $providers = collect(Arr::wrap($this->index->config()['searchables'] ?? []));
 
         if ($providers->contains('all')) {
-            return $manager->providers()->map(fn ($_, $key) => $manager->make($key, $this->index, ['*']));
+            return $manager->providers()
+                ->filter->includedInAll()
+                ->map(fn ($_, $key) => $manager->make($key, $this->index, ['*']));
         }
 
         return $providers

src/Search/Searchables/Provider.php

@@ -50,6 +50,11 @@ public function setKeys(array $keys): self
         return $this;
     }
 
+    public function includedInAll(): bool
+    {
+        return true;
+    }
+
     protected function usesWildcard()
     {
         return in_array('*', $this->keys);

tests/Search/SearchablesTest.php

@@ -99,6 +99,39 @@ public function all_searchables_include_entries_terms_assets_and_users()
         $this->assertEquals($everything, $items->all());
     }
 
+    #[Test]
+    public function all_searchables_doesnt_include_searchable_where_included_in_all_is_false()
+    {
+        app(Providers::class)->register($entries = Mockery::mock(Entries::class)->makePartial());
+        app(Providers::class)->register($terms = Mockery::mock(Terms::class)->makePartial());
+        app(Providers::class)->register($assets = Mockery::mock(Assets::class)->makePartial());
+        app(Providers::class)->register($users = Mockery::mock(Users::class)->makePartial());
+
+        $entries->shouldReceive('provide')->andReturn(collect([$entryA = Entry::make(), $entryB = Entry::make()]));
+        $terms->shouldReceive('provide')->andReturn(collect([$termA = Term::make(), $termB = Term::make()]));
+        $assets->shouldReceive('provide')->andReturn(collect([$assetA = Asset::make(), $assetB = Asset::make()]));
+
+        $users->shouldReceive('includedInAll')->andReturn(false);
+        $users->shouldReceive('provide')->andReturn(collect([$userA = User::make(), $userB = User::make()]));
+
+        $searchables = $this->makeSearchables(['searchables' => 'all']);
+
+        $everythingApartFromUsers = [
+            $entryA,
+            $entryB,
+            $termA,
+            $termB,
+            $assetA,
+            $assetB,
+        ];
+
+        $items = $searchables->all();
+        $this->assertInstanceOf(Collection::class, $items);
+        $this->assertEquals($everythingApartFromUsers, $items->all());
+        $this->assertFalse($searchables->contains($userA));
+        $this->assertFalse($searchables->contains($userB));
+    }
+
     #[Test]
     public function it_gets_searchables_from_specific_providers()
     {