From 2f5119d0b3298ef2a1bb14fce99320512929a218 Mon Sep 17 00:00:00 2001
From: Alejandro Celaya <alejandro@alejandrocelaya.com>
Date: Sat, 30 Jul 2016 10:08:21 +0200
Subject: [PATCH] Split ContentBasedErrorHandler responsibilities into two
 separated classes

---
 config/autoload/services.global.php           | 10 ++++--
 .../Expressive/ContentBasedErrorHandler.php   | 34 ++++++++++---------
 .../src/Expressive/ErrorHandlerManager.php    | 21 ++++++++++++
 ...ory.php => ErrorHandlerManagerFactory.php} |  4 +--
 .../ErrorHandlerManagerInterface.php          |  9 +++++
 5 files changed, 57 insertions(+), 21 deletions(-)
 create mode 100644 module/Common/src/Expressive/ErrorHandlerManager.php
 rename module/Common/src/Expressive/{ContentBasedErrorHandlerFactory.php => ErrorHandlerManagerFactory.php} (88%)
 create mode 100644 module/Common/src/Expressive/ErrorHandlerManagerInterface.php

diff --git a/config/autoload/services.global.php b/config/autoload/services.global.php
index d7f56ed6..841a389a 100644
--- a/config/autoload/services.global.php
+++ b/config/autoload/services.global.php
@@ -1,6 +1,8 @@
 <?php
-use Shlinkio\Shlink\Common\Expressive\ContentBasedErrorHandlerFactory;
-use Shlinkio\Shlink\Rest\Expressive\JsonErrorHandler;
+use Acelaya\ZsmAnnotatedServices\Factory\V3\AnnotatedFactory;
+use Shlinkio\Shlink\Common\Expressive\ContentBasedErrorHandler;
+use Shlinkio\Shlink\Common\Expressive\ErrorHandlerManager;
+use Shlinkio\Shlink\Common\Expressive\ErrorHandlerManagerFactory;
 use Zend\Expressive;
 use Zend\Expressive\Container;
 use Zend\Expressive\Helper;
@@ -23,11 +25,13 @@ return [
             Router\FastRouteRouter::class => InvokableFactory::class,
 
             // View
-            'Zend\Expressive\FinalHandler' => ContentBasedErrorHandlerFactory::class,
+            ContentBasedErrorHandler::class => AnnotatedFactory::class,
+            ErrorHandlerManager::class => ErrorHandlerManagerFactory::class,
             Template\TemplateRendererInterface::class => Twig\TwigRendererFactory::class,
         ],
         'aliases' => [
             Router\RouterInterface::class => Router\FastRouteRouter::class,
+            'Zend\Expressive\FinalHandler' => ContentBasedErrorHandler::class,
         ],
     ],
 
diff --git a/module/Common/src/Expressive/ContentBasedErrorHandler.php b/module/Common/src/Expressive/ContentBasedErrorHandler.php
index 60e1dfdb..df6cde91 100644
--- a/module/Common/src/Expressive/ContentBasedErrorHandler.php
+++ b/module/Common/src/Expressive/ContentBasedErrorHandler.php
@@ -1,27 +1,29 @@
 <?php
 namespace Shlinkio\Shlink\Common\Expressive;
 
-use Psr\Http\Message\ServerRequestInterface as Request;
+use Acelaya\ZsmAnnotatedServices\Annotation\Inject;
 use Psr\Http\Message\ResponseInterface as Response;
+use Psr\Http\Message\ServerRequestInterface as Request;
 use Shlinkio\Shlink\Common\Exception\InvalidArgumentException;
-use Zend\ServiceManager\AbstractPluginManager;
-use Zend\ServiceManager\Exception\InvalidServiceException;
 
-class ContentBasedErrorHandler extends AbstractPluginManager implements ErrorHandlerInterface
+class ContentBasedErrorHandler implements ErrorHandlerInterface
 {
     const DEFAULT_CONTENT = 'text/html';
 
-    public function validate($instance)
-    {
-        if (is_callable($instance)) {
-            return;
-        }
+    /**
+     * @var ErrorHandlerManagerInterface
+     */
+    private $errorHandlerManager;
 
-        throw new InvalidServiceException(sprintf(
-            'Only callables are valid plugins for "%s". "%s" provided',
-            __CLASS__,
-            is_object($instance) ? get_class($instance) : gettype($instance)
-        ));
+    /**
+     * ContentBasedErrorHandler constructor.
+     * @param ErrorHandlerManagerInterface|ErrorHandlerManager $errorHandlerManager
+     *
+     * @Inject({ErrorHandlerManager::class})
+     */
+    public function __construct(ErrorHandlerManagerInterface $errorHandlerManager)
+    {
+        $this->errorHandlerManager = $errorHandlerManager;
     }
 
     /**
@@ -50,11 +52,11 @@ class ContentBasedErrorHandler extends AbstractPluginManager implements ErrorHan
         $accepts = $request->hasHeader('Accept') ? $request->getHeaderLine('Accept') : self::DEFAULT_CONTENT;
         $accepts = explode(',', $accepts);
         foreach ($accepts as $accept) {
-            if (! $this->has($accept)) {
+            if (! $this->errorHandlerManager->has($accept)) {
                 continue;
             }
 
-            return $this->get($accept);
+            return $this->errorHandlerManager->get($accept);
         }
 
         throw new InvalidArgumentException(sprintf(
diff --git a/module/Common/src/Expressive/ErrorHandlerManager.php b/module/Common/src/Expressive/ErrorHandlerManager.php
new file mode 100644
index 00000000..5cce0095
--- /dev/null
+++ b/module/Common/src/Expressive/ErrorHandlerManager.php
@@ -0,0 +1,21 @@
+<?php
+namespace Shlinkio\Shlink\Common\Expressive;
+
+use Zend\ServiceManager\AbstractPluginManager;
+use Zend\ServiceManager\Exception\InvalidServiceException;
+
+class ErrorHandlerManager extends AbstractPluginManager implements ErrorHandlerManagerInterface
+{
+    public function validate($instance)
+    {
+        if (is_callable($instance)) {
+            return;
+        }
+
+        throw new InvalidServiceException(sprintf(
+            'Only callables are valid plugins for "%s". "%s" provided',
+            __CLASS__,
+            is_object($instance) ? get_class($instance) : gettype($instance)
+        ));
+    }
+}
diff --git a/module/Common/src/Expressive/ContentBasedErrorHandlerFactory.php b/module/Common/src/Expressive/ErrorHandlerManagerFactory.php
similarity index 88%
rename from module/Common/src/Expressive/ContentBasedErrorHandlerFactory.php
rename to module/Common/src/Expressive/ErrorHandlerManagerFactory.php
index f262d320..e96e1ca3 100644
--- a/module/Common/src/Expressive/ContentBasedErrorHandlerFactory.php
+++ b/module/Common/src/Expressive/ErrorHandlerManagerFactory.php
@@ -7,7 +7,7 @@ use Zend\ServiceManager\Exception\ServiceNotCreatedException;
 use Zend\ServiceManager\Exception\ServiceNotFoundException;
 use Zend\ServiceManager\Factory\FactoryInterface;
 
-class ContentBasedErrorHandlerFactory implements FactoryInterface
+class ErrorHandlerManagerFactory implements FactoryInterface
 {
     /**
      * Create an object
@@ -25,6 +25,6 @@ class ContentBasedErrorHandlerFactory implements FactoryInterface
     {
         $config = $container->get('config')['error_handler'];
         $plugins = isset($config['plugins']) ? $config['plugins'] : [];
-        return new ContentBasedErrorHandler($container, $plugins);
+        return new ErrorHandlerManager($container, $plugins);
     }
 }
diff --git a/module/Common/src/Expressive/ErrorHandlerManagerInterface.php b/module/Common/src/Expressive/ErrorHandlerManagerInterface.php
new file mode 100644
index 00000000..371cbbf4
--- /dev/null
+++ b/module/Common/src/Expressive/ErrorHandlerManagerInterface.php
@@ -0,0 +1,9 @@
+<?php
+namespace Shlinkio\Shlink\Common\Expressive;
+
+use Interop\Container\ContainerInterface;
+
+interface ErrorHandlerManagerInterface extends ContainerInterface
+{
+
+}