[AsseticBundle] moved filters into individual config files which must…

… be explicitly loaded You must now explicitly load those filters you want to use in your app. Some filters have additional configuration options: assetic: filters: cssrewrite: ~ yui_css: { jar: "/path/to/yuicompressor.jar" } You can also register your own filters now by referencing a configuration file: assetic: filters: my_filter: resource: "%kernel.root_dir%/config/my_filter.xml" foo: bar This configuration would load the referenced configuration file and set the "assetic.filter.my_filter.foo" parameter to "bar"
symfony · Mar 28, 2011 · 04a257d · 04a257d
1 parent 260efb3
commit 04a257d
Show file tree

Hide file tree

Showing 18 changed files with 372 additions and 96 deletions.
diff --git a/src/Symfony/Bundle/AsseticBundle/AsseticBundle.php b/src/Symfony/Bundle/AsseticBundle/AsseticBundle.php
@@ -13,7 +13,9 @@
 
 use Symfony\Bundle\AsseticBundle\DependencyInjection\Compiler\AssetFactoryPass;
 use Symfony\Bundle\AsseticBundle\DependencyInjection\Compiler\AssetManagerPass;
+use Symfony\Bundle\AsseticBundle\DependencyInjection\Compiler\CheckYuiFilterPass;
 use Symfony\Bundle\AsseticBundle\DependencyInjection\Compiler\FilterManagerPass;
+use Symfony\Bundle\AsseticBundle\DependencyInjection\Compiler\CheckClosureFilterPass;
 use Symfony\Bundle\AsseticBundle\DependencyInjection\Compiler\TemplatingPass;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
@@ -29,6 +31,8 @@ public function build(ContainerBuilder $container)
     {
         parent::build($container);
 
+        $container->addCompilerPass(new CheckClosureFilterPass());
+        $container->addCompilerPass(new CheckYuiFilterPass());
         $container->addCompilerPass(new TemplatingPass());
         $container->addCompilerPass(new AssetFactoryPass());
         $container->addCompilerPass(new AssetManagerPass());

diff --git a/src/Symfony/Bundle/AsseticBundle/DependencyInjection/AsseticExtension.php b/src/Symfony/Bundle/AsseticBundle/DependencyInjection/AsseticExtension.php
@@ -34,6 +34,8 @@ class AsseticExtension extends Extension
      */
     public function load(array $configs, ContainerBuilder $container)
     {
+        $parameterBag = $container->getParameterBag();
+
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__ . '/../Resources/config'));
         $loader->load('assetic.xml');
         $loader->load('templating_twig.xml');
@@ -46,29 +48,37 @@ public function load(array $configs, ContainerBuilder $container)
         $container->setParameter('assetic.read_from', $config['read_from']);
         $container->setParameter('assetic.write_to', $config['write_to']);
 
-        if (isset($config['closure'])) {
-            $container->setParameter('assetic.google_closure_compiler_jar', $config['closure']);
-            $loader->load('google_closure_compiler.xml');
-        }
+        $container->setParameter('assetic.closure.jar', $config['closure']);
+        $container->setParameter('assetic.java.bin', $config['java']);
+        $container->setParameter('assetic.node.bin', $config['node']);
+        $container->setParameter('assetic.sass.bin', $config['sass']);
+        $container->setParameter('assetic.yui.jar', $config['yui']);
+
+        // register filters
+        foreach ($config['filters'] as $name => $filter) {
+            if (isset($filter['resource'])) {
+                $loader->load($parameterBag->resolveValue($filter['resource']));
+                unset($filter['resource']);
+            } else {
+                $loader->load('filters/'.$name.'.xml');
+            }
 
-        if (isset($config['yui'])) {
-            $container->setParameter('assetic.yui_jar', $config['yui']);
-            $loader->load('yui_compressor.xml');
+            foreach ($filter as $key => $value) {
+                $container->setParameter('assetic.filter.'.$name.'.'.$key, $value);
+            }
         }
 
-        if ($container->getParameterBag()->resolveValue($container->getParameterBag()->get('assetic.use_controller'))) {
+        // choose dynamic or static
+        if ($parameterBag->resolveValue($parameterBag->get('assetic.use_controller'))) {
             $loader->load('controller.xml');
             $container->setParameter('assetic.twig_extension.class', '%assetic.twig_extension.dynamic.class%');
         } else {
             $loader->load('asset_writer.xml');
             $container->setParameter('assetic.twig_extension.class', '%assetic.twig_extension.static.class%');
         }
 
-        if ($container->hasParameter('assetic.less.compress')) {
-            $container->getDefinition('assetic.filter.less')->addMethodCall('setCompress', array('%assetic.less.compress%'));
-        }
-
-        $this->registerFormulaResources($container, $container->getParameterBag()->resolveValue($config['bundles']));
+        // register config resources
+        self::registerFormulaResources($container, $parameterBag->resolveValue($config['bundles']));
     }
 
     static protected function processConfigs(array $configs, $debug, array $bundles)

diff --git a/src/Symfony/Bundle/AsseticBundle/DependencyInjection/Compiler/CheckClosureFilterPass.php b/src/Symfony/Bundle/AsseticBundle/DependencyInjection/Compiler/CheckClosureFilterPass.php
@@ -0,0 +1,33 @@
+<?php
+
+/*
+ * This file is part of the Symfony framework.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Symfony\Bundle\AsseticBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+
+/**
+ * Tags either the closure JAR or API filter for the filter manager.
+ *
+ * @author Kris Wallsmith <kris.wallsmith@symfony.com>
+ */
+class CheckClosureFilterPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->hasDefinition('assetic.filter.closure.jar') &&
+            $container->getParameterBag()->resolveValue($container->getParameter('assetic.filter.closure.jar'))) {
+            $container->remove('assetic.filter.closure.api');
+        } elseif ($container->hasDefinition('assetic.filter.closure.api')) {
+            $container->remove('assetic.filter.closure.jar');
+        }
+    }
+}
diff --git a/src/Symfony/Bundle/AsseticBundle/DependencyInjection/Compiler/CheckYuiFilterPass.php b/src/Symfony/Bundle/AsseticBundle/DependencyInjection/Compiler/CheckYuiFilterPass.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony framework.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * This source file is subject to the MIT license that is bundled
+ * with this source code in the file LICENSE.
+ */
+
+namespace Symfony\Bundle\AsseticBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+
+/**
+ * Checks that the location of the YUI JAR has been configured.
+ *
+ * @author Kris Wallsmith <kris.wallsmith@symfony.com>
+ */
+class CheckYuiFilterPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if ($container->hasDefinition('assetic.filter.yui_css') &&
+            !$container->getParameterBag()->resolveValue($container->getParameter('assetic.filter.yui_css.jar'))) {
+            throw new \RuntimeException('The Assetic "yui_css" configuration requires a "jar" value.');
+        }
+
+        if ($container->hasDefinition('assetic.filter.yui_js') &&
+            !$container->getParameterBag()->resolveValue($container->getParameter('assetic.filter.yui_js.jar'))) {
+            throw new \RuntimeException('The Assetic "yui_js" configuration requires a "jar" value.');
+        }
+    }
+}
diff --git a/src/Symfony/Bundle/AsseticBundle/DependencyInjection/Configuration.php b/src/Symfony/Bundle/AsseticBundle/DependencyInjection/Configuration.php
@@ -20,6 +20,7 @@
  * sections are normalized, and merged.
  *
  * @author Christophe Coevoet <stof@notk.org>
+ * @author Kris Wallsmith <kris@symfony.com>
  */
 class Configuration
 {
@@ -41,26 +42,38 @@ public function getConfigTree($debug, array $bundles)
                 ->booleanNode('use_controller')->defaultValue($debug)->end()
                 ->scalarNode('read_from')->defaultValue('%kernel.root_dir%/../web')->end()
                 ->scalarNode('write_to')->defaultValue('%assetic.read_from%')->end()
-                ->scalarNode('closure')->end()
-                ->scalarNode('yui')->end()
+                ->scalarNode('closure')->defaultNull()->end()
+                ->scalarNode('java')->defaultNull()->end()
+                ->scalarNode('node')->defaultNull()->end()
+                ->scalarNode('sass')->defaultNull()->end()
+                ->scalarNode('yui')->defaultNull()->end()
             ->end()
             ->fixXmlConfig('bundle')
             ->children()
                 ->arrayNode('bundles')
                     ->defaultValue($bundles)
                     ->requiresAtLeastOneElement()
                     ->beforeNormalization()
-                        ->ifTrue(function($v){ return !is_array($v); })
-                        ->then(function($v){ return array($v); })
+                        ->ifTrue(function($v) { return !is_array($v); })
+                        ->then(function($v) { return array($v); })
                     ->end()
                     ->prototype('scalar')
                         ->beforeNormalization()
                             ->ifTrue(function($v) { return is_array($v) && isset($v['name']); })
-                            ->then(function($v){ return $v['name']; })
+                            ->then(function($v) { return $v['name']; })
                         ->end()
                     ->end()
                 ->end()
             ->end()
+            ->fixXmlConfig('filter')
+            ->children()
+                ->arrayNode('filters')
+                    ->addDefaultsIfNotSet()
+                    ->requiresAtLeastOneElement()
+                    ->useAttributeAsKey('name')
+                    ->prototype('array')->end()
+                ->end()
+            ->end()
         ;
 
         return $tree->buildTree();

diff --git a/src/Symfony/Bundle/AsseticBundle/Resources/config/assetic.xml b/src/Symfony/Bundle/AsseticBundle/Resources/config/assetic.xml
@@ -7,28 +7,18 @@
     <parameters>
         <parameter key="assetic.asset_factory.class">Symfony\Bundle\AsseticBundle\Factory\AssetFactory</parameter>
         <parameter key="assetic.asset_manager.class">Assetic\Factory\LazyAssetManager</parameter>
-        <parameter key="assetic.filter_manager.class">Symfony\Bundle\AsseticBundle\FilterManager</parameter>
+        <parameter key="assetic.asset_manager_cache_warmer.class">Symfony\Bundle\AsseticBundle\CacheWarmer\AssetManagerCacheWarmer</parameter>
         <parameter key="assetic.cached_formula_loader.class">Assetic\Factory\Loader\CachedFormulaLoader</parameter>
         <parameter key="assetic.config_cache.class">Assetic\Cache\ConfigCache</parameter>
-        <parameter key="assetic.asset_manager_cache_warmer.class">Symfony\Bundle\AsseticBundle\CacheWarmer\AssetManagerCacheWarmer</parameter>
         <parameter key="assetic.directory_resource.class">Symfony\Bundle\AsseticBundle\Factory\Resource\DirectoryResource</parameter>
+        <parameter key="assetic.filter_manager.class">Symfony\Bundle\AsseticBundle\FilterManager</parameter>
 
-        <parameter key="assetic.filter.coffee.class">Assetic\Filter\CoffeeScriptFilter</parameter>
-        <parameter key="assetic.filter.cssrewrite.class">Assetic\Filter\CssRewriteFilter</parameter>
-        <parameter key="assetic.filter.google_closure_compiler_api.class">Assetic\Filter\GoogleClosure\CompilerApiFilter</parameter>
-        <parameter key="assetic.filter.google_closure_compiler_jar.class">Assetic\Filter\GoogleClosure\CompilerJarFilter</parameter>
-        <parameter key="assetic.filter.less.class">Assetic\Filter\LessFilter</parameter>
-        <parameter key="assetic.filter.sass.class">Assetic\Filter\Sass\SassFilter</parameter>
-        <parameter key="assetic.filter.scss.class">Assetic\Filter\Sass\ScssFilter</parameter>
-        <parameter key="assetic.filter.sprockets.class">Assetic\Filter\SprocketsFilter</parameter>
-        <parameter key="assetic.filter.stylus.class">Assetic\Filter\StylusFilter</parameter>
-
-        <parameter key="assetic.java_bin">/usr/bin/java</parameter>
-        <parameter key="assetic.sass_bin">/usr/bin/sass</parameter>
-        <parameter key="assetic.node_bin">/usr/bin/node</parameter>
-        <parameter key="assetic.node_paths" type="collection"></parameter>
-        <parameter key="assetic.sprocketize_bin">/usr/bin/sprocketize</parameter>
-        <parameter key="assetic.coffee_bin">/usr/bin/coffee</parameter>
+        <parameter key="assetic.closure.jar" />
+        <parameter key="assetic.java.bin">/usr/bin/java</parameter>
+        <parameter key="assetic.node.bin">/usr/bin/node</parameter>
+        <parameter key="assetic.node.paths" type="collection"></parameter>
+        <parameter key="assetic.sass.bin">/usr/bin/sass</parameter>
+        <parameter key="assetic.yui.jar" />
 
         <parameter key="assetic.cache_dir">%kernel.cache_dir%/assetic</parameter>
     </parameters>
@@ -43,52 +33,13 @@
             <argument type="service" id="assetic.asset_factory" />
             <argument type="collection"></argument>
         </service>
+
         <service id="assetic.asset_factory" class="%assetic.asset_factory.class%" public="false">
             <argument type="service" id="kernel" />
             <argument>%assetic.read_from%</argument>
             <argument>%assetic.debug%</argument>
             <call method="setFilterManager"><argument type="service" id="assetic.filter_manager" /></call>
         </service>
-
-        <!-- filters -->
-        <service id="assetic.filter.cssrewrite" class="%assetic.filter.cssrewrite.class%">
-            <tag name="assetic.filter" alias="cssrewrite" />
-        </service>
-        <service id="assetic.filter.less" class="%assetic.filter.less.class%">
-            <tag name="assetic.filter" alias="less" />
-            <argument>%assetic.read_from%</argument>
-            <argument>%assetic.node_bin%</argument>
-            <argument>%assetic.node_paths%</argument>
-        </service>
-        <service id="assetic.filter.sass" class="%assetic.filter.sass.class%">
-            <tag name="assetic.filter" alias="sass" />
-            <argument>%assetic.sass_bin%</argument>
-        </service>
-        <service id="assetic.filter.scss" class="%assetic.filter.scss.class%">
-            <tag name="assetic.filter" alias="scss" />
-            <argument>%assetic.sass_bin%</argument>
-        </service>
-        <service id="assetic.filter.google_closure_compiler" class="%assetic.filter.google_closure_compiler_api.class%">
-            <tag name="assetic.filter" alias="closure" />
-        </service>
-        <service id="assetic.filter.sprockets" class="%assetic.filter.sprockets.class%">
-            <tag name="assetic.filter" alias="sprockets" />
-            <argument>%assetic.read_from%</argument>
-            <argument>%assetic.sprocketize_bin%</argument>
-        </service>
-        <service id="assetic.filter.coffee" class="%assetic.filter.coffee.class%">
-            <tag name="assetic.filter" alias="coffee" />
-            <argument>%assetic.coffee_bin%</argument>
-            <argument>%assetic.node_bin%</argument>
-        </service>
-        <service id="assetic.filter.stylus" class="%assetic.filter.stylus.class%">
-            <tag name="assetic.filter" alias="stylus" />
-            <argument>%assetic.read_from%</argument>
-            <argument>%assetic.node_bin%</argument>
-            <argument>%assetic.node_paths%</argument>
-        </service>
-
-        <!-- other -->
         <service id="assetic.config_cache" class="%assetic.config_cache.class%" public="false">
             <argument>%assetic.cache_dir%/config</argument>
         </service>

diff --git a/src/Symfony/Bundle/AsseticBundle/Resources/config/filters/closure.xml b/src/Symfony/Bundle/AsseticBundle/Resources/config/filters/closure.xml
@@ -0,0 +1,25 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="assetic.filter.closure.api.class">Assetic\Filter\GoogleClosure\CompilerApiFilter</parameter>
+        <parameter key="assetic.filter.closure.jar.class">Assetic\Filter\GoogleClosure\CompilerJarFilter</parameter>
+        <parameter key="assetic.filter.closure.java">%assetic.java.bin%</parameter>
+        <parameter key="assetic.filter.closure.jar">%assetic.closure.jar%</parameter>
+    </parameters>
+
+    <services>
+        <service id="assetic.filter.closure.jar" class="%assetic.filter.closure.jar.class%">
+            <tag name="assetic.filter" alias="closure" />
+            <argument>%assetic.filter.closure.jar%</argument>
+            <argument>%assetic.filter.closure.java%</argument>
+        </service>
+
+        <service id="assetic.filter.closure.api" class="%assetic.filter.closure.api.class%">
+            <tag name="assetic.filter" alias="closure" />
+        </service>
+    </services>
+</container>
diff --git a/src/Symfony/Bundle/AsseticBundle/Resources/config/filters/coffee.xml b/src/Symfony/Bundle/AsseticBundle/Resources/config/filters/coffee.xml
@@ -0,0 +1,20 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="assetic.filter.coffee.class">Assetic\Filter\CoffeeScriptFilter</parameter>
+        <parameter key="assetic.filter.coffee.bin">/usr/bin/coffee</parameter>
+        <parameter key="assetic.filter.coffee.node">%assetic.node.bin%</parameter>
+    </parameters>
+
+    <services>
+        <service id="assetic.filter.coffee" class="%assetic.filter.coffee.class%">
+            <tag name="assetic.filter" alias="coffee" />
+            <argument>%assetic.filter.coffee.bin%</argument>
+            <argument>%assetic.filter.coffee.node%</argument>
+        </service>
+    </services>
+</container>
diff --git a/...ources/config/google_closure_compiler.xml → ...e/Resources/config/filters/cssrewrite.xml b/...ources/config/google_closure_compiler.xml → ...e/Resources/config/filters/cssrewrite.xml
@@ -4,11 +4,13 @@
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
+    <parameters>
+        <parameter key="assetic.filter.cssrewrite.class">Assetic\Filter\CssRewriteFilter</parameter>
+    </parameters>
+
     <services>
-        <service id="assetic.filter.google_closure_compiler" class="%assetic.filter.google_closure_compiler_jar.class%">
-            <tag name="assetic.filter" alias="closure" />
-            <argument>%assetic.google_closure_compiler_jar%</argument>
-            <argument>%assetic.java_bin%</argument>
+        <service id="assetic.filter.cssrewrite" class="%assetic.filter.cssrewrite.class%">
+            <tag name="assetic.filter" alias="cssrewrite" />
         </service>
     </services>
 </container>
diff --git a/src/Symfony/Bundle/AsseticBundle/Resources/config/filters/less.xml b/src/Symfony/Bundle/AsseticBundle/Resources/config/filters/less.xml
@@ -0,0 +1,21 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="assetic.filter.less.class">Assetic\Filter\LessFilter</parameter>
+        <parameter key="assetic.filter.less.node">%assetic.node.bin%</parameter>
+        <parameter key="assetic.filter.less.node_paths">%assetic.node.paths%</parameter>
+    </parameters>
+
+    <services>
+        <service id="assetic.filter.less" class="%assetic.filter.less.class%">
+            <tag name="assetic.filter" alias="less" />
+            <argument>%assetic.read_from%</argument>
+            <argument>%assetic.filter.less.node%</argument>
+            <argument>%assetic.filter.less.node_paths%</argument>
+        </service>
+    </services>
+</container>
diff --git a/src/Symfony/Bundle/AsseticBundle/Resources/config/filters/sass.xml b/src/Symfony/Bundle/AsseticBundle/Resources/config/filters/sass.xml
@@ -0,0 +1,18 @@
+<?xml version="1.0" ?>
+
+<container xmlns="http://symfony.com/schema/dic/services"
+    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+    xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+
+    <parameters>
+        <parameter key="assetic.filter.sass.class">Assetic\Filter\Sass\SassFilter</parameter>
+        <parameter key="assetic.filter.sass.bin">%assetic.sass.bin%</parameter>
+    </parameters>
+
+    <services>
+        <service id="assetic.filter.sass" class="%assetic.filter.sass.class%">
+            <tag name="assetic.filter" alias="sass" />
+            <argument>%assetic.filter.sass.bin%</argument>
+        </service>
+    </services>
+</container>