Update README.md

CHANGELOG.md

@@ -1,7 +0,0 @@
-# Changelog
-
-## [X.X.X] - XXXX-XX-XX
-- Allow passing in a space-separated string to the `classes` option
-
-## [1.0.0] - 2023-06-27
-- First major version release

README.md

@@ -1,3 +1,5 @@
+# DEPRECATED in favour of Symfony UX Icon
+
 # PCM Icon Bundle
 
 Use icons inside of Twig templates with ease! Project must be using Tailwind for the colours to work properly.
@@ -62,7 +64,7 @@ COLOUR:
 
 `hover (string)` Name of the colour to use when the icon is hovered over
 
-`classes (string[]|string)` Additional classes to add to the icon as either an array of strings or a space-separated string. This can cause Tailwind class collisions, so it is not recommended to use.
+`classes (string[])` Additional classes to add to the icon. This can cause Tailwind class collisions, so only use it as a last resort.
 
 ## Reminders
 Remember to add `./config/packages/*.yaml` as a value in your Tailwind config content array if it does not already exist. This will ensure Tailwind classes inside of the config file get compiled.

src/Exception/EmptyFileException.php

@@ -1,7 +0,0 @@
-<?php
-
-declare(strict_types=1);
-
-namespace Pcm\IconBundle\Exception;
-
-class EmptyFileException extends \Exception {};

src/Twig/Runtime/IconRuntime.php

@@ -5,7 +5,6 @@ declare(strict_types=1);
 namespace Pcm\IconBundle\Twig\Runtime;
 
 use Pcm\IconBundle\Exception\ColourNotFound;
-use Pcm\IconBundle\Exception\EmptyFileException;
 use Pcm\IconBundle\Exception\IconNotFound;
 use Twig\Extension\RuntimeExtensionInterface;
 
@@ -17,7 +16,7 @@ final class IconRuntime implements RuntimeExtensionInterface
         'size'    => null,
         'colour'  => null,
         'hover'   => null,
-        'classes' => "",
+        'classes' => [],
     ];
 
     public function __construct(private array $defaultOptions, private array $directories, private array $colours)
@@ -27,13 +26,12 @@ final class IconRuntime implements RuntimeExtensionInterface
      * @param array $options
      * ```
      * $options = [
-     *     'icon'    => (string)          **REQUIRED** Icon name without trailing `.svg`
+     *     'icon'    => (string)  **REQUIRED** Icon name without trailing `.svg`
-     *     'title'   => (?string)         Title text to appear on mouse hover
+     *     'title'   => (?string) Title text to appear on mouse hover
-     *     'size'    => (int)             Height and width in px
+     *     'size'    => (int)     Height and width in px
-     *     'colour'  => (string)          Main colour
+     *     'colour'  => (string)  Main colour
-     *     'hover'   => (?string)         Hover colour
+     *     'hover'   => (?string) Hover colour
-     *     'classes' => (string[]|string) Additional classes to add to the icon, given as
+     *     'classes' => (array)   Additional classes to add to the icon. Not recommended.
-     *                                    an array of strings or a space-separated string.
      * ]
      * ```
      *
@@ -45,10 +43,6 @@ final class IconRuntime implements RuntimeExtensionInterface
 
         $svg = $this->getSvg($options['icon']);
 
-        if (empty($svg)) {
-            throw new EmptyFileException(\sprintf("The file %s.svg was found, but it was empty!", $options['icon']));
-        }
-
         $this->sanitiseSvg($svg);
 
         $colourClasses = $this->getColourClasses($options['colour'], $options['hover']);
@@ -66,9 +60,9 @@ final class IconRuntime implements RuntimeExtensionInterface
         return $svg;
     }
 
-    private function getExtraClasses(array|string $extraClasses): string
+    private function getExtraClasses(array $extraClasses): string
     {
-        return \is_array($extraClasses) ? implode(' ', $extraClasses) : $extraClasses;
+        return implode(' ', $extraClasses);
     }
 
     private function mergeWithDefaultOptions(array $userOptions): array
@@ -109,9 +103,6 @@ final class IconRuntime implements RuntimeExtensionInterface
         $this->removeBlackFillAttributes($svg);
     }
 
-    /**
-     * @throws IconNotFound when an svg file with the passed in name cannot be found
-     */
     private function findSvgFilepath(string $iconName): string
     {
         foreach ($this->directories as $directory) {

tests/Twig/Runtime/IconRuntimeTest.php

@@ -6,7 +6,6 @@ namespace Pcm\IconBundle\Tests\Twig\Functions;
 
 use Pcm\IconBundle\DependencyInjection\Configuration;
 use Pcm\IconBundle\Exception\ColourNotFound;
-use Pcm\IconBundle\Exception\EmptyFileException;
 use Pcm\IconBundle\Exception\IconNotFound;
 use Pcm\IconBundle\Twig\Runtime\IconRuntime;
 use PHPUnit\Framework\TestCase;
@@ -51,12 +50,6 @@ class IconRuntimeTest extends TestCase
         $this->icon->renderIcon(['icon' => random_bytes(8)]);
     }
 
-    public function testThrowsIfPassedInAnEmptyFile(): void
-    {
-        $this->expectException(EmptyFileException::class);
-        $this->icon->renderIcon(['icon' => 'empty']);
-    }
-
     public function testNoTitleExistsIfNotPassedIn(): void
     {
         $content = $this->icon->renderIcon(['icon' => self::ICON]);
@@ -232,26 +225,19 @@ class IconRuntimeTest extends TestCase
         $this->assertMatchesRegularExpression('/<svg.+class=".*group-hover:stroke-white.*".*>/', $contents);
     }
 
-    public function testExtraClassesThrowsIfNotAnArrayOrString(): void
+    public function testExtraClassesThrowsIfNotAnArray(): void
     {
         $this->expectException(\TypeError::class);
-        $this->icon->renderIcon(['icon' => self::ICON, 'classes' => 1]);
+        $this->icon->renderIcon(['icon' => self::ICON, 'classes' => 'string_value']);
     }
 
-    public function testExtraClassesGetAddedFromArray(): void
+    public function testExtraClassesGetAdded(): void
     {
         $contents = $this->icon->renderIcon(['icon' => self::ICON, 'classes' => ['abc', 'def']]);
         $this->assertMatchesRegularExpression('/<svg.+class=".*abc.*".*>/', $contents);
         $this->assertMatchesRegularExpression('/<svg.+class=".*def.*".*>/', $contents);
     }
 
-    public function testExtraClassesGetAddedFromString(): void
-    {
-        $contents = $this->icon->renderIcon(['icon' => self::ICON, 'classes' => 'ghi jkl']);
-        $this->assertMatchesRegularExpression('/<svg.+class=".*ghi.*".*>/', $contents);
-        $this->assertMatchesRegularExpression('/<svg.+class=".*jkl.*".*>/', $contents);
-    }
-
     public function testAddingExtraClassesDoesntStripAwayColourClasses(): void
     {
         $contents = $this->icon->renderIcon(['icon' => self::ICON, 'classes' => ['abc']]);