Create a CSV Response class

This class is almost identical to TextResponse, except that it sets the
Content-Type header to text/csv.

Author: settermjd

src/Response/CsvResponse.php

@@ -0,0 +1,79 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-diactoros for the canonical source repository
+ * @copyright Copyright (c) 2015-2018 Zend Technologies USA Inc. (https://www.zend.com)
+ * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace Zend\Diactoros\Response;
+
+use Psr\Http\Message\StreamInterface;
+use Zend\Diactoros\Exception;
+use Zend\Diactoros\Response;
+use Zend\Diactoros\Stream;
+
+use function get_class;
+use function gettype;
+use function is_object;
+use function is_string;
+use function sprintf;
+
+/**
+ * CSV response.
+ *
+ * Allows creating a CSV response by passing a string to the constructor;
+ * by default, sets a status code of 200 and sets the Content-Type header to
+ * text/csv.
+ */
+class CsvResponse extends Response
+{
+    use InjectContentTypeTrait;
+
+    /**
+     * Create a CSV response.
+     *
+     * Produces a CSV response with a Content-Type of text/csv and a default
+     * status of 200.
+     *
+     * @param string|StreamInterface $text String or stream for the message body.
+     * @param int $status Integer status code for the response; 200 by default.
+     * @param array $headers Array of headers to use at initialization.
+     * @throws Exception\InvalidArgumentException if $text is neither a string or stream.
+     */
+    public function __construct($text, int $status = 200, array $headers = [])
+    {
+        parent::__construct(
+            $this->createBody($text),
+            $status,
+            $this->injectContentType('text/csv; charset=utf-8', $headers)
+        );
+    }
+
+    /**
+     * Create the CSV message body.
+     *
+     * @param string|StreamInterface $text
+     * @throws Exception\InvalidArgumentException if $text is neither a string or stream.
+     */
+    private function createBody($text) : StreamInterface
+    {
+        if ($text instanceof StreamInterface) {
+            return $text;
+        }
+
+        if (! is_string($text)) {
+            throw new Exception\InvalidArgumentException(sprintf(
+                'Invalid CSV content (%s) provided to %s',
+                (is_object($text) ? get_class($text) : gettype($text)),
+                __CLASS__
+            ));
+        }
+
+        $body = new Stream('php://temp', 'wb+');
+        $body->write($text);
+        $body->rewind();
+        return $body;
+    }
+}

test/Response/CsvResponseTest.php

@@ -0,0 +1,97 @@
+<?php
+/**
+ * @see       https://github.com/zendframework/zend-diactoros for the canonical source repository
+ * @copyright Copyright (c) 2015-2018 Zend Technologies USA Inc. (http://www.zend.com)
+ * @license   https://github.com/zendframework/zend-diactoros/blob/master/LICENSE.md New BSD License
+ */
+
+declare(strict_types=1);
+
+namespace ZendTest\Diactoros\Response;
+
+use InvalidArgumentException;
+use PHPUnit\Framework\TestCase;
+use Psr\Http\Message\StreamInterface;
+use Zend\Diactoros\Response\CsvResponse;
+
+class CsvResponseTest extends TestCase
+{
+    const VALID_CSV_BODY = <<<EOF
+"first","last","email","dob",
+"john","citizen","[email protected]","01/01/1970",
+EOF;
+
+    public function testConstructorAcceptsBodyAsString()
+    {
+        $response = new CsvResponse(self::VALID_CSV_BODY);
+        $this->assertSame(self::VALID_CSV_BODY, (string) $response->getBody());
+        $this->assertSame(200, $response->getStatusCode());
+    }
+
+    public function testConstructorAllowsPassingStatus()
+    {
+        $status = 404;
+
+        $response = new CsvResponse(self::VALID_CSV_BODY, $status);
+        $this->assertSame(404, $response->getStatusCode());
+        $this->assertSame(self::VALID_CSV_BODY, (string) $response->getBody());
+    }
+
+    public function testConstructorAllowsPassingHeaders()
+    {
+        $status = 404;
+        $headers = [
+            'x-custom' => [ 'foo-bar' ],
+        ];
+
+        $response = new CsvResponse(self::VALID_CSV_BODY, $status, $headers);
+        $this->assertSame(['foo-bar'], $response->getHeader('x-custom'));
+        $this->assertSame('text/csv; charset=utf-8', $response->getHeaderLine('content-type'));
+        $this->assertSame(404, $response->getStatusCode());
+        $this->assertSame(self::VALID_CSV_BODY, (string) $response->getBody());
+    }
+
+    public function testAllowsStreamsForResponseBody()
+    {
+        $stream = $this->prophesize(StreamInterface::class);
+        $body   = $stream->reveal();
+        $response = new CsvResponse($body);
+        $this->assertSame($body, $response->getBody());
+    }
+
+    public function invalidContent()
+    {
+        return [
+            'null'       => [null],
+            'true'       => [true],
+            'false'      => [false],
+            'zero'       => [0],
+            'int'        => [1],
+            'zero-float' => [0.0],
+            'float'      => [1.1],
+            'array'      => [['php://temp']],
+            'object'     => [(object) ['php://temp']],
+        ];
+    }
+
+    /**
+     * @dataProvider invalidContent
+     */
+    public function testRaisesExceptionforNonStringNonStreamBodyContent($body)
+    {
+        $this->expectException(InvalidArgumentException::class);
+
+        new CsvResponse($body);
+    }
+
+    /**
+     * @group 115
+     */
+    public function testConstructorRewindsBodyStream()
+    {
+        $response = new CsvResponse(self::VALID_CSV_BODY);
+
+        $actual = $response->getBody()->getContents();
+        $this->assertSame(self::VALID_CSV_BODY, $actual);
+    }
+}