Renamed decorator to enhancer

dantleech · dantleech · commit 6a338b58a436 · 2015-02-14T07:39:07.000Z
diff --git a/CmfResourceRestBundle.php b/CmfResourceRestBundle.php
@@ -13,13 +13,13 @@
 
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
-use Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection\Compiler\DecoratorPass;
+use Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection\Compiler\EnhancerPass;
 
 class CmfResourceRestBundle extends Bundle
 {
     public function build(ContainerBuilder $container)
     {
-        $container->addCompilerPass(new DecoratorPass());
+        $container->addCompilerPass(new EnhancerPass());
         parent::build($container);
     }
 }
diff --git a/DependencyInjection/CmfResourceRestExtension.php b/DependencyInjection/CmfResourceRestExtension.php
@@ -54,10 +54,15 @@ public function load(array $configs, ContainerBuilder $container)
 
         $loader->load('serializer.xml');
         $loader->load('resource-rest.xml');
-        $loader->load('decorator.xml');
+        $loader->load('enhancer.xml');
 
         $this->configurePayloadAliasRegistry($container, $config['payload_alias_map']);
-        $this->configureDecoratorMap($container, $config['decorator_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)
@@ -66,14 +71,28 @@ private function configurePayloadAliasRegistry(ContainerBuilder $container, $ali
         $registry->replaceArgument(1, $aliasMap);
     }
 
-    private function configureDecoratorMap(ContainerBuilder $container, $decoratorMap)
+    private function configureEnhancerMap(ContainerBuilder $container, $enhancerMap)
     {
-        $registry = $container->getDefinition('cmf_resource_rest.registry.decorator');
-        $registry->replaceArgument(1, $decoratorMap);
+        $enhancerMap = $this->normalizeEnhancerMap($enhancerMap);
+        $registry = $container->getDefinition('cmf_resource_rest.registry.enhancer');
+        $registry->replaceArgument(1, $enhancerMap);
     }
 
-    public function getNamespace()
+    private function normalizeEnhancerMap($enhancerMap)
     {
-        return 'http://cmf.symfony.com/schema/dic/' . $this->getAlias();
+        // 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;
     }
 }
diff --git a/DependencyInjection/Compiler/EnhancerPass.php b/DependencyInjection/Compiler/EnhancerPass.php
@@ -19,22 +19,22 @@
 /**
  * @author Daniel Leech <daniel@dantleech.com>
  */
-class DecoratorPass implements CompilerPassInterface
+class EnhancerPass implements CompilerPassInterface
 {
     public function process(ContainerBuilder $container)
     {
-        if (!$container->has('cmf_resource_rest.registry.decorator')) {
+        if (!$container->has('cmf_resource_rest.registry.enhancer')) {
             return;
         }
 
-        $taggedIds = $container->findTaggedServiceIds('cmf_resource_rest.decorator');
+        $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 decorator "%s" has no "alias" attribute in its tag',
+                    'Resource enhancer "%s" has no "alias" attribute in its tag',
                     $id
                 ));
             }
@@ -43,7 +43,7 @@ public function process(ContainerBuilder $container)
 
             if (isset($aliasMap[$name])) {
                 throw new InvalidArgumentException(sprintf(
-                    'Decorator with name "%s" (id: "%s") has already been registered',
+                    'Enhancer with name "%s" (id: "%s") has already been registered',
                     $name,
                     $id
                 ));
@@ -52,7 +52,7 @@ public function process(ContainerBuilder $container)
             $aliasMap[$name] = $id;
         }
 
-        $registryDef = $container->getDefinition('cmf_resource_rest.registry.decorator');
+        $registryDef = $container->getDefinition('cmf_resource_rest.registry.enhancer');
         $registryDef->replaceArgument(2, $aliasMap);
     }
 }
diff --git a/DependencyInjection/Configuration.php b/DependencyInjection/Configuration.php
@@ -26,6 +26,7 @@ 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')
@@ -36,10 +37,12 @@ public function getConfigTreeBuilder()
                          ->end()
                     ->end()
                 ->end()
-                ->arrayNode('decorator_map')
-                    ->useAttributeAsKey('repository')
+                ->arrayNode('enhancer_map')
                     ->prototype('array')
-                        ->prototype('scalar')->end()
+                        ->children()
+                            ->scalarNode('repository')->isRequired()->end()
+                            ->scalarNode('enhancer')->isRequired()->end()
+                        ->end()
                     ->end()
                 ->end()
             ->end();
diff --git a/Enhancer/EnhancerInterface.php b/Enhancer/EnhancerInterface.php
@@ -9,27 +9,27 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Cmf\Bundle\ResourceRestBundle\Decorator;
+namespace Symfony\Cmf\Bundle\ResourceRestBundle\Enhancer;
 
 use JMS\Serializer\Context;
 use Puli\Repository\Api\Resource\Resource;
 
 /**
- * Decorator classes decorate the REST response for resources
+ * Enhancer classes enhance the REST response for resources
  *
  * @author Daniel Leech <daniel@dantleech.com>
  */
-interface DecoratorInterface
+interface EnhancerInterface
 {
     /**
-     * Decorate the given serialization context.
+     * Enhance the given serialization context.
      *
      * For example:
      *
      *     $context->addData('foobar', 'Some value');
      *
      * @param Context Serialization context
-     * @param resource The resource being serialized
+     * @param Resource The resource being serialized
      */
-    public function decorate(Context $context, Resource $resource);
+    public function enhance(Context $context, Resource $resource);
 }
diff --git a/Enhancer/PayloadEnhancer.php b/Enhancer/PayloadEnhancer.php
@@ -9,7 +9,7 @@
  * file that was distributed with this source code.
  */
 
-namespace Symfony\Cmf\Bundle\ResourceRestBundle\Decorator;
+namespace Symfony\Cmf\Bundle\ResourceRestBundle\Enhancer;
 
 use JMS\Serializer\Context;
 use Puli\Repository\Api\Resource\Resource;
@@ -19,12 +19,12 @@
  *
  * @author Daniel Leech <daniel@dantleech.com>
  */
-class PayloadDecorator implements DecoratorInterface
+class PayloadEnhancer implements EnhancerInterface
 {
     /**
      * {@inheritDoc}
      */
-    public function decorate(Context $context, Resource $resource)
+    public function enhance(Context $context, Resource $resource)
     {
         $visitor = $context->getVisitor();
         $visitor->addData('payload', $context->accept($resource->getPayload()));
diff --git a/Registry/EnhancerRegistry.php b/Registry/EnhancerRegistry.php
@@ -18,11 +18,11 @@
 use Puli\Repository\Api\ResourceRepository;
 
 /**
- * Registry for resource decorators
+ * Registry for resource enhancers
  *
  * @author Daniel Leech <daniel@dantleech.com>
  */
-class DecoratorRegistry
+class EnhancerRegistry
 {
     /**
      * @var array
@@ -32,7 +32,7 @@ class DecoratorRegistry
     /**
      * @var array
      */
-    private $decoratorMap = array();
+    private $enhancerMap = array();
 
     /**
      * @var ContainerInterface
@@ -41,49 +41,49 @@ class DecoratorRegistry
 
     /**
      * @param ContainerInterface $container The service container
-     * @param array $decoratorMap Map of decorator aliases to repository names
-     * @param array $aliasMap Serice ID map for decorator aliases
+     * @param array $enhancerMap Map of enhancer aliases to repository names
+     * @param array $aliasMap Serice ID map for enhancer aliases
      */
     public function __construct(
         ContainerInterface $container,
-        $decoratorMap = array(),
+        $enhancerMap = array(),
         $aliasMap = array()
     )
     {
         $this->container = $container;
-        $this->decoratorMap = $decoratorMap;
+        $this->enhancerMap = $enhancerMap;
         $this->aliasMap = $aliasMap;
     }
 
     /**
-     * Return all of the decorators which are reigstered against
+     * Return all of the enhancers which are reigstered against
      * the repository with the given alias.
      *
      * @param string $repositoryAlias
-     * @return DecoratorInterface[]
+     * @return EnhancerInterface[]
      */
-    public function getDecorators($repositoryAlias)
+    public function getEnhancers($repositoryAlias)
     {
-        if (!isset($this->decoratorMap[$repositoryAlias])) {
+        if (!isset($this->enhancerMap[$repositoryAlias])) {
             return array();
         }
 
-        $aliases = $this->decoratorMap[$repositoryAlias];
+        $aliases = $this->enhancerMap[$repositoryAlias];
 
         foreach ($aliases as $alias) {
             if (!isset($this->aliasMap[$alias])) {
                 throw new \InvalidArgumentException(sprintf(
-                    'Unknown decorator alias "%s". Known aliases: "%s"',
+                    'Unknown enhancer alias "%s". Known aliases: "%s"',
                     implode('", "', array_keys($this->aliasMap))
                 ));
             }
 
-            $decorator = $this->container->get(
+            $enhancer = $this->container->get(
                 $this->aliasMap[$alias]
             );
-            $decorators[] = $decorator;
+            $enhancers[] = $enhancer;
         }
 
-        return $decorators;
+        return $enhancers;
     }
 }
diff --git a/Resources/config/enhancer.xml b/Resources/config/enhancer.xml
@@ -5,13 +5,13 @@
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <parameters>
-        <parameter key="cmf_resource_rest.decorator.payload.class">Symfony\Cmf\Bundle\ResourceRestBundle\Decorator\PayloadDecorator</parameter>
+        <parameter key="cmf_resource_rest.enhancer.payload.class">Symfony\Cmf\Bundle\ResourceRestBundle\Enhancer\PayloadEnhancer</parameter>
     </parameters>
 
     <services>
 
-        <service id="cmf_resource_rest.decorator.payload" class="%cmf_resource_rest.decorator.payload.class%">
-            <tag name="cmf_resource_rest.decorator" alias="payload" />
+        <service id="cmf_resource_rest.enhancer.payload" class="%cmf_resource_rest.enhancer.payload.class%">
+            <tag name="cmf_resource_rest.enhancer" alias="payload" />
         </service>
 
     </services>
diff --git a/Resources/config/resource-rest.xml b/Resources/config/resource-rest.xml
@@ -8,7 +8,7 @@
         <parameter key="cmf_resource_rest.controller.resource.class">Symfony\Cmf\Bundle\ResourceRestBundle\Controller\ResourceController</parameter>
         <parameter key="cmf_resource_rest.path_helper.class">Symfony\Cmf\Bundle\ResourceRestBundle\Helper\PathHelper</parameter>
         <parameter key="cmf_resource_rest.registry.payload_alias.class">Symfony\Cmf\Bundle\ResourceRestBundle\Registry\PayloadAliasRegistry</parameter>
-        <parameter key="cmf_resource_rest.registry.decorator.class">Symfony\Cmf\Bundle\ResourceRestBundle\Registry\DecoratorRegistry</parameter>
+        <parameter key="cmf_resource_rest.registry.enhancer.class">Symfony\Cmf\Bundle\ResourceRestBundle\Registry\EnhancerRegistry</parameter>
     </parameters>
 
     <services>
@@ -26,7 +26,7 @@
             <argument type="collection" />
         </service>
 
-        <service id="cmf_resource_rest.registry.decorator" class="%cmf_resource_rest.registry.decorator.class%">
+        <service id="cmf_resource_rest.registry.enhancer" class="%cmf_resource_rest.registry.enhancer.class%">
             <argument type="service" id="service_container" />
             <argument type="collection" />
             <argument type="collection" />
diff --git a/Resources/config/serializer.xml b/Resources/config/serializer.xml
@@ -30,7 +30,7 @@
         <service id="cmf_resource_rest.serializer.subscriber.resource" class="%cmf_resource_rest.serializer.subscriber.resource.class%">
             <argument type="service" id="cmf_resource.registry" />
             <argument type="service" id="cmf_resource_rest.registry.payload_alias" />
-            <argument type="service" id="cmf_resource_rest.registry.decorator" />
+            <argument type="service" id="cmf_resource_rest.registry.enhancer" />
             <tag name="jms_serializer.event_subscriber" />
         </service>
 
diff --git a/Serializer/EventSubscriber/ResourceSubscriber.php b/Serializer/EventSubscriber/ResourceSubscriber.php
@@ -20,7 +20,7 @@
 use Puli\Repository\Api\Resource\Resource;
 use Symfony\Cmf\Component\Resource\RepositoryRegistryInterface;
 use Symfony\Cmf\Bundle\ResourceRestBundle\Registry\PayloadAliasRegistry;
-use Symfony\Cmf\Bundle\ResourceRestBundle\Registry\DecoratorRegistry;
+use Symfony\Cmf\Bundle\ResourceRestBundle\Registry\EnhancerRegistry;
 
 /**
  * Force instaces of ResourceCollection to type "ResourceCollection"
@@ -31,16 +31,16 @@ class ResourceSubscriber implements EventSubscriberInterface
 {
     private $registry;
     private $payloadAliasRegistry;
-    private $decoratorRegistry;
+    private $enhancerRegistry;
 
     public function __construct(
         RepositoryRegistryInterface $registry,
         PayloadAliasRegistry $payloadAliasRegistry,
-        DecoratorRegistry $decoratorRegistry
+        EnhancerRegistry $enhancerRegistry
     ) {
         $this->registry = $registry;
         $this->payloadAliasRegistry = $payloadAliasRegistry;
-        $this->decoratorRegistry = $decoratorRegistry;
+        $this->enhancerRegistry = $enhancerRegistry;
     }
 
     public static function getSubscribedEvents()
@@ -92,10 +92,10 @@ public function onPostSerialize(ObjectEvent $event)
         $visitor->addData('repository_path', $object->getRepositoryPath());
         $visitor->addData('children', $context->accept($object->listChildren()));
 
-        $decorators = $this->decoratorRegistry->getDecorators($repositoryAlias);
+        $enhancers = $this->enhancerRegistry->getEnhancers($repositoryAlias);
 
-        foreach ($decorators as $decorator) {
-            $decorator->decorate($context, $object);
+        foreach ($enhancers as $enhancer) {
+            $enhancer->enhance($context, $object);
         }
     }
 }
diff --git a/Tests/Features/resource_api_decorator.feature b/Tests/Features/resource_api_decorator.feature
@@ -1,7 +1,7 @@
 Feature: Resource decoration
     In order to add additional data to resource REST responses
     As a developer
-    I need to be able to register decorators which do this
+    I need to be able to register enhancers which do this
 
     Background:
         Given the test application has the following configuration:
@@ -13,8 +13,10 @@ Feature: Resource decoration
                             basepath: /tests/cmf/articles
 
             cmf_resource_rest:
-                decorator_map:
-                    phpcr_repo: [ 'payload' ]
+                enhancer_map:
+                    -
+                        repository: phpcr_repo
+                        enhancer: payload
 
             """
 
diff --git a/Tests/Unit/DependencyInjection/CmfResourceRestExtensionTest.php b/Tests/Unit/DependencyInjection/CmfResourceRestExtensionTest.php
diff --git a/Tests/Unit/DependencyInjection/ConfigurationTest.php b/Tests/Unit/DependencyInjection/ConfigurationTest.php
diff --git a/Tests/Unit/DependencyInjection/fixtures/config.xml b/Tests/Unit/DependencyInjection/fixtures/config.xml
diff --git a/Tests/Unit/DependencyInjection/fixtures/config.yml b/Tests/Unit/DependencyInjection/fixtures/config.yml
diff --git a/Tests/Unit/Registry/EnhancerRegistryTest.php b/Tests/Unit/Registry/EnhancerRegistryTest.php

Original file line number	Diff line number	Diff line change
`@@ -13,13 +13,13 @@`
`13`	`13`
`14`	`14`	`use Symfony\Component\HttpKernel\Bundle\Bundle;`
`15`	`15`	`use Symfony\Component\DependencyInjection\ContainerBuilder;`
`16`		`-use Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection\Compiler\DecoratorPass;`
	`16`	`+use Symfony\Cmf\Bundle\ResourceRestBundle\DependencyInjection\Compiler\EnhancerPass;`
`17`	`17`
`18`	`18`	`class CmfResourceRestBundle extends Bundle`
`19`	`19`	`{`
`20`	`20`	`public function build(ContainerBuilder $container)`
`21`	`21`	`{`
`22`		`- $container->addCompilerPass(new DecoratorPass());`
	`22`	`+ $container->addCompilerPass(new EnhancerPass());`
`23`	`23`	`parent::build($container);`
`24`	`24`	`}`
`25`	`25`	`}`
Original file line number	Diff line number	Diff line change
`@@ -19,22 +19,22 @@`
`19`	`19`	`/**`
`20`	`20`	`* @author Daniel Leech <[email protected]>`
`21`	`21`	`*/`
`22`		`-class DecoratorPass implements CompilerPassInterface`
	`22`	`+class EnhancerPass implements CompilerPassInterface`
`23`	`23`	`{`
`24`	`24`	`public function process(ContainerBuilder $container)`
`25`	`25`	`{`
`26`		`- if (!$container->has('cmf_resource_rest.registry.decorator')) {`
	`26`	`+ if (!$container->has('cmf_resource_rest.registry.enhancer')) {`
`27`	`27`	`return;`
`28`	`28`	`}`
`29`	`29`
`30`		`- $taggedIds = $container->findTaggedServiceIds('cmf_resource_rest.decorator');`
	`30`	`+ $taggedIds = $container->findTaggedServiceIds('cmf_resource_rest.enhancer');`
`31`	`31`
`32`	`32`	`$repositoryMap = array();`
`33`	`33`	`$aliasMap = array();`
`34`	`34`	`foreach ($taggedIds as $id => $attributes) {`
`35`	`35`	`if (!isset($attributes[0]['alias'])) {`
`36`	`36`	`throw new InvalidArgumentException(sprintf(`
`37`		`- 'Resource decorator "%s" has no "alias" attribute in its tag',`
	`37`	`+ 'Resource enhancer "%s" has no "alias" attribute in its tag',`
`38`	`38`	`$id`
`39`	`39`	`));`
`40`	`40`	`}`
`@@ -43,7 +43,7 @@ public function process(ContainerBuilder $container)`
`43`	`43`
`44`	`44`	`if (isset($aliasMap[$name])) {`
`45`	`45`	`throw new InvalidArgumentException(sprintf(`
`46`		`- 'Decorator with name "%s" (id: "%s") has already been registered',`
	`46`	`+ 'Enhancer with name "%s" (id: "%s") has already been registered',`
`47`	`47`	`$name,`
`48`	`48`	`$id`
`49`	`49`	`));`
`@@ -52,7 +52,7 @@ public function process(ContainerBuilder $container)`
`52`	`52`	`$aliasMap[$name] = $id;`
`53`	`53`	`}`
`54`	`54`
`55`		`- $registryDef = $container->getDefinition('cmf_resource_rest.registry.decorator');`
	`55`	`+ $registryDef = $container->getDefinition('cmf_resource_rest.registry.enhancer');`
`56`	`56`	`$registryDef->replaceArgument(2, $aliasMap);`
`57`	`57`	`}`
`58`	`58`	`}`
Original file line number	Diff line number	Diff line change
`@@ -9,27 +9,27 @@`
`9`	`9`	`* file that was distributed with this source code.`
`10`	`10`	`*/`
`11`	`11`
`12`		`-namespace Symfony\Cmf\Bundle\ResourceRestBundle\Decorator;`
	`12`	`+namespace Symfony\Cmf\Bundle\ResourceRestBundle\Enhancer;`
`13`	`13`
`14`	`14`	`use JMS\Serializer\Context;`
`15`	`15`	`use Puli\Repository\Api\Resource\Resource;`
`16`	`16`
`17`	`17`	`/**`
`18`		`- * Decorator classes decorate the REST response for resources`
	`18`	`+ * Enhancer classes enhance the REST response for resources`
`19`	`19`	`*`
`20`	`20`	`* @author Daniel Leech <[email protected]>`
`21`	`21`	`*/`
`22`		`-interface DecoratorInterface`
	`22`	`+interface EnhancerInterface`
`23`	`23`	`{`
`24`	`24`	`/**`
`25`		`- * Decorate the given serialization context.`
	`25`	`+ * Enhance the given serialization context.`
`26`	`26`	`*`
`27`	`27`	`* For example:`
`28`	`28`	`*`
`29`	`29`	`* $context->addData('foobar', 'Some value');`
`30`	`30`	`*`
`31`	`31`	`* @param Context Serialization context`
`32`		`- * @param resource The resource being serialized`
	`32`	`+ * @param Resource The resource being serialized`
`33`	`33`	`*/`
`34`		`- public function decorate(Context $context, Resource $resource);`
	`34`	`+ public function enhance(Context $context, Resource $resource);`
`35`	`35`	`}`