Merge pull request #100 from symfony-cmf/cleanup-adapter-interface

remove redundant parameter from AdapterInterface

Author: ElectricMaxxx

CHANGELOG.md

@@ -1,6 +1,12 @@
 Changelog
 =========
 
+2.0.0-RC3
+---------
+
+* **2017-08-03**: [BC Break] Removed second argument $contentDocument from `AdapterInterface::createAutoRoute`.
+                  If you call this method manually or implemented the interface, you need to adjust your code.
+
 2.0.0-RC2
 ---------
 

src/Adapter/EventDispatchingAdapter.php

@@ -26,6 +26,14 @@
  */
 class EventDispatchingAdapter implements AdapterInterface
 {
+    /**
+     * @var AdapterInterface
+     */
+    private $adapter;
+
+    /**
+     * @var EventDispatcherInterface
+     */
     private $dispatcher;
 
     public function __construct(AdapterInterface $adapter, EventDispatcherInterface $eventDispatcher)
@@ -78,9 +86,9 @@ public function removeAutoRoute(AutoRouteInterface $autoRoute)
     /**
      * {@inheritdoc}
      */
-    public function createAutoRoute(UriContext $uriContext, $contentDocument, $autoRouteTag)
+    public function createAutoRoute(UriContext $uriContext, $autoRouteTag)
     {
-        $autoRoute = $this->adapter->createAutoRoute($uriContext, $contentDocument, $autoRouteTag);
+        $autoRoute = $this->adapter->createAutoRoute($uriContext, $autoRouteTag);
         $this->dispatcher->dispatch(RoutingAutoEvents::POST_CREATE, new AutoRouteCreateEvent($autoRoute, $uriContext));
 
         return $autoRoute;

src/AdapterInterface.php

@@ -11,6 +11,7 @@
 
 namespace Symfony\Cmf\Component\RoutingAuto;
 
+use Symfony\Cmf\Component\Routing\RouteObjectInterface;
 use Symfony\Cmf\Component\RoutingAuto\Model\AutoRouteInterface;
 
 /**
@@ -40,16 +41,14 @@ public function getLocales($object);
     public function translateObject($object, $locale);
 
     /**
-     * Create a new auto route at the given path
-     * with the given document as the content.
+     * Create a new auto route from the given context.
      *
      * @param UriContext $uriContext
-     * @param object     $document
      * @param string     $tag
      *
      * @return AutoRouteInterface new route document
      */
-    public function createAutoRoute(UriContext $uriContext, $document, $tag);
+    public function createAutoRoute(UriContext $uriContext, $tag);
 
     /**
      * Return the canonical name for the given class, this is
@@ -92,7 +91,7 @@ public function compareAutoRouteLocale(AutoRouteInterface $autoRoute, $locale);
      * @param string     $uri        The URI to find
      * @param UriContext $uriContext The current URI context
      *
-     * @return null|Symfony\Cmf\Component\Routing\RouteObjectInterface
+     * @return RouteObjectInterface|null
      */
     public function findRouteForUri($uri, UriContext $uriContext);
 

src/AutoRouteManager.php

@@ -12,7 +12,6 @@
 namespace Symfony\Cmf\Component\RoutingAuto;
 
 use Symfony\Cmf\Component\RoutingAuto\Model\AutoRouteInterface;
-use Symfony\Component\EventDispatcher\EventDispatcher;
 
 /**
  * This class is concerned with the automatic creation of route objects.
@@ -46,12 +45,6 @@ class AutoRouteManager
      */
     protected $collectionBuilder;
 
-    /**
-     * @param AdapterInterface             $adapter             Database adapter
-     * @param UriGeneratorInterface        $uriGenerator        Routing auto URL generator
-     * @param DefunctRouteHandlerInterface $defunctRouteHandler Handler for defunct routes
-     * @param EventDispatcher              $eventDispatcher     Dispatcher for events
-     */
     public function __construct(
         AdapterInterface $adapter,
         UriGeneratorInterface $uriGenerator,
@@ -73,6 +66,7 @@ public function buildUriContextCollection(UriContextCollection $uriContextCollec
     {
         $this->collectionBuilder->build($uriContextCollection);
 
+        /** @var UriContext $uriContext */
         foreach ($uriContextCollection->getUriContexts() as $uriContext) {
             $subject = $uriContextCollection->getSubject();
 
@@ -99,12 +93,7 @@ public function buildUriContextCollection(UriContextCollection $uriContextCollec
             if (null === $autoRoute) {
                 $autoRouteTag = $this->adapter->generateAutoRouteTag($uriContext);
 
-                // TODO: The second argument below is now **pointless**, as the
-                // UriContext contains both the original and translated subject
-                // objects.
-                //
-                // See: https://github.com/symfony-cmf/RoutingAuto/issues/73
-                $autoRoute = $this->adapter->createAutoRoute($uriContext, $subject, $autoRouteTag);
+                $autoRoute = $this->adapter->createAutoRoute($uriContext, $autoRouteTag);
             }
 
             $uriContext->setAutoRoute($autoRoute);

src/UriContext.php

@@ -11,6 +11,8 @@
 
 namespace Symfony\Cmf\Component\RoutingAuto;
 
+use Symfony\Cmf\Component\RoutingAuto\Model\AutoRouteInterface;
+
 /**
  * Class which holds all the necessary information to make an auto route.
  *

tests/Unit/Adapter/EventDispatchingAdapterTest.php

@@ -11,15 +11,56 @@
 
 namespace Symfony\Cmf\Component\RoutingAuto\Tests\Unit\Adapter;
 
+use Prophecy\Prophecy\ObjectProphecy;
 use Symfony\Cmf\Component\RoutingAuto\Adapter\EventDispatchingAdapter;
+use Symfony\Cmf\Component\RoutingAuto\AdapterInterface;
 use Symfony\Cmf\Component\RoutingAuto\Event\AutoRouteCreateEvent;
 use Symfony\Cmf\Component\RoutingAuto\Event\AutoRouteMigrateEvent;
+use Symfony\Cmf\Component\RoutingAuto\Model\AutoRouteInterface;
 use Symfony\Cmf\Component\RoutingAuto\RoutingAutoEvents;
+use Symfony\Cmf\Component\RoutingAuto\UriContext;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
 class EventDispatchingAdapterTest extends \PHPUnit_Framework_TestCase
 {
+    /**
+     * @var AdapterInterface|ObjectProphecy
+     */
+    private $realAdapter;
+
+    /**
+     * @var EventDispatcher
+     */
+    private $dispatcher;
+
+    /**
+     * @var EventDispatchingAdapter
+     */
+    private $adapter;
+
+    /**
+     * @var EventDispatchingAdapterSubscriber
+     */
+    private $subscriber;
+
+    /**
+     * @var UriContext|ObjectProphecy
+     */
+    private $uriContext;
+
+    /**
+     * @var AutoRouteInterface|ObjectProphecy
+     */
+    private $autoRoute;
+
+    /**
+     * @var AutoRouteInterface|ObjectProphecy
+     */
+    private $autoRoute2;
+
+    private $content;
+
     public function setUp()
     {
         $this->realAdapter = $this->prophesize('Symfony\Cmf\Component\RoutingAuto\AdapterInterface');
@@ -39,8 +80,8 @@ public function setUp()
 
     public function testCreateAutoRoute()
     {
-        $this->realAdapter->createAutoRoute($this->uriContext->reveal(), null, 'fr')->willReturn($this->autoRoute->reveal());
-        $this->adapter->createAutoRoute($this->uriContext->reveal(), null, 'fr');
+        $this->realAdapter->createAutoRoute($this->uriContext->reveal(), 'fr')->willReturn($this->autoRoute->reveal());
+        $this->adapter->createAutoRoute($this->uriContext->reveal(), 'fr');
         $this->assertNotNull($this->subscriber->createEvent);
         $this->assertInstanceOf('Symfony\Cmf\Component\RoutingAuto\Event\AutoRouteCreateEvent', $this->subscriber->createEvent);
         $this->assertSame($this->autoRoute->reveal(), $this->subscriber->createEvent->getAutoRoute());

tests/Unit/AutoRouteManagerTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\Cmf\Component\RoutingAuto\Tests\Unit;
 
 use Prophecy\Argument;
+use Prophecy\Prophecy\ObjectProphecy;
 use Symfony\Cmf\Component\RoutingAuto\AdapterInterface;
 use Symfony\Cmf\Component\RoutingAuto\AutoRouteManager;
 use Symfony\Cmf\Component\RoutingAuto\DefunctRouteHandlerInterface;
@@ -23,10 +24,29 @@
 
 class AutoRouteManagerTest extends \PHPUnit_Framework_TestCase
 {
+    /**
+     * @var AdapterInterface|ObjectProphecy
+     */
     private $adapter;
+
+    /**
+     * @var UriGeneratorInterface|ObjectProphecy
+     */
     private $uriGenerator;
+
+    /**
+     * @var DefunctRouteHandlerInterface|ObjectProphecy
+     */
     private $defunctRouteHandler;
+
+    /**
+     * @var UriContextCollectionBuilder|ObjectProphecy
+     */
     private $collectionBuilder;
+
+    /**
+     * @var AutoRouteManager|ObjectProphecy
+     */
     private $manager;
     private $subject;
     private $collection;
@@ -494,7 +514,7 @@ private function configureAdapter(array $route)
         $this->adapter->generateAutoRouteTag(self::is($route['context']))
             ->willReturn($route['locale']);
 
-        $this->adapter->createAutoRoute(self::is($route['context']), $route['subject'], $route['locale'])
+        $this->adapter->createAutoRoute(self::is($route['context']), $route['locale'])
             ->willReturn($route['createdAutoRoute']);
 
         $this->adapter->findRouteForUri($route['generatedUri'], self::is($route['context']))