Update documentation

[packbundle] / DependencyInjection / Configuration.php

diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
index 00417437754a62e722c8ff89147a1012a96eb6d9..22ae9d9d0126c8843be70de5200ea9b2aeebf1c5 100644 (file)
--- a/DependencyInjection/Configuration.php
+++ b/DependencyInjection/Configuration.php
@@ -12,74 +12,155 @@ use Symfony\Component\Process\ExecutableFinder;
  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
  */
 class Configuration implements ConfigurationInterface {
  * To learn more see {@link http://symfony.com/doc/current/cookbook/bundles/configuration.html}
  */
 class Configuration implements ConfigurationInterface {

-       //Constructor required to derivate prefix from kernel.project_dir
-       public function __construct($projectDir) {
-               $this->projectDir = $projectDir;
-       }
-

        /**
         * {@inheritdoc}
         */
        public function getConfigTreeBuilder() {
        /**
         * {@inheritdoc}
         */
        public function getConfigTreeBuilder() {

-               $treeBuilder = new TreeBuilder();
+               //Get TreeBuilder object
+               $treeBuilder = new TreeBuilder('rapsys_pack');
+
+               //Get ExecutableFinder object

                $finder = new ExecutableFinder();
 
                $finder = new ExecutableFinder();
 

-               #TODO: see how we deal with asset url generation: see Rapsys/PackBundle/Twig/PackTokenParser.php +243
-               #framework:
-               #    assets:
-               #        packages:
-               #            rapsys_pack:
-               #                base_path: '/'
-               #                version: ~
-               #
-               ## Force cache disable to regenerate resources each time
-               ##twig:
-               ##    cache: ~
+               /**
+                * XXX: Note about the output schemes
+                *
+                * The output files are written based on the output.<ext> scheme with the * replaced by the hashed path of packed files
+                *
+                * The following service configuration make twig render the output file path with the right '/' basePath prefix:
+                * services:
+                *     assets.pack_package:
+                *         class: Rapsys\PackBundle\Asset\PathPackage
+                *         arguments: [ '/', '@assets.empty_version_strategy', '@assets.context' ]
+                *     rapsys_pack.twig.pack_extension:
+                *         class: Rapsys\PackBundle\Twig\PackExtension
+                *         arguments: [ '@file_locator', '@service_container', '@assets.pack_package' ]
+                *         tags: [ twig.extension ]
+                */
+
+               //The bundle default values
+               $defaults = [
+                       'config' => [
+                               'name' => 'asset_url',
+                               'scheme' => 'https://',
+                               'timeout' => (int)ini_get('default_socket_timeout'),
+                               'agent' => (string)ini_get('user_agent')?:'rapsys_pack/0.1.3',
+                               'redirect' => 5
+                       ],
+                       'output' => [
+                               'css' => '@RapsysPack/css/*.pack.css',
+                               'js' =>  '@RapsysPack/js/*.pack.js',
+                               'img' => '@RapsysPack/img/*.pack.jpg'
+                       ],
+                       'filters' => [
+                               'css' => [
+                                       'class' => 'Rapsys\PackBundle\Twig\Filter\CPackFilter',
+                                       'args' => [
+                                               $finder->find('cpack', '/usr/local/bin/cpack'),
+                                               'minify'
+                                       ]
+                               ],
+                               'js' => [
+                                       'class' => 'Rapsys\PackBundle\Twig\Filter\JPackFilter',
+                                       'args' => [
+                                               $finder->find('jpack', '/usr/local/bin/jpack'),
+                                               'best'
+                                       ]
+                               ],
+                               'img' => [
+                                       'class' => 'Rapsys\PackBundle\Twig\Filter\IPackFilter',
+                                       'args' => []
+                               ],
+                       ]
+               ];

 
                //Here we define the parameters that are allowed to configure the bundle.
 
                //Here we define the parameters that are allowed to configure the bundle.

-               //TODO: see https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php for default value and description
-               //TODO: see http://symfony.com/doc/current/components/config/definition.html
-               //TODO: see https://github.com/symfony/assetic-bundle/blob/master/DependencyInjection/Configuration.php#L63
-               //TODO: use bin/console config:dump-reference to dump class infos
+               //XXX: see https://github.com/symfony/symfony/blob/master/src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php for default value and description
+               //XXX: see http://symfony.com/doc/current/components/config/definition.html
+               //XXX: see https://github.com/symfony/assetic-bundle/blob/master/DependencyInjection/Configuration.php#L63
+               //XXX: see php bin/console config:dump-reference rapsys_pack to dump default config
+               //XXX: see php bin/console debug:config rapsys_pack to dump config

                $treeBuilder
                        //Parameters
                $treeBuilder
                        //Parameters

-                       ->root('parameters')
+                       ->getRootNode()
+                               ->addDefaultsIfNotSet()

                                ->children()
                                ->children()

-                                       ->arrayNode('rapsys_pack')
+                                       ->arrayNode('config')
+                                               ->addDefaultsIfNotSet()

                                                ->children()
                                                ->children()

-                                                       ->scalarNode('coutput')->defaultValue('css/*.pack.css')->end()
-                                                       ->scalarNode('joutput')->defaultValue('js/*.pack.js')->end()
-                                                       ->scalarNode('ioutput')->defaultValue('img/*.pack.jpg')->end()
-                                                       ->arrayNode('cfilter')
-                                                               ->treatNullLike(array())
-                                                               ->scalarPrototype()->end()
-                                                               ->defaultValue(array('Rapsys\PackBundle\Twig\Filter\CPackFilter'))
-                                                       ->end()
-                                                       ->arrayNode('jfilter')
-                                                               ->treatNullLike(array())
-                                                               ->scalarPrototype()->end()
-                                                               ->defaultValue(array('Rapsys\PackBundle\Twig\Filter\JPackFilter'))
-                                                       ->end()
-                                                       ->arrayNode('ifilter')
-                                                               ->treatNullLike(array())
-                                                               ->scalarPrototype()->end()
-                                                               ->defaultValue(array('Rapsys\PackBundle\Twig\Filter\IPackFilter'))
-                                                       ->end()
-                                                       ->scalarNode('prefix')->defaultValue($this->projectDir)->end()
-                                                       ->scalarNode('scheme')->defaultValue('https://')->end()
-                                                       ->integerNode('timeout')->min(0)->defaultValue((int)ini_get('default_socket_timeout'))->end()
-                                                       ->scalarNode('agent')->defaultValue(ini_get('user_agent'))->end()
-                                                       ->integerNode('redirect')->min(1)->defaultValue(20)->end()
+                                                       ->scalarNode('name')->cannotBeEmpty()->defaultValue($defaults['config']['name'])->end()
+                                                       ->scalarNode('scheme')->cannotBeEmpty()->defaultValue($defaults['config']['scheme'])->end()
+                                                       ->integerNode('timeout')->min(0)->max(300)->defaultValue($defaults['config']['timeout'])->end()
+                                                       ->scalarNode('agent')->cannotBeEmpty()->defaultValue($defaults['config']['agent'])->end()
+                                                       ->integerNode('redirect')->min(1)->max(30)->defaultValue($defaults['config']['redirect'])->end()

                                                ->end()
                                        ->end()
                                                ->end()
                                        ->end()

-                                       ->arrayNode('rapsys_pack_cpackfilter')
+                                       ->arrayNode('output')
+                                               ->addDefaultsIfNotSet()

                                                ->children()
                                                ->children()

-                                                       ->scalarNode('bin')->defaultValue(function () use ($finder) { return $finder->find('cpack', '/usr/local/bin/cpack'); })->end()
+                                                       ->scalarNode('css')->cannotBeEmpty()->defaultValue($defaults['output']['css'])->end()
+                                                       ->scalarNode('js')->cannotBeEmpty()->defaultValue($defaults['output']['js'])->end()
+                                                       ->scalarNode('img')->cannotBeEmpty()->defaultValue($defaults['output']['img'])->end()

                                                ->end()
                                        ->end()
                                                ->end()
                                        ->end()

-                                       ->arrayNode('rapsys_pack_jpackfilter')
+                                       ->arrayNode('filters')
+                                               ->addDefaultsIfNotSet()

                                                ->children()
                                                ->children()

-                                                       ->scalarNode('bin')->defaultValue(function () use ($finder) { return $finder->find('jpack', '/usr/local/bin/jpack'); })->end()
+                                                       ->arrayNode('css')
+                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                               ->addDefaultChildrenIfNoneSet()
+                                                               ->arrayPrototype()
+                                                                       ->children()
+                                                                               ->scalarNode('class')
+                                                                                       ->isRequired()
+                                                                                       ->cannotBeEmpty()
+                                                                                       ->defaultValue($defaults['filters']['css']['class'])
+                                                                               ->end()
+                                                                               ->arrayNode('args')
+                                                                                       /*->isRequired()*/
+                                                                                       ->treatNullLike(array())
+                                                                                       ->defaultValue($defaults['filters']['css']['args'])
+                                                                                       ->scalarPrototype()->end()
+                                                                               ->end()
+                                                                       ->end()
+                                                               ->end()
+                                                       ->end()
+                                                       ->arrayNode('js')
+                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                               ->addDefaultChildrenIfNoneSet()
+                                                               ->arrayPrototype()
+                                                                       ->children()
+                                                                               ->scalarNode('class')
+                                                                                       ->isRequired()
+                                                                                       ->cannotBeEmpty()
+                                                                                       ->defaultValue($defaults['filters']['js']['class'])
+                                                                               ->end()
+                                                                               ->arrayNode('args')
+                                                                                       ->treatNullLike(array())
+                                                                                       ->defaultValue($defaults['filters']['js']['args'])
+                                                                                       ->scalarPrototype()->end()
+                                                                               ->end()
+                                                                       ->end()
+                                                               ->end()
+                                                       ->end()
+                                                       ->arrayNode('img')
+                                                               #XXX: undocumented, see Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php +513
+                                                               ->addDefaultChildrenIfNoneSet()
+                                                               ->arrayPrototype()
+                                                                       ->children()
+                                                                               ->scalarNode('class')
+                                                                                       ->isRequired()
+                                                                                       ->cannotBeEmpty()
+                                                                                       ->defaultValue($defaults['filters']['img']['class'])
+                                                                               ->end()
+                                                                               ->arrayNode('args')
+                                                                                       ->treatNullLike(array())
+                                                                                       ->defaultValue($defaults['filters']['img']['args'])
+                                                                                       ->scalarPrototype()->end()
+                                                                               ->end()
+                                                                       ->end()
+                                                               ->end()
+                                                       ->end()

                                                ->end()
                                        ->end()
                                ->end()
                                                ->end()
                                        ->end()
                                ->end()