Merge pull request #308 from gacela-project/feat/add-rector

Add rector

.php-cs-fixer.dist.php

@@ -28,7 +28,7 @@
         'encoding' => true,
         'ereg_to_preg' => true,
         'explicit_string_variable' => true,
-        'fully_qualified_strict_types' => true,
+        'fully_qualified_strict_types' => false,
         'type_declaration_spaces' => true,
         'general_phpdoc_annotation_remove' => [
             'annotations' => [

composer.json

@@ -36,9 +36,10 @@
         "infection/infection": "^0.26",
         "phpbench/phpbench": "^1.2",
         "phpmetrics/phpmetrics": "^2.8",
-        "phpunit/phpunit": "^9.6",
         "phpstan/phpstan": "^1.10",
+        "phpunit/phpunit": "^9.6",
         "psalm/plugin-phpunit": "^0.18",
+        "rector/rector": "^0.18",
         "symfony/console": "^5.4",
         "symfony/var-dumper": "^5.4",
         "vimeo/psalm": "^5.18"

rector.php

@@ -0,0 +1,23 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\Config\RectorConfig;
+use Rector\Set\ValueObject\SetList;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->paths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ]);
+
+    $rectorConfig->sets([
+        SetList::CODE_QUALITY,
+        SetList::CODING_STYLE,
+        SetList::DEAD_CODE,
+        SetList::PRIVATIZATION,
+        SetList::TYPE_DECLARATION,
+        SetList::EARLY_RETURN,
+        SetList::INSTANCEOF,
+    ]);
+};

src/Console/ConsoleDependencyProvider.php

@@ -28,7 +28,7 @@ public function provideModuleDependencies(Container $container): void
 
     private function addCommands(Container $container): void
     {
-        $container->set(self::COMMANDS, static fn () => [
+        $container->set(self::COMMANDS, static fn (): array => [
             new MakeFileCommand(),
             new MakeModuleCommand(),
             new ListModulesCommand(),
@@ -37,7 +37,7 @@ private function addCommands(Container $container): void
 
     private function addTemplateByFilenameMap(Container $container): void
     {
-        $container->set(self::TEMPLATE_BY_FILENAME_MAP, fn () => [
+        $container->set(self::TEMPLATE_BY_FILENAME_MAP, fn (): array => [
             FilenameSanitizer::FACADE => $this->getConfig()->getFacadeMakerTemplate(),
             FilenameSanitizer::FACTORY => $this->getConfig()->getFactoryMakerTemplate(),
             FilenameSanitizer::CONFIG => $this->getConfig()->getConfigMakerTemplate(),

src/Console/Domain/AllAppModules/AllAppModulesFinder.php

@@ -27,11 +27,12 @@ public function findAllAppModules(string $filter): array
         /** @var SplFileInfo $fileInfo */
         foreach ($this->fileIterator as $fileInfo) {
             $appModule = $this->createAppModule($fileInfo, $filter);
-            if ($appModule !== null && $this->isFacade($appModule)) {
+            if ($appModule instanceof AppModule && $this->isFacade($appModule)) {
                 $result[$appModule->facadeClass()] = $appModule;
             }
         }
-        uksort($result, static fn ($a, $b) => $a <=> $b);
+
+        uksort($result, static fn ($a, $b): int => $a <=> $b);
 
         return array_values($result);
     }

src/Console/Domain/AllAppModules/AppModuleCreator.php

@@ -97,8 +97,9 @@ private function findDependencyProvider(string $facadeClass): ?string
             if ((new ReflectionClass($resolver))->isAnonymous()) {
                 throw new DependencyProviderNotFoundException($resolver);
             }
+
             return $resolver::class;
-        } catch (DependencyProviderNotFoundException $e) {
+        } catch (DependencyProviderNotFoundException $dependencyProviderNotFoundException) {
             return null;
         }
     }

src/Console/Domain/CommandArguments/CommandArgumentsException.php

@@ -23,7 +23,10 @@ public static function noAutoloadPsr4Found(): self
      */
     public static function noAutoloadPsr4MatchFound(string $desiredNamespace, array $knownPsr4 = []): self
     {
-        $parsedKnownPsr4 = array_map(static fn (string $p) => str_replace('\\', '', $p), $knownPsr4);
+        $parsedKnownPsr4 = array_map(
+            static fn (string $p): string => str_replace('\\', '', $p),
+            $knownPsr4,
+        );
 
         return new self(
             sprintf(

src/Console/Domain/CommandArguments/CommandArgumentsParser.php

@@ -47,6 +47,7 @@ public function parse(string $desiredNamespace): CommandArguments
             if (isset($psr4[$psr4Key])) {
                 return $this->foundPsr4($psr4Key, $psr4[$psr4Key], $desiredNamespace);
             }
+
             if (isset($psr4Dev[$psr4Key])) {
                 return $this->foundPsr4($psr4Key, $psr4Dev[$psr4Key], $desiredNamespace);
             }
@@ -72,7 +73,7 @@ private function allPossiblePsr4Combinations(string $desiredNamespace): array
         $result = [];
 
         foreach (explode('/', $desiredNamespace) as $explodedArg) {
-            if (empty($result)) {
+            if ($result === []) {
                 $result[] = $explodedArg;
             } else {
                 $prevValue = $result[count($result) - 1];

src/Console/Domain/FileContent/FileContentGenerator.php

@@ -34,7 +34,7 @@ public function generate(CommandArguments $commandArguments, string $filename, b
 
         $template = $this->templateByFilenameMap[$filename] ?? '';
         if (empty($template)) {
-            throw new RuntimeException("Unknown template for '{$filename}'?");
+            throw new RuntimeException(sprintf("Unknown template for '%s'?", $filename));
         }
 
         $fileContent = str_replace($search, $replace, $template);

src/Console/Domain/FilenameSanitizer/FilenameSanitizer.php

@@ -11,8 +11,11 @@
 final class FilenameSanitizer implements FilenameSanitizerInterface
 {
     public const FACADE = 'Facade';
+
     public const FACTORY = 'Factory';
+
     public const CONFIG = 'Config';
+
     public const DEPENDENCY_PROVIDER = 'DependencyProvider';
 
     public const EXPECTED_FILENAMES = [

src/Console/Infrastructure/Command/ListModulesCommand.php

@@ -23,6 +23,7 @@ final class ListModulesCommand extends Command
     use DocBlockResolverAwareTrait;
 
     private const CHECK_SYMBOL = '✔️';
+
     private const CROSS_SYMBOL = '✖️';
 
     private ?OutputInterface $output = null;

src/Console/Infrastructure/Command/MakeFileCommand.php

@@ -50,7 +50,7 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $filename,
                 $shortName,
             );
-            $output->writeln("> Path '{$absolutePath}' created successfully");
+            $output->writeln(sprintf("> Path '%s' created successfully", $absolutePath));
         }
 
         return self::SUCCESS;

src/Console/Infrastructure/Command/MakeModuleCommand.php

@@ -41,12 +41,12 @@ protected function execute(InputInterface $input, OutputInterface $output): int
                 $filename,
                 $shortName,
             );
-            $output->writeln("> Path '{$fullPath}' created successfully");
+            $output->writeln(sprintf("> Path '%s' created successfully", $fullPath));
         }
 
         $pieces = explode('/', $commandArguments->directory());
         $moduleName = end($pieces);
-        $output->writeln("Module '{$moduleName}' created successfully");
+        $output->writeln(sprintf("Module '%s' created successfully", $moduleName));
 
         return self::SUCCESS;
     }

src/Console/Infrastructure/FileContentIo.php

@@ -17,9 +17,16 @@ public function mkdir(string $directory): void
         if (is_dir($directory)) {
             return;
         }
-        if (!mkdir($directory) && !is_dir($directory)) {
-            throw new RuntimeException(sprintf('Directory "%s" was not created', $directory));
+
+        if (mkdir($directory)) {
+            return;
         }
+
+        if (is_dir($directory)) {
+            return;
+        }
+
+        throw new RuntimeException(sprintf('Directory "%s" was not created', $directory));
     }
 
     public function filePutContents(string $path, string $fileContent): void