Refactored formatting

Author: snapshotpl

src/Formatter/BothFormatter.php

@@ -0,0 +1,24 @@
+<?php
+
+declare (strict_types=1);
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+
+/**
+ * @codeCoverageIgnore
+ */
+final class EmptyMessageFormatter implements ServerRequestFormatter, ResponseFormatter
+{
+    public function formatServerRequest(ServerRequestInterface $request): FormattedMessage
+    {
+        return FormattedMessage::createEmpty();
+    }
+
+    public function formatResponse(ResponseInterface $response): FormattedMessage
+    {
+        return FormattedMessage::createEmpty();
+    }
+}

src/Formatter/EmptyMessageFormatter.php

@@ -0,0 +1,39 @@
+<?php
+
+declare (strict_types=1);
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+final class FormattedMessage
+{
+    private $value;
+
+    public static function fromString(string $value) : self
+    {
+        $instance = new self();
+        $instance->value = $value;
+
+        return $instance;
+    }
+
+    public static function fromArray(array $value) : self
+    {
+        $instance = new self();
+        $instance->value = $value;
+
+        return $instance;
+    }
+
+    public static function createEmpty() : self
+    {
+        return new self();
+    }
+
+    /**
+     * @return array|string|null
+     */
+    public function getValue()
+    {
+        return $this->value;
+    }
+}

src/Formatter/FormattedMessage.php

@@ -1,15 +1,12 @@
 <?php
 
+declare (strict_types=1);
+
 namespace PhpMiddleware\LogHttpMessages\Formatter;
 
 use Psr\Http\Message\ResponseInterface;
-use Psr\Http\Message\ServerRequestInterface;
-use Zend\Diactoros\Response\Serializer;
 
-final class ResponseFormatter implements HttpMessagesFormatter
+interface ResponseFormatter
 {
-    public function format(ServerRequestInterface $request, ResponseInterface $response)
-    {
-        return Serializer::toString($response);
-    }
+    public function formatResponse(ResponseInterface $response) : FormattedMessage;
 }

src/Formatter/HttpMessagesFormatter.php

@@ -0,0 +1,12 @@
+<?php
+
+declare (strict_types=1);
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+use Psr\Http\Message\ServerRequestInterface;
+
+interface ServerRequestFormatter
+{
+    public function formatServerRequest(ServerRequestInterface $request) : FormattedMessage;
+}

src/Formatter/RequestFormatter.php

@@ -0,0 +1,28 @@
+<?php
+
+declare (strict_types=1);
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Zend\Diactoros\Response\ArraySerializer as ResponseSerializer;
+use Zend\Diactoros\Request\ArraySerializer as RequestSerializer;
+
+final class ZendDiactorosToArrayMessageFormatter implements ServerRequestFormatter, ResponseFormatter
+{
+    public function formatResponse(ResponseInterface $response): FormattedMessage
+    {
+        $array = ResponseSerializer::toArray($response);
+
+        return FormattedMessage::fromArray($array);
+    }
+
+    public function formatServerRequest(ServerRequestInterface $request): FormattedMessage
+    {
+        $array = RequestSerializer::toArray($request);
+
+        return FormattedMessage::fromArray($array);
+    }
+
+}

src/Formatter/ResponseFormatter.php

@@ -0,0 +1,27 @@
+<?php
+
+declare (strict_types=1);
+
+namespace PhpMiddleware\LogHttpMessages\Formatter;
+
+use Psr\Http\Message\ResponseInterface;
+use Psr\Http\Message\ServerRequestInterface;
+use Zend\Diactoros\Response\Serializer as ResponseSerializer;
+use Zend\Diactoros\Request\Serializer as RequestSerializer;
+
+final class ZendDiactorosToStringMessageFormatter implements ServerRequestFormatter, ResponseFormatter
+{
+    public function formatResponse(ResponseInterface $response): FormattedMessage
+    {
+        $string = ResponseSerializer::toString($response);
+
+        return FormattedMessage::fromString($string);
+    }
+
+    public function formatServerRequest(ServerRequestInterface $request): FormattedMessage
+    {
+        $string = RequestSerializer::toString($request);
+
+        return FormattedMessage::fromString($string);
+    }
+}

src/Formatter/ServerRequestFormatter.php

@@ -6,36 +6,38 @@
 
 use Interop\Http\ServerMiddleware\DelegateInterface;
 use Interop\Http\ServerMiddleware\MiddlewareInterface;
-use PhpMiddleware\LogHttpMessages\Formatter\HttpMessagesFormatter;
+use PhpMiddleware\LogHttpMessages\Formatter\ResponseFormatter;
+use PhpMiddleware\LogHttpMessages\Formatter\ServerRequestFormatter;
 use Psr\Http\Message\ResponseInterface as Response;
 use Psr\Http\Message\ServerRequestInterface as ServerRequest;
 use Psr\Log\LoggerInterface as Logger;
 use Psr\Log\LogLevel;
-use UnexpectedValueException;
 
 final class LogMiddleware implements MiddlewareInterface
 {
-    protected $logger;
-
-    protected $level;
-
-    protected $formatter;
-
-    public function __construct(HttpMessagesFormatter $formatter, Logger $logger, $level = LogLevel::INFO)
-    {
-        $this->formatter = $formatter;
+    const LOG_MESSAGE = 'Request/Response';
+
+    private $logger;
+    private $level;
+    private $requestFormatter;
+    private $responseFormatter;
+    private $logMessage;
+
+    public function __construct(
+        ServerRequestFormatter $requestFormatter,
+        ResponseFormatter $responseFormatter,
+        Logger $logger,
+        string $level = LogLevel::INFO,
+        string $logMessage = self::LOG_MESSAGE
+    ) {
+        $this->requestFormatter = $requestFormatter;
+        $this->responseFormatter = $responseFormatter;
         $this->logger = $logger;
         $this->level = $level;
+        $this->logMessage = $logMessage;
     }
 
-    /**
-     * @param ServerRequest $request
-     * @param Response $response
-     * @param callable $next
-     *
-     * @return Response
-     */
-    public function __invoke(ServerRequest $request, Response $response, callable $next)
+    public function __invoke(ServerRequest $request, Response $response, callable $next) : Response
     {
         $outResponse = $next($request, $response);
 
@@ -44,13 +46,7 @@ public function __invoke(ServerRequest $request, Response $response, callable $n
         return $outResponse;
     }
 
-    /**
-     * @param ServerRequest $request
-     * @param DelegateInterface $delegate
-     *
-     * @return Response
-     */
-    public function process(ServerRequest $request, DelegateInterface $delegate)
+    public function process(ServerRequest $request, DelegateInterface $delegate) : Response
     {
         $response = $delegate->process($request);
 
@@ -59,21 +55,14 @@ public function process(ServerRequest $request, DelegateInterface $delegate)
         return $response;
     }
 
-    /**
-     * @param ServerRequest $request
-     * @param Response $response
-     *
-     * @throws UnexpectedValueException
-     */
     private function logMessages(ServerRequest $request, Response $response)
     {
-        $messages = $this->formatter->format($request, $response);
-
-        if (!is_string($messages)) {
-            throw new UnexpectedValueException(sprintf('%s must return string', HttpMessagesFormatter::class));
-        }
+        $formattedRequest = $this->requestFormatter->formatServerRequest($request);
+        $formattedResponse = $this->responseFormatter->formatResponse($response);
 
-        $this->logger->log($this->level, $messages);
+        $this->logger->log($this->level, $this->logMessage, [
+            'request' => $formattedRequest->getValue(),
+            'response' => $formattedResponse->getValue(),
+        ]);
     }
-
 }