🦺 check for form in filter

Author: garak

.github/workflows/build.yaml

@@ -72,7 +72,7 @@ jobs:
               run: composer config minimum-stability dev && composer config prefer-stable true
               if: contains(matrix.symfony, '@dev')
             - name: Install dependencies
-              uses: ramsey/composer-install@v3
+              uses: ramsey/composer-install@v4
               with:
                   dependency-versions: ${{ matrix.dependencies }}
               env:

src/Filter.php

@@ -15,21 +15,27 @@ final class Filter
     /** @var array<int|string, FormInterface> */
     private array $forms = [];
 
-    public function __construct(private FormFactoryInterface $formFactory, private RequestStack $requestStack)
-    {
+    public function __construct(
+        private readonly FormFactoryInterface $formFactory,
+        private readonly RequestStack $requestStack,
+    ) {
     }
 
     /**
      * Perform actual filtering. You need to pass an identifying name.
      * You'll get an array with name of fields as keys and the filtered values
      * as values (except for "_sort" key, which holds info for sorting).
+     * You need to call saveFilter() before calling this method.
      *
      * @return array<string, mixed>
      */
     public function filter(string $name): array
     {
         $filter = [];
         $fname = $name.$this->getSession()->getId();
+        if (!isset($this->forms[$fname])) {
+            throw new \UnexpectedValueException(\sprintf('No filter found for "%s". Did you call saveFilter()?', $name));
+        }
         /** @var array<string, mixed>|null $values */
         $values = $this->getSession()->get('filter.'.$name);
         if (null !== $values) {

tests/FilterTest.php

@@ -2,6 +2,7 @@
 
 namespace PUGX\FilterBundle\Tests;
 
+use Filter\FilterException;
 use PHPUnit\Framework\TestCase;
 use PUGX\FilterBundle\Filter;
 use Symfony\Component\Form\FormFactoryInterface;
@@ -29,6 +30,12 @@ protected function setUp(): void
         $this->filter = new Filter($this->factory, $stack);
     }
 
+    public function testFilterWithoutSaveFilterShouldThrowException(): void
+    {
+        $this->expectException(\UnexpectedValueException::class);
+        $this->filter->filter('foo');
+    }
+
     public function testFilter(): void
     {
         $this->filter->saveFilter(StubFormType::class, 'foo');
@@ -72,6 +79,7 @@ public function testFormViewWithoutPreviousForm(): void
 
     public function testSort(): void
     {
+        $this->filter->saveFilter(StubFormType::class, 'foo');
         $this->filter->sort('foo', 'bar');
         $filter = $this->filter->filter('foo');
         self::assertArrayHasKey('_sort', $filter);