126 lines
4.7 KiB
PHP
126 lines
4.7 KiB
PHP
<?php
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Tests\Architecture;
|
|
|
|
use App\Casts\CalendarDateCast;
|
|
use App\Casts\UtcDatetimeCast;
|
|
use App\Contracts\Action;
|
|
use App\Contracts\ActionInput;
|
|
use App\Contracts\Query;
|
|
use App\Contracts\QueryInput;
|
|
use Illuminate\Database\Eloquent\Model;
|
|
use Symfony\Component\Finder\Finder;
|
|
|
|
// Application coding rules
|
|
arch('No Domain Entities are used in Controllers')
|
|
->expect('App\Http\Controllers')
|
|
->not->toUse('Domain\Models\Entities');
|
|
|
|
arch('No Domain Entities are used in Policies')
|
|
->expect('App\Policies')
|
|
->not->toUse('Domain\Models\Entities');
|
|
|
|
arch('App DTOs are final readonly classes')
|
|
->expect('App\Dto')
|
|
->classes()
|
|
->toBeFinal()
|
|
->toBeReadonly();
|
|
|
|
arch('App Actions implement App\Contracts\Action and Inputs implement ActionInput', function (): void {
|
|
$path = __DIR__ . '/../../app/Cqs/Actions';
|
|
$files = (new Finder())->files()->in($path)->name('*.php');
|
|
|
|
foreach ($files as $file) {
|
|
$subPath = $file->getRelativePathname();
|
|
$className = 'App\\Cqs\\Actions\\' . str_replace(['/', '.php'], ['\\', ''], $subPath);
|
|
|
|
if (! class_exists($className) && ! interface_exists($className)) {
|
|
throw new \RuntimeException("Symbol {$className} does not exist.");
|
|
}
|
|
|
|
$reflection = new \ReflectionClass($className);
|
|
|
|
if (str_ends_with($className, 'Input')) {
|
|
expect($reflection->implementsInterface(ActionInput::class))
|
|
->toBeTrue("{$className} must implement App\Contracts\ActionInput");
|
|
} elseif (str_ends_with($className, 'Output')) {
|
|
if (! $reflection->isEnum()) {
|
|
expect($reflection->isFinal())
|
|
->toBeTrue("{$className} must be final");
|
|
expect($reflection->isReadOnly())
|
|
->toBeTrue("{$className} must be readonly");
|
|
}
|
|
} else {
|
|
expect($reflection->implementsInterface(Action::class))
|
|
->toBeTrue("{$className} must implement App\Contracts\Action");
|
|
}
|
|
}
|
|
});
|
|
|
|
arch('App Queries implement App\Contracts\Query and Inputs implement QueryInput', function (): void {
|
|
$path = __DIR__ . '/../../app/Cqs/Queries';
|
|
$files = (new Finder())->files()->in($path)->name('*.php');
|
|
|
|
foreach ($files as $file) {
|
|
$subPath = $file->getRelativePathname();
|
|
$className = 'App\\Cqs\\Queries\\' . str_replace(['/', '.php'], ['\\', ''], $subPath);
|
|
|
|
if (! class_exists($className) && ! interface_exists($className)) {
|
|
throw new \RuntimeException("Symbol {$className} does not exist.");
|
|
}
|
|
|
|
$reflection = new \ReflectionClass($className);
|
|
|
|
if (str_ends_with($className, 'Input')) {
|
|
expect($reflection->implementsInterface(QueryInput::class))
|
|
->toBeTrue("{$className} must implement App\Contracts\QueryInput");
|
|
} elseif (str_ends_with($className, 'Output')) {
|
|
expect($reflection->isFinal() && $reflection->isReadOnly())
|
|
->toBeTrue("{$className} must be final readonly");
|
|
} else {
|
|
expect($reflection->implementsInterface(Query::class))
|
|
->toBeTrue("{$className} must implement App\Contracts\Query");
|
|
}
|
|
}
|
|
});
|
|
|
|
arch('Eloquent models use UtcDatetimeCast or CalendarDateCast instead of raw date or datetime casts', function (): void {
|
|
$forbiddenCasts = [
|
|
'date',
|
|
'datetime',
|
|
'immutable_date',
|
|
'immutable_datetime',
|
|
'custom_datetime',
|
|
'immutable_custom_datetime',
|
|
'timestamp',
|
|
];
|
|
$path = __DIR__ . '/../../app/Models';
|
|
$files = (new Finder())->files()->in($path)->name('*.php');
|
|
|
|
foreach ($files as $file) {
|
|
$subPath = $file->getRelativePathname();
|
|
$className = 'App\\Models\\' . str_replace(['/', '.php'], ['\\', ''], $subPath);
|
|
|
|
if (! class_exists($className)) {
|
|
throw new \RuntimeException("Model class {$className} does not exist.");
|
|
}
|
|
|
|
$reflection = new \ReflectionClass($className);
|
|
if ($reflection->isAbstract() || ! $reflection->isSubclassOf(Model::class)) {
|
|
continue;
|
|
}
|
|
|
|
/** @var Model $instance */
|
|
$instance = $reflection->newInstanceWithoutConstructor();
|
|
foreach ($instance->getCasts() as $attribute => $cast) {
|
|
$baseCast = is_string($cast) ? explode(':', $cast, 2)[0] : '';
|
|
expect(in_array($baseCast, $forbiddenCasts, true))
|
|
->toBeFalse(
|
|
"{$className}::casts()['{$attribute}'] must use "
|
|
. UtcDatetimeCast::class . ' or ' . CalendarDateCast::class . " instead of '{$cast}'."
|
|
);
|
|
}
|
|
}
|
|
});
|