[PHP 7.4] Fix literator separator string/int missmatch in PHPStan type (

#2913)

* add fixture failing scope

* fix printing of raw value and literal separator

.phpstorm.meta.php

@@ -47,6 +47,7 @@
     \PhpParser\Node::getAttribute(),
     0,
     \Rector\NodeTypeResolver\Node\AttributeKey::SCOPE,
+    \Rector\NodeTypeResolver\Node\AttributeKey::REPRINT_RAW_VALUE,
     \Rector\NodeTypeResolver\Node\AttributeKey::PARENT_NODE,
     \Rector\NodeTypeResolver\Node\AttributeKey::NEXT_NODE,
     \Rector\NodeTypeResolver\Node\AttributeKey::PREVIOUS_NODE,
@@ -67,6 +68,7 @@
     \PhpParser\Node::setAttribute(),
     0,
     \Rector\NodeTypeResolver\Node\AttributeKey::SCOPE,
+    \Rector\NodeTypeResolver\Node\AttributeKey::REPRINT_RAW_VALUE,
     \Rector\NodeTypeResolver\Node\AttributeKey::PARENT_NODE,
     \Rector\NodeTypeResolver\Node\AttributeKey::NEXT_NODE,
     \Rector\NodeTypeResolver\Node\AttributeKey::PREVIOUS_NODE,

packages/NodeTypeResolver/Node/AttributeKey.php

@@ -158,4 +158,10 @@ final class AttributeKey
      * @var string
      */
     public const PHP_ATTRIBUTE_NAME = 'php_attribute_name';
+
+    /**
+     * Helper attribute to reprint raw value of int/float/string
+     * @var string
+     */
+    public const REPRINT_RAW_VALUE = 'reprint_raw_value';
 }

phpstan.neon

@@ -551,8 +551,9 @@ parameters:
             message: '#Instead of "DateTime" class/interface use "Nette\\Utils\\DateTime"#'
             path: src/Application/VersionResolver.php
 
+        # complex multiprinter
         -
-            message: '#Class cognitive complexity is 55, keep it under 50#'
+            message: '#Class cognitive complexity is \d+, keep it under 50#'
             path: src/PhpParser/Printer/BetterStandardPrinter.php #41
 
         # validate class-string input

rules-tests/Php74/Rector/LNumber/AddLiteralSeparatorToNumberRector/Fixture/fixture.php.inc → rules-tests/Php74/Rector/LNumber/AddLiteralSeparatorToNumberRector/Fixture/big_floats.php.inc

@@ -2,12 +2,10 @@
 
 namespace Rector\Tests\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector\Fixture;
 
-class Fixture
+final class BigFloats
 {
     public function run()
     {
-        $int = 1000;
-        $int2 = 1000000;
         $float = 1000.0;
         $float2 = 1000000.0;
         $float3 = 1000500.001;
@@ -20,12 +18,10 @@ class Fixture
 
 namespace Rector\Tests\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector\Fixture;
 
-class Fixture
+final class BigFloats
 {
     public function run()
     {
-        $int = 1000;
-        $int2 = 1_000_000;
         $float = 1000.0;
         $float2 = 1_000_000.0;
         $float3 = 1_000_500.001;

rules-tests/Php74/Rector/LNumber/AddLiteralSeparatorToNumberRector/Fixture/big_integers.php.inc

@@ -0,0 +1,27 @@
+<?php
+
+namespace Rector\Tests\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector\Fixture;
+
+final class BigIntegers
+{
+    public function run()
+    {
+        $int2 = 1000000;
+    }
+}
+
+?>
+-----
+<?php
+
+namespace Rector\Tests\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector\Fixture;
+
+final class BigIntegers
+{
+    public function run()
+    {
+        $int2 = 1_000_000;
+    }
+}
+
+?>

rules-tests/Php74/Rector/LNumber/AddLiteralSeparatorToNumberRector/Fixture/skip_low_valuefixture.php.inc

@@ -0,0 +1,11 @@
+<?php
+
+namespace Rector\Tests\Php74\Rector\LNumber\AddLiteralSeparatorToNumberRector\Fixture;
+
+final class SkipLowValue
+{
+    public function run()
+    {
+        $int = 1000;
+    }
+}

rules/Php74/Rector/LNumber/AddLiteralSeparatorToNumberRector.php

@@ -128,7 +128,11 @@ public function refactor(Node $node): ?Node
             }
         }
 
-        $node->value = $literalSeparatedNumber;
+        // this cannot be integer directly to $node->value, as PHPStan sees it as error type
+        // @see https://github.com/rectorphp/rector/issues/7454
+        $node->setAttribute(AttributeKey::RAW_VALUE, $literalSeparatedNumber);
+        $node->setAttribute(AttributeKey::REPRINT_RAW_VALUE, true);
+        $node->setAttribute(AttributeKey::ORIGINAL_NODE, null);
 
         return $node;
     }

src/PhpParser/Printer/BetterStandardPrinter.php

@@ -18,6 +18,7 @@
 use PhpParser\Node\Name\FullyQualified;
 use PhpParser\Node\Scalar\DNumber;
 use PhpParser\Node\Scalar\EncapsedStringPart;
+use PhpParser\Node\Scalar\LNumber;
 use PhpParser\Node\Scalar\String_;
 use PhpParser\Node\Stmt\Class_;
 use PhpParser\Node\Stmt\ClassMethod;
@@ -252,8 +253,8 @@ protected function pSingleQuotedString(string $string): string
      */
     protected function pScalar_DNumber(DNumber $dNumber): string
     {
-        if (is_string($dNumber->value)) {
-            return $dNumber->value;
+        if ($this->shouldPrintNewRawValue($dNumber)) {
+            return (string) $dNumber->getAttribute(AttributeKey::RAW_VALUE);
         }
 
         return parent::pScalar_DNumber($dNumber);
@@ -469,6 +470,24 @@ protected function pModifiers(int $modifiers): string
             . (($modifiers & Class_::MODIFIER_READONLY) !== 0 ? 'readonly ' : '');
     }
 
+    /**
+     * Invoke re-print even if only raw value was changed.
+     * That allows PHPStan to use int strict types, while changing the value with literal "_"
+     */
+    protected function pScalar_LNumber(LNumber $lNumber): string|int
+    {
+        if ($this->shouldPrintNewRawValue($lNumber)) {
+            return (string) $lNumber->getAttribute(AttributeKey::RAW_VALUE);
+        }
+
+        return parent::pScalar_LNumber($lNumber);
+    }
+
+    private function shouldPrintNewRawValue(LNumber|DNumber $lNumber): bool
+    {
+        return $lNumber->getAttribute(AttributeKey::REPRINT_RAW_VALUE) === true;
+    }
+
     private function resolveContentOnExpr(Expr $expr, string $content): string
     {
         $parentNode = $expr->getAttribute(AttributeKey::PARENT_NODE);