Merge pull request #36 from tkasper/allow_cors_embed

Author: Jannik

CHANGELOG.md

@@ -1,3 +1,9 @@
+2.6.8
+=====
+
+*   (improvement) Add global `allow_cors` option for assets.
+
+
 2.6.7
 =====
 

README.md

@@ -115,6 +115,8 @@ becklyn_assets:
     public_path: '%kernel.project_dir%/public' 
     # relative path to the directory, where the assets are copied to (relative to `public_path`)
     output_dir: 'assets' 
+    # allow crossorigin assets e.g needed for basic auth if using safari browser
+    allow_cors: true
 ```
 
 Commands

src/DependencyInjection/BecklynAssetsConfiguration.php

@@ -30,6 +30,9 @@ public function getConfigTreeBuilder ()
                     ->defaultValue('assets')
                     ->info("The relative path to the assets output dir. Relative to `public_path`.")
                 ->end()
+                ->booleanNode("allow_cors")
+                    ->defaultFalse()
+                ->end()
                 ->arrayNode("dependency_maps")
                     ->setDeprecated("The `becklyn_assets.dependency_maps` option is deprecated, as the the maps will always be automatically loaded.")
                     ->scalarPrototype()->end()

src/DependencyInjection/BecklynAssetsExtension.php

@@ -2,6 +2,7 @@
 
 namespace Becklyn\AssetsBundle\DependencyInjection;
 
+use Becklyn\AssetsBundle\Html\AssetHtmlGenerator;
 use Becklyn\AssetsBundle\Namespaces\NamespaceRegistry;
 use Becklyn\AssetsBundle\RouteLoader\AssetsRouteLoader;
 use Becklyn\AssetsBundle\Storage\AssetStorage;
@@ -43,6 +44,9 @@ public function load (array $configs, ContainerBuilder $container) : void
 
         $container->getDefinition(AssetsRouteLoader::class)
             ->setArgument('$outputDir', $config["output_dir"]);
+
+        $container->getDefinition(AssetHtmlGenerator::class)
+            ->setArgument('$allowCors', $config["allow_cors"]);
     }
 
 

src/Html/AssetHtmlGenerator.php

@@ -51,14 +51,21 @@ class AssetHtmlGenerator
     private $htmlBuilder;
 
 
+    /**
+     * @var bool
+     */
+    private $allowCors;
+
+
     /**
      */
     public function __construct (
         AssetsRegistry $registry,
         AssetUrl $assetUrl,
         FileTypeRegistry $fileTypeRegistry,
         bool $isDebug,
-        DependencyMapFactory $dependencyMapFactory
+        DependencyMapFactory $dependencyMapFactory,
+        bool $allowCors = false
     )
     {
         $this->registry = $registry;
@@ -67,6 +74,7 @@ public function __construct (
         $this->isDebug = $isDebug;
         $this->dependencyMap = $dependencyMapFactory->getDependencyMap();
         $this->htmlBuilder = new HtmlBuilder();
+        $this->allowCors = $allowCors;
     }
 
 
@@ -144,6 +152,11 @@ public function linkAssets (array $assetPaths, bool $withDependencies = true) :
                 }
             }
 
+            if ($this->allowCors)
+            {
+                $embed->setAttribute("crossorigin", "anonymous");
+            }
+
             try
             {
                 $html .= $this->htmlBuilder->buildElement($fileType->buildElementForEmbed($embed));

tests/Html/AssetHtmlGeneratorTest.php

@@ -38,46 +38,6 @@ protected function setUp () : void
     }
 
 
-    protected function buildGenerator (bool $isDebug)
-    {
-        $registry = $this->getMockBuilder(AssetsRegistry::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $assetUrl = $this->getMockBuilder(AssetUrl::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $importRewriter = $this->getMockBuilder(CssImportRewriter::class)
-            ->disableOriginalConstructor()
-            ->getMock();
-
-        $importRewriter
-            ->method("rewriteRelativeImports")
-            ->willReturnArgument(1);
-
-        $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()
-            ->getMock();
-
-        $dependencyMapFactory
-            ->method("getDependencyMap")
-            ->willReturn(new DependencyMap());
-
-        $assetUrl
-            ->method("generateUrl")
-            ->willReturnCallback(function (Asset $asset) { return $asset->getAssetPath(); });
-
-        $generator = new AssetHtmlGenerator($registry, $assetUrl, $fileTypeRegistry, $isDebug, $dependencyMapFactory);
-        return [$generator, $registry, $assetUrl, $fileTypeRegistry];
-    }
-
-
     public function testDebugJS () : void
     {
         /**
@@ -314,4 +274,62 @@ public function testHttpImports (array $assets, string $expectedOutput) : void
         $html = $generator->linkAssets($assets);
         self::assertSame($expectedOutput, $html);
     }
+
+
+    /**
+     *
+     */
+    public function testAllowCors () : void
+    {
+        /**
+         * @var AssetHtmlGenerator
+         * @var \PHPUnit_Framework_MockObject_MockObject $registry
+         */
+        [$generator] = $this->buildGenerator(false, true);
+
+        self::assertSame(
+            '<script crossorigin="anonymous" defer src="http://example.org/test.js"></script>',
+            $generator->linkAssets(["http://example.org/test.js"])
+        );
+    }
+
+
+    protected function buildGenerator (bool $isDebug, bool $allowCors = false)
+    {
+        $registry = $this->getMockBuilder(AssetsRegistry::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $assetUrl = $this->getMockBuilder(AssetUrl::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $importRewriter = $this->getMockBuilder(CssImportRewriter::class)
+            ->disableOriginalConstructor()
+            ->getMock();
+
+        $importRewriter
+            ->method("rewriteRelativeImports")
+            ->willReturnArgument(1);
+
+        $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()
+            ->getMock();
+
+        $dependencyMapFactory
+            ->method("getDependencyMap")
+            ->willReturn(new DependencyMap());
+
+        $assetUrl
+            ->method("generateUrl")
+            ->willReturnCallback(function (Asset $asset) { return $asset->getAssetPath(); });
+
+        $generator = new AssetHtmlGenerator($registry, $assetUrl, $fileTypeRegistry, $isDebug, $dependencyMapFactory, $allowCors);
+        return [$generator, $registry, $assetUrl, $fileTypeRegistry];
+    }
 }