Adding optional request path the request data object

Author: JustSteveKing

src/DataObjects/Data.php

@@ -7,11 +7,11 @@
 final class Data
 {
     /**
-     * @param Server $server The Server Object.
-     * @param Language $language The Language Object.
-     * @param Request $request The Request Object.
-     * @param Response $response The Response Object.
-     * @param list<Error> $errors The list of Errors.
+     * @param  Server  $server The Server Object.
+     * @param  Language  $language The Language Object.
+     * @param  Request  $request The Request Object.
+     * @param  Response  $response The Response Object.
+     * @param  list<Error>  $errors The list of Errors.
      */
     public function __construct(
         public Server $server,

src/DataObjects/Request.php

@@ -9,19 +9,21 @@
 final class Request
 {
     /**
-     * @param string $timestamp The timestamp of the request in the format: YYYY-MM-DD hh:mm:ss.
-     * @param string $ip The real IP address of the request.
-     * @param string $url The full URL of the request including query data if any.
-     * @param string $user_agent The User Agent of the request.
-     * @param null|Method $method The HTTP method of the request, uppercase if possible.
-     * @param array<int|string,string> $headers The request headers for the request in key:value format.
-     * @param array<int|string,mixed> $body The complete request data sent with this request.
-     * @param array<int|string,mixed> $raw The raw body from the request.
+     * @param  string  $timestamp The timestamp of the request in the format: YYYY-MM-DD hh:mm:ss.
+     * @param  string  $ip The real IP address of the request.
+     * @param  string  $url The full URL of the request including query data if any.
+     * @param  null|string  $route_path The path of the route from the framework.
+     * @param  string  $user_agent The User Agent of the request.
+     * @param  null|Method  $method The HTTP method of the request, uppercase if possible.
+     * @param  array<int|string,string>  $headers The request headers for the request in key:value format.
+     * @param  array<int|string,mixed>  $body The complete request data sent with this request.
+     * @param  array<int|string,mixed>  $raw The raw body from the request.
      */
     public function __construct(
         public string $timestamp,
         public string $ip,
         public string $url,
+        public null|string $route_path,
         public string $user_agent,
         public null|Method $method,
         public array $headers,
@@ -35,6 +37,7 @@ public function __construct(
      *     timestamp: string,
      *     ip: string,
      *     url: string,
+     *     route_path: null|string,
      *     user_agent: string,
      *     method: string|null,
      *     headers: array,
@@ -48,6 +51,7 @@ public function __toArray(): array
             'timestamp' => $this->timestamp,
             'ip' => $this->ip,
             'url' => $this->url,
+            'route_path' => $this->route_path,
             'user_agent' => $this->user_agent,
             'method' => $this->method->value ?? null,
             'headers' => $this->headers,

tests/DataObjects/DataTest.php

@@ -2,7 +2,6 @@
 
 declare(strict_types=1);
 
-
 use Treblle\Utils\Http\Method;
 
 it('can cast an object to an array', function (string $string): void {
@@ -42,12 +41,13 @@
             'name' => $string,
             'version' => $string,
             'expose_php' => $string,
-            'display_errors' => $string
+            'display_errors' => $string,
         ],
         'request' => [
             'timestamp' => $string,
             'ip' => $string,
             'url' => $string,
+            'route_path' => $string,
             'user_agent' => $string,
             'method' => Method::GET->value,
             'headers' => [
@@ -69,7 +69,7 @@
             'load_time' => 12.3,
             'body' => [
                 $string => $string,
-            ]
+            ],
         ],
         'errors' => [
             [
@@ -78,7 +78,7 @@
                 'message' => $string,
                 'file' => $string,
                 'line' => 123,
-            ]
-        ]
+            ],
+        ],
     ]);
 })->with('strings');

tests/DataObjects/RequestTest.php

@@ -10,6 +10,7 @@
         timestamp: $string,
         ip: $string,
         url: $string,
+        route_path: $string,
         user_agent: $string,
         method: Method::DELETE,
         headers: [
@@ -35,6 +36,7 @@
         timestamp: $string,
         ip: $string,
         url: $string,
+        route_path: $string,
         user_agent: $string,
         method: Method::GET,
         headers: [
@@ -44,7 +46,7 @@
             $string => $string,
         ],
         raw: [
-            $string => $string
+            $string => $string,
         ]
     );
 
@@ -54,6 +56,7 @@
         'timestamp' => $string,
         'ip' => $string,
         'url' => $string,
+        'route_path' => $string,
         'user_agent' => $string,
         'method' => Method::GET->value,
         'headers' => [
@@ -63,7 +66,7 @@
             $string => $string,
         ],
         'raw' => [
-            $string => $string
-        ]
+            $string => $string,
+        ],
     ]);
 })->with('strings');

tests/Pest.php

@@ -41,6 +41,7 @@ function createData(string $string): Data
             timestamp: $string,
             ip: $string,
             url: $string,
+            route_path: $string,
             user_agent: $string,
             method: Method::GET,
             headers: [