Code quality improvements

Author: wazabii8

FileIterator.php

@@ -9,6 +9,7 @@
 use MaplePHP\Blunder\Run;
 use RecursiveDirectoryIterator;
 use RecursiveIteratorIterator;
+use SplFileInfo;
 
 class FileIterator
 {
@@ -31,18 +32,21 @@ public function executeAll(string $directory): void
     {
         $files = $this->findFiles($directory);
         if (empty($files)) {
-            throw new RuntimeException("No files found matching the pattern \"" . static::PATTERN . "\" in directory \"$directory\" ");
+            throw new RuntimeException("No files found matching the pattern \"" . (string)(static::PATTERN ?? "") . "\" in directory \"$directory\" ");
         } else {
             foreach ($files as $file) {
                 extract($this->args, EXTR_PREFIX_SAME, "wddx");
                 Unit::resetUnit();
                 Unit::setHeaders([
                     "args" => $this->args,
                     "file" => $file,
-                    "checksum" => md5($file)
+                    "checksum" => md5((string)$file)
                 ]);
 
-                $this->requireUnitFile($file)();
+                $call = $this->requireUnitFile((string)$file);
+                if (!is_null($call)) {
+                    $call();
+                }
                 if(!Unit::hasUnit()) {
                     throw new RuntimeException("The Unitary Unit class has not been initiated inside \"$file\".");
                 }
@@ -54,19 +58,22 @@ public function executeAll(string $directory): void
 
     /**
      * Will Scan and find all unitary test files
-     * @param $dir
+     * @param string $dir
      * @return array
      */
-    private function findFiles($dir): array
+    private function findFiles(string $dir): array
     {
         $files = [];
         $realDir = realpath($dir);
-        if(!$realDir) {
+        if($realDir === false) {
             throw new RuntimeException("Directory \"$dir\" does not exist. Try using a absolut path!");
         }
         $iterator = new RecursiveIteratorIterator(new RecursiveDirectoryIterator($dir));
+
+        /** @var string $pattern */
+        $pattern = static::PATTERN;
         foreach ($iterator as $file) {
-            if (fnmatch(static::PATTERN, $file->getFilename()) &&
+            if (($file instanceof SplFileInfo) && fnmatch($pattern, $file->getFilename()) &&
                 (isset($this->args['path']) || !str_contains($file->getPathname(), DIRECTORY_SEPARATOR . "vendor" . DIRECTORY_SEPARATOR ))) {
                 if(!$this->findExcluded($this->exclude(), $dir, $file->getPathname())) {
                     $files[] = $file->getPathname();
@@ -83,7 +90,7 @@ private function findFiles($dir): array
     function exclude(): array
     {
         $excl = array();
-        if(isset($this->args['exclude'])) {
+        if(isset($this->args['exclude']) && is_string($this->args['exclude'])) {
             $exclude = explode(',', $this->args['exclude']);
             foreach ($exclude as $file) {
                 $file = str_replace(['"', "'"], "", $file);
@@ -109,7 +116,7 @@ function findExcluded(array $exclArr, string $relativeDir, string $file): bool
     {
         $file = $this->getNaturalPath($file);
         foreach ($exclArr as $excl) {
-            $relativeExclPath = $this->getNaturalPath($relativeDir . DIRECTORY_SEPARATOR . $excl);
+            $relativeExclPath = $this->getNaturalPath($relativeDir . DIRECTORY_SEPARATOR . (string)$excl);
             if(fnmatch($relativeExclPath, $file)) {
                 return true;
             }
@@ -130,13 +137,13 @@ function getNaturalPath(string $path): string
     /**
      * Require file without inheriting any class information
      * @param string $file
-     * @return Closure
+     * @return Closure|null
      */
-    private function requireUnitFile(string $file): Closure
+    private function requireUnitFile(string $file): ?Closure
     {
-        $call = function() use ($file): void
+        $clone = clone $this;
+        $call = function() use ($file, $clone): void
         {
-
             $cli = new CliHandler();
             if(isset(self::$headers['args']['trace'])) {
                 $cli->enableTraceLines(true);
@@ -145,14 +152,32 @@ private function requireUnitFile(string $file): Closure
             $run->load();
 
             ob_start();
+            if (!is_file($file)) {
+                throw new RuntimeException("File \"$file\" do not exists.");
+            }
             require_once ($file);
-            Unit::getUnit()->execute();
+
+            $clone->getUnit()->execute();
 
             $outputBuffer = ob_get_clean();
-            if($outputBuffer && Unit::hasUnit()) {
-                Unit::getUnit()->buildNotice("Note:", $outputBuffer, 80);
+            if (strlen($outputBuffer) && Unit::hasUnit()) {
+                $clone->getUnit()->buildNotice("Note:", $outputBuffer, 80);
             }
         };
         return $call->bindTo(null);
     }
+
+    /**
+     * @return Unit
+     * @throws RuntimeException|\Exception
+     */
+    protected function getUnit(): Unit
+    {
+        $unit = Unit::getUnit();
+        if (is_null($unit)) {
+            throw new RuntimeException("The Unit instance has not been initiated.");
+        }
+        return $unit;
+
+    }
 }

README.md

@@ -63,20 +63,18 @@ $unit = new MaplePHP\Unitary\Unit();
 
 // If you build your library right it will become very easy to mock, like I have below.
 $request = new MaplePHP\Http\Request(
-    "POST", // The HTTP Method (GET, POST, PUT, DELETE, PATCH)
-    "https://admin:mypass@example.com:65535/test.php?id=5221&place=stockholm", // The Request URI
-    ["Content-Type" => "application/x-www-form-urlencoded"], // Add Headers, empty array is allowed
-    ["email" => "john.doe@example.com"] // Post data
+    "GET",
+    "https://admin:mypass@example.com:65535/test.php?id=5221&greeting=hello",
 );
 
 // Begin by adding a test
 $unit->case("MaplePHP Request URI path test", function() use($request) {
 
     // Test 1
     $this->add($request->getMethod(), function() {
-        return $this->equal("POST");
+        return $this->equal("GET");
 
-    }, "HTTP Request method Type is not POST");
+    }, "HTTP Request method Type does not equal GET");
     // Adding a error message is not required, but it is highly recommended
 
     // Test 2
@@ -96,7 +94,7 @@ $unit->case("MaplePHP Request URI path test", function() use($request) {
             return ($this->withValue($arr[0])->equal("admin") && $this->withValue($arr[1])->equal("mypass"));
         }
 
-    ], "Is not a valid port number");
+    ], "Did not get the expected user Info credentials");
 });
 
 $unit->execute();

TestCase.php

@@ -4,19 +4,19 @@
 namespace MaplePHP\Unitary;
 
 use BadMethodCallException;
-use Closure;
 use ErrorException;
-use MaplePHP\Validate\Inp;
 use RuntimeException;
+use Closure;
 use Throwable;
+use MaplePHP\Validate\Inp;
 
 class TestCase
 {
     private mixed $value;
     private ?string $message;
-    private array $test;
+    private array $test = [];
     private int $count = 0;
-    private Closure $bind;
+    private ?Closure $bind = null;
 
     function __construct(?string $message = null)
     {
@@ -40,7 +40,9 @@ function bind(Closure $bind): void
     function dispatchTest(): array
     {
         $test = $this->bind;
-        $test($this);
+        if (!is_null($test)) {
+            $test($this);
+        }
         return $this->test;
     }
 
@@ -56,11 +58,11 @@ function add(mixed $expect, array|Closure $validation, ?string $message = null):
     {
         $this->value = $expect;
         $test = new TestUnit($this->value, $message);
-        if(is_callable($validation)) {
+        if($validation instanceof Closure) {
             $test->setUnit($this->buildClosureTest($validation));
         } else {
             foreach($validation as $method => $args) {
-                if(!is_callable($args) && !is_array($args)) {
+                if(!($args instanceof Closure) && !is_array($args)) {
                     $args = [$args];
                 }
                 $test->setUnit($this->buildArrayTest($method, $args), $method, (is_array($args) ? $args : []));
@@ -145,8 +147,11 @@ public function getTest(): array
      */
     public function buildClosureTest(Closure $validation): bool
     {
+        $bool = false;
         $validation = $validation->bindTo($this->valid($this->value));
-        $bool = $validation($this->value);
+        if(!is_null($validation)) {
+            $bool = $validation($this->value);
+        }
         if(!is_bool($bool)) {
             throw new RuntimeException("A callable validation must return a boolean!");
         }
@@ -167,8 +172,11 @@ public function buildClosureTest(Closure $validation): bool
      */
     public function buildArrayTest(string $method, array|Closure $args): bool
     {
-        if(is_callable($args)) {
+        if($args instanceof Closure) {
             $args = $args->bindTo($this->valid($this->value));
+            if(is_null($args)) {
+                throw new ErrorException("The argument is not returning a callable Closure!");
+            }
             $bool = $args($this->value);
             if(!is_bool($bool)) {
                 throw new RuntimeException("A callable validation must return a boolean!");
@@ -177,17 +185,15 @@ public function buildArrayTest(string $method, array|Closure $args): bool
             if(!method_exists(Inp::class, $method)) {
                 throw new BadMethodCallException("The validation $method does not exist!");
             }
-            if(!is_array($args)) {
-                $args = [];
-            }
+
             try {
                 $bool = call_user_func_array([$this->valid($this->value), $method], $args);
             } catch (Throwable $e) {
-                throw new RuntimeException($e->getMessage(), $e->getCode(), $e);
+                throw new RuntimeException($e->getMessage(), (int)$e->getCode(), $e);
             }
         }
 
-        return $bool;
+        return (bool)$bool;
     }
 
     /**

TestUnit.php

@@ -11,7 +11,7 @@ class TestUnit
     private bool $valid;
     private mixed $value;
     private ?string $message;
-    private array $unit;
+    private array $unit = [];
     private int $count = 0;
 
     /**
@@ -136,7 +136,7 @@ public function getReadValue(): string
     final protected function excerpt(string $value): string
     {
         $format = new Str($value);
-        return $format->excerpt(40)->get();
+        return (string)$format->excerpt(42)->get();
     }
 
 }