Update Response class to build on top of abstract message class

Author: clue

src/Message/Response.php

@@ -3,11 +3,12 @@
 namespace React\Http\Message;
 
 use Fig\Http\Message\StatusCodeInterface;
+use Psr\Http\Message\ResponseInterface;
 use Psr\Http\Message\StreamInterface;
 use React\Http\Io\BufferedBody;
 use React\Http\Io\HttpBodyStream;
 use React\Stream\ReadableStreamInterface;
-use RingCentral\Psr7\Response as Psr7Response;
+use RingCentral\Psr7\MessageTrait;
 
 /**
  * Represents an outgoing server response message.
@@ -40,7 +41,7 @@
  *
  * @see \Psr\Http\Message\ResponseInterface
  */
-final class Response extends Psr7Response implements StatusCodeInterface
+final class Response extends MessageTrait implements ResponseInterface, StatusCodeInterface
 {
     /**
      * Create an HTML response
@@ -257,6 +258,41 @@ public static function xml($xml)
         return new self(self::STATUS_OK, array('Content-Type' => 'application/xml'), $xml);
     }
 
+    /**
+     * @var bool
+     * @see self::$phrasesMap
+     */
+    private static $phrasesInitialized = false;
+
+    /**
+     * Map of standard HTTP status codes to standard reason phrases.
+     *
+     * This map will be fully populated with all standard reason phrases on
+     * first access. By default, it only contains a subset of HTTP status codes
+     * that have a custom mapping to reason phrases (such as those with dashes
+     * and all caps words). See `self::STATUS_*` for all possible status code
+     * constants.
+     *
+     * @var array<int,string>
+     * @see self::STATUS_*
+     * @see self::getReasonPhraseForStatusCode()
+     */
+    private static $phrasesMap = array(
+        200 => 'OK',
+        203 => 'Non-Authoritative Information',
+        207 => 'Multi-Status',
+        226 => 'IM Used',
+        414 => 'URI Too Large',
+        418 => 'I\'m a teapot',
+        505 => 'HTTP Version Not Supported'
+    );
+
+    /** @var int */
+    private $statusCode;
+
+    /** @var string */
+    private $reasonPhrase;
+
     /**
      * @param int                                            $status  HTTP status code (e.g. 200/404), see `self::STATUS_*` constants
      * @param array<string,string|string[]>                  $headers additional response headers
@@ -280,12 +316,60 @@ public function __construct(
             throw new \InvalidArgumentException('Invalid response body given');
         }
 
-        parent::__construct(
-            $status,
-            $headers,
-            $body,
-            $version,
-            $reason
-        );
+        $this->protocol = (string) $version;
+        $this->setHeaders($headers);
+        $this->stream = $body;
+
+        $this->statusCode = (int) $status;
+        $this->reasonPhrase = ($reason !== '' && $reason !== null) ? (string) $reason : self::getReasonPhraseForStatusCode($status);
+    }
+
+    public function getStatusCode()
+    {
+        return $this->statusCode;
+    }
+
+    public function withStatus($code, $reasonPhrase = '')
+    {
+        if ((string) $reasonPhrase === '') {
+            $reasonPhrase = self::getReasonPhraseForStatusCode($code);
+        }
+
+        if ($this->statusCode === (int) $code && $this->reasonPhrase === (string) $reasonPhrase) {
+            return $this;
+        }
+
+        $response = clone $this;
+        $response->statusCode = (int) $code;
+        $response->reasonPhrase = (string) $reasonPhrase;
+
+        return $response;
+    }
+
+    public function getReasonPhrase()
+    {
+        return $this->reasonPhrase;
+    }
+
+    /**
+     * @param int $code
+     * @return string default reason phrase for given status code or empty string if unknown
+     */
+    private static function getReasonPhraseForStatusCode($code)
+    {
+        if (!self::$phrasesInitialized) {
+            self::$phrasesInitialized = true;
+
+            // map all `self::STATUS_` constants from status code to reason phrase
+            // e.g. `self::STATUS_NOT_FOUND = 404` will be mapped to `404 Not Found`
+            $ref = new \ReflectionClass(__CLASS__);
+            foreach ($ref->getConstants() as $name => $value) {
+                if (!isset(self::$phrasesMap[$value]) && \strpos($name, 'STATUS_') === 0) {
+                    self::$phrasesMap[$value] = \ucwords(\strtolower(\str_replace('_', ' ', \substr($name, 7))));
+                }
+            }
+        }
+
+        return isset(self::$phrasesMap[$code]) ? self::$phrasesMap[$code] : '';
     }
 }

tests/Io/StreamingServerTest.php

@@ -1567,9 +1567,9 @@ function ($data) use (&$buffer) {
 
         $this->assertInstanceOf('InvalidArgumentException', $error);
 
-        $this->assertContainsString("HTTP/1.1 505 HTTP Version not supported\r\n", $buffer);
+        $this->assertContainsString("HTTP/1.1 505 HTTP Version Not Supported\r\n", $buffer);
         $this->assertContainsString("\r\n\r\n", $buffer);
-        $this->assertContainsString("Error 505: HTTP Version not supported", $buffer);
+        $this->assertContainsString("Error 505: HTTP Version Not Supported", $buffer);
     }
 
     public function testRequestOverflowWillEmitErrorAndSendErrorResponse()

tests/Message/ResponseTest.php

@@ -54,6 +54,39 @@ public function testResourceBodyWillThrow()
         new Response(200, array(), tmpfile());
     }
 
+    public function testWithStatusReturnsNewInstanceWhenStatusIsChanged()
+    {
+        $response = new Response(200);
+
+        $new = $response->withStatus(404);
+        $this->assertNotSame($response, $new);
+        $this->assertEquals(404, $new->getStatusCode());
+        $this->assertEquals('Not Found', $new->getReasonPhrase());
+        $this->assertEquals(200, $response->getStatusCode());
+        $this->assertEquals('OK', $response->getReasonPhrase());
+    }
+
+    public function testWithStatusReturnsSameInstanceWhenStatusIsUnchanged()
+    {
+        $response = new Response(200);
+
+        $new = $response->withStatus(200);
+        $this->assertSame($response, $new);
+        $this->assertEquals(200, $response->getStatusCode());
+        $this->assertEquals('OK', $response->getReasonPhrase());
+    }
+
+    public function testWithStatusReturnsNewInstanceWhenStatusIsUnchangedButReasonIsChanged()
+    {
+        $response = new Response(200);
+
+        $new = $response->withStatus(200, 'Quite Ok');
+        $this->assertNotSame($response, $new);
+        $this->assertEquals(200, $new->getStatusCode());
+        $this->assertEquals('Quite Ok', $new->getReasonPhrase());
+        $this->assertEquals(200, $response->getStatusCode());
+        $this->assertEquals('OK', $response->getReasonPhrase());
+    }
 
     public function testHtmlMethodReturnsHtmlResponse()
     {