Merge pull request #146 from ro0NL/req-resp

Add Formatter::formatResponseForRequest()

Author: dbu

CHANGELOG.md

@@ -6,6 +6,11 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/)
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## [1.13.0] - tomorrow
+
+- Added `Formatter::formatResponseForRequest()`
+- Deprecated `Formatter::formatResponse()`
+
 ## [1.12.0] - 2021-08-29
 
 - Added support for adjusting binary detection regex in FullHttpMessageFormatter

spec/Formatter/CurlCommandFormatterSpec.php

@@ -54,9 +54,10 @@ function it_formats_post_request(RequestInterface $request, UriInterface $uri, S
         $this->formatRequest($request)->shouldReturn("curl 'http://foo.com/bar' --http2 --request POST --data 'body \" data test'\'' bar'");
     }
 
-    function it_does_nothing_for_response(ResponseInterface $response)
+    function it_does_nothing_for_response(ResponseInterface $response, RequestInterface $request)
     {
         $this->formatResponse($response)->shouldReturn('');
+        $this->formatResponseForRequest($response, $request)->shouldReturn('');
     }
 
     function it_formats_the_request_with_user_agent(RequestInterface $request, UriInterface $uri, StreamInterface $body)

spec/Formatter/FullHttpMessageFormatterSpec.php

@@ -126,7 +126,7 @@ function it_does_not_format_no_seekable_request(RequestInterface $request, Strea
         $this->formatRequest($request)->shouldReturn($expectedMessage);
     }
 
-    function it_formats_the_response_with_size_limit(ResponseInterface $response, StreamInterface $stream)
+    function it_formats_the_response_with_size_limit(ResponseInterface $response, StreamInterface $stream, RequestInterface $request)
     {
         $this->beConstructedWith(18);
 
@@ -150,6 +150,7 @@ function it_formats_the_response_with_size_limit(ResponseInterface $response, St
 This is an HTML st
 STR;
         $this->formatResponse($response)->shouldReturn($expectedMessage);
+        $this->formatResponseForRequest($response, $request)->shouldReturn($expectedMessage);
     }
 
     function it_formats_the_response_without_size_limit(ResponseInterface $response, StreamInterface $stream)

spec/Formatter/SimpleFormatterSpec.php

@@ -29,12 +29,13 @@ function it_formats_the_request(RequestInterface $request, UriInterface $uri)
         $this->formatRequest($request)->shouldReturn('GET http://foo.com/bar 1.1');
     }
 
-    function it_formats_the_response(ResponseInterface $response)
+    function it_formats_the_response(ResponseInterface $response, RequestInterface $request)
     {
         $response->getReasonPhrase()->willReturn('OK');
         $response->getProtocolVersion()->willReturn('1.1');
         $response->getStatusCode()->willReturn('200');
 
         $this->formatResponse($response)->shouldReturn('200 OK 1.1');
+        $this->formatResponseForRequest($response, $request)->shouldReturn('200 OK 1.1');
     }
 }

src/Formatter.php

@@ -9,6 +9,8 @@
  * Formats a request and/or a response as a string.
  *
  * @author Márk Sági-Kazár <mark.sagikazar@gmail.com>
+ *
+ * @method string formatResponseForRequest(ResponseInterface $response, RequestInterface $request) Formats a response in context of its request.
  */
 interface Formatter
 {
@@ -20,6 +22,8 @@ interface Formatter
     public function formatRequest(RequestInterface $request);
 
     /**
+     * @deprecated since 1.13, use formatResponseForRequest() instead
+     *
      * Formats a response.
      *
      * @return string

src/Formatter/CurlCommandFormatter.php

@@ -68,6 +68,14 @@ public function formatResponse(ResponseInterface $response)
         return '';
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
+    {
+        return $this->formatResponse($response);
+    }
+
     /**
      * @return string
      */

src/Formatter/FullHttpMessageFormatter.php

@@ -74,6 +74,14 @@ public function formatResponse(ResponseInterface $response)
         return $this->addBody($response, $message);
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
+    {
+        return $this->formatResponse($response);
+    }
+
     /**
      * Add the message body if the stream is seekable.
      *

src/Formatter/SimpleFormatter.php

@@ -39,4 +39,12 @@ public function formatResponse(ResponseInterface $response)
             $response->getProtocolVersion()
         );
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function formatResponseForRequest(ResponseInterface $response, RequestInterface $request)
+    {
+        return $this->formatResponse($response);
+    }
 }