[Downgrade] Add composer platform check (#4721)

rectorphp · Nov 27, 2020 · d962e3f · d962e3f
1 parent dade407
commit d962e3f
Show file tree

Hide file tree

Showing 11 changed files with 250 additions and 2 deletions.
diff --git a/composer.json b/composer.json
@@ -162,7 +162,8 @@
             "Rector\\Twig\\": "rules/twig/src",
             "Rector\\TypeDeclaration\\": "rules/type-declaration/src",
             "Rector\\VendorLocker\\": "packages/vendor-locker/src",
-            "Rector\\Carbon\\": "rules/carbon/src"
+            "Rector\\Carbon\\": "rules/carbon/src",
+            "Rector\\Downgrade\\": "rules/downgrade/src"
         }
     },
     "autoload-dev": {
@@ -281,7 +282,8 @@
             "Rector\\Utils\\PHPStanAttributeTypeSyncer\\": "utils/phpstan-attribute-type-syncer/src",
             "Rector\\Utils\\PHPStanStaticTypeMapperChecker\\": "utils/phpstan-static-type-mapper-checker/src",
             "Rector\\Utils\\ProjectValidator\\": "utils/project-validator/src",
-            "Rector\\Carbon\\Tests\\": "rules/carbon/tests"
+            "Rector\\Carbon\\Tests\\": "rules/carbon/tests",
+            "Rector\\Downgrade\\Tests\\": "rules/downgrade/tests"
         }
     },
     "scripts": {

diff --git a/config/set/downgrade-php71.php b/config/set/downgrade-php71.php
@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Rector\Downgrade\Rector\LNumber\ChangePhpVersionInPlatformCheckRector;
 use Rector\DowngradePhp71\Rector\ClassConst\DowngradeClassConstantVisibilityRector;
 use Rector\DowngradePhp71\Rector\FunctionLike\DowngradeNullableTypeParamDeclarationRector;
 use Rector\DowngradePhp71\Rector\FunctionLike\DowngradeNullableTypeReturnDeclarationRector;
@@ -14,4 +15,8 @@
     $services->set(DowngradeNullableTypeReturnDeclarationRector::class);
     $services->set(DowngradeVoidTypeReturnDeclarationRector::class);
     $services->set(DowngradeClassConstantVisibilityRector::class);
+    $services->set(ChangePhpVersionInPlatformCheckRector::class)
+        ->call('configure', [[
+            ChangePhpVersionInPlatformCheckRector::TARGET_PHP_VERSION => 70100,
+        ]]);
 };
diff --git a/config/set/downgrade-php72.php b/config/set/downgrade-php72.php
@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Rector\Downgrade\Rector\LNumber\ChangePhpVersionInPlatformCheckRector;
 use Rector\DowngradePhp72\Rector\FunctionLike\DowngradeParamObjectTypeDeclarationRector;
 use Rector\DowngradePhp72\Rector\FunctionLike\DowngradeReturnObjectTypeDeclarationRector;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -10,4 +11,8 @@
     $services = $containerConfigurator->services();
     $services->set(DowngradeParamObjectTypeDeclarationRector::class);
     $services->set(DowngradeReturnObjectTypeDeclarationRector::class);
+    $services->set(ChangePhpVersionInPlatformCheckRector::class)
+        ->call('configure', [[
+            ChangePhpVersionInPlatformCheckRector::TARGET_PHP_VERSION => 70200,
+        ]]);
 };
diff --git a/config/set/downgrade-php73.php b/config/set/downgrade-php73.php
@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Rector\Downgrade\Rector\LNumber\ChangePhpVersionInPlatformCheckRector;
 use Rector\DowngradePhp73\Rector\List_\DowngradeListReferenceAssignmentRector;
 use Rector\DowngradePhp73\Rector\String_\DowngradeFlexibleHeredocSyntaxRector;
 use Symfony\Component\DependencyInjection\Loader\Configurator\ContainerConfigurator;
@@ -10,4 +11,8 @@
     $services = $containerConfigurator->services();
     $services->set(DowngradeFlexibleHeredocSyntaxRector::class);
     $services->set(DowngradeListReferenceAssignmentRector::class);
+    $services->set(ChangePhpVersionInPlatformCheckRector::class)
+        ->call('configure', [[
+            ChangePhpVersionInPlatformCheckRector::TARGET_PHP_VERSION => 70300,
+        ]]);
 };
diff --git a/config/set/downgrade-php74.php b/config/set/downgrade-php74.php
@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Rector\Downgrade\Rector\LNumber\ChangePhpVersionInPlatformCheckRector;
 use Rector\DowngradePhp74\Rector\Array_\DowngradeArraySpreadRector;
 use Rector\DowngradePhp74\Rector\ArrowFunction\ArrowFunctionToAnonymousFunctionRector;
 use Rector\DowngradePhp74\Rector\Coalesce\DowngradeNullCoalescingOperatorRector;
@@ -20,4 +21,8 @@
     $services->set(DowngradeStripTagsCallWithArrayRector::class);
     $services->set(DowngradeArraySpreadRector::class);
     $services->set(DowngradeArrayMergeCallWithoutArgumentsRector::class);
+    $services->set(ChangePhpVersionInPlatformCheckRector::class)
+        ->call('configure', [[
+            ChangePhpVersionInPlatformCheckRector::TARGET_PHP_VERSION => 70400,
+        ]]);
 };
diff --git a/config/set/downgrade-php80.php b/config/set/downgrade-php80.php
@@ -2,6 +2,7 @@
 
 declare(strict_types=1);
 
+use Rector\Downgrade\Rector\LNumber\ChangePhpVersionInPlatformCheckRector;
 use Rector\DowngradePhp80\Rector\FunctionLike\DowngradeParamMixedTypeDeclarationRector;
 use Rector\DowngradePhp80\Rector\FunctionLike\DowngradeReturnMixedTypeDeclarationRector;
 use Rector\DowngradePhp80\Rector\FunctionLike\DowngradeReturnStaticTypeDeclarationRector;
@@ -18,4 +19,8 @@
     $services->set(DowngradeParamMixedTypeDeclarationRector::class);
     $services->set(DowngradeReturnMixedTypeDeclarationRector::class);
     $services->set(DowngradeReturnStaticTypeDeclarationRector::class);
+    $services->set(ChangePhpVersionInPlatformCheckRector::class)
+        ->call('configure', [[
+            ChangePhpVersionInPlatformCheckRector::TARGET_PHP_VERSION => 80000,
+        ]]);
 };
diff --git a/rector-ci.php b/rector-ci.php
@@ -76,6 +76,7 @@
         '*/Fixture/*',
         '*/Source/*',
         '*/Expected/*',
+
         __DIR__ . '/packages/doctrine-annotation-generated/src',
         // template files
         __DIR__ . '/packages/rector-generator/templates',

diff --git a/rules/downgrade/src/Rector/LNumber/ChangePhpVersionInPlatformCheckRector.php b/rules/downgrade/src/Rector/LNumber/ChangePhpVersionInPlatformCheckRector.php
@@ -0,0 +1,151 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Downgrade\Rector\LNumber;
+
+use Nette\Utils\Strings;
+use PhpParser\Node;
+use PhpParser\Node\Expr\BinaryOp\Greater;
+use PhpParser\Node\Expr\BinaryOp\GreaterOrEqual;
+use PhpParser\Node\Scalar\LNumber;
+use PhpParser\Node\Scalar\String_;
+use Rector\Core\Contract\Rector\ConfigurableRectorInterface;
+use Rector\Core\Rector\AbstractRector;
+use Rector\Core\Util\PhpVersionFactory;
+use Rector\NodeTypeResolver\Node\AttributeKey;
+use Symplify\RuleDocGenerator\ValueObject\CodeSample\ConfiguredCodeSample;
+use Symplify\RuleDocGenerator\ValueObject\RuleDefinition;
+use Webmozart\Assert\Assert;
+
+/**
+ * @see https://php.watch/articles/composer-platform-check
+ * @see https://getcomposer.org/doc/06-config.md#platform-check
+ *
+ * @see \Rector\Downgrade\Tests\Rector\LNumber\ChangePhpVersionInPlatformCheckRector\ChangePhpVersionInPlatformCheckRectorTest
+ */
+final class ChangePhpVersionInPlatformCheckRector extends AbstractRector implements ConfigurableRectorInterface
+{
+    /**
+     * @var string
+     */
+    public const TARGET_PHP_VERSION = 'target_php_version';
+
+    /**
+     * @see https://regex101.com/r/oVWPoe/1/
+     * @var string
+     */
+    private const PHP_VERSION_REGEX = '#(?<sign>>=|>) (?<version>\d\.\d\.\d)#';
+
+    /**
+     * @var int
+     */
+    private $targetPhpVersion;
+
+    /**
+     * @var PhpVersionFactory
+     */
+    private $phpVersionFactory;
+
+    public function __construct(PhpVersionFactory $phpVersionFactory)
+    {
+        $this->phpVersionFactory = $phpVersionFactory;
+    }
+
+    public function getRuleDefinition(): RuleDefinition
+    {
+        return new RuleDefinition('Change `vendor/composer/platform_check.php` to desired minimal PHP version', [
+            new ConfiguredCodeSample(
+                <<<'CODE_SAMPLE'
+$issues = [];
+
+if (!(PHP_VERSION_ID >= 70300)) {
+    $issues[] = 'Your Composer dependencies require a PHP version ">= 7.3.0". You are running ' . PHP_VERSION  .  '.';
+}
+CODE_SAMPLE
+,
+                <<<'CODE_SAMPLE'
+$issues = [];
+
+if (!(PHP_VERSION_ID >= 70100)) {
+    $issues[] = 'Your Composer dependencies require a PHP version ">= 7.1.0". You are running ' . PHP_VERSION  .  '.';
+}
+CODE_SAMPLE
+,
+                [
+                    self::TARGET_PHP_VERSION => 70100,
+                ]
+            ),
+        ]);
+    }
+
+    /**
+     * @return string[]
+     */
+    public function getNodeTypes(): array
+    {
+        return [LNumber::class, String_::class];
+    }
+
+    /**
+     * @param LNumber|String_ $node
+     */
+    public function refactor(Node $node): ?Node
+    {
+        if ($node instanceof LNumber) {
+            return $this->refactorLNumber($node);
+        }
+
+        if ($node instanceof String_) {
+            return $this->refactorString($node);
+        }
+
+        return null;
+    }
+
+    /**
+     * @param mixed[] $configuration
+     */
+    public function configure(array $configuration): void
+    {
+        $targetPhpVersion = $configuration[self::TARGET_PHP_VERSION] ?? null;
+        Assert::integer($targetPhpVersion);
+
+        $this->targetPhpVersion = $targetPhpVersion;
+    }
+
+    private function refactorLNumber(LNumber $lNumber): ?LNumber
+    {
+        if (Strings::length((string) $lNumber->value) !== 5) {
+            return null;
+        }
+
+        $parent = $lNumber->getAttribute(AttributeKey::PARENT_NODE);
+        if (! $parent instanceof Greater && ! $parent instanceof GreaterOrEqual) {
+            return null;
+        }
+
+        return new LNumber($this->targetPhpVersion);
+    }
+
+    private function refactorString(String_ $string): ?String_
+    {
+        $match = Strings::match($string->value, self::PHP_VERSION_REGEX);
+        if ($match === null) {
+            return null;
+        }
+
+        $stringPhpVersion = $this->phpVersionFactory->createStringVersion($this->targetPhpVersion);
+        $changedContent = Strings::replace($string->value, self::PHP_VERSION_REGEX, function (array $match) use (
+            $stringPhpVersion
+        ): string {
+            return $match['sign'] . ' ' . $stringPhpVersion;
+        });
+
+        if ($string->value === $changedContent) {
+            return null;
+        }
+
+        return new String_($changedContent);
+    }
+}
diff --git a/...umber/ChangePhpVersionInPlatformCheckRector/ChangePhpVersionInPlatformCheckRectorTest.php b/...umber/ChangePhpVersionInPlatformCheckRector/ChangePhpVersionInPlatformCheckRectorTest.php
@@ -0,0 +1,38 @@
+<?php
+
+declare(strict_types=1);
+
+namespace Rector\Downgrade\Tests\Rector\LNumber\ChangePhpVersionInPlatformCheckRector;
+
+use Iterator;
+use Rector\Downgrade\Rector\LNumber\ChangePhpVersionInPlatformCheckRector;
+use Rector\Testing\PHPUnit\AbstractRectorTestCase;
+use Symplify\SmartFileSystem\SmartFileInfo;
+
+final class ChangePhpVersionInPlatformCheckRectorTest extends AbstractRectorTestCase
+{
+    /**
+     * @dataProvider provideData()
+     */
+    public function test(SmartFileInfo $fileInfo): void
+    {
+        $this->doTestFileInfo($fileInfo);
+    }
+
+    public function provideData(): Iterator
+    {
+        return $this->yieldFilesFromDirectory(__DIR__ . '/Fixture');
+    }
+
+    /**
+     * @return mixed[]
+     */
+    protected function getRectorsWithConfiguration(): array
+    {
+        return [
+            ChangePhpVersionInPlatformCheckRector::class => [
+                ChangePhpVersionInPlatformCheckRector::TARGET_PHP_VERSION => 70100,
+            ],
+        ];
+    }
+}
diff --git a/...ngrade/tests/Rector/LNumber/ChangePhpVersionInPlatformCheckRector/Fixture/fixture.php.inc b/...ngrade/tests/Rector/LNumber/ChangePhpVersionInPlatformCheckRector/Fixture/fixture.php.inc
@@ -0,0 +1,23 @@
+<?php
+
+namespace Rector\Downgrade\Tests\Rector\LNumber\ChangePhpVersionInPlatformCheckRector\Fixture;
+
+$issues = [];
+
+if (!(PHP_VERSION_ID >= 70300)) {
+    $issues[] = 'Your Composer dependencies require a PHP version ">= 7.3.0". You are running ' . PHP_VERSION  .  '.';
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Downgrade\Tests\Rector\LNumber\ChangePhpVersionInPlatformCheckRector\Fixture;
+
+$issues = [];
+
+if (!(PHP_VERSION_ID >= 70100)) {
+    $issues[] = 'Your Composer dependencies require a PHP version ">= 7.1". You are running ' . PHP_VERSION  .  '.';
+}
+
+?>
diff --git a/src/Util/PhpVersionFactory.php b/src/Util/PhpVersionFactory.php
@@ -4,6 +4,8 @@
 
 namespace Rector\Core\Util;
 
+use PHPStan\Php\PhpVersion;
+
 final class PhpVersionFactory
 {
     public function createIntVersion(string $version): int
@@ -26,4 +28,10 @@ public function createIntVersion(string $version): int
 
         return (int) $version;
     }
+
+    public function createStringVersion(int $version): string
+    {
+        $phpVersion = new PhpVersion($version);
+        return $phpVersion->getVersionString();
+    }
 }