[code-quality] Add DirnameDirConcatStringToDirectStringPathRector (#7552)

* cs

* [code-quality] Add DirnameDirConcatStringToDirectStringPathRector

Author: TomasVotruba

rules-tests/CodeQuality/Rector/Concat/DirnameDirConcatStringToDirectStringPathRector/DirnameDirConcatStringToDirectStringPathRectorTest.php

@@ -0,0 +1,28 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Tests\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector;
+
+use Iterator;
+use PHPUnit\Framework\Attributes\DataProvider;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+
+final class DirnameDirConcatStringToDirectStringPathRectorTest extends AbstractRectorTestCase
+{
+    #[DataProvider('provideData')]
+    public function test(string $filePath): void
+    {
+        $this->doTestFile($filePath);
+    }
+
+    public static function provideData(): Iterator
+    {
+        return self::yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    public function provideConfigFilePath(): string
+    {
+        return __DIR__ . '/config/configured_rule.php';
+    }
+}

rules-tests/CodeQuality/Rector/Concat/DirnameDirConcatStringToDirectStringPathRector/Fixture/fixture.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector\Fixture;
+
+final class Fixture
+{
+    public function run()
+    {
+        $path = dirname(__DIR__) . '/file.txt';
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector\Fixture;
+
+final class Fixture
+{
+    public function run()
+    {
+        $path = __DIR__ . '/../file.txt';
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Concat/DirnameDirConcatStringToDirectStringPathRector/Fixture/skip_multi_dirnames.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector\Fixture;
+
+final class SkipMultiDirnames
+{
+    public function run()
+    {
+        $path = dirname(__DIR__, 3) . '/file.txt';
+    }
+}

rules-tests/CodeQuality/Rector/Concat/DirnameDirConcatStringToDirectStringPathRector/Fixture/skip_too_shart_paths.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector\Fixture;
+
+final class SkipTooShortPaths
+{
+    public function run()
+    {
+        $path = dirname(__DIR__) . 'file.txt';
+    }
+}

rules-tests/CodeQuality/Rector/Concat/DirnameDirConcatStringToDirectStringPathRector/Fixture/windows_paths.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector\Fixture;
+
+final class WindowsPaths
+{
+    public function run()
+    {
+        $path = dirname(__DIR__) . '\some\file.txt';
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector\Fixture;
+
+final class WindowsPaths
+{
+    public function run()
+    {
+        $path = __DIR__ . '\..\some\file.txt';
+    }
+}
+
+?>

rules-tests/CodeQuality/Rector/Concat/DirnameDirConcatStringToDirectStringPathRector/config/configured_rule.php

@@ -0,0 +1,10 @@
+<?php
+
+declare(strict_types=1);
+
+use Rector\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector;
+use Rector\Config\RectorConfig;
+
+return static function (RectorConfig $rectorConfig): void {
+    $rectorConfig->rules([DirnameDirConcatStringToDirectStringPathRector::class]);
+};

rules/CodeQuality/Rector/Concat/DirnameDirConcatStringToDirectStringPathRector.php

@@ -0,0 +1,99 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\CodeQuality\Rector\Concat;
+
+use PhpParser\Node;
+use PhpParser\Node\Expr\BinaryOp\Concat;
+use PhpParser\Node\Expr\FuncCall;
+use PhpParser\Node\Scalar\MagicConst\Dir;
+use PhpParser\Node\Scalar\String_;
+use Rector\Rector\AbstractRector;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\CodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+
+/**
+ * @see \Rector\Tests\CodeQuality\Rector\Concat\DirnameDirConcatStringToDirectStringPathRector\DirnameDirConcatStringToDirectStringPathRectorTest
+ */
+final class DirnameDirConcatStringToDirectStringPathRector extends AbstractRector
+{
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Change dirname() and string concat, to __DIR__ and direct string path', [
+            new CodeSample(
+                <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function run()
+    {
+        $path = dirname(__DIR__) . '/vendor/autoload.php';
+    }
+}
+CODE_SAMPLE
+                ,
+                <<<'CODE_SAMPLE'
+class SomeClass
+{
+    public function run()
+    {
+        $path = __DIR__ . '/../vendor/autoload.php';
+    }
+}
+CODE_SAMPLE
+            ),
+        ]);
+
+    }
+
+    public function getNodeTypes(): array
+    {
+        return [Concat::class];
+    }
+
+    /**
+     * @param Concat $node
+     */
+    public function refactor(Node $node): ?Concat
+    {
+        if (! $node->left instanceof FuncCall || ! $this->isName($node->left, 'dirname')) {
+            return null;
+        }
+
+        if (! $node->right instanceof String_) {
+            return null;
+        }
+
+        $dirnameFuncCall = $node->left;
+        if ($dirnameFuncCall->isFirstClassCallable()) {
+            return null;
+        }
+
+        // avoid multiple dir nesting for now
+        if (count($dirnameFuncCall->getArgs()) !== 1) {
+            return null;
+        }
+
+        $firstArg = $dirnameFuncCall->getArgs()[0];
+        if (! $firstArg->value instanceof Dir) {
+            return null;
+        }
+
+        $string = $node->right;
+        if (str_contains($string->value, '/')) {
+            // linux paths
+            $string->value = '/../' . ltrim($string->value, '/');
+            $node->left = new Dir();
+            return $node;
+        }
+
+        if (str_contains($string->value, '\\')) {
+            // windows paths
+            $string->value = '\\..\\' . ltrim($string->value, '\\');
+            $node->left = new Dir();
+            return $node;
+        }
+
+        return null;
+    }
+}

scripts/list-unused-rules.php

@@ -45,7 +45,6 @@
 
 $unusedRectorRules = array_diff($rectorClasses, $usedRectorRules);
 
-
 $symfonyStyle->newLine();
 $symfonyStyle->listing($unusedRectorRules);
 

src/NodeTypeResolver/NodeTypeCorrector.php

@@ -50,9 +50,6 @@ private function removeAccessoryArrayListType(Type $type): Type
             $cleanTypes[] = $intersectionType;
         }
 
-        //        dump($cleanTypes);
-        //        die;
-
         if (count($cleanTypes) === 1) {
             return $cleanTypes[0];
         }