Merge pull request #1 from geosocio/group-resolver

Add Group Resolver
geosocio · Sep 30, 2017 · e462bd1 · e462bd1
2 parents 6158747 + 0e4b370
commit e462bd1
Show file tree

Hide file tree

Showing 21 changed files with 777 additions and 255 deletions.
diff --git a/README.md b/README.md
@@ -19,6 +19,8 @@ groups annotation.
 * Response Groups `GeoSocio\HttpSerializer\Annotation\ResponseGroups`
 * Request & Response Groups `Symfony\Component\Serializer\Annotation\Groups`
 
+They may also be applied with a `GroupResolver`.
+
 ## Example
 ```php
 /**

diff --git a/composer.json b/composer.json
@@ -17,7 +17,6 @@
     },
     "require": {
         "symfony/http-foundation": "^3.0",
-        "symfony/security": "^3.0",
         "symfony/http-kernel": "^3.0",
         "symfony/serializer": "^3.0",
         "doctrine/annotations": "^1.0",

diff --git a/src/ArgumentResolver/ContentClassResolver.php b/src/ArgumentResolver/ContentClassResolver.php
@@ -3,7 +3,7 @@
 namespace GeoSocio\HttpSerializer\ArgumentResolver;
 
 use GeoSocio\HttpSerializer\Event\DeserializeEvent;
-use GeoSocio\HttpSerializer\Loader\GroupLoaderInterface;
+use GeoSocio\HttpSerializer\GroupResolver\RequestGroupResolverInterface;
 use GeoSocio\HttpSerializer\Exception\ConstraintViolationException;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
@@ -48,11 +48,6 @@ class ContentClassResolver implements ArgumentValueResolverInterface
      */
     protected $decoder;
 
-    /**
-     * @var GroupLoaderInterface
-     */
-    protected $loader;
-
     /**
      * @var EventDispatcherInterface
      */
@@ -63,30 +58,35 @@ class ContentClassResolver implements ArgumentValueResolverInterface
      */
     protected $validator;
 
+    /**
+     * @var RequestGroupResolverInterface
+     */
+    protected $groupResolver;
+
     /**
      * Content Class Resolver
      *
      * @param SerializerInterface $serializer
      * @param DenormalizerInterface $denormalizer
      * @param DecoderInterface $decoder
-     * @param GroupLoaderInterface $loader
      * @param EventDispatcherInterface $eventDispatcher
      * @param ValidatorInterface $validator
+     * @param RequestGroupResolverInterface $groupResolver
      */
     public function __construct(
         SerializerInterface $serializer,
         DenormalizerInterface $denormalizer,
         DecoderInterface $decoder,
-        GroupLoaderInterface $loader,
         EventDispatcherInterface $eventDispatcher,
-        ValidatorInterface $validator
+        ValidatorInterface $validator,
+        RequestGroupResolverInterface $groupResolver
     ) {
         $this->serializer = $serializer;
         $this->denormalizer = $denormalizer;
         $this->decoder = $decoder;
-        $this->loader = $loader;
         $this->eventDispatcher = $eventDispatcher;
         $this->validator = $validator;
+        $this->groupResolver = $groupResolver;
     }
 
     /**
@@ -136,7 +136,7 @@ public function resolve(Request $request, ArgumentMetadata $argument)
             $argument->getType(),
             $request->getRequestFormat(),
             [
-                'groups' => $this->loader->getRequestGroups($request),
+                'groups' => $this->groupResolver->resolve($request, $argument->getType()),
             ],
             $request
         );

diff --git a/src/EventListener/KernelViewListener.php b/src/EventListener/KernelViewListener.php
@@ -3,7 +3,7 @@
 namespace GeoSocio\HttpSerializer\EventListener;
 
 use GeoSocio\HttpSerializer\Event\SerializeEvent;
-use GeoSocio\HttpSerializer\Loader\GroupLoaderInterface;
+use GeoSocio\HttpSerializer\GroupResolver\ResponseGroupResolverInterface;
 use Symfony\Component\EventDispatcher\EventDispatcherInterface;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Response;
@@ -34,36 +34,36 @@ class KernelViewListener
     protected $encoder;
 
     /**
-     * @var GroupLoaderInterface
+     * @var EventDispatcherInterface
      */
-    protected $loader;
+    protected $eventDispatcher;
 
     /**
-     * @var EventDispatcherInterface
+     * @var ResponseGroupResolverInterface
      */
-    protected $eventDispatcher;
+    protected $groupResolver;
 
     /**
      * Creates the Event Listener.
      *
      * @param SerializerInterface $serializer
      * @param NormalizerInterface $normalizer
      * @param EncoderInterface $encoder
-     * @param GroupLoaderInterface $loader
      * @param EventDispatcherInterface $eventDispatcher
+     * @param ResponseGroupResolverInterface $groupResolver
      */
     public function __construct(
         SerializerInterface $serializer,
         NormalizerInterface $normalizer,
         EncoderInterface $encoder,
-        GroupLoaderInterface $loader,
-        EventDispatcherInterface $eventDispatcher
+        EventDispatcherInterface $eventDispatcher,
+        ResponseGroupResolverInterface $groupResolver
     ) {
         $this->serializer = $serializer;
         $this->normalizer = $normalizer;
         $this->encoder = $encoder;
-        $this->loader = $loader;
         $this->eventDispatcher = $eventDispatcher;
+        $this->groupResolver = $groupResolver;
     }
 
     /**
@@ -103,13 +103,11 @@ public function onKernelView(GetResponseForControllerResultEvent $event) :? Resp
                 break;
         }
 
-        $groups = $this->loader->getResponseGroups($request);
-
         $serializeEvent = new SerializeEvent(
             $result,
             $request->getRequestFormat(),
             [
-                'groups' => $groups,
+                'groups' => $this->groupResolver->resolve($request, $result),
                 'enable_max_depth' => true,
             ],
             $request

diff --git a/src/GroupResolver/RequestGroupResolverInterface.php b/src/GroupResolver/RequestGroupResolverInterface.php
@@ -0,0 +1,31 @@
+<?php
+
+namespace GeoSocio\HttpSerializer\GroupResolver;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Verification Interface.
+ */
+interface RequestGroupResolverInterface
+{
+    /**
+     * Generate the groups from the object.
+     *
+     * @param Request $request
+     * @param string $type
+     *
+     * @return array An array of groups.
+     */
+    public function resolve(Request $request, string $type) : array;
+
+    /**
+     * Deteremine if resolver supports the currect subject.
+     *
+     * @param Request $request
+     * @param string $type
+     *
+     * @return bool
+     */
+    public function supports(Request $request, string $type) : bool;
+}
diff --git a/src/GroupResolver/RequestGroupResolverManager.php b/src/GroupResolver/RequestGroupResolverManager.php
@@ -0,0 +1,56 @@
+<?php
+
+namespace GeoSocio\HttpSerializer\GroupResolver;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Group Resolver Manager.
+ */
+class RequestGroupResolverManager implements RequestGroupResolverManagerInterface
+{
+    /**
+     * @var RequestGroupResolverInterface[]
+     */
+    protected $resolvers = [];
+
+    /**
+     * {@inheritdoc}
+     */
+    public function resolve(Request $request, string $type) : array
+    {
+        $resolved = array_map(function ($resolver) use ($request, $type) {
+            if ($resolver->supports($request, $type)) {
+                return $resolver->resolve($request, $type);
+            }
+
+            return [];
+        }, $this->resolvers);
+
+        return array_merge(...$resolved);
+    }
+
+     /**
+      * {@inheritdoc}
+      */
+    public function supports(Request $request, string $type) : bool
+    {
+        foreach ($this->resolvers as $resolver) {
+            if ($resolver->supports($request, $type)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function addResolver(RequestGroupResolverInterface $resolver)
+    {
+        $this->resolvers[] = $resolver;
+
+        return $this;
+    }
+}
diff --git a/src/GroupResolver/RequestGroupResolverManagerInterface.php b/src/GroupResolver/RequestGroupResolverManagerInterface.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace GeoSocio\HttpSerializer\GroupResolver;
+
+/**
+ * Group Resolver Manager Interface.
+ */
+interface RequestGroupResolverManagerInterface extends RequestGroupResolverInterface
+{
+    /**
+     * Adds a group resolver to the manager.
+     *
+     * @param RequestGroupResolverInterface $resolver
+     *
+     * @return self
+     */
+    public function addResolver(RequestGroupResolverInterface $resolver);
+}
diff --git a/src/GroupResolver/ResponseGroupResolverInterface.php b/src/GroupResolver/ResponseGroupResolverInterface.php
@@ -0,0 +1,30 @@
+<?php
+
+namespace GeoSocio\HttpSerializer\GroupResolver;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Verification Interface.
+ */
+interface ResponseGroupResolverInterface
+{
+    /**
+     * Generate the groups from the object.
+     *
+     * @param Request $request
+     * @param object $object
+     *
+     * @return array An array of groups.
+     */
+    public function resolve(Request $request, $object) : array;
+
+    /**
+     * Deteremine if resolver supports the currect subject.
+     *
+     * @param object $object
+     *
+     * @return bool
+     */
+    public function supports(Request $request, $object) : bool;
+}
diff --git a/src/GroupResolver/ResponseGroupResolverManager.php b/src/GroupResolver/ResponseGroupResolverManager.php
@@ -0,0 +1,56 @@
+<?php
+
+namespace GeoSocio\HttpSerializer\GroupResolver;
+
+use Symfony\Component\HttpFoundation\Request;
+
+/**
+ * Group Resolver Manager.
+ */
+class ResponseGroupResolverManager implements ResponseGroupResolverInterface
+{
+    /**
+     * @var ResponseGroupResolverInterface[]
+     */
+    protected $resolvers = [];
+
+    /**
+     * {@inheritdoc}
+     */
+    public function resolve(Request $request, $object) : array
+    {
+        $resolved = array_map(function ($resolver) use ($request, $object) {
+            if ($resolver->supports($request, $object)) {
+                return $resolver->resolve($request, $object);
+            }
+
+            return [];
+        }, $this->resolvers);
+
+        return array_merge(...$resolved);
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function supports(Request $request, $object) : bool
+    {
+        foreach ($this->resolvers as $resolver) {
+            if ($resolver->supports($request, $object)) {
+                return true;
+            }
+        }
+
+        return false;
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function addResolver(ResponseGroupResolverInterface $resolver)
+    {
+        $this->resolvers[] = $resolver;
+
+        return $this;
+    }
+}
diff --git a/src/GroupResolver/ResponseGroupResolverManagerInterface.php b/src/GroupResolver/ResponseGroupResolverManagerInterface.php
@@ -0,0 +1,18 @@
+<?php
+
+namespace GeoSocio\HttpSerializer\GroupResolver;
+
+/**
+ * Group Resolver Manager Interface.
+ */
+interface ResponseGroupResolverManagerInterface extends ResponseGroupResolverInterface
+{
+    /**
+     * Adds a group resolver to the manager.
+     *
+     * @param ResponseGroupResolverInterface $resolver
+     *
+     * @return self
+     */
+    public function addResolver(ResponseGroupResolverInterface $resolver);
+}