Refactored collection handling

Author: dantleech

Resources/config/serializer.xml

@@ -5,14 +5,15 @@
     xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
 
     <parameters>
-        <parameter key="cmf_resource_rest.serializer.handler.collection.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\Handler\CollectionHandler</parameter>
+        <parameter key="cmf_resource_rest.serializer.handler.resource_collection.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\Handler\ResourceCollectionHandler</parameter>
         <parameter key="cmf_resource_rest.serializer.handler.phpcr_node.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\Handler\PhpcrNodeHandler</parameter>
         <parameter key="cmf_resource_rest.serializer.subscriber.phpcr_node.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\EventSubscriber\PhpcrNodeSubscriber</parameter>
+        <parameter key="cmf_resource_rest.serializer.subscriber.resource_collection.class">Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\EventSubscriber\ResourceCollectionSubscriber</parameter>
     </parameters>
 
     <services>
 
-        <service id="cmf_resource_rest.serializer.handler.collection" class="%cmf_resource_rest.serializer.handler.collection.class%">
+        <service id="cmf_resource_rest.serializer.handler.resource_collection" class="%cmf_resource_rest.serializer.handler.resource_collection.class%">
             <tag name="jms_serializer.subscribing_handler"/>
         </service>
 
@@ -23,5 +24,9 @@
         <service id="cmf_resource_rest.serializer.subscriber.phpcr_node" class="%cmf_resource_rest.serializer.subscriber.phpcr_node.class%">
             <tag name="jms_serializer.event_subscriber" />
         </service>
+
+        <service id="cmf_resource_rest.serializer.subscriber.resource_collection" class="%cmf_resource_rest.serializer.subscriber.resource_collection.class%">
+            <tag name="jms_serializer.event_subscriber" />
+        </service>
     </services>
 </container>

Serializer/EventSubscriber/ResourceCollectionSubscriber.php

@@ -0,0 +1,45 @@
+<?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\Serializer\EventSubscriber;
+
+use JMS\Serializer\EventDispatcher\EventSubscriberInterface;
+use PHPCR\NodeInterface;
+use JMS\Serializer\EventDispatcher\Events;
+use JMS\Serializer\EventDispatcher\PreSerializeEvent;
+use Puli\Repository\Api\ResourceCollection;
+
+/**
+ * Force instaces of ResourceCollection to type "ResourceCollection"
+ *
+ * @author Daniel Leech <[email protected]>
+ */
+class ResourceCollectionSubscriber implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents()
+    {
+        return array(
+            array(
+                'event' => Events::PRE_SERIALIZE,
+                'method' => 'onPreSerialize',
+            ),
+        );
+    }
+
+    public function onPreSerialize(PreSerializeEvent $event)
+    {
+        $object = $event->getObject();
+
+        if ($object instanceof ResourceCollection) {
+            $event->setType('Puli\Repository\Api\ResourceCollection');
+        }
+    }
+}

Serializer/Handler/PhpcrNodeHandler.php

@@ -36,6 +36,12 @@ public static function getSubscribingMethods()
         );
     }
 
+    /**
+     * @param JsonSerializationVisitor $visitor
+     * @param NodeInterface $nodeInterface
+     * @param array $type
+     * @param Context $context
+     */
     public function serializePhpcrNode(
         JsonSerializationVisitor $visitor,
         NodeInterface $node,

Serializer/Handler/CollectionHandler.php renamed to Serializer/Handler/ResourceCollectionHandler.php

@@ -19,31 +19,40 @@
 use JMS\Serializer\Context;
 
 /**
- * Normalize Collection objects to flat arrays
+ * Serialize ResourceCollection instances into flat arrays
  *
  * @author Daniel Leech <[email protected]>
  */
-class CollectionHandler implements SubscribingHandlerInterface
+class ResourceCollectionHandler implements SubscribingHandlerInterface
 {
     public static function getSubscribingMethods()
     {
         return array(
             array(
                 'event' => GraphNavigator::DIRECTION_SERIALIZATION,
                 'format' => 'json',
-                'type' => 'Puli\Repository\Resource\Collection\ArrayResourceCollection',
-                'method' => 'normalizeCollection',
+                'type' => 'Puli\Repository\Api\ResourceCollection',
+                'method' => 'serializeCollection',
             ),
         );
     }
 
-    public function normalizeCollection(
+    /**
+     * @param JsonSerializationVisitor $visitor
+     * @param ResourceCollection $resourceCollection
+     * @param array $type
+     * @param Context $context
+     */
+    public function serializeCollection(
         JsonSerializationVisitor $visitor,
         ResourceCollection $collection,
         array $type,
         Context $context
     ) {
-        $res = $visitor->visitarray($collection->toArray(), array('name' => 'Symfony\Cmf\Component\Resource\Repository\Resource\PhpcrOdmResource'), $context);
+        $res = array();
+        foreach ($collection as $resource) {
+            $res[$resource->getName()] = $context->accept($resource);
+        }
 
         return $res;
     }

Tests/Unit/Serializer/EventSubscriber/PhpcrNodeSubscriberTest.php

@@ -0,0 +1,39 @@
+<?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\Tests\Serializer\EventSubscriber;
+
+use Prophecy\PhpUnit\ProphecyTestCase;
+use Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\EventSubscriber\PhpcrNodeSubscriber;
+
+class PhpcrNodeSubscriberTest extends ProphecyTestCase
+{
+    private $node;
+    private $event;
+    private $subscriber;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->node = $this->prophesize('PHPCR\NodeInterface');
+        $this->event = $this->prophesize('JMS\Serializer\EventDispatcher\PreSerializeEvent');
+        $this->subscriber = new PhpcrNodeSubscriber();
+    }
+
+    public function testPreSerialize()
+    {
+        $this->event->getObject()->willReturn($this->node->reveal());
+        $this->event->setType('PHPCR\NodeInterface')->shouldBeCalled();
+        $this->subscriber->onPreSerialize($this->event->reveal());
+    }
+}
+

Tests/Unit/Serializer/EventSubscriber/ResourceCollectionSubscriberTest.php

@@ -0,0 +1,39 @@
+<?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\Tests\Serializer\EventSubscriber;
+
+use Prophecy\PhpUnit\ProphecyTestCase;
+use Symfony\Cmf\Bundle\ResourceRestBundle\Serializer\EventSubscriber\ResourceCollectionSubscriber;
+
+class ResourceCollectionSubscriberTest extends ProphecyTestCase
+{
+    private $collection;
+    private $event;
+    private $subscriber;
+
+    public function setUp()
+    {
+        parent::setUp();
+
+        $this->collection = $this->prophesize('Puli\Repository\Resource\Collection\ArrayResourceCollection');
+        $this->event = $this->prophesize('JMS\Serializer\EventDispatcher\PreSerializeEvent');
+        $this->subscriber = new ResourceCollectionSubscriber();
+    }
+
+    public function testPreSerialize()
+    {
+        $this->event->getObject()->willReturn($this->collection->reveal());
+        $this->event->setType('Puli\Repository\Api\ResourceCollection')->shouldBeCalled();
+        $this->subscriber->onPreSerialize($this->event->reveal());
+    }
+}
+