Merge pull request #8 from faissaloux/refactor-expectations

Refactor expectations

Author: faissaloux

phpstan.neon

@@ -5,4 +5,3 @@ parameters:
 
     ignoreErrors:
         - "#Undefined variable: \\$this#"
-        - "#Variable \\$this might not be defined#"

src/Autoload.php

@@ -2,6 +2,21 @@
 
 declare(strict_types=1);
 
-namespace Faissaloux\PestInside;
+use Faissaloux\PestInside\Expectation;
+use Pest\Expectation as PestExpectation;
 
-require_once __DIR__.'/Expectation.php';
+$expectations = get_class_methods(Expectation::class);
+$expectations = array_filter($expectations, fn ($function): bool => str_starts_with($function, 'toReturn'));
+
+foreach ($expectations as $expectation) {
+    expect()->extend(
+        $expectation,
+        function (int $depth = -1) use ($expectation): PestExpectation {
+            if (is_callable($callback = [new Expectation($this->value), $expectation])) {
+                call_user_func($callback, ...func_get_args());
+            }
+
+            return $this;
+        }
+    );
+}

src/Expectation.php

@@ -2,64 +2,65 @@
 
 declare(strict_types=1);
 
-use Pest\Expectation as PestExpectation;
+namespace Faissaloux\PestInside;
 
-expect()->extend(
-    'toReturnUnique',
-    function (int $depth = -1): PestExpectation {
-        $files = [$this->value];
+use Pest\Expectation as PestExpectation;
 
-        if (is_dir($files[0])) {
-            $files = getFilesIn($files[0], $depth);
+final class Expectation
+{
+    /**
+     * @var array<string>
+     */
+    private array $files;
 
-            if ($files === []) {
-                expect(true)->toBeTrue();
+    public function __construct(private string $value)
+    {
+        $this->files = [$value];
+    }
 
-                return $this;
-            }
+    private function fetchFilesIfDirectory(int $depth): void
+    {
+        if (is_dir($this->files[0])) {
+            $this->files = getFilesIn($this->files[0], $depth);
         }
+    }
 
-        foreach ((array) $files as $file) {
-            if (! file_exists($file)) {
-                expect(true)->toBeFalse("$file not found!");
-            }
-
-            $content = include $file;
-
-            expect($content)->toBeArray();
+    private function checkFileExistence(string $file): void
+    {
+        if (! file_exists($file)) {
+            expect(true)->toBeFalse("$file not found!");
+        }
+    }
 
-            $duplicates = array_diff_assoc($content, array_unique($content));
+    /**
+     * @return array<string>
+     */
+    private function getContentFrom(string $file): array
+    {
+        $content = include $file;
 
-            expect($duplicates)->toBeEmpty('Duplicates found:'.implode(',', $duplicates)." in $file");
-        }
+        expect($content)->toBeArray();
 
-        return $this;
+        return $content;
     }
-);
-
-expect()->extend(
-    'toReturnLowercase',
-    function (int $depth = -1): PestExpectation {
-        $files = [$this->value];
 
-        if (is_dir($files[0])) {
-            $files = getFilesIn($files[0], $depth);
+    /**
+     * @return PestExpectation<string>
+     */
+    public function toReturnLowercase(int $depth = -1): PestExpectation
+    {
+        $this->fetchFilesIfDirectory($depth);
 
-            if ($files === []) {
-                expect(true)->toBeTrue();
+        if ($this->files === []) {
+            expect(true)->toBeTrue();
 
-                return $this;
-            }
+            return new PestExpectation($this->value);
         }
 
-        foreach ((array) $files as $file) {
-            if (! file_exists($file)) {
-                expect(true)->toBeFalse("$file not found!");
-            }
-
-            $content = include $file;
+        foreach ($this->files as $file) {
+            $this->checkFileExistence($file);
 
-            expect($content)->toBeArray();
+            $content = $this->getContentFrom($file);
 
             // Clean up content from numerics and special characters.
             $cleanContent = array_map(function (string $word): string {
@@ -75,6 +76,32 @@ function (int $depth = -1): PestExpectation {
             }
         }
 
-        return $this;
+        return new PestExpectation($this->value);
+    }
+
+    /**
+     * @return PestExpectation<string>
+     */
+    public function toReturnUnique(int $depth = -1): PestExpectation
+    {
+        $this->fetchFilesIfDirectory($depth);
+
+        if ($this->files === []) {
+            expect(true)->toBeTrue();
+
+            return new PestExpectation($this->value);
+        }
+
+        foreach ($this->files as $file) {
+            $this->checkFileExistence($file);
+
+            $content = $this->getContentFrom($file);
+
+            $duplicates = array_diff_assoc($content, array_unique($content));
+
+            expect($duplicates)->toBeEmpty('Duplicates found:'.implode(',', $duplicates)." in $file");
+        }
+
+        return new PestExpectation($this->value);
     }
-);
+}