Use hooks to set query scope automatically

Author: ryanmitchell

README.md

@@ -41,10 +41,13 @@ By using `pluck('id')`, you ensure that the returned data is a flat array of IDs
 Here’s how to apply this advanced filter within your template:
 
 ```antlers
-{{ collection:articles query_scope="filter_builder" :filter_builder="my_filter_builder_field_handle" }}
+{{ collection:articles :filter_builder="my_filter_builder_field_handle" }}
     <!-- Articles that match the locations of the current page will be displayed -->
 {{ /collection:articles }}
+
 ```
+Note: the filter builder requires a query scope behind the scenes, so will not work alongside a query_scope parameter.
+
 You may combine the dynamic Filter Builder query with filter parameters.
 
 The Statamic Filter Builder addon is your pathway to creating a responsive and context-aware website, where content curation is as intelligent as it is effortless.

src/ServiceProvider.php

@@ -3,6 +3,7 @@
 namespace Tv2regionerne\StatamicFilterBuilder;
 
 use Statamic\Providers\AddonServiceProvider;
+use Statamic\Tags\Collection\Collection as CollectionTag;
 
 class ServiceProvider extends AddonServiceProvider
 {
@@ -20,4 +21,30 @@ class ServiceProvider extends AddonServiceProvider
             'resources/js/addon.js',
         ],
     ];
+
+    public function boot()
+    {
+        $this->addCollectionHook();
+    }
+
+    private function addCollectionHook(): self
+    {
+        CollectionTag::hook('init', function ($value, $next) {
+            if (! $this->params->get('filter_builder')) {
+                return $next($value);
+            }
+
+            if ($this->params->get('query_scope')) {
+                return $next($value);
+            }
+
+            $this->params = $this->params->merge([
+                'query_scope' => 'filter_builder',
+            ]);
+
+            return $next($value);
+        });
+
+        return $this;
+    }
 }

tests/TestCase.php

@@ -3,9 +3,25 @@
 namespace Tests;
 
 use Statamic\Testing\AddonTestCase;
+use Statamic\Testing\Concerns\PreventsSavingStacheItemsToDisk;
 use Tv2regionerne\StatamicFilterBuilder\ServiceProvider;
 
 class TestCase extends AddonTestCase
 {
+    use PreventsSavingStacheItemsToDisk;
+
+    protected $fakeStacheDirectory = __DIR__.'/__fixtures__/dev-null';
+
     protected string $addonServiceProvider = ServiceProvider::class;
+
+    protected function setUp(): void
+    {
+        parent::setUp();
+
+        $this->withoutVite();
+
+        if (! file_exists($this->fakeStacheDirectory)) {
+            mkdir($this->fakeStacheDirectory, 0777, true);
+        }
+    }
 }

tests/Unit/CollectionTagHookTest.php

@@ -0,0 +1,46 @@
+<?php
+
+use Statamic\Facades;
+use Statamic\Tags\Collection\Collection as CollectionTag;
+
+uses(Tests\TestCase::class);
+
+beforeEach(function () {
+    Facades\Collection::make()
+        ->handle('pages')
+        ->save();
+});
+
+it('adds query scope when none is applied', function () {
+    $params = [];
+    CollectionTag::hook('fetched-entries', function () use (&$params) {
+        $params = $this->params->all();
+    });
+
+    Facades\Antlers::parse('{{ collection:pages filter_builder="something" }}{{ title }}{{ /collection:pages }}');
+
+    $this->assertArrayHasKey('query_scope', $params);
+});
+
+it('doesnt add a query scope if one already exists', function () {
+    $params = [];
+    CollectionTag::hook('fetched-entries', function () use (&$params) {
+        $params = $this->params->all();
+    });
+
+    Facades\Antlers::parse('{{ collection:pages filter_builder="something" query_scope="some_scope" }}{{ title }}{{ /collection:pages }}');
+
+    $this->assertArrayHasKey('query_scope', $params);
+    $this->assertNotSame('filter_builder', $params['query_scope']);
+});
+
+it('doesn\'t add query scope when no filter builder param is added', function () {
+    $params = [];
+    CollectionTag::hook('fetched-entries', function () use (&$params) {
+        $params = $this->params->all();
+    });
+
+    Facades\Antlers::parse('{{ collection:pages }}{{ title }}{{ /collection:pages }}');
+
+    $this->assertArrayNotHasKey('query_scope', $params);
+});