Refactoring

Author: coisa

composer.json

@@ -0,0 +1,58 @@
+{
+    "name": "fast-forward/http-message",
+    "description": "Fast Forward PSR-7 HTTP Message utility classes",
+    "license": "MIT",
+    "type": "library",
+    "authors": [
+        {
+            "name": "Felipe Sayão Lobato Abreu",
+            "email": "github@mentordosnerds.com"
+        }
+    ],
+    "homepage": "https://github.com/php-fast-forward",
+    "support": {
+        "issues": "https://github.com/php-fast-forward/http-message/issues",
+        "source": "https://github.com/php-fast-forward/http-message"
+    },
+    "require": {
+        "php": "^8.2",
+        "nyholm/psr7": "^1.8",
+        "psr/http-message": "^2.0"
+    },
+    "require-dev": {
+        "coisa/php-cs-fixer": "^2.1",
+        "phpspec/prophecy-phpunit": "^2.3",
+        "phpunit/phpunit": "^9.6 || ^10.5 || ^11.5"
+    },
+    "minimum-stability": "stable",
+    "autoload": {
+        "psr-4": {
+            "FastForward\\Http\\Message\\": "src/"
+        }
+    },
+    "autoload-dev": {
+        "psr-4": {
+            "FastForward\\Http\\Message\\Tests\\": "tests/"
+        }
+    },
+    "config": {
+        "sort-packages": true
+    },
+    "extra": {
+        "branch-alias": {
+            "dev-main": "1.x-dev"
+        }
+    },
+    "scripts": {
+        "cs-check": "php-cs-fixer fix --dry-run --diff",
+        "cs-fix": "php-cs-fixer fix",
+        "mutation-testing": "infection --threads=4",
+        "pre-commit": [
+            "@cs-check",
+            "@static-analysis",
+            "@tests"
+        ],
+        "static-analysis": "phpstan analyse --level 5 src",
+        "tests": "phpunit --testdox"
+    }
+}

src/JsonResponse.php

@@ -11,28 +11,21 @@ final class JsonResponse extends Response implements JsonResponseInterface
 {
     public function __construct(
         mixed $payload = [],
-        StatusCode $status = StatusCode::OK,
+        string $charset = 'utf-8'
     ) {
         parent::__construct(
-            status: $status->value,
-            headers: ['Content-Type' => 'application/json; charset=utf-8'],
-            body: $this->createBody($payload),
-            reason: $status->reasonPhrase(),
+            headers: ['Content-Type' => 'application/json; charset=' . $charset],
+            body: new JsonStream($payload),
         );
     }
 
-    private function createBody(mixed $payload): JsonStreamInterface
-    {
-        return new JsonStream($payload);
-    }
-
     public function getPayload(): mixed
     {
         return $this->getBody()->getPayload();
     }
 
     public function withPayload(mixed $payload): self
     {
-        return $this->withBody($this->createBody($payload));
+        return $this->withBody($this->getBody()->withPayload($payload));
     }
 }

src/RequestMethod.php

@@ -16,33 +16,63 @@
  */
 enum RequestMethod: string
 {
-    /** @var string The HEAD method requests the headers for a given resource without the response body. */
-    case HEAD = 'HEAD';
+    /** The HEAD method requests the headers for a given resource without the response body. */
+    case Head = 'HEAD';
 
-    /** @var string The GET method requests a representation of the specified resource. It MUST NOT have side-effects. */
-    case GET = 'GET';
+    /** The GET method requests a representation of the specified resource. It MUST NOT have side-effects. */
+    case Get = 'GET';
 
-    /** @var string The POST method submits data to be processed, often causing a change in state or side-effects. */
-    case POST = 'POST';
+    /** The POST method submits data to be processed, often causing a change in state or side-effects. */
+    case Post = 'POST';
 
-    /** @var string The PUT method replaces the target resource with the request payload. */
-    case PUT = 'PUT';
+    /** The PUT method replaces the target resource with the request payload. */
+    case Put = 'PUT';
 
-    /** @var string The PATCH method applies partial modifications to the target resource. */
-    case PATCH = 'PATCH';
+    /** The PATCH method applies partial modifications to the target resource. */
+    case Patch = 'PATCH';
 
-    /** @var string The DELETE method removes the specified resource. */
-    case DELETE = 'DELETE';
+    /** The DELETE method removes the specified resource. */
+    case Delete = 'DELETE';
 
-    /** @var string The PURGE method requests that a cached resource be removed, often used with proxy servers. */
-    case PURGE = 'PURGE';
+    /** The PURGE method requests that a cached resource be removed, often used with proxy servers. */
+    case Purge = 'PURGE';
 
-    /** @var string The OPTIONS method describes the communication options for the target resource. */
-    case OPTIONS = 'OPTIONS';
+    /** The OPTIONS method describes the communication options for the target resource. */
+    case Options = 'OPTIONS';
 
-    /** @var string The TRACE method performs a message loop-back test along the path to the target resource. */
-    case TRACE = 'TRACE';
+    /** The TRACE method performs a message loop-back test along the path to the target resource. */
+    case Trace = 'TRACE';
 
-    /** @var string The CONNECT method establishes a tunnel to the target resource, often used with HTTPS proxies. */
-    case CONNECT = 'CONNECT';
+    /** The CONNECT method establishes a tunnel to the target resource, often used with HTTPS proxies. */
+    case Connect = 'CONNECT';
+
+    /**
+     * Returns true if the method is considered safe (does not modify server state).
+     *
+     * @return bool
+     */
+    public function isSafe(): bool
+    {
+        return in_array($this, [self::Get, self::Head, self::Options, self::Trace], true);
+    }
+
+    /**
+     * Returns true if the method is idempotent (multiple identical requests have the same effect as a single one).
+     *
+     * @return bool
+     */
+    public function isIdempotent(): bool
+    {
+        return in_array($this, [self::Get, self::Head, self::Put, self::Delete, self::Options, self::Trace], true);
+    }
+
+    /**
+     * Returns true if the method is considered cacheable by default.
+     *
+     * @return bool
+     */
+    public function isCacheable(): bool
+    {
+        return in_array($this, [self::Get, self::Head], true);
+    }
 }