Encapsulate the facet distribution and facet stats in our own objects

src/Engine/FacetDistribution.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Engine;
+
+use Webmozart\Assert\Assert;
+
+/**
+ * @implements \IteratorAggregate<string, FacetValues>
+ * @implements \ArrayAccess<string, FacetValues>
+ */
+final class FacetDistribution implements \Countable, \IteratorAggregate, \ArrayAccess
+{
+    /** @var array<string, FacetValues> */
+    private array $facetValues = [];
+
+    /**
+     * @param array<string, mixed> $facetDistribution
+     */
+    public function __construct(array $facetDistribution)
+    {
+        foreach ($facetDistribution as $facet => $facetValues) {
+            Assert::isArray($facetValues);
+
+            $this->facetValues[$facet] = new FacetValues($facet, $facetValues);
+        }
+    }
+
+    /**
+     * @psalm-assert-if-true FacetValues $this->facetValues[$facet]
+     */
+    public function has(string $facet): bool
+    {
+        return isset($this->facetValues[$facet]);
+    }
+
+    public function get(string $facet): FacetValues
+    {
+        if (!$this->has($facet)) {
+            throw new \InvalidArgumentException(sprintf('Facet "%s" does not exist', $facet));
+        }
+
+        return $this->facetValues[$facet];
+    }
+
+    /**
+     * @return \ArrayIterator<string, FacetValues>
+     */
+    public function getIterator(): \ArrayIterator
+    {
+        return new \ArrayIterator($this->facetValues);
+    }
+
+    public function count(): int
+    {
+        return count($this->facetValues);
+    }
+
+    public function isEmpty(): bool
+    {
+        return [] === $this->facetValues;
+    }
+
+    public function offsetExists(mixed $offset): bool
+    {
+        return $this->has($offset);
+    }
+
+    public function offsetGet(mixed $offset): FacetValues
+    {
+        return $this->get($offset);
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        throw new \LogicException('You cannot set an offset');
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        throw new \LogicException('You cannot unset an offset');
+    }
+}

src/Engine/FacetStat.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Engine;
+
+final class FacetStat
+{
+    public readonly float|int $min;
+
+    public readonly float|int $max;
+
+    public function __construct(
+        public readonly string $name,
+        array $values,
+    ) {
+        if (!isset($values['min'], $values['max'])) {
+            throw new \InvalidArgumentException('The $values must contain a min and a max key');
+        }
+
+        if (!is_numeric($values['min']) || !is_numeric($values['max'])) {
+            throw new \InvalidArgumentException('The $values must contain numeric values');
+        }
+
+        $this->min = $values['min'] + 0;
+        $this->max = $values['max'] + 0;
+    }
+}

src/Engine/FacetStats.php

@@ -0,0 +1,84 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Engine;
+
+use Webmozart\Assert\Assert;
+
+/**
+ * @implements \IteratorAggregate<string, FacetStat>
+ * @implements \ArrayAccess<string, FacetStat>
+ */
+final class FacetStats implements \Countable, \IteratorAggregate, \ArrayAccess
+{
+    /** @var array<string, FacetStat> */
+    private array $facetStats = [];
+
+    /**
+     * @param array<string, mixed> $facetStats
+     */
+    public function __construct(array $facetStats)
+    {
+        foreach ($facetStats as $facet => $facetStat) {
+            Assert::isArray($facetStat);
+
+            $this->facetStats[$facet] = new FacetStat($facet, $facetStat);
+        }
+    }
+
+    /**
+     * @psalm-assert-if-true FacetStat $this->facetStats[$facet]
+     */
+    public function has(string $facet): bool
+    {
+        return isset($this->facetStats[$facet]);
+    }
+
+    public function get(string $facet): FacetStat
+    {
+        if (!$this->has($facet)) {
+            throw new \InvalidArgumentException(sprintf('Facet "%s" does not exist', $facet));
+        }
+
+        return $this->facetStats[$facet];
+    }
+
+    /**
+     * @return \ArrayIterator<string, FacetStat>
+     */
+    public function getIterator(): \ArrayIterator
+    {
+        return new \ArrayIterator($this->facetStats);
+    }
+
+    public function count(): int
+    {
+        return count($this->facetStats);
+    }
+
+    public function isEmpty(): bool
+    {
+        return [] === $this->facetStats;
+    }
+
+    public function offsetExists(mixed $offset): bool
+    {
+        return $this->has($offset);
+    }
+
+    public function offsetGet(mixed $offset): FacetStat
+    {
+        return $this->get($offset);
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        throw new \LogicException('You cannot set an offset');
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        throw new \LogicException('You cannot unset an offset');
+    }
+}

src/Engine/FacetValues.php

@@ -0,0 +1,121 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Setono\SyliusMeilisearchPlugin\Engine;
+
+use Webmozart\Assert\Assert;
+
+/**
+ * @implements \ArrayAccess<string, int>
+ * @implements \IteratorAggregate<string, int>
+ */
+final class FacetValues implements \Countable, \IteratorAggregate, \ArrayAccess
+{
+    /**
+     * This holds the facet values for the respective facet and search results. Examples for $values include:
+     *
+     * [
+     *   "Celsius Small" => 3
+     *   "Date & Banana" => 2
+     *   "Modern Wear" => 6
+     *   "You are breathtaking" => 10
+     * ]
+     *
+     * [
+     *   "false" => 16
+     *   "true" => 5
+     * ]
+     *
+     * [
+     *   "1.74" => 1
+     *   "12.21" => 1
+     *   "16.52" => 1
+     *   "21.06" => 1
+     *   "22.49" => 1
+     *   "24.19" => 1
+     * ]
+     *
+     * @var array<string, int>
+     */
+    private array $values = [];
+
+    public function __construct(
+        public readonly string $name,
+        array $values,
+    ) {
+        foreach ($values as $key => $value) {
+            if (!is_string($key) || !is_int($value)) {
+                throw new \InvalidArgumentException(sprintf(
+                    'The $values array must be an array of strings and integers. Input was: %s',
+                    json_encode($values, \JSON_THROW_ON_ERROR),
+                ));
+            }
+
+            $this->values[$key] = $value;
+        }
+    }
+
+    /**
+     * @return list<string>
+     */
+    public function getValues(): array
+    {
+        return array_keys($this->values);
+    }
+
+    public function getValueCount(string $value): int
+    {
+        if (!$this->has($value)) {
+            throw new \InvalidArgumentException(sprintf('Facet value "%s" does not exist', $value));
+        }
+
+        return $this->values[$value];
+    }
+
+    /**
+     * @psalm-assert-if-true int $this->values[$value]
+     */
+    public function has(string $value): bool
+    {
+        return isset($this->values[$value]);
+    }
+
+    /**
+     * @return \ArrayIterator<string, int>
+     */
+    public function getIterator(): \ArrayIterator
+    {
+        return new \ArrayIterator($this->values);
+    }
+
+    public function offsetExists(mixed $offset): bool
+    {
+        return $this->has($offset);
+    }
+
+    public function offsetGet(mixed $offset): int
+    {
+        return $this->values[$offset];
+    }
+
+    public function offsetSet(mixed $offset, mixed $value): void
+    {
+        throw new \LogicException('You cannot set an offset');
+    }
+
+    public function offsetUnset(mixed $offset): void
+    {
+        throw new \LogicException('You cannot unset an offset');
+    }
+
+    public function count(): int
+    {
+        return count($this->values);
+    }
+
+    public function isEmpty(): bool
+    {
+        return [] === $this->values;
+    }
+}

src/Engine/SearchResult.php

@@ -10,7 +10,7 @@
 
 final class SearchResult
 {
     public function __construct(
         /** The index that was queried */
         public readonly Index $index,
 
@@ -20,12 +20,8 @@
         public readonly int $page,
         public readonly int $pageSize,
         public readonly int $totalPages,
-
-        /** @var array<string, mixed> $facetStats */
-        public readonly array $facetStats,
-
-        /** @var array<string, mixed> $facetDistribution */
-        public readonly array $facetDistribution,
+        public readonly FacetStats $facetStats,
+        public readonly FacetDistribution $facetDistribution,
     ) {
     }
 
@@ -54,8 +50,8 @@
             $page,
             $pageSize,
             $totalPages,
-            $meilisearchSearchResult->getFacetStats(),
-            $meilisearchSearchResult->getFacetDistribution(),
+            new FacetStats($meilisearchSearchResult->getFacetStats()),
+            new FacetDistribution($meilisearchSearchResult->getFacetDistribution()),
         );
     }
 }

src/Form/Builder/CheckboxFilterFormBuilder.php

@@ -5,13 +5,15 @@
 namespace Setono\SyliusMeilisearchPlugin\Form\Builder;
 
 use Setono\SyliusMeilisearchPlugin\Document\Metadata\Facet;
+use Setono\SyliusMeilisearchPlugin\Engine\FacetStat;
+use Setono\SyliusMeilisearchPlugin\Engine\FacetValues;
 use Symfony\Component\Form\Extension\Core\Type\CheckboxType;
 use Symfony\Component\Form\FormBuilderInterface;
 use function Symfony\Component\String\u;
 
 final class CheckboxFilterFormBuilder implements FilterFormBuilderInterface
 {
-    public function build(FormBuilderInterface $builder, Facet $facet, array $values, array $stats = null): void
+    public function build(FormBuilderInterface $builder, Facet $facet, FacetValues $values, FacetStat $stats = null): void
     {
         $builder->add($facet->name, CheckboxType::class, [
             'label' => sprintf('setono_sylius_meilisearch.form.search.facet.%s', u($facet->name)->snake()),
@@ -24,7 +26,7 @@
         ]);
     }
 
-    public function supports(Facet $facet, array $values, array $stats = null): bool
+    public function supports(Facet $facet, FacetValues $values, FacetStat $stats = null): bool
     {
         return $facet->type === 'bool' && match (count($values)) {
             1 => isset($values['true']),