added RedirectRoute ORM implementation, phase 2 (squashed)

Author: ilukac

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+2.3.0 (unreleased)
+------------------
+
+* Implemented redirect route feature for the Doctrine ORM model
+* Removed the name for staticPrefix index on the Route model due to name colision when the model is inherited by RediretRoute model
+
 2.2.0
 -----
 

src/Doctrine/Orm/RedirectRoute.php

@@ -0,0 +1,100 @@
+<?php
+
+/*
+ * This file is part of the Symfony CMF package.
+ *
+ * (c) 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\RoutingBundle\Doctrine\Orm;
+
+use Symfony\Cmf\Bundle\RoutingBundle\Model\RedirectRoute as RedirectRouteModel;
+
+/**
+ * {@inheritdoc}
+ *
+ * Provides a redirect route stored in the Doctrine ORM and used as content for generic route to provide redirects
+ */
+class RedirectRoute extends RedirectRouteModel
+{
+    /**
+     * Unique id of this route.
+     *
+     * @var int
+     */
+    protected $id;
+
+    /**
+     * @var string
+     */
+    protected $serialisedParameters;
+
+    /**
+     * Overwrite to be able to create route without pattern.
+     *
+     * Additional options:
+     *
+     * * add_trailing_slash: When set, a trailing slash is appended to the route
+     *
+     * @param array $options
+     */
+    public function __construct(array $options = [])
+    {
+        parent::__construct($options);
+    }
+
+    public function setId($id)
+    {
+        $this->id = $id;
+
+        return $this;
+    }
+
+    public function getId()
+    {
+        return $this->id;
+    }
+
+    /**
+     * Set the parameters for building this route. Used with both route name
+     * and target route document.
+     */
+    public function setParameters(array $parameters)
+    {
+        $this->serialisedParameters = json_encode($parameters);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getParameters()
+    {
+        $params = json_decode($this->serialisedParameters);
+
+        return is_array($params) ? $params : [];
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function getPath()
+    {
+        $pattern = parent::getPath();
+        if ($this->getOption('add_trailing_slash') && '/' !== $pattern[strlen($pattern) - 1]) {
+            $pattern .= '/';
+        }
+
+        return $pattern;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function isBooleanOption($name)
+    {
+        return 'add_trailing_slash' === $name || parent::isBooleanOption($name);
+    }
+}

src/Resources/config/doctrine-model/Route.orm.xml

@@ -8,7 +8,7 @@
         <field name="staticPrefix" type="string" nullable="true" column="staticPrefix"/>
 
         <indexes>
-            <index name="prefix_idx" columns="staticPrefix"/>
+            <index columns="staticPrefix"/>
         </indexes>
     </mapped-superclass>
 

src/Resources/config/doctrine-orm/RedirectRoute.orm.xml

@@ -0,0 +1,22 @@
+<doctrine-mapping xmlns="http://doctrine-project.org/schemas/orm/doctrine-mapping"
+      xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+      xsi:schemaLocation="https://raw.github.com/doctrine/doctrine2/master/doctrine-mapping.xsd">
+
+    <entity name="Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Orm\RedirectRoute" table="orm_redirects">
+
+        <id name="id" type="integer" column="id">
+            <generator strategy="AUTO"/>
+        </id>
+
+        <!-- we hardcode the column name to overwrite column naming strategies as we have to define the index on the column name -->
+        <field name="routeName" type="string" unique="true" column="routeName"/>
+        <field name="uri" type="string" nullable="true"/>
+        <field name="permanent" type="boolean"/>
+
+        <many-to-one field="routeTarget" target-entity="Route" >
+            <join-column name="routeTargetId" referenced-column-name="id" />
+        </many-to-one>
+
+    </entity>
+
+</doctrine-mapping>

tests/Functional/Doctrine/Orm/RedirectRouteTest.php

@@ -3,56 +3,57 @@
 /*
  * This file is part of the Symfony CMF package.
  *
- * (c) 2011-2017 Symfony CMF
+ * (c) 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\RoutingBundle\Tests\Functional\Doctrine\Orm;
 
-use Symfony\Cmf\Bundle\RoutingBundle\Tests\Functional\BaseTestCase;
-use Symfony\Cmf\Component\Routing\RedirectRouteInterface;
-use Symfony\Cmf\Bundle\RoutingBundle\Model\RedirectRoute;
+use Symfony\Cmf\Bundle\RoutingBundle\Controller\RedirectController;
+use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Orm\RedirectRoute;
+use Symfony\Cmf\Bundle\RoutingBundle\Doctrine\Orm\Route;
+use Symfony\Component\HttpFoundation\RedirectResponse;
 
 class RedirectRouteTest extends OrmTestCase
 {
     private $repository;
 
+    private $controller;
+
     public function setUp()
     {
         parent::setUp();
         $this->clearDb(Route::class);
         $this->clearDb(RedirectRoute::class);
 
         $this->repository = $this->getContainer()->get('cmf_routing.route_provider');
+        $this->controller = new RedirectController($this->getContainer()->get('router'));
     }
 
     public function testRedirectDoctrine()
     {
         $route = $this->createRoute('route1', '/test');
 
         $redirectRouteDoc = new RedirectRoute();
-        $redirectRouteDoc->setRouteName("redirect1");
+        $redirectRouteDoc->setRouteName('redirect1');
         $redirectRouteDoc->setRouteTarget($route);
         $redirectRouteDoc->setPermanent(true);
 
+        $this->getDm()->persist($redirectRouteDoc);
         $this->getDm()->flush();
 
-        $redirectRoute = new Route();
-        $redirectRoute->setName("redirect1");
-        $redirectRoute->setStaticPrefix('/redirect');
+        $redirectRoute = $this->createRoute('redirect1', '/redirect');
         $redirectRoute->setContent($redirectRouteDoc);
 
         $this->getDm()->flush();
         $this->getDm()->clear();
 
-        $route1 = $this->repository->getRouteByName('route1');
-        $redirect1 = $this->repository->getRouteByName('redirect1');
-        $this->assertInstanceOf(Route::class, $route1);
-        $this->assertInstanceOf(RedirectRouteInterface::class, $redirect1);
+        $response = $this->controller->redirectAction($redirectRoute->getContent());
 
-        $this->assertSame($route1, $redirect1->getContent()->getRouteTarget());
+        $this->assertInstanceOf(RedirectResponse::class, $response);
+        $this->assertSame(301, $response->getStatusCode());
+        $this->assertSame('http://localhost/test', $response->getTargetUrl());
     }
-
 }