Merge pull request #114 from cakephp/2.x-rector

add rector

Author: LordSimal

composer.json

@@ -57,6 +57,9 @@
         "stan": "@phpstan",
         "phpstan-baseline": "tools/phpstan --generate-baseline",
         "stan-setup": "phive install",
+        "rector-setup": "cp composer.json composer.backup && composer require --dev rector/rector:\"~2.3.1\" && mv composer.backup composer.json",
+        "rector-check": "vendor/bin/rector process --dry-run",
+        "rector-fix": "vendor/bin/rector process",
         "test": "phpunit"
     },
     "config": {

rector.php

@@ -0,0 +1,56 @@
+<?php
+declare(strict_types=1);
+
+use Rector\Caching\ValueObject\Storage\FileCacheStorage;
+use Rector\CodeQuality\Rector\Class_\ConvertStaticToSelfRector;
+use Rector\CodeQuality\Rector\FuncCall\CompactToVariablesRector;
+use Rector\CodeQuality\Rector\If_\ExplicitBoolCompareRector;
+use Rector\CodingStyle\Rector\Assign\SplitDoubleAssignRector;
+use Rector\CodingStyle\Rector\Catch_\CatchExceptionNameMatchingTypeRector;
+use Rector\CodingStyle\Rector\Stmt\NewlineAfterStatementRector;
+use Rector\Config\RectorConfig;
+use Rector\DeadCode\Rector\ClassMethod\RemoveUselessReturnTagRector;
+use Rector\Php74\Rector\Closure\ClosureToArrowFunctionRector;
+use Rector\Php80\Rector\Class_\ClassPropertyAssignToConstructorPromotionRector;
+use Rector\Set\ValueObject\SetList;
+use Rector\TypeDeclaration\Rector\Class_\TypedPropertyFromCreateMockAssignRector;
+use Rector\TypeDeclaration\Rector\ClassMethod\ReturnTypeFromStrictFluentReturnRector;
+
+$cacheDir = getenv('RECTOR_CACHE_DIR') ?: sys_get_temp_dir() . DIRECTORY_SEPARATOR . 'rector';
+
+return RectorConfig::configure()
+    ->withPaths([
+        __DIR__ . '/src',
+        __DIR__ . '/tests',
+    ])
+
+    ->withCache(
+        cacheClass: FileCacheStorage::class,
+        cacheDirectory: $cacheDir,
+    )
+
+    ->withPhpSets()
+    ->withAttributesSets()
+
+    ->withSets([
+        SetList::CODE_QUALITY,
+        SetList::CODING_STYLE,
+        SetList::DEAD_CODE,
+        SetList::EARLY_RETURN,
+        SetList::INSTANCEOF,
+        SetList::TYPE_DECLARATION,
+    ])
+
+    ->withSkip([
+        ClassPropertyAssignToConstructorPromotionRector::class,
+        CatchExceptionNameMatchingTypeRector::class,
+        ClosureToArrowFunctionRector::class,
+        RemoveUselessReturnTagRector::class,
+        CompactToVariablesRector::class,
+        ReturnTypeFromStrictFluentReturnRector::class,
+        SplitDoubleAssignRector::class,
+        NewlineAfterStatementRector::class,
+        ExplicitBoolCompareRector::class,
+        TypedPropertyFromCreateMockAssignRector::class,
+        ConvertStaticToSelfRector::class,
+    ]);

src/Command/CompileCommand.php

@@ -13,9 +13,6 @@
 
 class CompileCommand extends BaseCommand
 {
-    /**
-     * @var \Cake\TwigView\View\TwigView
-     */
     protected TwigView $twigView;
 
     /**
@@ -64,7 +61,7 @@ public function execute(Arguments $args, ConsoleIo $io)
         $this->twigView = new $viewClass();
 
         // $type is validated by the 'choices' option in buildOptionsParser
-        return $this->{"execute{$type}"}($args, $io);
+        return $this->{'execute' . $type}($args, $io);
     }
 
     /**
@@ -79,7 +76,7 @@ protected function executeAll(Arguments $args, ConsoleIo $io): int
         $io->info('Compiling all templates');
 
         foreach (Scanner::all($this->twigView->getExtensions()) as $section => $templates) {
-            $io->info("Compiling section {$section}");
+            $io->info('Compiling section ' . $section);
             foreach ($templates as $template) {
                 if ($this->compileFile($io, $template) === static::CODE_ERROR) {
                     return static::CODE_ERROR;
@@ -106,7 +103,7 @@ protected function executePlugin(Arguments $args, ConsoleIo $io): int
             return static::CODE_ERROR;
         }
 
-        $io->info("Compiling plugin {$plugin}");
+        $io->info('Compiling plugin ' . $plugin);
         foreach (Scanner::plugin($plugin, $this->twigView->getExtensions()) as $template) {
             if ($this->compileFile($io, $template) === static::CODE_ERROR) {
                 return static::CODE_ERROR;
@@ -146,9 +143,9 @@ protected function compileFile(ConsoleIo $io, string $filename): int
     {
         try {
             $this->twigView->getTwig()->load($filename);
-            $io->success("Compiled {$filename}.");
+            $io->success(sprintf('Compiled %s.', $filename));
         } catch (Exception $exception) {
-            $io->error("Unable to compile {$filename}.");
+            $io->error(sprintf('Unable to compile %s.', $filename));
             $io->error($exception->getMessage());
 
             return static::CODE_ERROR;

src/Filesystem/RelativeScanner.php

@@ -77,15 +77,11 @@ protected static function strip(array $sections): array
      */
     protected static function stripAbsolutePath(array $paths, ?string $plugin = null): array
     {
-        if ($plugin === null) {
-            $allPaths = App::path('templates');
-        } else {
-            $allPaths = [Plugin::templatePath($plugin)];
-        }
+        $allPaths = $plugin === null ? App::path('templates') : [Plugin::templatePath($plugin)];
 
         foreach ($allPaths as $templatesPath) {
             array_walk($paths, function (&$path) use ($templatesPath): void {
-                if (substr($path, 0, strlen($templatesPath)) === $templatesPath) {
+                if (str_starts_with($path, $templatesPath)) {
                     $path = substr($path, strlen($templatesPath));
                 }
             });

src/Filesystem/Scanner.php

@@ -45,15 +45,15 @@ public static function all(array $extensions): array
 
         foreach (App::path('templates') as $path) {
             if (is_dir($path)) {
-                $sections['APP'] = $sections['APP'] ?? [];
+                $sections['APP'] ??= [];
                 $sections['APP'] = array_merge($sections['APP'], static::iteratePath($path, $extensions));
             }
         }
 
         foreach (static::pluginsWithTemplates() as $plugin) {
             $path = Plugin::templatePath($plugin);
             if (is_dir($path)) {
-                $sections[$plugin] = $sections[$plugin] ?? [];
+                $sections[$plugin] ??= [];
                 $sections[$plugin] = array_merge($sections[$plugin], static::iteratePath($path, $extensions));
             }
         }
@@ -101,7 +101,7 @@ protected static function pluginsWithTemplates(): array
     {
         $plugins = Plugin::loaded();
 
-        array_walk($plugins, function ($plugin, $index) use (&$plugins): void {
+        array_walk($plugins, function (string $plugin, $index) use (&$plugins): void {
             $path = Plugin::templatePath($plugin);
 
             if (!is_dir($path)) {
@@ -133,7 +133,7 @@ protected static function iteratePath(string $path, array $extensions): array
      */
     protected static function setupIterator(string $path, array $extensions): Iterator
     {
-        $extPattern = '(?:' . implode('|', array_map('preg_quote', $extensions)) . ')';
+        $extPattern = '(?:' . implode('|', array_map(preg_quote(...), $extensions)) . ')';
 
         return new RegexIterator(new RecursiveIteratorIterator(
             new RecursiveDirectoryIterator(
@@ -158,12 +158,8 @@ protected static function walkIterator(Iterator $iterator): array
         $items = [];
 
         $array = iterator_to_array($iterator);
-        uasort($array, function ($a, $b) {
-            if ($a == $b) {
-                return 0;
-            }
-
-            return $a < $b ? -1 : 1;
+        uasort($array, function ($a, $b): int {
+            return $a <=> $b;
         });
 
         foreach ($array as $paths) {

src/Filesystem/TreeScanner.php

@@ -90,7 +90,7 @@ protected static function convertToTree(array $paths): array
      */
     protected static function convertPathToTree(array &$paths, mixed $index, string $path): void
     {
-        if (strpos($path, DIRECTORY_SEPARATOR) !== false) {
+        if (str_contains($path, DIRECTORY_SEPARATOR)) {
             $chunks = explode(DIRECTORY_SEPARATOR, $path);
             $paths = static::branch($paths, $chunks);
             unset($paths[$index]);
@@ -107,7 +107,7 @@ protected static function convertPathToTree(array &$paths, mixed $index, string
     protected static function branch(array $paths, array $branches): array
     {
         $twig = array_shift($branches);
-        if (count($branches) === 0) {
+        if ($branches === []) {
             $paths[] = $twig;
 
             return $paths;

src/Panel/TwigPanel.php

@@ -30,8 +30,6 @@ class TwigPanel extends DebugPanel
 
     /**
      * Plugin name.
-     *
-     * @var string
      */
     public string $plugin = 'Cake/TwigView';
 

src/Twig/Extension/ArraysExtension.php

@@ -36,7 +36,7 @@ public function getFunctions(): array
         return [
             new TwigFunction('in_array', 'in_array'),
             new TwigFunction('explode', 'explode'),
-            new TwigFunction('array', function ($array) {
+            new TwigFunction('array', function ($array): array {
                 return (array)$array;
             }),
             new TwigFunction('array_push', 'array_push'),

src/Twig/Extension/BasicExtension.php

@@ -36,7 +36,7 @@ public function getFilters(): array
         return [
             new TwigFilter('env', 'Cake\Core\env'),
             new TwigFilter('h', 'Cake\Core\h'),
-            new TwigFilter('null', function () {
+            new TwigFilter('null', function (): string {
                 return '';
             }),
         ];

src/Twig/Extension/ConfigureExtension.php

@@ -18,6 +18,7 @@
 
 namespace Cake\TwigView\Twig\Extension;
 
+use Cake\Core\Configure;
 use Twig\Extension\AbstractExtension;
 use Twig\TwigFunction;
 
@@ -36,7 +37,7 @@ class ConfigureExtension extends AbstractExtension
     public function getFunctions(): array
     {
         return [
-            new TwigFunction('config', 'Cake\Core\Configure::read'),
+            new TwigFunction('config', Configure::class . '::read'),
         ];
     }
 }