Merge pull request #8 from symfony-cmf/resource_alias

Resource aliases

Author: dantleech

CmfResourceRestBundle.php

@@ -13,11 +13,13 @@
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection\Compiler\EnhancerPass;
 
 class CmfResourceRestBundle extends Bundle
 {
     public function build(ContainerBuilder $container)
     {
+        $container->addCompilerPass(new EnhancerPass());
         parent::build($container);
     }
 }

DependencyInjection/CmfResourceRestExtension.php

@@ -16,6 +16,7 @@
 use Symfony\Component\HttpKernel\DependencyInjection\Extension;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
 use Symfony\Component\DependencyInjection\Extension\PrependExtensionInterface;
+use Symfony\Component\Config\Definition\Processor;
 
 class CmfResourceRestExtension extends Extension implements PrependExtensionInterface
 {
@@ -46,8 +47,52 @@ public function prepend(ContainerBuilder $container)
      */
     public function load(array $configs, ContainerBuilder $container)
     {
+        $processor = new Processor();
         $loader = new XmlFileLoader($container, new FileLocator(__DIR__.'/../Resources/config'));
+        $configuration = new Configuration();
+        $config = $processor->processConfiguration($configuration, $configs);
+
         $loader->load('serializer.xml');
         $loader->load('resource-rest.xml');
+        $loader->load('enhancer.xml');
+
+        $this->configurePayloadAliasRegistry($container, $config['payload_alias_map']);
+        $this->configureEnhancerMap($container, $config['enhancer_map']);
+    }
+
+    public function getNamespace()
+    {
+        return 'http://cmf.symfony.com/schema/dic/' . $this->getAlias();
+    }
+
+    private function configurePayloadAliasRegistry(ContainerBuilder $container, $aliasMap)
+    {
+        $registry = $container->getDefinition('cmf_resource_rest.registry.payload_alias');
+        $registry->replaceArgument(1, $aliasMap);
+    }
+
+    private function configureEnhancerMap(ContainerBuilder $container, $enhancerMap)
+    {
+        $enhancerMap = $this->normalizeEnhancerMap($enhancerMap);
+        $registry = $container->getDefinition('cmf_resource_rest.registry.enhancer');
+        $registry->replaceArgument(1, $enhancerMap);
+    }
+
+    private function normalizeEnhancerMap($enhancerMap)
+    {
+        // normalize enhancer map
+        $normalized = array();
+        foreach ($enhancerMap as $enhancerMapping) {
+            $repository = $enhancerMapping['repository'];
+            $enhancer = $enhancerMapping['enhancer'];
+
+            if (!isset($normalized[$repository])) {
+                $normalized[$repository] = array();
+            }
+
+            $normalized[$repository][] = $enhancer;
+        }
+
+        return $normalized;
     }
 }

DependencyInjection/Compiler/EnhancerPass.php

@@ -0,0 +1,58 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection\Compiler;
+
+use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface;
+use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
+
+/**
+ * @author Daniel Leech <[email protected]>
+ */
+class EnhancerPass implements CompilerPassInterface
+{
+    public function process(ContainerBuilder $container)
+    {
+        if (!$container->has('cmf_resource_rest.registry.enhancer')) {
+            return;
+        }
+
+        $taggedIds = $container->findTaggedServiceIds('cmf_resource_rest.enhancer');
+
+        $repositoryMap = array();
+        $aliasMap = array();
+        foreach ($taggedIds as $id => $attributes) {
+            if (!isset($attributes[0]['alias'])) {
+                throw new InvalidArgumentException(sprintf(
+                    'Resource enhancer "%s" has no "alias" attribute in its tag',
+                    $id
+                ));
+            }
+
+            $name = $attributes[0]['alias'];
+
+            if (isset($aliasMap[$name])) {
+                throw new InvalidArgumentException(sprintf(
+                    'Enhancer with name "%s" (id: "%s") has already been registered',
+                    $name,
+                    $id
+                ));
+            }
+
+            $aliasMap[$name] = $id;
+        }
+
+        $registryDef = $container->getDefinition('cmf_resource_rest.registry.enhancer');
+        $registryDef->replaceArgument(2, $aliasMap);
+    }
+}

DependencyInjection/Configuration.php

@@ -0,0 +1,52 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection;
+
+use Symfony\Component\Config\Definition\ConfigurationInterface;
+use Symfony\Component\Config\Definition\Builder\TreeBuilder;
+
+class Configuration implements ConfigurationInterface
+{
+    /**
+     * Returns the config tree builder.
+     *
+     * @return TreeBuilder
+     */
+    public function getConfigTreeBuilder()
+    {
+        $treeBuilder = new TreeBuilder();
+        $treeBuilder->root('cmf_resource_rest')
+            ->fixXmlConfig('payload_alias', 'payload_alias_map')
+            ->fixXmlConfig('enhance', 'enhancer_map')
+            ->children()
+                ->arrayNode('payload_alias_map')
+                    ->useAttributeAsKey('name')
+                    ->prototype('array')
+                         ->children()
+                             ->scalarNode('repository')->end()
+                             ->scalarNode('type')->end()
+                         ->end()
+                    ->end()
+                ->end()
+                ->arrayNode('enhancer_map')
+                    ->prototype('array')
+                        ->children()
+                            ->scalarNode('repository')->isRequired()->end()
+                            ->scalarNode('enhancer')->isRequired()->end()
+                        ->end()
+                    ->end()
+                ->end()
+            ->end();
+
+        return $treeBuilder;
+    }
+}

Enhancer/EnhancerInterface.php

@@ -0,0 +1,35 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\ResourceRestBundle\Enhancer;
+
+use JMS\Serializer\Context;
+use Puli\Repository\Api\Resource\Resource;
+
+/**
+ * Enhancer classes enhance the REST response for resources
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+interface EnhancerInterface
+{
+    /**
+     * Enhance the given serialization context.
+     *
+     * For example:
+     *
+     *     $context->addData('foobar', 'Some value');
+     *
+     * @param Context Serialization context
+     * @param Resource The resource being serialized
+     */
+    public function enhance(Context $context, Resource $resource);
+}

Enhancer/PayloadEnhancer.php

@@ -0,0 +1,32 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\ResourceRestBundle\Enhancer;
+
+use JMS\Serializer\Context;
+use Puli\Repository\Api\Resource\Resource;
+
+/**
+ * Serialize the payload
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class PayloadEnhancer implements EnhancerInterface
+{
+    /**
+     * {@inheritDoc}
+     */
+    public function enhance(Context $context, Resource $resource)
+    {
+        $visitor = $context->getVisitor();
+        $visitor->addData('payload', $context->accept($resource->getPayload()));
+    }
+}

Registry/EnhancerRegistry.php

@@ -0,0 +1,89 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2014 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Bundle\ResourceRestBundle\Registry;
+
+use Symfony\Cmf\Component\Resource\RepositoryFactoryInterface;
+use Symfony\Component\DependencyInjection\ContainerInterface;
+use Symfony\Cmf\Component\Resource\RepositoryRegistryInterface;
+use Puli\Repository\Api\Resource\Resource;
+use Puli\Repository\Api\ResourceRepository;
+
+/**
+ * Registry for resource enhancers
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class EnhancerRegistry
+{
+    /**
+     * @var array
+     */
+    private $aliasMap = array();
+
+    /**
+     * @var array
+     */
+    private $enhancerMap = array();
+
+    /**
+     * @var ContainerInterface
+     */
+    private $container;
+
+    /**
+     * @param ContainerInterface $container The service container
+     * @param array $enhancerMap Map of enhancer aliases to repository names
+     * @param array $aliasMap Serice ID map for enhancer aliases
+     */
+    public function __construct(
+        ContainerInterface $container,
+        $enhancerMap = array(),
+        $aliasMap = array()
+    )
+    {
+        $this->container = $container;
+        $this->enhancerMap = $enhancerMap;
+        $this->aliasMap = $aliasMap;
+    }
+
+    /**
+     * Return all of the enhancers which are reigstered against
+     * the repository with the given alias.
+     *
+     * @param string $repositoryAlias
+     * @return EnhancerInterface[]
+     */
+    public function getEnhancers($repositoryAlias)
+    {
+        if (!isset($this->enhancerMap[$repositoryAlias])) {
+            return array();
+        }
+
+        $aliases = $this->enhancerMap[$repositoryAlias];
+
+        foreach ($aliases as $alias) {
+            if (!isset($this->aliasMap[$alias])) {
+                throw new \InvalidArgumentException(sprintf(
+                    'Unknown enhancer alias "%s". Known aliases: "%s"',
+                    implode('", "', array_keys($this->aliasMap))
+                ));
+            }
+
+            $enhancer = $this->container->get(
+                $this->aliasMap[$alias]
+            );
+            $enhancers[] = $enhancer;
+        }
+
+        return $enhancers;
+    }
+}