Merge FollowRequireByDirRector to almost identical AbsolutizeRequireA…

…ndIncludePathRector (#2048)
rectorphp · Apr 10, 2022 · 60f1dad · 60f1dad
1 parent 0227d24
commit 60f1dad
Show file tree

Hide file tree

Showing 10 changed files with 95 additions and 175 deletions.
diff --git a/config/set/coding-style.php b/config/set/coding-style.php
@@ -20,7 +20,6 @@
 use Rector\CodingStyle\Rector\FuncCall\ConsistentPregDelimiterRector;
 use Rector\CodingStyle\Rector\FuncCall\VersionCompareFuncCallToConstantRector;
 use Rector\CodingStyle\Rector\If_\NullableCompareToNullRector;
-use Rector\CodingStyle\Rector\Include_\FollowRequireByDirRector;
 use Rector\CodingStyle\Rector\Plus\UseIncrementAssignRector;
 use Rector\CodingStyle\Rector\PostInc\PostIncDecToPreIncDecRector;
 use Rector\CodingStyle\Rector\Property\AddFalseDefaultToBoolPropertyRector;
@@ -44,7 +43,6 @@
     $services->set(SplitGroupedConstantsAndPropertiesRector::class);
     $services->set(StringClassNameToClassConstantRector::class);
     $services->set(ConsistentPregDelimiterRector::class);
-    $services->set(FollowRequireByDirRector::class);
     $services->set(CatchExceptionNameMatchingTypeRector::class);
     $services->set(UseIncrementAssignRector::class);
     $services->set(SplitDoubleAssignRector::class);

diff --git a/...uireByDirRector/Fixture/extra_dot.php.inc → ...cludePathRector/Fixture/extra_dot.php.inc b/...uireByDirRector/Fixture/extra_dot.php.inc → ...cludePathRector/Fixture/extra_dot.php.inc
@@ -1,6 +1,6 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\Include_\FollowRequireByDirRector\Fixture;
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
 
 class ExtraDot
 {
@@ -15,7 +15,7 @@ class ExtraDot
 -----
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\Include_\FollowRequireByDirRector\Fixture;
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
 
 class ExtraDot
 {

diff --git a/...equireByDirRector/Fixture/fixture.php.inc → ...cludePathRector/Fixture/full_list.php.inc b/...equireByDirRector/Fixture/fixture.php.inc → ...cludePathRector/Fixture/full_list.php.inc
@@ -1,8 +1,8 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\Include_\FollowRequireByDirRector\Fixture;
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
 
-class Fixture
+final class FullList
 {
     public function run()
     {
@@ -12,7 +12,7 @@ class Fixture
         require_once 'autoload.php';
         include 'autoload.php';
         include_once 'autoload.php';
-        require 'path/' . $variable;
+
         require $variable;
         require __DIR__ . $variable;
         require __DIR__ . 'string';
@@ -23,9 +23,9 @@ class Fixture
 -----
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\Include_\FollowRequireByDirRector\Fixture;
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
 
-class Fixture
+final class FullList
 {
     public function run()
     {
@@ -35,7 +35,7 @@ class Fixture
         require_once __DIR__ . '/autoload.php';
         include __DIR__ . '/autoload.php';
         include_once __DIR__ . '/autoload.php';
-        require __DIR__ . '/path/' . $variable;
+
         require $variable;
         require __DIR__ . $variable;
         require __DIR__ . 'string';

diff --git a/...lity/Rector/Include_/AbsolutizeRequireAndIncludePathRector/Fixture/inter_variable.php.inc b/...lity/Rector/Include_/AbsolutizeRequireAndIncludePathRector/Fixture/inter_variable.php.inc
@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
+
+final class InterVariable
+{
+    public function run(string $variable)
+    {
+        require 'path/' . $variable;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
+
+final class InterVariable
+{
+    public function run(string $variable)
+    {
+        require __DIR__ . '/path/' . $variable;
+    }
+}
+
+?>
diff --git a/...owRequireByDirRector/Fixture/phar.php.inc → ...AndIncludePathRector/Fixture/phar.php.inc b/...owRequireByDirRector/Fixture/phar.php.inc → ...AndIncludePathRector/Fixture/phar.php.inc
@@ -1,13 +1,12 @@
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\Include_\FollowRequireByDirRector\Fixture;
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
 
 class Phar
 {
     public function run()
     {
         require 'vendor/autoload.php';
-        require '/vendor/autoload.php';
         require 'phar://vendor/autoload.php';
     }
 }
@@ -16,13 +15,12 @@ class Phar
 -----
 <?php
 
-namespace Rector\Tests\CodingStyle\Rector\Include_\FollowRequireByDirRector\Fixture;
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
 
 class Phar
 {
     public function run()
     {
-        require __DIR__ . '/vendor/autoload.php';
         require __DIR__ . '/vendor/autoload.php';
         require 'phar://vendor/autoload.php';
     }

diff --git a/...Rector/Include_/AbsolutizeRequireAndIncludePathRector/Fixture/skip_absolute_paths.php.inc b/...Rector/Include_/AbsolutizeRequireAndIncludePathRector/Fixture/skip_absolute_paths.php.inc
@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\CodeQuality\Rector\Include_\AbsolutizeRequireAndIncludePathRector\Fixture;
+
+final class SkipAbsolutePaths
+{
+    public function run()
+    {
+        require '/vendor/autoload.php';
+    }
+}
diff --git a/...sts/CodingStyle/Rector/Include_/FollowRequireByDirRector/FollowRequireByDirRectorTest.php b/...sts/CodingStyle/Rector/Include_/FollowRequireByDirRector/FollowRequireByDirRectorTest.php
diff --git a/rules-tests/CodingStyle/Rector/Include_/FollowRequireByDirRector/config/configured_rule.php b/rules-tests/CodingStyle/Rector/Include_/FollowRequireByDirRector/config/configured_rule.php
diff --git a/rules/CodeQuality/Rector/Include_/AbsolutizeRequireAndIncludePathRector.php b/rules/CodeQuality/Rector/Include_/AbsolutizeRequireAndIncludePathRector.php
@@ -68,10 +68,22 @@ public function getNodeTypes(): array
      */
     public function refactor(Node $node): ?Node
     {
+        if ($node->expr instanceof Concat && $node->expr->left instanceof String_ && $this->isRefactorableStringPath(
+            $node->expr->left
+        )) {
+            $node->expr->left = $this->prefixWithDirConstant($node->expr->left);
+
+            return $node;
+        }
+
         if (! $node->expr instanceof String_) {
             return null;
         }
 
+        if (! $this->isRefactorableStringPath($node->expr)) {
+            return null;
+        }
+
         /** @var string $includeValue */
         $includeValue = $this->valueResolver->getValue($node->expr);
 
@@ -96,8 +108,42 @@ public function refactor(Node $node): ?Node
             $node->expr->value = '/' . $includeValue;
         }
 
-        $node->expr = new Concat(new Dir(), $node->expr);
+        $node->expr = $this->prefixWithDirConstant($node->expr);
 
         return $node;
     }
+
+    private function isRefactorableStringPath(String_ $string): bool
+    {
+        return ! \str_starts_with($string->value, 'phar://');
+    }
+
+    private function prefixWithDirConstant(String_ $string): Concat
+    {
+        $this->removeExtraDotSlash($string);
+        $this->prependSlashIfMissing($string);
+
+        return new Concat(new Dir(), $string);
+    }
+
+    /**
+     * Remove "./" which would break the path
+     */
+    private function removeExtraDotSlash(String_ $string): void
+    {
+        if (! \str_starts_with($string->value, './')) {
+            return;
+        }
+
+        $string->value = Strings::replace($string->value, '#^\.\/#', '/');
+    }
+
+    private function prependSlashIfMissing(String_ $string): void
+    {
+        if (\str_starts_with($string->value, '/')) {
+            return;
+        }
+
+        $string->value = '/' . $string->value;
+    }
 }
diff --git a/rules/CodingStyle/Rector/Include_/FollowRequireByDirRector.php b/rules/CodingStyle/Rector/Include_/FollowRequireByDirRector.php