Add a new Preload component

Author: dunglas

src/Symfony/Bridge/Twig/Extension/AssetExtension.php

@@ -12,7 +12,6 @@
 namespace Symfony\Bridge\Twig\Extension;
 
 use Symfony\Component\Asset\Packages;
-use Symfony\Component\Asset\Preload\PreloadManagerInterface;
 
 /**
  * Twig extension for the Symfony Asset component.
@@ -22,12 +21,10 @@
 class AssetExtension extends \Twig_Extension
 {
     private $packages;
-    private $preloadManager;
 
-    public function __construct(Packages $packages, PreloadManagerInterface $preloadManager = null)
+    public function __construct(Packages $packages)
     {
         $this->packages = $packages;
-        $this->preloadManager = $preloadManager;
     }
 
     /**
@@ -38,7 +35,6 @@ public function getFunctions()
         return array(
             new \Twig_SimpleFunction('asset', array($this, 'getAssetUrl')),
             new \Twig_SimpleFunction('asset_version', array($this, 'getAssetVersion')),
-            new \Twig_SimpleFunction('preload', array($this, 'preload')),
         );
     }
 
@@ -71,26 +67,6 @@ public function getAssetVersion($path, $packageName = null)
         return $this->packages->getVersion($path, $packageName);
     }
 
-    /**
-     * Preloads an asset.
-     *
-     * @param string $path   A public path
-     * @param string $as     A valid destination according to https://fetch.spec.whatwg.org/#concept-request-destination
-     * @param bool   $nopush If this asset should not be pushed over HTTP/2
-     *
-     * @return string The path of the asset
-     */
-    public function preload($path, $as = '', $nopush = false)
-    {
-        if (null === $this->preloadManager) {
-            throw new \RuntimeException('A preload manager must be configured to use the "preload" function.');
-        }
-
-        $this->preloadManager->addResource($path, $as, $nopush);
-
-        return $path;
-    }
-
     /**
      * Returns the name of the extension.
      *

src/Symfony/Bridge/Twig/Extension/PreloadExtension.php

@@ -0,0 +1,65 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bridge\Twig\Extension;
+
+use Symfony\Component\Preload\PreloadManagerInterface;
+
+/**
+ * Twig extension for the Symfony Preload component.
+ *
+ * @author Kévin Dunglas <dunglas@gmail.com>
+ */
+class PreloadExtension extends \Twig_Extension
+{
+    private $preloadManager;
+
+    public function __construct(PreloadManagerInterface $preloadManager)
+    {
+        $this->preloadManager = $preloadManager;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getFunctions()
+    {
+        return array(
+            new \Twig_SimpleFunction('preload', array($this, 'preload')),
+        );
+    }
+
+    /**
+     * Preloads an asset.
+     *
+     * @param string $path   A public path
+     * @param string $as     A valid destination according to https://fetch.spec.whatwg.org/#concept-request-destination
+     * @param bool   $nopush If this asset should not be pushed over HTTP/2
+     *
+     * @return string The path of the asset
+     */
+    public function preload($path, $as = '', $nopush = false)
+    {
+        $this->preloadManager->addResource($path, $as, $nopush);
+
+        return $path;
+    }
+
+    /**
+     * Returns the name of the extension.
+     *
+     * @return string The extension name
+     */
+    public function getName()
+    {
+        return 'preload';
+    }
+}

src/Symfony/Bridge/Twig/Tests/Extension/AssetExtensionTest.php renamed to src/Symfony/Bridge/Twig/Tests/Extension/PreloadExtensionTest.php

@@ -12,14 +12,13 @@
 namespace Symfony\Bridge\Twig\Tests\Extension;
 
 use PHPUnit\Framework\TestCase;
-use Symfony\Bridge\Twig\Extension\AssetExtension;
-use Symfony\Component\Asset\Packages;
-use Symfony\Component\Asset\Preload\PreloadManager;
+use Symfony\Bridge\Twig\Extension\PreloadExtension;
+use Symfony\Component\Preload\PreloadManager;
 
 /**
  * @author Kévin Dunglas <dunglas@gmail.com>
  */
-class AssetExtensionTest extends TestCase
+class PreloadExtensionTest extends TestCase
 {
     public function testGetAndPreloadAssetUrl()
     {
@@ -28,18 +27,9 @@ public function testGetAndPreloadAssetUrl()
         }
 
         $preloadManager = new PreloadManager();
-        $extension = new AssetExtension(new Packages(), $preloadManager);
+        $extension = new PreloadExtension($preloadManager);
 
         $this->assertEquals('/foo.css', $extension->preload('/foo.css', 'style', true));
         $this->assertEquals('</foo.css>; rel=preload; as=style; nopush', $preloadManager->buildLinkValue());
     }
-
-    /**
-     * @expectedException \RuntimeException
-     */
-    public function testNoConfiguredPreloadManager()
-    {
-        $extension = new AssetExtension(new Packages());
-        $extension->preload('/foo.css');
-    }
 }

src/Symfony/Bundle/TwigBundle/DependencyInjection/TwigExtension.php

@@ -16,6 +16,7 @@
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
+use Symfony\Component\Preload\PreloadManagerInterface;
 
 /**
  * TwigExtension.
@@ -48,6 +49,10 @@ public function load(array $configs, ContainerBuilder $container)
             $container->removeDefinition('twig.translation.extractor');
         }
 
+        if (!interface_exists(PreloadManagerInterface::class)) {
+            $container->removeDefinition('twig.extension.preload');
+        }
+
         foreach ($configs as $key => $config) {
             if (isset($config['globals'])) {
                 foreach ($config['globals'] as $name => $value) {

src/Symfony/Bundle/TwigBundle/Resources/config/twig.xml

@@ -70,7 +70,10 @@
 
         <service id="twig.extension.assets" class="Symfony\Bridge\Twig\Extension\AssetExtension" public="false">
             <argument type="service" id="assets.packages" />
-            <argument type="service" id="assets.preload_manager" on-invalid="ignore" />
+        </service>
+
+        <service id="twig.extension.preload" class="Symfony\Bridge\Twig\Extension\PreloadExtension" public="false">
+            <argument type="service" id="assets.preload_manager" />
         </service>
 
         <service id="twig.extension.code" class="Symfony\Bridge\Twig\Extension\CodeExtension" public="false">

src/Symfony/Component/Preload/.gitignore

@@ -0,0 +1,3 @@
+vendor/
+composer.lock
+phpunit.xml

src/Symfony/Component/Preload/CHANGELOG.md

@@ -0,0 +1,7 @@
+CHANGELOG
+=========
+
+3.3.0
+-----
+
+ * added the component

src/Symfony/Component/Asset/EventListener/PreloadListener.php renamed to src/Symfony/Component/Preload/EventListener/PreloadListener.php

@@ -9,10 +9,9 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Asset\EventListener;
+namespace Symfony\Component\Preload\EventListener;
 
-use Symfony\Component\Asset\Preload\PreloadManager;
-use Symfony\Component\Asset\Preload\PreloadManagerInterface;
+use Symfony\Component\Preload\PreloadManagerInterface;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;
 use Symfony\Component\HttpKernel\KernelEvents;

src/Symfony/Component/Preload/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2004-2017 Fabien Potencier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

src/Symfony/Component/Asset/Preload/PreloadManager.php renamed to src/Symfony/Component/Preload/PreloadManager.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Asset\Preload;
+namespace Symfony\Component\Preload;
 
 /**
  * Manages preload HTTP headers.

src/Symfony/Component/Asset/Preload/PreloadManagerInterface.php renamed to src/Symfony/Component/Preload/PreloadManagerInterface.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Asset\Preload;
+namespace Symfony\Component\Preload;
 
 /**
  * Manages resources to preload according to the W3C "Preload" specification.

src/Symfony/Component/Preload/README.md

@@ -0,0 +1,14 @@
+Preload Component
+===============
+
+The Preload component manages preloading and prefetching of HTTP resources through Link headers
+and HTTP/2 pushes.
+
+Resources
+---------
+
+  * [Documentation](https://symfony.com/doc/current/components/preload/introduction.html)
+  * [Contributing](https://symfony.com/doc/current/contributing/index.html)
+  * [Report issues](https://github.com/symfony/symfony/issues) and
+    [send Pull Requests](https://github.com/symfony/symfony/pulls)
+    in the [main Symfony repository](https://github.com/symfony/symfony)

src/Symfony/Component/Asset/Tests/EventListener/PreloadListenerTest.php renamed to src/Symfony/Component/Preload/Tests/EventListener/PreloadListenerTest.php

@@ -9,11 +9,11 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Asset\Tests\EventListener;
+namespace Symfony\Component\Preload\Tests\EventListener;
 
 use PHPUnit\Framework\TestCase;
-use Symfony\Component\Asset\EventListener\PreloadListener;
-use Symfony\Component\Asset\Preload\PreloadManager;
+use Symfony\Component\Preload\EventListener\PreloadListener;
+use Symfony\Component\Preload\PreloadManager;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 use Symfony\Component\HttpFoundation\Response;
 use Symfony\Component\HttpKernel\Event\FilterResponseEvent;

src/Symfony/Component/Asset/Tests/Preload/PreloadManagerTest.php renamed to src/Symfony/Component/Preload/Tests/PreloadManagerTest.php

@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Component\Asset\Preload;
+namespace Symfony\Component\Preload;
 
 use PHPUnit\Framework\TestCase;
 

src/Symfony/Component/Preload/composer.json

@@ -0,0 +1,39 @@
+{
+    "name": "symfony/preload",
+    "type": "library",
+    "description": "Symfony Preload Component",
+    "keywords": ["HTTP/2", "preload", "prefetch", "push", "performance"],
+    "homepage": "https://symfony.com",
+    "license": "MIT",
+    "authors": [
+        {
+            "name": "Kévin Dunglas",
+            "email": "dunglas@gmail.com"
+        },
+        {
+            "name": "Symfony Community",
+            "homepage": "https://symfony.com/contributors"
+        }
+    ],
+    "require": {
+        "php": ">=5.5.9"
+    },
+    "suggest": {
+        "symfony/http-kernel": ""
+    },
+    "require-dev": {
+        "symfony/http-kernel": "^2.8 || ^3.0"
+    },
+    "autoload": {
+        "psr-4": { "Symfony\\Component\\Preload\\": "" },
+        "exclude-from-classmap": [
+            "/Tests/"
+        ]
+    },
+    "minimum-stability": "dev",
+    "extra": {
+        "branch-alias": {
+            "dev-master": "3.3-dev"
+        }
+    }
+}

src/Symfony/Component/Preload/phpunit.xml.dist

@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+         xsi:noNamespaceSchemaLocation="http://schema.phpunit.de/4.1/phpunit.xsd"
+         backupGlobals="false"
+         colors="true"
+         bootstrap="vendor/autoload.php"
+>
+    <php>
+        <ini name="error_reporting" value="-1" />
+    </php>
+
+    <testsuites>
+        <testsuite name="Symfony Preload Component Test Suite">
+            <directory>./Tests/</directory>
+        </testsuite>
+    </testsuites>
+
+    <filter>
+        <whitelist>
+            <directory>./</directory>
+            <exclude>
+                <directory>./Tests</directory>
+                <directory>./vendor</directory>
+            </exclude>
+        </whitelist>
+    </filter>
+</phpunit>