309 lines
12 KiB
PHP
309 lines
12 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Pcm\IconBundle\Tests\Twig\Functions;
|
|
|
|
use Pcm\IconBundle\Twig\Functions\IconExtension;
|
|
use Pcm\IconBundle\Twig\Functions\IconNotFound;
|
|
use Pcm\IconBundle\Twig\Functions\PalleteNotFound;
|
|
use PHPUnit\Framework\TestCase;
|
|
|
|
class IconExtensionTest extends TestCase
|
|
{
|
|
private const ICON = 'test';
|
|
|
|
private const PALLETES = [
|
|
'primary' => [
|
|
'fill' => 'fill-primary',
|
|
'stroke' => 'stroke-primary',
|
|
'fill-hover' => 'hover:fill-primary',
|
|
'stroke-hover' => 'hover:stroke-primary',
|
|
'fill-group-hover' => 'group-hover:fill-primary',
|
|
'stroke-group-hover' => 'group-hover:stroke-primary',
|
|
],
|
|
'white' => [
|
|
'fill' => 'fill-white',
|
|
'stroke' => 'stroke-white',
|
|
'fill-hover' => 'hover:fill-white',
|
|
'stroke-hover' => 'hover:stroke-white',
|
|
'fill-group-hover' => 'group-hover:fill-white',
|
|
'stroke-group-hover' => 'group-hover:stroke-white',
|
|
]
|
|
];
|
|
|
|
/**
|
|
* @var IconExtension
|
|
*/
|
|
private IconExtension $icon;
|
|
|
|
protected function setUp(): void
|
|
{
|
|
$this->icon = new IconExtension(['tests/icons'], self::PALLETES);
|
|
}
|
|
|
|
public function testInstanceOf(): void
|
|
{
|
|
$this->assertInstanceOf(IconExtension::class, $this->icon);
|
|
}
|
|
|
|
public function testThrowsIfDirectoriesIsEmpty(): void
|
|
{
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
new IconExtension([], self::PALLETES);
|
|
}
|
|
|
|
public function testThrowsIfDirectoriesContainsNonString(): void
|
|
{
|
|
$this->expectException(\TypeError::class);
|
|
new IconExtension([99], self::PALLETES);
|
|
}
|
|
|
|
public function testThrowsIfDirectoriesContainsNonStringAmongStrings(): void
|
|
{
|
|
$this->expectException(\TypeError::class);
|
|
new IconExtension(['string', 99, 'string'], self::PALLETES);
|
|
}
|
|
|
|
public function testThrowsWhenPassedAnInvalidIconName(): void
|
|
{
|
|
$this->expectException(IconNotFound::class);
|
|
$this->icon->renderIcon(['icon' => random_bytes(8)]);
|
|
}
|
|
|
|
public function testNoTitleExistsIfNotPassedIn(): void
|
|
{
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON]);
|
|
$this->assertStringNotContainsString('<title>', $content);
|
|
$this->assertStringNotContainsString('</title>', $content);
|
|
}
|
|
|
|
public function testTitleGetsAddedIfSpecified(): void
|
|
{
|
|
$title = 'test_title';
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON, 'title' => $title]);
|
|
$this->assertMatchesRegularExpression("/<title>{$title}<\/title>/", $content);
|
|
}
|
|
|
|
public function testTitleThrowsIfNotPassedAString(): void
|
|
{
|
|
$this->expectException(\TypeError::class);
|
|
$this->icon->renderIcon(['icon' => self::ICON, 'title' => 99]);
|
|
}
|
|
|
|
public function testTitleThrowsIfPassedAnEmptyString():void
|
|
{
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
$this->icon->renderIcon(['icon' => self::ICON, 'title' => '']);
|
|
}
|
|
|
|
public function testThrowsWhenPassedNegativeSizeValue(): void
|
|
{
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
$this->icon->renderIcon(['icon' => self::ICON, 'size' => -1]);
|
|
}
|
|
|
|
public function testThrowsWhenSizeIsNotAnInt(): void
|
|
{
|
|
$this->expectException(\TypeError::class);
|
|
$this->icon->renderIcon(['icon' => self::ICON, 'size' => 1.0]);
|
|
}
|
|
|
|
public function testSvgWidthIsSet(): void
|
|
{
|
|
$regex = '/^<svg.+?width="99"/';
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON, 'size' => 99]);
|
|
$this->assertMatchesRegularExpression($regex, $content);
|
|
}
|
|
|
|
public function testSvgHeightIsSet(): void
|
|
{
|
|
$regex = '/^<svg.+?width="99"/';
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON, 'size' => 99]);
|
|
$this->assertMatchesRegularExpression($regex, $content);
|
|
}
|
|
|
|
public function testNoXmlDeclarationIsAdded(): void
|
|
{
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON, 'size' => 99]);
|
|
$this->assertStringNotContainsString('<xml', $content);
|
|
}
|
|
|
|
public function testOnlyOneWidthAttributeIsSet(): void
|
|
{
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON, 'size' => 99]);
|
|
$timesMatched = preg_match_all('/width="99"/', $content);
|
|
$this->assertSame(1, $timesMatched);
|
|
}
|
|
|
|
public function testOnlyOneHeightAttributeIsSet(): void
|
|
{
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON, 'size' => 99]);
|
|
$timesMatched = preg_match_all('/height="99"/', $content);
|
|
$this->assertSame(1, $timesMatched);
|
|
}
|
|
|
|
public function testDefaultSizeIsSetOnSvgIfNoSizeOptionPassed(): void
|
|
{
|
|
$defaultSize = IconExtension::DEFAULT_SIZE;
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON]);
|
|
|
|
$regex = "/^<svg.+?width=\"{$defaultSize}\"/";
|
|
$this->assertMatchesRegularExpression($regex, $content);
|
|
|
|
$regex = "/^<svg.+?height=\"{$defaultSize}\"/";
|
|
$this->assertMatchesRegularExpression($regex, $content);
|
|
}
|
|
|
|
public function testDefaultSizeIsOnlySetOnce(): void
|
|
{
|
|
$defaultSize = IconExtension::DEFAULT_SIZE;
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON]);
|
|
|
|
$widthRegex = "/width=\"{$defaultSize}\"/";
|
|
$timesMatched = preg_match_all($widthRegex, $content);
|
|
$this->assertSame(1, $timesMatched);
|
|
|
|
$heightRegex = "/height=\"{$defaultSize}\"/";
|
|
$timesMatched = preg_match_all($heightRegex, $content);
|
|
$this->assertSame(1, $timesMatched);
|
|
}
|
|
|
|
public function testThrowsIfPalletsIsEmpty(): void
|
|
{
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
new IconExtension(['/'], []);
|
|
}
|
|
|
|
public function testThrowsIfPalletesContainsNonArray(): void
|
|
{
|
|
$this->expectException(\TypeError::class);
|
|
new IconExtension(['/'], [99]);
|
|
}
|
|
|
|
public function testThrowsIfPalletesContainsNonArrayInbetweenArrays(): void
|
|
{
|
|
$this->expectException(\TypeError::class);
|
|
new IconExtension(['/'], [[], 99, []]);
|
|
}
|
|
|
|
public function testThrowsIfChildArrayDoesntContainStrokeKey(): void
|
|
{
|
|
$this->expectException(\Exception::class);
|
|
new IconExtension(['/'], [['fill' => '', 'fill-hover' => '', 'stroke-hover' => '', 'fill-group-hover' => '', 'stroke-group-hover' => '']]);
|
|
}
|
|
|
|
public function testThrowsIfChildArrayDoesntContainFillKey(): void
|
|
{
|
|
$this->expectException(\Exception::class);
|
|
new IconExtension(['/'], [['stroke' => '', 'fill-hover' => '', 'stroke-hover' => '', 'fill-group-hover' => '', 'stroke-group-hover' => '']]);
|
|
}
|
|
|
|
public function testThrowsIfChildArrayDoesntContainFillHoverKey(): void
|
|
{
|
|
$this->expectException(\Exception::class);
|
|
new IconExtension(['/'], [['fill' => '', 'stroke' => '', 'stroke-hover' => '', 'fill-group-hover' => '', 'stroke-group-hover' => '']]);
|
|
}
|
|
|
|
public function testThrowsIfChildArrayDoesntContainStrokeHoverKey(): void
|
|
{
|
|
$this->expectException(\Exception::class);
|
|
new IconExtension(['/'], [['fill' => '', 'stroke' => '', 'fill-hover' => '', 'fill-group-hover' => '', 'stroke-group-hover' => '']]);
|
|
}
|
|
|
|
public function testThrowsIfChildArrayDoesntContainFillGroupHoverKey(): void
|
|
{
|
|
$this->expectException(\Exception::class);
|
|
new IconExtension(['/'], [['fill' => '', 'stroke' => '', 'fill-hover' => '', 'stroke-hover' => '', 'stroke-group-hover' => '']]);
|
|
}
|
|
|
|
public function testThrowsIfChildArrayDoesntContainStrokeGroupHoverKey(): void
|
|
{
|
|
$this->expectException(\Exception::class);
|
|
new IconExtension(['/'], [['fill' => '', 'stroke' => '', 'fill-hover' => '', 'stroke-hover' => '', 'fill-group-hover' => '']]);
|
|
}
|
|
|
|
public function testBlackStrokeAttributeValuesAreRemoved(): void
|
|
{
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON]);
|
|
$this->assertDoesNotMatchRegularExpression('/stroke="\s*#000\s*"/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/stroke="\s*#000000\s*"/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/stroke="\s*#black\s*"/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/stroke="\s*rgb\(0,\s*0,\s*0\)\s*"/', $content);
|
|
}
|
|
|
|
public function testBlackStrokeStylesAreRemoved(): void
|
|
{
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON]);
|
|
$this->assertDoesNotMatchRegularExpression('/stroke:\s*#000\s*/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/stroke:\s*#000000\s*/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/stroke:\s*black\s*/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/stroke:\s*rgb\(0,\s*0,\s*0\)\s*/', $content);
|
|
}
|
|
|
|
public function testBlackFillAttributeValuesAreRemoved(): void
|
|
{
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON]);
|
|
$this->assertDoesNotMatchRegularExpression('/fill="\s*#000\s*"/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/fill="\s*#000000\s*"/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/fill="\s*#black\s*"/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/fill="\s*rgb\(0,\s*0,\s*0\)\s*"/', $content);
|
|
}
|
|
|
|
public function testBlackFillStylesAreRemoved(): void
|
|
{
|
|
$content = $this->icon->renderIcon(['icon' => self::ICON]);
|
|
$this->assertDoesNotMatchRegularExpression('/fill:\s*#000\s*/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/fill:\s*#000000\s*/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/fill:\s*black\s*/', $content);
|
|
$this->assertDoesNotMatchRegularExpression('/fill:\s*rgb\(0,\s*0,\s*0\)\s*/', $content);
|
|
}
|
|
|
|
public function testThrowsIfColourPalleteIsNotFound(): void
|
|
{
|
|
$this->expectException(PalleteNotFound::class);
|
|
$this->icon->renderIcon(['icon' => self::ICON, 'colour' => 'red']);
|
|
}
|
|
|
|
public function testSvgClassContainsPalleteClasses(): void
|
|
{
|
|
$contents = $this->icon->renderIcon(['icon' => self::ICON, 'colour' => 'white']);
|
|
$this->assertMatchesRegularExpression('/<svg.*?class=".*?fill-white.*?>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.*?class=".*?stroke-white?.*>/', $contents);
|
|
}
|
|
|
|
public function testThrowsIfHoverPalleteIsNotFound(): void
|
|
{
|
|
$this->expectException(PalleteNotFound::class);
|
|
$this->icon->renderIcon(['icon' => self::ICON, 'hover' => 'red']);
|
|
}
|
|
|
|
public function testSvgClassContainsHoverPalleteClasses(): void
|
|
{
|
|
$contents = $this->icon->renderIcon(['icon' => self::ICON, 'hover' => 'white']);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*cursor-pointer.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*hover:fill-white.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*hover:stroke-white.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*group-hover:fill-white.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*group-hover:stroke-white.*".*>/', $contents);
|
|
}
|
|
|
|
public function testSvgClassContainsHoverAndColourPalleteClasses(): void
|
|
{
|
|
$contents = $this->icon->renderIcon(['icon' => self::ICON, 'hover' => 'white', 'colour' => 'primary']);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*fill-primary.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*stroke-primary.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*cursor-pointer.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*hover:fill-white.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*hover:stroke-white.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*group-hover:fill-white.*".*>/', $contents);
|
|
$this->assertMatchesRegularExpression('/<svg.+class=".*group-hover:stroke-white.*".*>/', $contents);
|
|
}
|
|
|
|
public function testThrowsIfInvalidOptionPassed(): void
|
|
{
|
|
$this->expectException(\InvalidArgumentException::class);
|
|
$this->icon->renderIcon(['icon' => self::ICON, 'fake-key-should-throw' => null]);
|
|
}
|
|
}
|