-
-
Notifications
You must be signed in to change notification settings - Fork 371
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[config] Extract RectorConfigValidator and handle config validation t…
…here
- Loading branch information
1 parent
9c7842f
commit 8b48bf5
Showing
2 changed files
with
125 additions
and
104 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,102 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| namespace Rector\Validation; | ||
|
|
||
| use Rector\Core\Exception\ShouldNotHappenException; | ||
|
|
||
| final class RectorConfigValidator | ||
| { | ||
| /** | ||
| * @param string[] $rectorClasses | ||
| */ | ||
| public static function ensureNoDuplicatedClasses(array $rectorClasses): void | ||
| { | ||
| $duplicatedRectorClasses = self::resolveDuplicatedValues($rectorClasses); | ||
| if ($duplicatedRectorClasses === []) { | ||
| return; | ||
| } | ||
|
|
||
| throw new ShouldNotHappenException('Following rules are registered twice: ' . implode( | ||
| ', ', | ||
| $duplicatedRectorClasses | ||
| )); | ||
| } | ||
|
|
||
| /** | ||
| * @param mixed[] $skip | ||
| */ | ||
| public static function ensureRectorRulesExist(array $skip): void | ||
| { | ||
| $nonExistingRules = []; | ||
|
|
||
| foreach ($skip as $key => $value) { | ||
| if (self::isRectorClassValue($key) && ! class_exists($key)) { | ||
| $nonExistingRules[] = $key; | ||
| continue; | ||
| } | ||
|
|
||
| if (self::isRectorClassValue($value) && ! class_exists($value)) { | ||
| $nonExistingRules[] = $value; | ||
| } | ||
| } | ||
|
|
||
| if ($nonExistingRules === []) { | ||
| return; | ||
| } | ||
|
|
||
| $nonExistingRulesString = ''; | ||
| foreach ($nonExistingRules as $nonExistingRule) { | ||
| $nonExistingRulesString .= ' * ' . $nonExistingRule . PHP_EOL; | ||
| } | ||
|
|
||
| throw new ShouldNotHappenException( | ||
| 'These rules from "$rectorConfig->skip()" does not exist - remove them or fix their names:' . PHP_EOL . $nonExistingRulesString | ||
| ); | ||
| } | ||
|
|
||
| private static function isRectorClassValue(mixed $value): bool | ||
| { | ||
| // only validate string | ||
| if (! is_string($value)) { | ||
| return false; | ||
| } | ||
|
|
||
| // not regex path | ||
| if (str_contains($value, '*')) { | ||
| return false; | ||
| } | ||
|
|
||
| // not if no Rector suffix | ||
| if (! str_ends_with($value, 'Rector')) { | ||
| return false; | ||
| } | ||
|
|
||
| // not directory | ||
| if (is_dir($value)) { | ||
| return false; | ||
| } | ||
|
|
||
| // not file | ||
| return ! is_file($value); | ||
| } | ||
|
|
||
| /** | ||
| * @param string[] $values | ||
| * @return string[] | ||
| */ | ||
| private static function resolveDuplicatedValues(array $values): array | ||
| { | ||
| $counted = array_count_values($values); | ||
| $duplicates = []; | ||
|
|
||
| foreach ($counted as $value => $count) { | ||
| if ($count > 1) { | ||
| $duplicates[] = $value; | ||
| } | ||
| } | ||
|
|
||
| return array_unique($duplicates); | ||
| } | ||
| } |