Print int custom raw value

[Orest-Divintari]

There is a use case where via rector we convert an integer from this format 1050 to 10_50 which represents for example $10.50

This was supported by rector but after this pr that is not supported anymore.

If you create a new Int_(10_50) the printer will print it as 1050

So i created this pr to add it here if that makes sense
If not, could you please let me know if there is an alternative solution to separate with _ integer values ?

[theofidry]

There is a version of the printer for which the node formatting is preserved (within reason). Maybe that could be done there automatically rather than hiding it behind an undocumented flag.

[Orest-Divintari]

There is a version of the printer for which the node formatting is preserved (within reason). Maybe that could be done there automatically rather than hiding it behind an undocumented flag.

Thanks for replying!
I want to clarify the use case: I'm not trying to preserve existing formatting, but rather transform the formatting of parsed integers.

For example, in a Cash context where amounts are in cents:

• Original: new Cash(1050)
• Desired output: new Cash(10_50) (for readability of $10.50)

[ruudk]

There is a version of the printer for which the node formatting is preserved (within reason). Maybe that could be done there automatically rather than hiding it behind an undocumented flag.

It's true, when using the preserving formatter, this is kept. But that's the point. We want to change existing integers and format them using underscores. That means that we don't want to preserve, want a complete new representation. Therefore, the preserving formatter does not have a role.

$node = Int_::fromString('12_34');

// object(PhpParser\Node\Scalar\Int_)#2 (2) {
//  ["attributes":protected]=>
//  array(2) {
//    ["rawValue"]=>
//    string(5) "12_34"
//    ["kind"]=>
//    int(10)
//  }
//  ["value"]=>
//  int(1234)
// }
var_dump($node);

echo new Standard()->prettyPrintExpr($node); // returns 1234 while we expect 12_34

So there is no way with the Standard printer, and plain AST, to write it to format 12_34.

[ruudk]

@samsonasik What do you think of this? I think it makes a lot of sense. Would be great if you could do a review as well.

[samsonasik]

This should apply on float values as well?

[staabm]

Would be interesting to see how much slower this additional calls will be when pretty-printing a reasonable big code file (especially for those not opt-in into the feature)

[ruudk]

Any idea how to prevent the slowdown?

[samsonasik]

how about add something like Kind::RAW_VALUE ?

[Orest-Divintari]

i used the raw value approach

[ruudk]

@staabm Thanks for the review, would you mind having another look at the updated PR? Would be great to have your approval too. Thanks 🙏

[Orest-Divintari]

This should apply on float values as well?

the float method does not reach to the kind attribute
If the concern for performance regarding the int method was to reach to another attribute
Does that apply here as well ?

Meaning,
Will it slow down if we check for the kind attribute in the float method ?

[samsonasik]

Looks good to me 👍

I think this can be starter, another scalar values can follow this if this merged 👍

[samsonasik]

I think rawValue attribute need to be added as well here, ensure rawValue is added as well before returned.

Suggested change

	return new Int_((int) $str, $attributes);
	$attributes['rawValue'] = $str;
	return new Int_((int) $str, $attributes);

so the value is always there to avoid changed on reprinting later.

if needed, move $attributes['rawValue'] = $str; to early before the if.

[Orest-Divintari]

$str is not the raw value
if you override the raw value with $str then this new change will do nothing
the goal is to be able to set the raw value yourself and print that instead of $str
$attributes['rawValue'] = $str;

[samsonasik]

okay 👍 let's see @nikic opinion about this or if there is better way for this :)

[ruudk]

@nikic I know you are probably very busy, but if you have time, would you mind giving this a review? This will help us a lot in Rector. Thanks 🙏