Add Iconify chunk()

Author: smnandre

src/Icons/src/Iconify.php

@@ -27,19 +27,27 @@ final class Iconify
 {
     public const API_ENDPOINT = 'https://api.iconify.design';
 
+    // URL must be 500 chars max (iconify limit)
+    // -39 chars: https://api.iconify.design/XXX.json?icons=
+    // -safe margin
+    private const int MAX_ICONS_QUERY_LENGTH = 400;
+
     private HttpClientInterface $http;
     private \ArrayObject $sets;
+    private int $maxIconsQueryLength;
 
     public function __construct(
         private CacheInterface $cache,
         string $endpoint = self::API_ENDPOINT,
         ?HttpClientInterface $http = null,
+        ?int $maxIconsQueryLength = null,
     ) {
         if (!class_exists(HttpClient::class)) {
             throw new \LogicException('You must install "symfony/http-client" to use Iconify. Try running "composer require symfony/http-client".');
         }
 
         $this->http = ScopingHttpClient::forBaseUri($http ?? HttpClient::create(), $endpoint);
+        $this->maxIconsQueryLength = min(self::MAX_ICONS_QUERY_LENGTH, $maxIconsQueryLength ?? self::MAX_ICONS_QUERY_LENGTH);
     }
 
     public function metadataFor(string $prefix): array
@@ -95,13 +103,10 @@ public function fetchIcons(string $prefix, array $names): array
         sort($names);
         $queryString = implode(',', $names);
         if (!preg_match('#^[a-z0-9-,]+$#', $queryString)) {
-            throw new \InvalidArgumentException('Invalid icon names.');
+            throw new \InvalidArgumentException('Invalid icon names.'.$queryString);
         }
 
-        // URL must be 500 chars max (iconify limit)
-        // -39 chars: https://api.iconify.design/XXX.json?icons=
-        // -safe margin
-        if (450 < \strlen($prefix.$queryString)) {
+        if (self::MAX_ICONS_QUERY_LENGTH < \strlen($prefix.$queryString)) {
             throw new \InvalidArgumentException('The query string is too long.');
         }
 
@@ -155,6 +160,40 @@ public function searchIcons(string $prefix, string $query)
         return new \ArrayObject($response->toArray());
     }
 
+    /**
+     * @return iterable<string[]>
+     */
+    public function chunk(string $prefix, array $names): iterable
+    {
+        if (100 < ($prefixLength = strlen($prefix))) {
+            throw new \InvalidArgumentException(sprintf('The icon prefix "%s" is too long.', $prefix));
+        }
+
+        $maxLength = $this->maxIconsQueryLength - $prefixLength;
+
+        $curBatch = [];
+        $curLength = 0;
+        foreach ($names as $name) {
+            if (100 < ($nameLength = strlen($name))) {
+                throw new \InvalidArgumentException(sprintf('The icon name "%s" is too long.', $name));
+            }
+            if ($curLength && ($maxLength < ($curLength + $nameLength + 1))) {
+                yield $curBatch;
+
+                $curBatch = [];
+                $curLength = 0;
+            }
+            $curLength += $nameLength + 1;
+            $curBatch[] = $name;
+        }
+
+        if ($curLength) {
+            yield $curBatch;
+        }
+
+        yield from [];
+    }
+
     private function sets(): \ArrayObject
     {
         return $this->sets ??= $this->cache->get('ux-iconify-sets', function () {

src/Icons/tests/Unit/IconifyTest.php

@@ -238,6 +238,85 @@ public function testGetMetadata(): void
         $this->assertSame('Font Awesome Solid', $metadata['name']);
     }
 
+    /**
+     * @dataProvider provideChunkCases
+     */
+    public function testChunk(int $maxQueryLength, string $prefix, array $names, array $chunks): void
+    {
+        $iconify = new Iconify(
+            new NullAdapter(),
+            'https://example.com',
+            new MockHttpClient([]),
+            $maxQueryLength,
+        );
+
+        $this->assertSame($chunks, iterator_to_array($iconify->chunk($prefix, $names)));
+    }
+
+    public static function provideChunkCases(): iterable
+    {
+        yield 'no icon should make no chunk' => [
+            10,
+            'ppppp',
+            [],
+            [],
+        ];
+
+        yield 'one icon should make one chunk' => [
+            10,
+            'ppppp',
+            ['aaaa1'],
+            [['aaaa1']],
+        ];
+
+        yield 'two icons that should make two chunck' => [
+            10,
+            'ppppp',
+            ['aa1', 'aa2'],
+            [['aa1'], ['aa2']],
+        ];
+
+        yield 'three icons that should make two chunck' => [
+            15,
+            'ppppp',
+            ['aaa1', 'aaa2', 'aaa3'],
+            [['aaa1', 'aaa2'], ['aaa3']],
+        ];
+
+        yield 'four icons that should make two chunck' => [
+            15,
+            'ppppp',
+            ['aaaaaaaa1', 'a2', 'a3', 'a4'],
+            [['aaaaaaaa1'], ['a2', 'a3', 'a4']],
+        ];
+    }
+
+    public function testChunkThrowWithIconPrefixTooLong(): void
+    {
+        $iconify = new Iconify(new NullAdapter(), 'https://example.com', new MockHttpClient([]));
+
+        $prefix = str_pad('p', 101, 'p');
+        $name = 'icon';
+
+        $this->expectExceptionMessage(sprintf('The icon prefix "%s" is too long.', $prefix));
+
+        // We need to iterate over the iterator to trigger the exception
+        $result = iterator_to_array($iconify->chunk($prefix, [$name]));
+    }
+
+    public function testChunkThrowWithIconNameTooLong(): void
+    {
+        $iconify = new Iconify(new NullAdapter(), 'https://example.com', new MockHttpClient([]));
+
+        $prefix = 'prefix';
+        $name = str_pad('n', 101, 'n');
+
+        $this->expectExceptionMessage(sprintf('The icon name "%s" is too long.', $name));
+
+        // We need to iterate over the iterator to trigger the exception
+        $result = iterator_to_array($iconify->chunk($prefix, [$name]));
+    }
+
     private function createHttpClient(mixed $data, int $code = 200): MockHttpClient
     {
         $mockResponse = new JsonMockResponse($data, ['http_code' => $code]);