Code quality improvements

wazabii8 · wazabii8 · commit 428f317ce93b · 2024-09-29T16:03:31.000+02:00
diff --git a/Client.php b/Client.php
@@ -53,7 +53,7 @@ public function hasOption(int $key): bool
     {
         return (isset($this->options[$key]));
     }
-    
+
     /**
      * Sends a PSR-7 request and returns a PSR-7 response.
      * @param  RequestInterface $request
@@ -232,7 +232,7 @@ private function buildOptions(): void
      */
     private function buildHeaders(RequestInterface $request): void
     {
-        $data = array();
+        $data = [];
         foreach ($request->getHeaders() as $name => $_unUsedVal) {
             $data[] = "{$name}: " . $request->getHeaderLine($name);
         }
diff --git a/Cookies.php b/Cookies.php
@@ -35,7 +35,7 @@ public function __construct(
         $this->secure = $secure;
         $this->httpOnly = $httpOnly;
     }
-    
+
     /**
      * Set cookie allowed path
      * @param string $path URI Path
diff --git a/Dir.php b/Dir.php
@@ -12,7 +12,7 @@ class Dir implements DirInterface
     private $dir;
     private $getRootDir;
     private $handler;
-    
+
 
     public function __construct($dir, ?string $getRootDir = null)
     {
diff --git a/Env.php b/Env.php
@@ -9,10 +9,10 @@
 
 class Env
 {
-    private $fileData = array();
-    private $data = array();
-    private $set = array();
-    private $drop = array();
+    private $fileData = [];
+    private $data = [];
+    private $set = [];
+    private $drop = [];
 
     public function __construct(?string $file = null)
     {
@@ -65,7 +65,7 @@ public function generateOutput(array $fromArr = ["data", "fileData", "set"])
     {
         $out = "";
 
-        $data = array();
+        $data = [];
         $validData = ["data", "fileData", "set"];
         foreach ($validData as $d) {
             if (in_array($d, $fromArr)) {
diff --git a/Environment.php b/Environment.php
@@ -36,7 +36,7 @@ public function has($key): bool
     {
         return (bool)($this->get($key, null));
     }
-    
+
     /**
      * Return all env
      * @return array
@@ -52,7 +52,7 @@ public function fetch(): array
      */
     public function getUriParts(array $add = []): array
     {
-        $arr = array();
+        $arr = [];
         $arr['scheme'] = ($this->get("HTTPS") === 'on') ? 'https' : 'http';
         $arr['user'] = $this->get("PHP_AUTH_USER");
         $arr['pass'] = $this->get("PHP_AUTH_PW");
diff --git a/Headers.php b/Headers.php
@@ -6,7 +6,7 @@
 
 class Headers implements HeadersInterface
 {
-    protected $headers = array();
+    protected $headers = [];
 
     private static $getGlobalHeaders;
 
@@ -110,7 +110,7 @@ final public static function getGlobalHeaders($skip = false): array
         if (!$skip && function_exists("getallheaders")) {
             static::$getGlobalHeaders = getallheaders();
         } else {
-            static::$getGlobalHeaders = array();
+            static::$getGlobalHeaders = [];
             foreach ($_SERVER as $key => $value) {
                 if (substr($key, 0, 5) <> 'HTTP_') {
                     continue;
diff --git a/Interfaces/CookiesInterface.php b/Interfaces/CookiesInterface.php
@@ -39,7 +39,7 @@ public function sethttpOnly(bool $httpOnly): self;
      * @return self
      */
     public function setSameSite(string $samesite): self;
-    
+
     /**
      * Set cookie
      * @param string $name
@@ -56,12 +56,12 @@ public function set(string $name, string $value, int $expires, bool $force = fal
      */
     public function has(string $name): bool;
 
-     /**
-     * Get cookie
-     * @param  string      $name
-     * @param  string|null $default
-     * @return string|null
-     */
+    /**
+    * Get cookie
+    * @param  string      $name
+    * @param  string|null $default
+    * @return string|null
+    */
     public function get(string $name, ?string $default = null): ?string;
 
     /**
diff --git a/Interfaces/DirHandlerInterface.php b/Interfaces/DirHandlerInterface.php
@@ -3,9 +3,9 @@
  * DirHandlerInterface
  * Is used to extend upon the Dir instance with more dir methods
  */
+
 namespace MaplePHP\Http\Interfaces;
 
 interface DirHandlerInterface
 {
-
 }
diff --git a/Interfaces/MessageInterface.php b/Interfaces/MessageInterface.php
@@ -161,7 +161,7 @@ public function withBody(StreamInterface $body);
      * But is used by the framework
      *
      */
-    
+
     /**
      * Get header value data items
      * @param  string $name name/key (case insensitive)
diff --git a/Interfaces/ResponseInterface.php b/Interfaces/ResponseInterface.php
@@ -73,7 +73,7 @@ public function getReasonPhrase();
      * But is used by the framework
      *
      */
-    
+
     /**
      * Clear cache. No exceptions!
      * Out of security reasons it is actually good practice to call this BY default on a framework
diff --git a/Interfaces/StreamInterface.php b/Interfaces/StreamInterface.php
@@ -155,10 +155,16 @@ public function getContents();
      *     value is found, or null if the key is not found.
      */
     public function getMetadata(?string $key = null);
-    
+
     /**
      * Get current resource
      * @return resource
      */
     public function getResource();
+
+    /**
+     * Gets line from file pointer
+     * @return string|false
+     */
+    public function getLine(): string|bool;
 }
diff --git a/Interfaces/UrlHandlerInterface.php b/Interfaces/UrlHandlerInterface.php
@@ -3,11 +3,12 @@
  * UrlHandlerInterface
  * Is used to extend upon the Url instance with more url methods
  */
+
 namespace MaplePHP\Http\Interfaces;
 
 interface UrlHandlerInterface
 {
-	/**
+    /**
      * Get the public dir path
      * @return string|null
      */
diff --git a/Message.php b/Message.php
@@ -101,7 +101,7 @@ public function getHeaderLine($name)
      */
     public function getHeaderLineData(string $name): array
     {
-        $this->headerLine = array();
+        $this->headerLine = [];
         if ($this->hasHeader($name)) {
             $headerArr = $this->getHeader($name);
             foreach ($headerArr as $key => $val) {
diff --git a/Request.php b/Request.php
@@ -6,7 +6,6 @@
 use MaplePHP\Http\Interfaces\UriInterface;
 use MaplePHP\Http\Interfaces\HeadersInterface;
 use MaplePHP\Http\Interfaces\StreamInterface;
-use MaplePHP\Http\Uri;
 
 class Request extends Message implements RequestInterface
 {
@@ -119,8 +118,7 @@ public function isSSL(): bool
     public function getPort(): int
     {
         $serverPort = $this->env->get("SERVER_PORT");
-        $port = (int)(($serverPort) ? $serverPort : $this->uri->getPort());
-        return $port;
+        return (int)(($serverPort) ? $serverPort : $this->uri->getPort());
     }
 
     /**
@@ -135,7 +133,7 @@ final protected function setHostHeader(): void
     }
 
     /**
-     * This will resolve the Request Stream and make the call user friendly
+     * This will resolve the Request Stream and make the call user-friendly
      * @param  StreamInterface|array|string|null $body
      * @return StreamInterface
      */
@@ -156,18 +154,18 @@ private function resolveRequestStream(StreamInterface|array|string|null $body):
         return $stream;
     }
 
-     /**
-     * Get Cli keyword
-     * @return string|null
-     */
+    /**
+    * Get Cli keyword
+    * @return string|null
+    */
     public function getCliKeyword(): ?string
     {
         if (is_null($this->cliKeywords)) {
-            $new = array();
+            $new = [];
             $arg = $this->getUri()->getArgv();
             foreach ($arg as $val) {
                 if (is_string($val)) {
-                    if ((strpos($val, "--") === 0) || (strpos($val, "-") === 0)) {
+                    if ((str_starts_with($val, "--")) || (str_starts_with($val, "-"))) {
                         break;
                     } else {
                         $new[] = $val;
@@ -189,11 +187,11 @@ public function getCliArgs(): array
     {
         if (is_null($this->cliArgs)) {
             $args = $this->getUri()->getArgv();
-            $this->cliArgs = array();
+            $this->cliArgs = [];
             foreach ($args as $arg) {
                 if (is_string($arg)) {
                     $arg = str_replace("&", "#", $arg);
-                    if ((($pos1 = strpos($arg, "--")) === 0) || (strpos($arg, "-") === 0)) {
+                    if ((($pos1 = strpos($arg, "--")) === 0) || (str_starts_with($arg, "-"))) {
                         parse_str(substr($arg, ($pos1 !== false ? 2 : 1)), $result);
                         foreach ($result as &$val) {
                             $val = str_replace("#", "&", $val);
diff --git a/Response.php b/Response.php
@@ -10,7 +10,7 @@
 
 class Response extends Message implements ResponseInterface
 {
-    public const PHRASE = array(
+    public const PHRASE = [
         100 => 'Continue',
         101 => 'Switching Protocols',
         102 => 'Processing',
@@ -71,7 +71,7 @@ class Response extends Message implements ResponseInterface
         507 => 'Insufficient Storage',
         510 => 'Not Extended',
         511 => 'Network Authentication Required',
-    );
+    ];
 
     private $statusCode = 200;
     private $phrase;
diff --git a/ServerRequest.php b/ServerRequest.php
@@ -9,7 +9,7 @@
 
 class ServerRequest extends Request implements ServerRequestInterface
 {
-    protected $attr = array();
+    protected $attr = [];
     protected $env;
     protected $queryParams;
     protected $parsedBody;
diff --git a/Uri.php b/Uri.php
@@ -23,7 +23,7 @@ class Uri implements UriInterface
         'ldap' => 389,
     ];
 
-    private $parts = array();
+    private $parts = [];
     private $scheme;
     //private $uri;
     private $host;
@@ -214,7 +214,9 @@ public function getPath(): string
     {
         if ($val = $this->getUniquePart("path")) {
             $this->encoded['path'] = Format\Str::value($val)->toggleUrlencode(['%2F'], ['/'])->get();
-            if($this->encoded['path']) $this->encoded['path'] = "/".ltrim($this->encoded['path'], "/");
+            if($this->encoded['path']) {
+                $this->encoded['path'] = "/".ltrim($this->encoded['path'], "/");
+            }
         }
         return (string)$this->encoded['path'];
     }
diff --git a/Url.php b/Url.php
@@ -61,7 +61,7 @@ public function withType(null|string|array $type = null): self
 
 
         $inst = clone $this;
-        $parts = $vars = array();
+        $parts = $vars = [];
         foreach ($inst->parts as $sel => $row) {
             if (in_array($sel, $type)) {
                 if (is_array($row)) {
@@ -158,7 +158,7 @@ public function getRealPath(): string
     /**
      * Extract and get directories from the simulated htaccess path
      * @return string
-     */    
+     */
     public function getDirPath(): string
     {
         if (is_null($this->dirPath)) {
@@ -282,7 +282,7 @@ public function getRootDir(string $path = "", bool $endSlash = false): string
         if ($host = $this->getHost()) {
             $url .= "//{$host}";
         }
-        
+
         // Do not show standard ports becouse they are not needed.
         if (($port = $this->getPort()) && $port !== 80 && $port !== 443) {
             $url .= ":{$port}";
@@ -348,7 +348,7 @@ public function __call($method, $args): mixed
     {
         if (!is_null($this->handler) && method_exists($this->handler, $method)) {
             return call_user_func_array([$this->handler, $method], $args);
-        } else if (method_exists($this->uri, $method)) {
+        } elseif (method_exists($this->uri, $method)) {
             return call_user_func_array([$this->uri, $method], $args);
         } else {
             throw new \BadMethodCallException("The method ({$method}) does not exist in \"".__CLASS__."\" (UrlInterface or UriInterface).", 1);
diff --git a/composer.json b/composer.json
@@ -1,5 +1,6 @@
 {
     "name": "maplephp/http",
+    "version": "v1.0.6",
     "type": "library",
     "description": "The library is fully integrated with PSR-7 Http Message and designed for use with MaplePHP framework.",
     "keywords": ["psr7", "http", "message", "http message", "server", "request", "client", "upload", "stream", "headers"],
@@ -19,6 +20,9 @@
         "php": ">=8.0",
         "maplephp/dto": "^1.0"
     },
+    "require-dev": {
+        "maplephp/unitary": "^1.0"
+    },
     "autoload": {
         "psr-4": {
             "MaplePHP\\Http\\": ""
diff --git a/tests/unitary-request.php b/tests/unitary-request.php

Original file line number	Diff line number	Diff line change
`@@ -53,7 +53,7 @@ public function hasOption(int $key): bool`
`53`	`53`	`{`
`54`	`54`	`return (isset($this->options[$key]));`
`55`	`55`	`}`
`56`		`-`
	`56`	`+`
`57`	`57`	`/**`
`58`	`58`	`* Sends a PSR-7 request and returns a PSR-7 response.`
`59`	`59`	`* @param RequestInterface $request`
`@@ -232,7 +232,7 @@ private function buildOptions(): void`
`232`	`232`	`*/`
`233`	`233`	`private function buildHeaders(RequestInterface $request): void`
`234`	`234`	`{`
`235`		`- $data = array();`
	`235`	`+ $data = [];`
`236`	`236`	`foreach ($request->getHeaders() as $name => $_unUsedVal) {`
`237`	`237`	`$data[] = "{$name}: " . $request->getHeaderLine($name);`
`238`	`238`	`}`
Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ public function __construct(`
`35`	`35`	`$this->secure = $secure;`
`36`	`36`	`$this->httpOnly = $httpOnly;`
`37`	`37`	`}`
`38`		`-`
	`38`	`+`
`39`	`39`	`/**`
`40`	`40`	`* Set cookie allowed path`
`41`	`41`	`* @param string $path URI Path`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ class Dir implements DirInterface`
`12`	`12`	`private $dir;`
`13`	`13`	`private $getRootDir;`
`14`	`14`	`private $handler;`
`15`		`-`
	`15`	`+`
`16`	`16`
`17`	`17`	`public function __construct($dir, ?string $getRootDir = null)`
`18`	`18`	`{`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function has($key): bool`
`36`	`36`	`{`
`37`	`37`	`return (bool)($this->get($key, null));`
`38`	`38`	`}`
`39`		`-`
	`39`	`+`
`40`	`40`	`/**`
`41`	`41`	`* Return all env`
`42`	`42`	`* @return array`
`@@ -52,7 +52,7 @@ public function fetch(): array`
`52`	`52`	`*/`
`53`	`53`	`public function getUriParts(array $add = []): array`
`54`	`54`	`{`
`55`		`- $arr = array();`
	`55`	`+ $arr = [];`
`56`	`56`	`$arr['scheme'] = ($this->get("HTTPS") === 'on') ? 'https' : 'http';`
`57`	`57`	`$arr['user'] = $this->get("PHP_AUTH_USER");`
`58`	`58`	`$arr['pass'] = $this->get("PHP_AUTH_PW");`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,9 @@`
`3`	`3`	`* DirHandlerInterface`
`4`	`4`	`* Is used to extend upon the Dir instance with more dir methods`
`5`	`5`	`*/`
	`6`	`+`
`6`	`7`	`namespace MaplePHP\Http\Interfaces;`
`7`	`8`
`8`	`9`	`interface DirHandlerInterface`
`9`	`10`	`{`
`10`		`-`
`11`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -161,7 +161,7 @@ public function withBody(StreamInterface $body);`
`161`	`161`	`* But is used by the framework`
`162`	`162`	`*`
`163`	`163`	`*/`
`164`		`-`
	`164`	`+`
`165`	`165`	`/**`
`166`	`166`	`* Get header value data items`
`167`	`167`	`* @param string $name name/key (case insensitive)`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ public function getReasonPhrase();`
`73`	`73`	`* But is used by the framework`
`74`	`74`	`*`
`75`	`75`	`*/`
`76`		`-`
	`76`	`+`
`77`	`77`	`/**`
`78`	`78`	`* Clear cache. No exceptions!`
`79`	`79`	`* Out of security reasons it is actually good practice to call this BY default on a framework`
Original file line number	Diff line number	Diff line change
`@@ -101,7 +101,7 @@ public function getHeaderLine($name)`
`101`	`101`	`*/`
`102`	`102`	`public function getHeaderLineData(string $name): array`
`103`	`103`	`{`
`104`		`- $this->headerLine = array();`
	`104`	`+ $this->headerLine = [];`
`105`	`105`	`if ($this->hasHeader($name)) {`
`106`	`106`	`$headerArr = $this->getHeader($name);`
`107`	`107`	`foreach ($headerArr as $key => $val) {`
Original file line number	Diff line number	Diff line change
`@@ -9,7 +9,7 @@`
`9`	`9`
`10`	`10`	`class ServerRequest extends Request implements ServerRequestInterface`
`11`	`11`	`{`
`12`		`- protected $attr = array();`
	`12`	`+ protected $attr = [];`
`13`	`13`	`protected $env;`
`14`	`14`	`protected $queryParams;`
`15`	`15`	`protected $parsedBody;`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ class Uri implements UriInterface`
`23`	`23`	`'ldap' => 389,`
`24`	`24`	`];`
`25`	`25`
`26`		`- private $parts = array();`
	`26`	`+ private $parts = [];`
`27`	`27`	`private $scheme;`
`28`	`28`	`//private $uri;`
`29`	`29`	`private $host;`
`@@ -214,7 +214,9 @@ public function getPath(): string`
`214`	`214`	`{`
`215`	`215`	`if ($val = $this->getUniquePart("path")) {`
`216`	`216`	`$this->encoded['path'] = Format\Str::value($val)->toggleUrlencode(['%2F'], ['/'])->get();`
`217`		`- if($this->encoded['path']) $this->encoded['path'] = "/".ltrim($this->encoded['path'], "/");`
	`217`	`+ if($this->encoded['path']) {`
	`218`	`+ $this->encoded['path'] = "/".ltrim($this->encoded['path'], "/");`
	`219`	`+ }`
`218`	`220`	`}`
`219`	`221`	`return (string)$this->encoded['path'];`
`220`	`222`	`}`