conditional enhancer

Author: dbu

CHANGELOG.md

@@ -1,6 +1,9 @@
 Changelog
 =========
 
+* **2016-05-11**: Added a ConditionalEnhancer that accepts pairs of request matcher
+  and enhancer to be called if the request matcher matches the request.
+
 1.4.0
 -----
 

Enhancer/ConditionalEnhancer.php

@@ -0,0 +1,59 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Routing\Enhancer;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * This enhancer uses a HttpFoundation request matcher to decide which enhancer
+ * to use.
+ *
+ * @author David Buchmann
+ */
+class ConditionalEnhancer implements RouteEnhancerInterface
+{
+    /**
+     * The enhancer of the first entry where the matcher matches the request is
+     * used.
+     *
+     * The matcher has to implement Symfony\Component\HttpFoundation\RequestMatcherInterface.
+     *
+     * The enhancer has to implement RouteEnhancerInterface.
+     *
+     * @var array Ordered list of 'matcher', 'enhancer' pairs.
+     */
+    private $enhancerMap;
+
+    /**
+     * @param array $enhancerMap Ordered list of 'matcher', 'enhancer' pairs.
+     */
+    public function __construct(array $enhancerMap)
+    {
+        $this->enhancerMap = $enhancerMap;
+    }
+
+    /**
+     * If the target field is not set but the source field is, map the field.
+     *
+     * {@inheritdoc}
+     */
+    public function enhance(array $defaults, Request $request)
+    {
+        foreach ($this->enhancerMap as $pair) {
+            if ($pair['matcher']->matches($request)) {
+                return $pair['enhancer']->enhance($defaults, $request);
+            }
+        }
+
+        return $defaults;
+    }
+}

Tests/Enhancer/ConditionalEnhancerTest.php

@@ -0,0 +1,92 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 2011-2015 Symfony CMF
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Cmf\Component\Routing\Tests\Mapper;
+
+use Symfony\Cmf\Component\Routing\Enhancer\ConditionalEnhancer;
+use Symfony\Component\HttpFoundation\Request;
+use Symfony\Cmf\Component\Routing\Test\CmfUnitTestCase;
+
+class ConditionalEnhancerTest extends CmfUnitTestCase
+{
+    /**
+     * @var Request
+     */
+    private $request;
+
+    public function setUp()
+    {
+        $this->request = Request::create('/test');
+    }
+
+    public function testSecondMatch()
+    {
+        $defaults = array('foo' => 'bar');
+        $expected = array('matcher' => 'found');
+
+        $enhancer1 = $this->buildMock('\Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface');
+        $enhancer1->expects($this->never())
+            ->method('enhance');
+        $matcher1 = $this->buildMock('\Symfony\Component\HttpFoundation\RequestMatcherInterface');
+        $matcher1->expects($this->once())
+            ->method('matches')
+            ->with($this->request)
+            ->will($this->returnValue(false));
+
+        $enhancer2 = $this->buildMock('\Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface');
+        $enhancer2->expects($this->once())
+            ->method('enhance')
+            ->with($defaults, $this->request)
+            ->will($this->returnValue($expected));
+        $matcher2 = $this->buildMock('\Symfony\Component\HttpFoundation\RequestMatcherInterface');
+        $matcher2->expects($this->once())
+            ->method('matches')
+            ->with($this->request)
+            ->will($this->returnValue(true));
+
+        $enhancer = new ConditionalEnhancer(array(
+           array(
+               'matcher' => $matcher1,
+               'enhancer' => $enhancer1,
+           ),
+            array(
+                'matcher' => $matcher2,
+                'enhancer' => $enhancer2,
+            ),
+        ));
+
+        $this->assertEquals($expected, $enhancer->enhance($defaults, $this->request));
+    }
+
+    public function testNoMatch()
+    {
+        $defaults = array('foo' => 'bar');
+        $expected = array('matcher' => 'found');
+
+        $enhancer1 = $this->buildMock('\Symfony\Cmf\Component\Routing\Enhancer\RouteEnhancerInterface');
+        $enhancer1->expects($this->never())
+            ->method('enhance');
+        $matcher1 = $this->buildMock('\Symfony\Component\HttpFoundation\RequestMatcherInterface');
+        $matcher1->expects($this->once())
+            ->method('matches')
+            ->with($this->request)
+            ->will($this->returnValue(false));
+
+        $enhancer = new ConditionalEnhancer(array(
+            array(
+                'matcher' => $matcher1,
+                'enhancer' => $enhancer1,
+            ),
+        ));
+
+        $this->assertEquals($defaults, $enhancer->enhance($defaults, $this->request));
+    }
+}