Merge pull request #34 from Becklyn/next

Jannik Zschiesche · web-flow · commit cef5581ebc80 · 2020-01-17T00:49:23.000+01:00
Properly wire specialized file types + fix circular dependency issue
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,11 @@
+2.6.5
+=====
+
+*   (bug) Fixed a circular dependency issue.
+*   (improvement) The specialized file types are now properly autowired.
+*   (internal) Bump required Symfony version to 4.3+
+
+
 2.6.4
 =====
 
diff --git a/composer.json b/composer.json
@@ -21,15 +21,15 @@
         "ext-json": "*",
         "becklyn/html-builder": "^2.0",
         "psr/cache": "^1.0",
-        "symfony/config": "^4.2 || ^5.0",
-        "symfony/console": "^4.2 || ^5.0",
-        "symfony/dependency-injection": "^4.2 || ^5.0",
-        "symfony/filesystem": "^4.2 || ^5.0",
-        "symfony/finder": "^4.2 || ^5.0",
-        "symfony/http-kernel": "^4.2 || ^5.0",
+        "symfony/config": "^4.3 || ^5.0",
+        "symfony/console": "^4.3 || ^5.0",
+        "symfony/dependency-injection": "^4.3 || ^5.0",
+        "symfony/filesystem": "^4.3 || ^5.0",
+        "symfony/finder": "^4.3 || ^5.0",
+        "symfony/http-kernel": "^4.3 || ^5.0",
         "symfony/mime": "^4.3 || ^5.0",
-        "symfony/process": "^4.2 || ^5.0",
-        "symfony/routing": "^4.2 || ^5.0",
+        "symfony/process": "^4.3 || ^5.0",
+        "symfony/routing": "^4.3 || ^5.0",
         "symfony/service-contracts": "^1.1 || ^2.0",
         "twig/twig": "^2.9 || ^3.0"
     },
diff --git a/src/BecklynAssetsBundle.php b/src/BecklynAssetsBundle.php
@@ -3,12 +3,30 @@
 namespace Becklyn\AssetsBundle;
 
 use Becklyn\AssetsBundle\DependencyInjection\BecklynAssetsExtension;
+use Becklyn\AssetsBundle\File\Type\SpecializedFileType;
+use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 
 class BecklynAssetsBundle extends Bundle
 {
+    /**
+     * @inheritDoc
+     */
     public function getContainerExtension ()
     {
         return new BecklynAssetsExtension();
     }
+
+
+    /**
+     * @inheritDoc
+     */
+    public function build (ContainerBuilder $container) : void
+    {
+        $container
+            ->registerForAutoconfiguration(SpecializedFileType::class)
+            ->addTag("becklyn_assets.file_type");
+    }
+
+
 }
diff --git a/src/File/FileTypeRegistry.php b/src/File/FileTypeRegistry.php
@@ -5,6 +5,8 @@
 use Becklyn\AssetsBundle\Asset\Asset;
 use Becklyn\AssetsBundle\File\Type\FileType;
 use Becklyn\AssetsBundle\File\Type\GenericFile;
+use Psr\Container\ContainerInterface;
+use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 
 class FileTypeRegistry
 {
@@ -17,18 +19,18 @@ class FileTypeRegistry
     /**
      * The file types mapped by file extension.
      *
-     * @var array<string,FileType>
+     * @var ContainerInterface
      */
-    private $fileTypes = [];
+    private $specializedFileTypes;
 
 
     /**
-     * @param array $specializedFileTypes the mapping of `extension => FileType` of all specialized file types
+     * @param ContainerInterface $specializedFileTypes the mapping of `extension => FileType` of all specialized file types
      */
-    public function __construct (GenericFile $genericFileType, array $specializedFileTypes = [])
+    public function __construct (GenericFile $genericFileType, ContainerInterface $specializedFileTypes)
     {
         $this->genericFileType = $genericFileType;
-        $this->fileTypes = $specializedFileTypes;
+        $this->specializedFileTypes = $specializedFileTypes;
     }
 
 
@@ -46,7 +48,13 @@ public function getFileType (Asset $asset) : FileType
      */
     public function getByFileExtension (string $extension) : FileType
     {
-        return $this->fileTypes[$extension] ?? $this->genericFileType;
+        try {
+            return $this->specializedFileTypes->get($extension);
+        }
+        catch (ServiceNotFoundException $exception)
+        {
+            return $this->genericFileType;
+        }
     }
 
 
diff --git a/src/File/Type/CssFile.php b/src/File/Type/CssFile.php
@@ -7,7 +7,7 @@
 use Becklyn\AssetsBundle\File\Type\Css\CssImportRewriter;
 use Becklyn\HtmlBuilder\Node\HtmlElement;
 
-class CssFile extends FileType
+class CssFile extends SpecializedFileType
 {
     use GenericFileHeaderTrait;
 
@@ -80,4 +80,13 @@ public function shouldBeGzipCompressed () : bool
     {
         return true;
     }
+
+
+    /**
+     * @inheritDoc
+     */
+    public static function supportsExtension () : string
+    {
+        return "css";
+    }
 }
diff --git a/src/File/Type/JavaScriptFile.php b/src/File/Type/JavaScriptFile.php
@@ -6,7 +6,7 @@
 use Becklyn\AssetsBundle\Data\AssetEmbed;
 use Becklyn\HtmlBuilder\Node\HtmlElement;
 
-class JavaScriptFile extends FileType
+class JavaScriptFile extends SpecializedFileType
 {
     use GenericFileHeaderTrait;
 
@@ -51,4 +51,13 @@ public function shouldBeGzipCompressed () : bool
     {
         return true;
     }
+
+
+    /**
+     * @inheritDoc
+     */
+    public static function supportsExtension () : string
+    {
+        return "js";
+    }
 }
diff --git a/src/File/Type/SpecializedFileType.php b/src/File/Type/SpecializedFileType.php
@@ -0,0 +1,11 @@
+<?php declare(strict_types=1);
+
+namespace Becklyn\AssetsBundle\File\Type;
+
+abstract class SpecializedFileType extends FileType
+{
+    /**
+     * Returns the extension that this file type supports.
+     */
+    abstract public static function supportsExtension () : string;
+}
diff --git a/src/File/Type/SvgFile.php b/src/File/Type/SvgFile.php
@@ -4,7 +4,7 @@
 
 use Becklyn\AssetsBundle\Asset\Asset;
 
-class SvgFile extends FileType
+class SvgFile extends SpecializedFileType
 {
     use GenericFileHeaderTrait;
 
@@ -28,4 +28,13 @@ public function shouldBeGzipCompressed () : bool
     {
         return true;
     }
+
+
+    /**
+     * @inheritDoc
+     */
+    public static function supportsExtension () : string
+    {
+        return "svg";
+    }
 }
diff --git a/src/Resources/config/services.yaml b/src/Resources/config/services.yaml
@@ -14,10 +14,7 @@ services:
         public: true
 
     Becklyn\AssetsBundle\File\FileTypeRegistry:
-        $specializedFileTypes:
-            css: '@Becklyn\AssetsBundle\File\Type\CssFile'
-            js: '@Becklyn\AssetsBundle\File\Type\JavaScriptFile'
-            svg: '@Becklyn\AssetsBundle\File\Type\SvgFile'
+        $specializedFileTypes: !tagged_locator { tag: becklyn_assets.file_type, default_index_method: supportsExtension }
 
     Becklyn\AssetsBundle\Html\AssetHtmlGenerator:
         public: true
diff --git a/tests/File/FileLoaderTest.php b/tests/File/FileLoaderTest.php
@@ -9,6 +9,7 @@
 use Becklyn\AssetsBundle\File\Type\GenericFile;
 use Becklyn\AssetsBundle\Namespaces\NamespaceRegistry;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ServiceLocator;
 
 class FileLoaderTest extends TestCase
 {
@@ -36,7 +37,7 @@ protected function setUp () : void
             "bundles" => "{$this->fixtures}/public/bundles",
         ]);
 
-        $fileTypes = new FileTypeRegistry(new GenericFile());
+        $fileTypes = new FileTypeRegistry(new GenericFile(), new ServiceLocator([]));
 
         $this->loader = new FileLoader($this->namespaceRegistry, $fileTypes);
     }
@@ -100,9 +101,9 @@ public function testCustomProcessorCalledInDev () : void
             ->method("processForDev")
             ->willReturnArgument(2);
 
-        $fileTypes = new FileTypeRegistry(new GenericFile(), [
-            "css" => $testFileType,
-        ]);
+        $fileTypes = new FileTypeRegistry(new GenericFile(), new ServiceLocator([
+            "css" => function () use ($testFileType) { return $testFileType; },
+        ]));
 
         $loader = new FileLoader($this->namespaceRegistry, $fileTypes);
         $loader->loadFile(new Asset("bundles", "test/css/app.css"), FileLoader::MODE_DEV);
@@ -123,9 +124,9 @@ public function testCustomProcessorCalledInProd () : void
             ->method("processForProd")
             ->willReturnArgument(1);
 
-        $fileTypes = new FileTypeRegistry(new GenericFile(), [
-            "css" => $testFileType,
-        ]);
+        $fileTypes = new FileTypeRegistry(new GenericFile(), new ServiceLocator([
+            "css" => function () use ($testFileType) { return $testFileType; },
+        ]));
 
         $loader = new FileLoader($this->namespaceRegistry, $fileTypes);
         $loader->loadFile(new Asset("bundles", "test/css/app.css"), FileLoader::MODE_PROD);
@@ -145,9 +146,9 @@ public function testCustomProcessorNotCalledInUntouched () : void
             ->expects(self::never())
             ->method("processForProd");
 
-        $fileTypes = new FileTypeRegistry(new GenericFile(), [
-            "css" => $testFileType,
-        ]);
+        $fileTypes = new FileTypeRegistry(new GenericFile(), new ServiceLocator([
+            "css" => function () use ($testFileType) { return $testFileType; },
+        ]));
 
         $loader = new FileLoader($this->namespaceRegistry, $fileTypes);
         $loader->loadFile(new Asset("bundles", "test/css/app.css"), FileLoader::MODE_UNTOUCHED);
@@ -176,9 +177,9 @@ public function testFallbackType () : void
             ->method("processForProd")
             ->willReturnArgument(1);
 
-        $fileTypes = new FileTypeRegistry($genericFileType, [
-            "css" => $testFileType,
-        ]);
+        $fileTypes = new FileTypeRegistry($genericFileType, new ServiceLocator([
+            "css" => function () use ($testFileType) { return $testFileType; },
+        ]));
 
         $loader = new FileLoader($this->namespaceRegistry, $fileTypes);
         $loader->loadFile(new Asset("bundles", "test/js/test.js"), FileLoader::MODE_PROD);
diff --git a/tests/Html/AssetHtmlGeneratorTest.php b/tests/Html/AssetHtmlGeneratorTest.php
@@ -14,6 +14,7 @@
 use Becklyn\AssetsBundle\Html\AssetHtmlGenerator;
 use Becklyn\AssetsBundle\Url\AssetUrl;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ServiceLocator;
 use Tests\Becklyn\AssetsBundle\CreateHashedAssetTrait;
 
 class AssetHtmlGeneratorTest extends TestCase
@@ -55,10 +56,10 @@ protected function buildGenerator (bool $isDebug)
             ->method("rewriteRelativeImports")
             ->willReturnArgument(1);
 
-        $fileTypeRegistry = new FileTypeRegistry(new GenericFile(), [
-            "js" => new JavaScriptFile(),
-            "css" => new CssFile($importRewriter),
-        ]);
+        $fileTypeRegistry = new FileTypeRegistry(new GenericFile(), new ServiceLocator([
+            "js" => function () { return new JavaScriptFile(); },
+            "css" => function () use ($importRewriter) { return new CssFile($importRewriter); },
+        ]));
 
         $dependencyMapFactory = $this->getMockBuilder(DependencyMapFactory::class)
             ->disableOriginalConstructor()
diff --git a/tests/Storage/AssetStorageTest.php b/tests/Storage/AssetStorageTest.php
@@ -11,6 +11,7 @@
 use Becklyn\AssetsBundle\Storage\AssetStorage;
 use Becklyn\AssetsBundle\Storage\Compression\GzipCompression;
 use PHPUnit\Framework\TestCase;
+use Symfony\Component\DependencyInjection\ServiceLocator;
 use Symfony\Component\Filesystem\Filesystem;
 
 class AssetStorageTest extends TestCase
@@ -46,14 +47,17 @@ protected function setUp () : void
             "other" => "{$this->fixtures}/other",
         ]);
 
-        $fileTypeRegistry = new FileTypeRegistry(new GenericFile(), [
-            "js" => new class() extends FileType {
-                public function shouldIncludeHashInFileName () : bool
-                {
-                    return false;
-                }
-            },
-        ]);
+        $fileTypeRegistry = new FileTypeRegistry(new GenericFile(), new ServiceLocator([
+            "js" => function ()
+            {
+                return new class() extends FileType {
+                    public function shouldIncludeHashInFileName () : bool
+                    {
+                        return false;
+                    }
+                };
+            }
+        ]));
 
         $this->storage = new AssetStorage(
             new FileLoader($namespaces, $fileTypeRegistry),

Original file line number	Diff line number	Diff line change
`@@ -7,7 +7,7 @@`
`7`	`7`	`use Becklyn\AssetsBundle\File\Type\Css\CssImportRewriter;`
`8`	`8`	`use Becklyn\HtmlBuilder\Node\HtmlElement;`
`9`	`9`
`10`		`-class CssFile extends FileType`
	`10`	`+class CssFile extends SpecializedFileType`
`11`	`11`	`{`
`12`	`12`	`use GenericFileHeaderTrait;`
`13`	`13`
`@@ -80,4 +80,13 @@ public function shouldBeGzipCompressed () : bool`
`80`	`80`	`{`
`81`	`81`	`return true;`
`82`	`82`	`}`
	`83`	`+`
	`84`	`+`
	`85`	`+ /**`
	`86`	`+ * @inheritDoc`
	`87`	`+ */`
	`88`	`+ public static function supportsExtension () : string`
	`89`	`+ {`
	`90`	`+ return "css";`
	`91`	`+ }`
`83`	`92`	`}`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@`
`6`	`6`	`use Becklyn\AssetsBundle\Data\AssetEmbed;`
`7`	`7`	`use Becklyn\HtmlBuilder\Node\HtmlElement;`
`8`	`8`
`9`		`-class JavaScriptFile extends FileType`
	`9`	`+class JavaScriptFile extends SpecializedFileType`
`10`	`10`	`{`
`11`	`11`	`use GenericFileHeaderTrait;`
`12`	`12`
`@@ -51,4 +51,13 @@ public function shouldBeGzipCompressed () : bool`
`51`	`51`	`{`
`52`	`52`	`return true;`
`53`	`53`	`}`
	`54`	`+`
	`55`	`+`
	`56`	`+ /**`
	`57`	`+ * @inheritDoc`
	`58`	`+ */`
	`59`	`+ public static function supportsExtension () : string`
	`60`	`+ {`
	`61`	`+ return "js";`
	`62`	`+ }`
`54`	`63`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,7 +4,7 @@`
`4`	`4`
`5`	`5`	`use Becklyn\AssetsBundle\Asset\Asset;`
`6`	`6`
`7`		`-class SvgFile extends FileType`
	`7`	`+class SvgFile extends SpecializedFileType`
`8`	`8`	`{`
`9`	`9`	`use GenericFileHeaderTrait;`
`10`	`10`
`@@ -28,4 +28,13 @@ public function shouldBeGzipCompressed () : bool`
`28`	`28`	`{`
`29`	`29`	`return true;`
`30`	`30`	`}`
	`31`	`+`
	`32`	`+`
	`33`	`+ /**`
	`34`	`+ * @inheritDoc`
	`35`	`+ */`
	`36`	`+ public static function supportsExtension () : string`
	`37`	`+ {`
	`38`	`+ return "svg";`
	`39`	`+ }`
`31`	`40`	`}`