Add AssetExtension

Author: devanych

src/Extension/AssetExtension.php

@@ -0,0 +1,78 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Devanych\View\Extension;
+
+use RuntimeException;
+
+use function file_exists;
+use function filemtime;
+use function ltrim;
+use function rtrim;
+use function sprintf;
+
+final class AssetExtension implements ExtensionInterface
+{
+    /**
+     * @var string root directory storing the published asset files.
+     */
+    private string $basePath;
+
+    /**
+     * @var string base URL through which the published asset files can be accessed.
+     */
+    private string $baseUrl;
+
+    /**
+     * @var bool whether to append a timestamp to the URL of every published asset.
+     */
+    private bool $appendTimestamp;
+
+    /**
+     * @param string $basePath root directory storing the published asset files.
+     * @param string $baseUrl base URL through which the published asset files can be accessed.
+     * @param bool $appendTimestamp whether to append a timestamp to the URL of every published asset.
+     */
+    public function __construct(string $basePath, string $baseUrl = '', bool $appendTimestamp = false)
+    {
+        $this->basePath = rtrim($basePath, '\/');
+        $this->baseUrl = rtrim($baseUrl, '/');
+        $this->appendTimestamp = $appendTimestamp;
+    }
+
+    /**
+     * {@inheritDoc}
+     */
+    public function getFunctions(): array
+    {
+        return [
+            'asset' => [$this, 'assetFile'],
+        ];
+    }
+
+    /**
+     * Includes the asset file and appends a timestamp with the last modification of that file.
+     *
+     * @param string $file
+     * @return string
+     */
+    public function assetFile(string $file): string
+    {
+        $url = $this->baseUrl . '/' . ltrim($file, '/');
+        $path = $this->basePath . '/' . ltrim($file, '/');
+
+        if (!file_exists($path)) {
+            throw new RuntimeException(sprintf(
+                'Asset file "%s" does not exist.',
+                $path
+            ));
+        }
+
+        if ($this->appendTimestamp) {
+            return $url . '?v=' . filemtime($path);
+        }
+
+        return $url;
+    }
+}

tests/Extension/AssetExtensionTest.php

@@ -0,0 +1,67 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Devanych\Tests\View\Extension;
+
+use Devanych\View\Extension\AssetExtension;
+use PHPUnit\Framework\TestCase;
+use RuntimeException;
+
+use function filemtime;
+use function realpath;
+
+class AssetExtensionTest extends TestCase
+{
+    /**
+     * @var string
+     */
+    private string $baseUrl;
+
+    /**
+     * @var string
+     */
+    private string $basePath;
+
+    public function setUp(): void
+    {
+        $this->baseUrl = 'https://example.com/assets';
+        $this->basePath = realpath(__DIR__ . '/../TestAsset/assets');
+    }
+
+    public function testConstructorTrimsTrailingSlash(): void
+    {
+        $extension = new AssetExtension($this->basePath . '////', $this->baseUrl);
+        $this->assertSame($this->baseUrl . '/style.css', $extension->assetFile('style.css'));
+
+        $extension = new AssetExtension($this->basePath . '\\\\', $this->baseUrl);
+        $this->assertSame($this->baseUrl . '/style.css', $extension->assetFile('style.css'));
+
+        $extension = new AssetExtension($this->basePath . '\/\/', $this->baseUrl . '///');
+        $this->assertSame($this->baseUrl . '/style.css', $extension->assetFile('style.css'));
+    }
+
+    public function testAssetFileWithTrueAppendTimestampFlag(): void
+    {
+        $extension = $extension = new AssetExtension($this->basePath, $this->baseUrl, true);
+        $expected = $this->baseUrl . '/style.css?v=' . filemtime($this->basePath . '/style.css');
+        $this->assertSame($expected, $extension->assetFile('style.css'));
+    }
+
+    public function testAssetFileTrimsLeadingSlash(): void
+    {
+        $extension = $extension = new AssetExtension($this->basePath, $this->baseUrl);
+        $this->assertSame($this->baseUrl . '/style.css', $extension->assetFile('/style.css'));
+
+        $extension = $extension = new AssetExtension($this->basePath, $this->baseUrl, true);
+        $expected = $this->baseUrl . '/style.css?v=' . filemtime($this->basePath . '/style.css');
+        $this->assertSame($expected, $extension->assetFile('///style.css'));
+    }
+
+    public function testAssetFileThrowRuntimeExceptionForNonExistAssetFile(): void
+    {
+        $extension = $extension = new AssetExtension($this->basePath, $this->baseUrl);
+        $this->expectException(RuntimeException::class);
+        $extension->assetFile('asset/file/not/exist');
+    }
+}