Merge pull request #1455 from SimonBroekaert/feat/to_be_cased_correctly_arch_test_assertion

feat: add toBeCasedCorrectly arch test assertion

src/Expectation.php

@@ -18,6 +18,7 @@ use Pest\Arch\Expectations\ToOnlyUse;
 use Pest\Arch\Expectations\ToUse;
 use Pest\Arch\Expectations\ToUseNothing;
 use Pest\Arch\PendingArchExpectation;
+use Pest\Arch\Support\Composer;
 use Pest\Arch\Support\FileLineFinder;
 use Pest\Concerns\Extendable;
 use Pest\Concerns\Pipeable;
@@ -669,6 +670,41 @@ final class Expectation
         throw InvalidExpectation::fromMethods(['toHavePrivateMethods']);
     }
 
+    /**
+     * Asserts that the given expectation target is cased correctly.
+     */
+    public function toBeCasedCorrectly(): ArchExpectation
+    {
+        return Targeted::make(
+            $this,
+            function (ObjectDescription $object): bool {
+                if (! isset($object->reflectionClass)) {
+                    return false;
+                }
+
+                $realPath = realpath($object->path);
+
+                foreach (Composer::userNamespaces() as $directory => $namespace) {
+                    if (str_starts_with($realPath, $directory)) {
+                        $relativePath = substr($realPath, strlen($directory) + 1);
+                        $relativePath = explode('.', $relativePath)[0];
+                        $classFromPath = $namespace . '\\' . str_replace(DIRECTORY_SEPARATOR, '\\', $relativePath);
+
+                        if ($classFromPath === $object->reflectionClass->getName()) {
+                            return true;
+                        }
+
+                        return false;
+                    }
+                }
+
+                return false;
+            },
+            "to be cased correctly",
+            FileLineFinder::where(fn (string $line): bool => str_contains($line, 'class')),
+        );
+    }
+
     /**
      * Asserts that the given expectation target is enum.
      */

tests/Features/Expect/toBeCasedCorrectly.php

@@ -0,0 +1,12 @@
+<?php
+
+use Pest\Arch\Exceptions\ArchExpectationFailedException;
+
+test('pass')
+    ->expect('Tests\Fixtures\Arch\ToBeCasedCorrectly\CorrectCasing')
+    ->toBeCasedCorrectly();
+
+test('failure')
+    ->expect('Tests\Fixtures\Arch\ToBeCasedCorrectly\IncorrectCasing')
+    ->toBeCasedCorrectly()
+    ->throws(ArchExpectationFailedException::class);

tests/Fixtures/Arch/ToBeCasedCorrectly/CorrectCasing/CorrectCasing.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Tests\Fixtures\Arch\ToBeCasedCorrectly\CorrectCasing;
+
+class CorrectCasing {}

tests/Fixtures/Arch/ToBeCasedCorrectly/IncorrectCasing/incorrectCasing.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Tests\Fixtures\Arch\ToBeCasedCorrectly\IncorrectCasing;
+
+class IncorrectCasing {}

tests/Fixtures/Arch/ToBeCasedCorrectly/incorrectDirectoryCasing/CorrectCasing.php

@@ -0,0 +1,5 @@
+<?php
+
+namespace Tests\Fixtures\Arch\ToBeCasedCorrectly\IncorrectDirectoryCasing;
+
+class CorrectCasing {}