mirror of
https://github.com/rectorphp/rector.git
synced 2025-04-20 23:41:57 +02:00
[DX] Add ValidateFixtureNamespaceCommand and ValidateFixtureClassnameCommand (#4883)
Co-authored-by: rector-bot <tomas@getrector.org> Co-authored-by: Tomas Votruba <tomas.vot@gmail.com>
This commit is contained in:
Abdul Malik Ikhsan
GitHub
parent
b8b86de61d
commit
c2b7297b7a
@ -137,4 +137,9 @@ final class Option
|
||||
* @var string
|
||||
*/
|
||||
public const OPTION_CONFIG = 'config';
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
public const FIX = 'fix';
|
||||
}
|
||||
|
||||
@ -0,0 +1,285 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Rector\Utils\ProjectValidator\Command;
|
||||
|
||||
use Nette\Utils\Strings;
|
||||
use const PATHINFO_DIRNAME;
|
||||
use Rector\Core\Configuration\Option;
|
||||
use Rector\Core\Util\StaticRectorStrings;
|
||||
use Rector\PSR4\Composer\PSR4AutoloadPathsProvider;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Style\SymfonyStyle;
|
||||
use Symfony\Component\Finder\Finder;
|
||||
use Symplify\PackageBuilder\Console\ShellCode;
|
||||
use Symplify\SmartFileSystem\Finder\FinderSanitizer;
|
||||
use Symplify\SmartFileSystem\SmartFileInfo;
|
||||
use Symplify\SmartFileSystem\SmartFileSystem;
|
||||
|
||||
final class ValidateFixtureClassnameCommand extends Command
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
* @see https://regex101.com/r/5KtBi8/2
|
||||
*/
|
||||
private const NAMESPACE_REGEX = '#^namespace (.*);$#msU';
|
||||
|
||||
/**
|
||||
* @var string
|
||||
* @see https://regex101.com/r/IDSGdI/6
|
||||
*/
|
||||
private const CLASS_REGEX = '#(class) (\w+)\s+{$#msU';
|
||||
|
||||
/**
|
||||
* @var string
|
||||
* @see https://regex101.com/r/yv2Rul/4
|
||||
*/
|
||||
private const CLASS_WITH_EXTENDS_IMPLEMENTS_REGEX = '#(class) (\w+)\s+(extends|implements)\s+(.*)\s+\{$#msU';
|
||||
|
||||
/**
|
||||
* @var string
|
||||
* @see https://regex101.com/r/T5LUbA/6
|
||||
*/
|
||||
private const CLASS_USE_TRAIT_REGEX = '#^\s{0,}use\s+(.*);$#msU';
|
||||
|
||||
private const EXCLUDE_NAME = [
|
||||
'string',
|
||||
'false',
|
||||
'resource',
|
||||
'mixed',
|
||||
'git_wrapper',
|
||||
'this',
|
||||
'object',
|
||||
'array_item',
|
||||
];
|
||||
|
||||
/**
|
||||
* @var FinderSanitizer
|
||||
*/
|
||||
private $finderSanitizer;
|
||||
|
||||
/**
|
||||
* @var SymfonyStyle
|
||||
*/
|
||||
private $symfonyStyle;
|
||||
|
||||
/**
|
||||
* @var array<string, string>|array<string, string[]>
|
||||
*/
|
||||
private $psr4autoloadPaths;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $currentDirectory;
|
||||
|
||||
/**
|
||||
* @var SmartFileSystem
|
||||
*/
|
||||
private $smartFileSystem;
|
||||
|
||||
public function __construct(
|
||||
FinderSanitizer $finderSanitizer,
|
||||
PSR4AutoloadPathsProvider $psr4AutoloadPathsProvider,
|
||||
SymfonyStyle $symfonyStyle,
|
||||
SmartFileSystem $smartFileSystem
|
||||
) {
|
||||
$this->finderSanitizer = $finderSanitizer;
|
||||
$this->symfonyStyle = $symfonyStyle;
|
||||
$this->psr4autoloadPaths = $psr4AutoloadPathsProvider->provide();
|
||||
$this->currentDirectory = getcwd();
|
||||
$this->smartFileSystem = $smartFileSystem;
|
||||
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
protected function configure(): void
|
||||
{
|
||||
$this->addOption(Option::FIX, null, null, 'Fix found violations.');
|
||||
$this->setDescription('[CI] Validate tests fixtures class name');
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
$optionFix = (bool) $input->getOption(Option::FIX);
|
||||
$fixtureFiles = $this->getFixtureFiles();
|
||||
$incorrectClassNameFiles = [];
|
||||
|
||||
foreach ($fixtureFiles as $fixtureFile) {
|
||||
// 1. geting expected namespace ...
|
||||
$paths = explode('/tests/', (string) $fixtureFile);
|
||||
if (count($paths) > 2) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$path = ltrim(substr($paths[0], strlen($this->currentDirectory)) . '/tests', '/');
|
||||
$expectedNamespace = $this->getExpectedNamespace($path, $paths[1]);
|
||||
|
||||
if ($expectedNamespace === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// 2. reading file contents
|
||||
$fileContent = $this->smartFileSystem->readFile((string) $fixtureFile);
|
||||
$matchAll = Strings::matchAll($fileContent, self::NAMESPACE_REGEX);
|
||||
|
||||
if (! $this->isFoundCorrectNamespace($matchAll, $expectedNamespace)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$incorrectClassNameFiles = $this->checkAndFixClassName(
|
||||
$fileContent,
|
||||
$fixtureFile,
|
||||
$incorrectClassNameFiles,
|
||||
$expectedNamespace,
|
||||
$optionFix
|
||||
);
|
||||
}
|
||||
|
||||
if ($incorrectClassNameFiles !== []) {
|
||||
$this->symfonyStyle->listing($incorrectClassNameFiles);
|
||||
|
||||
$message = sprintf(
|
||||
'Found %d fixture files with invalid class name which not follow psr-4 defined in composer.json',
|
||||
count($incorrectClassNameFiles)
|
||||
);
|
||||
|
||||
if (! $optionFix) {
|
||||
$message .= '. Just add "--fix" to console command and rerun to apply.';
|
||||
$this->symfonyStyle->error($message);
|
||||
return ShellCode::ERROR;
|
||||
}
|
||||
|
||||
$this->symfonyStyle->success($message . ' and all fixtures are corrected', );
|
||||
return ShellCode::SUCCESS;
|
||||
}
|
||||
|
||||
$this->symfonyStyle->success('All fixtures are correct');
|
||||
return ShellCode::SUCCESS;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param string[] $incorrectClassNameFiles
|
||||
* @return string[]
|
||||
*/
|
||||
private function checkAndFixClassName(
|
||||
string $fileContent,
|
||||
SmartFileInfo $fixtureFile,
|
||||
array $incorrectClassNameFiles,
|
||||
string $expectedNamespace,
|
||||
bool $optionFix
|
||||
): array {
|
||||
$matchAll = Strings::matchAll($fileContent, self::CLASS_REGEX);
|
||||
|
||||
if ($matchAll === [] || count($matchAll) > 2) {
|
||||
return $incorrectClassNameFiles;
|
||||
}
|
||||
|
||||
$fileName = substr($fixtureFile->getFileName(), 0, -8);
|
||||
if (in_array($fileName, self::EXCLUDE_NAME, true)) {
|
||||
return $incorrectClassNameFiles;
|
||||
}
|
||||
|
||||
$hasTrait = (bool) Strings::match($fileContent, self::CLASS_USE_TRAIT_REGEX);
|
||||
if ($hasTrait) {
|
||||
return $incorrectClassNameFiles;
|
||||
}
|
||||
|
||||
$fileName = str_replace('-', '_', $fileName);
|
||||
$expectedClassName = ucfirst(StaticRectorStrings::uppercaseUnderscoreToCamelCase($fileName));
|
||||
$incorrectClassName = $this->getClassName($matchAll);
|
||||
if ($expectedClassName === $incorrectClassName) {
|
||||
return $incorrectClassNameFiles;
|
||||
}
|
||||
|
||||
$hasExtendsImplements = (bool) Strings::match($fileContent, self::CLASS_WITH_EXTENDS_IMPLEMENTS_REGEX);
|
||||
if ($hasExtendsImplements) {
|
||||
return $incorrectClassNameFiles;
|
||||
}
|
||||
|
||||
$incorrectClassNameFiles[] = (string) $fixtureFile;
|
||||
|
||||
if ($optionFix) {
|
||||
$this->fixClassName((string) $fixtureFile, $incorrectClassName, $fileContent, $expectedClassName);
|
||||
}
|
||||
|
||||
return $incorrectClassNameFiles;
|
||||
}
|
||||
|
||||
private function fixClassName(
|
||||
string $incorrectClassNameFile,
|
||||
string $incorrectClassName,
|
||||
string $incorrectFileContent,
|
||||
string $expectedClassName
|
||||
): void {
|
||||
$newContent = str_replace('class ' . $incorrectClassName, 'class ' . $expectedClassName, $incorrectFileContent);
|
||||
$this->smartFileSystem->dumpFile((string) $incorrectClassNameFile, $newContent);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return SmartFileInfo[]
|
||||
*/
|
||||
private function getFixtureFiles(): array
|
||||
{
|
||||
$finder = new Finder();
|
||||
$finder = $finder->files()
|
||||
->name('#\.php\.inc$#')
|
||||
->notName('#empty_file\.php\.inc$#')
|
||||
->path('#/Fixture/#')
|
||||
->notPath('#/blade-template/#')
|
||||
->notPath('#/RenameNamespaceRector/#')
|
||||
->notPath('#/TemplateAnnotationToThisRenderRector/#')
|
||||
->notPath('#bootstrap_names\.php\.inc#')
|
||||
->notPath('#trait_name\.php\.inc#')
|
||||
->notName('#_\.php\.inc$#')
|
||||
->notPath('#/ParamTypeDeclarationRector/#')
|
||||
->notPath('#/ReturnTypeDeclarationRector/#')
|
||||
->in(__DIR__ . '/../../../../tests')
|
||||
->in(__DIR__ . '/../../../../packages/*/tests')
|
||||
->in(__DIR__ . '/../../../../rules/*/tests');
|
||||
|
||||
return $this->finderSanitizer->sanitize($finder);
|
||||
}
|
||||
|
||||
private function getExpectedNamespace(string $path, string $relativePath): ?string
|
||||
{
|
||||
$relativePath = str_replace('/', '\\', dirname($relativePath, PATHINFO_DIRNAME));
|
||||
foreach ($this->psr4autoloadPaths as $prefix => $psr4autoloadPath) {
|
||||
if (is_string($psr4autoloadPath) && $psr4autoloadPath === $path) {
|
||||
return $prefix . $relativePath;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, array<int, string>> $matchAll
|
||||
*/
|
||||
private function isFoundCorrectNamespace(array $matchAll, string $expectedNamespace): bool
|
||||
{
|
||||
if ($matchAll === []) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$countMatchAll = count($matchAll);
|
||||
if ($countMatchAll === 1 && $matchAll[0][1] === $expectedNamespace) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $countMatchAll === 2 && $matchAll[0][1] === $expectedNamespace && $matchAll[1][1] === $expectedNamespace;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, array<int, string>> $matchAll
|
||||
*/
|
||||
private function getClassName(array $matchAll): string
|
||||
{
|
||||
$countMatchAll = count($matchAll);
|
||||
|
||||
return $matchAll[0][2];
|
||||
}
|
||||
}
|
||||
@ -0,0 +1,217 @@
|
||||
<?php
|
||||
|
||||
declare(strict_types=1);
|
||||
|
||||
namespace Rector\Utils\ProjectValidator\Command;
|
||||
|
||||
use Nette\Utils\Strings;
|
||||
use const PATHINFO_DIRNAME;
|
||||
use Rector\Core\Configuration\Option;
|
||||
use Rector\PSR4\Composer\PSR4AutoloadPathsProvider;
|
||||
use Symfony\Component\Console\Command\Command;
|
||||
use Symfony\Component\Console\Input\InputInterface;
|
||||
use Symfony\Component\Console\Output\OutputInterface;
|
||||
use Symfony\Component\Console\Style\SymfonyStyle;
|
||||
use Symfony\Component\Finder\Finder;
|
||||
use Symplify\PackageBuilder\Console\ShellCode;
|
||||
use Symplify\SmartFileSystem\Finder\FinderSanitizer;
|
||||
use Symplify\SmartFileSystem\SmartFileInfo;
|
||||
use Symplify\SmartFileSystem\SmartFileSystem;
|
||||
|
||||
final class ValidateFixtureNamespaceCommand extends Command
|
||||
{
|
||||
/**
|
||||
* @var string
|
||||
* @see https://regex101.com/r/5KtBi8/2
|
||||
*/
|
||||
private const NAMESPACE_REGEX = '#^namespace (.*);$#msU';
|
||||
|
||||
/**
|
||||
* @var FinderSanitizer
|
||||
*/
|
||||
private $finderSanitizer;
|
||||
|
||||
/**
|
||||
* @var SymfonyStyle
|
||||
*/
|
||||
private $symfonyStyle;
|
||||
|
||||
/**
|
||||
* @var array<string, string>|array<string, string[]>
|
||||
*/
|
||||
private $psr4autoloadPaths;
|
||||
|
||||
/**
|
||||
* @var string
|
||||
*/
|
||||
private $currentDirectory;
|
||||
|
||||
/**
|
||||
* @var SmartFileSystem
|
||||
*/
|
||||
private $smartFileSystem;
|
||||
|
||||
public function __construct(
|
||||
FinderSanitizer $finderSanitizer,
|
||||
PSR4AutoloadPathsProvider $psr4AutoloadPathsProvider,
|
||||
SymfonyStyle $symfonyStyle,
|
||||
SmartFileSystem $smartFileSystem
|
||||
) {
|
||||
$this->finderSanitizer = $finderSanitizer;
|
||||
$this->symfonyStyle = $symfonyStyle;
|
||||
$this->psr4autoloadPaths = $psr4AutoloadPathsProvider->provide();
|
||||
$this->currentDirectory = getcwd();
|
||||
$this->smartFileSystem = $smartFileSystem;
|
||||
|
||||
parent::__construct();
|
||||
}
|
||||
|
||||
protected function configure(): void
|
||||
{
|
||||
$this->addOption(Option::FIX, null, null, 'Fix found violations.');
|
||||
$this->setDescription('[CI] Validate tests fixtures namespace');
|
||||
}
|
||||
|
||||
protected function execute(InputInterface $input, OutputInterface $output): int
|
||||
{
|
||||
$optionFix = $input->getOption(Option::FIX);
|
||||
$fixtureFiles = $this->getFixtureFiles();
|
||||
$incorrectNamespaceFiles = [];
|
||||
|
||||
foreach ($fixtureFiles as $fixtureFile) {
|
||||
// 1. geting expected namespace ...
|
||||
$paths = explode('/tests/', (string) $fixtureFile);
|
||||
if (count($paths) > 2) {
|
||||
continue;
|
||||
}
|
||||
|
||||
$path = ltrim(substr($paths[0], strlen($this->currentDirectory)) . '/tests', '/');
|
||||
$expectedNamespace = $this->getExpectedNamespace($path, $paths[1]);
|
||||
|
||||
if ($expectedNamespace === null) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// 2. reading file contents
|
||||
$fileContent = $this->smartFileSystem->readFile((string) $fixtureFile);
|
||||
$matchAll = Strings::matchAll($fileContent, self::NAMESPACE_REGEX);
|
||||
|
||||
if ($this->isFoundCorrectNamespace($matchAll, $expectedNamespace)) {
|
||||
continue;
|
||||
}
|
||||
|
||||
// 3. collect files with incorrect namespace
|
||||
$incorrectNamespaceFiles[] = (string) $fixtureFile;
|
||||
$incorrectNamespace = $this->getIncorrectNamespace($matchAll, $expectedNamespace);
|
||||
|
||||
if ($optionFix) {
|
||||
$this->fixNamespace((string) $fixtureFile, $incorrectNamespace, $fileContent, $expectedNamespace);
|
||||
}
|
||||
}
|
||||
|
||||
if ($incorrectNamespaceFiles !== []) {
|
||||
$this->symfonyStyle->listing($incorrectNamespaceFiles);
|
||||
|
||||
$message = sprintf(
|
||||
'Found %d fixture files with invalid namespace which not follow psr-4 defined in composer.json',
|
||||
count($incorrectNamespaceFiles)
|
||||
);
|
||||
|
||||
if (! $optionFix) {
|
||||
$message .= '. Just add "--fix" to console command and rerun to apply.';
|
||||
$this->symfonyStyle->error($message);
|
||||
return ShellCode::ERROR;
|
||||
}
|
||||
|
||||
$this->symfonyStyle->success($message . ' and all fixtures are corrected', );
|
||||
return ShellCode::SUCCESS;
|
||||
}
|
||||
|
||||
$this->symfonyStyle->success('All fixtures are correct');
|
||||
return ShellCode::SUCCESS;
|
||||
}
|
||||
|
||||
private function fixNamespace(
|
||||
string $incorrectNamespaceFile,
|
||||
string $incorrectNamespace,
|
||||
string $incorrectFileContent,
|
||||
string $expectedNamespace
|
||||
): void {
|
||||
$newContent = str_replace(
|
||||
'namespace ' . $incorrectNamespace,
|
||||
'namespace ' . $expectedNamespace,
|
||||
$incorrectFileContent
|
||||
);
|
||||
$this->smartFileSystem->dumpFile((string) $incorrectNamespaceFile, $newContent);
|
||||
}
|
||||
|
||||
/**
|
||||
* @return SmartFileInfo[]
|
||||
*/
|
||||
private function getFixtureFiles(): array
|
||||
{
|
||||
$finder = new Finder();
|
||||
$finder = $finder->files()
|
||||
->name('#\.php\.inc$#')
|
||||
->notName('#empty_file\.php\.inc$#')
|
||||
->path('#/Fixture/#')
|
||||
->notPath('#/blade-template/#')
|
||||
->notPath('#/RenameNamespaceRector/#')
|
||||
->notPath('#/TemplateAnnotationToThisRenderRector/#')
|
||||
->notPath('#bootstrap_names\.php\.inc#')
|
||||
->notPath('#trait_name\.php\.inc#')
|
||||
->notName('#_\.php\.inc$#')
|
||||
->notPath('#/ParamTypeDeclarationRector/#')
|
||||
->notPath('#/ReturnTypeDeclarationRector/#')
|
||||
->in(__DIR__ . '/../../../../tests')
|
||||
->in(__DIR__ . '/../../../../packages/*/tests')
|
||||
->in(__DIR__ . '/../../../../rules/*/tests');
|
||||
|
||||
return $this->finderSanitizer->sanitize($finder);
|
||||
}
|
||||
|
||||
private function getExpectedNamespace(string $path, string $relativePath): ?string
|
||||
{
|
||||
$relativePath = str_replace('/', '\\', dirname($relativePath, PATHINFO_DIRNAME));
|
||||
foreach ($this->psr4autoloadPaths as $prefix => $psr4autoloadPath) {
|
||||
if (is_string($psr4autoloadPath) && $psr4autoloadPath === $path) {
|
||||
return $prefix . $relativePath;
|
||||
}
|
||||
}
|
||||
|
||||
return null;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, array<int, string>> $matchAll
|
||||
*/
|
||||
private function isFoundCorrectNamespace(array $matchAll, string $expectedNamespace): bool
|
||||
{
|
||||
if ($matchAll === []) {
|
||||
return true;
|
||||
}
|
||||
|
||||
$countMatchAll = count($matchAll);
|
||||
if ($countMatchAll === 1 && $matchAll[0][1] === $expectedNamespace) {
|
||||
return true;
|
||||
}
|
||||
|
||||
return $countMatchAll === 2 && $matchAll[0][1] === $expectedNamespace && $matchAll[1][1] === $expectedNamespace;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param array<int, array<int, string>> $matchAll
|
||||
*/
|
||||
private function getIncorrectNamespace(array $matchAll, string $expectedNamespace): string
|
||||
{
|
||||
$countMatchAll = count($matchAll);
|
||||
|
||||
if ($countMatchAll === 1) {
|
||||
return $matchAll[0][1];
|
||||
}
|
||||
|
||||
return $matchAll[0][1] !== $expectedNamespace
|
||||
? $matchAll[0][1]
|
||||
: $matchAll[1][1];
|
||||
}
|
||||
}
|
||||
Loading…
x
Reference in New Issue
Block a user