Add responses

Author: coisa

src/HtmlResponse.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of php-fast-forward/http-message.
+ *
+ * This source file is subject to the license bundled
+ * with this source code in the file LICENSE.
+ *
+ * @link      https://github.com/php-fast-forward/http-message
+ * @copyright Copyright (c) 2025 Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
+ * @license   https://opensource.org/licenses/MIT MIT License
+ */
+
+namespace FastForward\Http\Message;
+
+use Nyholm\Psr7\Response;
+use Nyholm\Psr7\Stream;
+
+/**
+ * Class HtmlResponse.
+ *
+ * Represents an HTTP response containing HTML content.
+ *
+ * This class MUST be used to generate HTTP responses with a `text/html` content type.
+ * It automatically sets the 'Content-Type' header, encodes the body using the specified charset,
+ * and applies the HTTP 200 (OK) status code by default.
+ *
+ * @package FastForward\Http\Message
+ */
+final class HtmlResponse extends Response
+{
+    /**
+     * Constructs a new HtmlResponse instance.
+     *
+     * This constructor SHALL set the 'Content-Type' header to `text/html` with the specified charset
+     * and initialize the response body with the provided HTML content. The response status code
+     * will be set to 200 (OK) by default, with the corresponding reason phrase.
+     *
+     * @param string                         $html    the HTML content to send in the response body
+     * @param string                         $charset The character encoding to declare in the 'Content-Type' header. Defaults to 'utf-8'.
+     * @param array<string, string|string[]> $headers optional additional headers to include in the response
+     */
+    public function __construct(string $html, string $charset = 'utf-8', array $headers = [])
+    {
+        $headers['Content-Type'] = 'text/html; charset=' . $charset;
+
+        parent::__construct(
+            status: StatusCode::Ok->value,
+            headers: $headers,
+            body: Stream::create($html),
+            reason: StatusCode::Ok->getReasonPhrase(),
+        );
+    }
+}

src/TextResponse.php

@@ -0,0 +1,56 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of php-fast-forward/http-message.
+ *
+ * This source file is subject to the license bundled
+ * with this source code in the file LICENSE.
+ *
+ * @link      https://github.com/php-fast-forward/http-message
+ * @copyright Copyright (c) 2025 Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
+ * @license   https://opensource.org/licenses/MIT MIT License
+ */
+
+namespace FastForward\Http\Message;
+
+use Nyholm\Psr7\Response;
+use Nyholm\Psr7\Stream;
+
+/**
+ * Class TextResponse.
+ *
+ * Represents an HTTP response containing plain text content.
+ *
+ * This class MUST be used to generate HTTP responses with a `text/plain` content type.
+ * It automatically sets the 'Content-Type' header, encodes the body using the specified charset,
+ * and applies the HTTP 200 (OK) status code by default.
+ *
+ * @package FastForward\Http\Message
+ */
+final class TextResponse extends Response
+{
+    /**
+     * Constructs a new TextResponse instance.
+     *
+     * This constructor SHALL set the 'Content-Type' header to `text/plain` with the specified charset
+     * and initialize the response body with the provided plain text content. The response status code
+     * will be set to 200 (OK) by default, with the corresponding reason phrase.
+     *
+     * @param string                         $text    the plain text content to send in the response body
+     * @param string                         $charset The character encoding to declare in the 'Content-Type' header. Defaults to 'utf-8'.
+     * @param array<string, string|string[]> $headers optional additional headers to include in the response
+     */
+    public function __construct(string $text, string $charset = 'utf-8', array $headers = [])
+    {
+        $headers['Content-Type'] = 'text/plain; charset=' . $charset;
+
+        parent::__construct(
+            status: StatusCode::Ok->value,
+            headers: $headers,
+            body: Stream::create($text),
+            reason: StatusCode::Ok->getReasonPhrase(),
+        );
+    }
+}

tests/HtmlResponseTest.php

@@ -0,0 +1,68 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of php-fast-forward/http-message.
+ *
+ * This source file is subject to the license bundled
+ * with this source code in the file LICENSE.
+ *
+ * @link      https://github.com/php-fast-forward/http-message
+ * @copyright Copyright (c) 2025 Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
+ * @license   https://opensource.org/licenses/MIT MIT License
+ */
+
+namespace FastForward\Http\Message\Tests;
+
+use FastForward\Http\Message\HtmlResponse;
+use FastForward\Http\Message\StatusCode;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ */
+#[CoversClass(HtmlResponse::class)]
+#[UsesClass(StatusCode::class)]
+final class HtmlResponseTest extends TestCase
+{
+    public function testConstructorWillSetHtmlBodyAndContentType(): void
+    {
+        $html = '<h1>Hello World</h1>';
+
+        $response = new HtmlResponse($html);
+
+        self::assertSame(StatusCode::Ok->value, $response->getStatusCode());
+        self::assertSame(StatusCode::Ok->getReasonPhrase(), $response->getReasonPhrase());
+        self::assertSame('text/html; charset=utf-8', $response->getHeaderLine('Content-Type'));
+        self::assertSame($html, (string) $response->getBody());
+    }
+
+    public function testConstructorWillRespectCustomCharset(): void
+    {
+        $html = '<p>Charset Test</p>';
+
+        $response = new HtmlResponse($html, charset: 'iso-8859-1');
+
+        self::assertSame('text/html; charset=iso-8859-1', $response->getHeaderLine('Content-Type'));
+        self::assertSame($html, (string) $response->getBody());
+    }
+
+    public function testConstructorWillPreserveAdditionalHeaders(): void
+    {
+        $html    = '<div>Content</div>';
+        $headers = [
+            'X-Test'  => 'test-value',
+            'X-Array' => ['one', 'two'],
+        ];
+
+        $response = new HtmlResponse($html, headers: $headers);
+
+        self::assertSame('text/html; charset=utf-8', $response->getHeaderLine('Content-Type'));
+        self::assertSame('test-value', $response->getHeaderLine('X-Test'));
+        self::assertSame('one, two', $response->getHeaderLine('X-Array'));
+        self::assertSame($html, (string) $response->getBody());
+    }
+}

tests/TextResponseTest.php

@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * This file is part of php-fast-forward/http-message.
+ *
+ * This source file is subject to the license bundled
+ * with this source code in the file LICENSE.
+ *
+ * @link      https://github.com/php-fast-forward/http-message
+ * @copyright Copyright (c) 2025 Felipe Sayão Lobato Abreu <github@mentordosnerds.com>
+ * @license   https://opensource.org/licenses/MIT MIT License
+ */
+
+namespace FastForward\Http\Message\Tests;
+
+use FastForward\Http\Message\StatusCode;
+use FastForward\Http\Message\TextResponse;
+use PHPUnit\Framework\Attributes\CoversClass;
+use PHPUnit\Framework\Attributes\UsesClass;
+use PHPUnit\Framework\TestCase;
+
+/**
+ * @internal
+ */
+#[CoversClass(TextResponse::class)]
+#[UsesClass(StatusCode::class)]
+final class TextResponseTest extends TestCase
+{
+    public function testConstructorWillSetTextBodyAndContentType(): void
+    {
+        $text = 'Plain text response';
+
+        $response = new TextResponse($text);
+
+        self::assertSame(StatusCode::Ok->value, $response->getStatusCode());
+        self::assertSame(StatusCode::Ok->getReasonPhrase(), $response->getReasonPhrase());
+        self::assertSame('text/plain; charset=utf-8', $response->getHeaderLine('Content-Type'));
+        self::assertSame($text, (string) $response->getBody());
+    }
+
+    public function testConstructorWillRespectCustomCharset(): void
+    {
+        $text    = 'Texto com charset';
+        $charset = 'iso-8859-1';
+
+        $response = new TextResponse($text, $charset);
+
+        self::assertSame('text/plain; charset=iso-8859-1', $response->getHeaderLine('Content-Type'));
+        self::assertSame($text, (string) $response->getBody());
+    }
+
+    public function testConstructorWillPreserveAdditionalHeaders(): void
+    {
+        $text    = 'Texto com cabeçalhos';
+        $headers = [
+            'X-Test'     => 'test-value',
+            'X-Multiple' => ['um', 'dois'],
+        ];
+
+        $response = new TextResponse($text, headers: $headers);
+
+        self::assertSame('text/plain; charset=utf-8', $response->getHeaderLine('Content-Type'));
+        self::assertSame('test-value', $response->getHeaderLine('X-Test'));
+        self::assertSame('um, dois', $response->getHeaderLine('X-Multiple'));
+        self::assertSame($text, (string) $response->getBody());
+    }
+}