Add RectorPHP

[internalsystemerror]

Q	A
Documentation	no
Bugfix	no
BC Break	no
New Feature	no
RFC	yes
QA	yes

Description

I thought I'd take a look at how we might use https://github.com/rectorphp/rector. This PR contains 2 commits to first add rector as a dependency with configuration, and then to actually run rector and see what has changed.

Its not my intention for this to merged as is, but as a demonstration to get feedback and help discuss an approach.

[weierophinney]

Overall this is very interesting as it highlights a number of changes that are easy to overlook as we bump versions.

[weierophinney]

This is the first change I'm not entirely clear on. I cannot remember what that third argument is supposed to be so seeing the 512 value makes me scratch my head. That said having an exception here makes a lot of sense since it will ensure that the assertion never gets run. I wonder if it can use named arguments here instead? Perhaps @samsonasik can answer that.

[Ocramius]

I think it would be best to use flags: JSON_THROW_ON_ERROR here

[internalsystemerror]

512 is the default value. Named parameters were introduced in PHP 8.0, so curious why it didn't use them for this. I guess this demonstrates that rector may be a start but it will nearly always required manual intervention?

[Ocramius]

Yes, it certainly always needs human review

[samsonasik]

I think JSON_THROW_ON_ERROR is fine here as this is test class

[samsonasik]

named arg currently used on rector for attribute creation

[Ocramius]

This is something I'd really like to see in our CI, rather than in a dev-dependency.

That said, it is fine here too, for now

[internalsystemerror]

There is no phar available for rector, and we could include it as a global dependency in CI, but that could lead to an introduced failure without any code changes in the repositories.

[Ocramius]

@internalsystemerror I would make a separate composer.lock just for that, installed globally in our CI container.

Not a problem for now though: just raising the idea :-)

Related: laminas/laminas-ci-matrix-action#131

[internalsystemerror]

No please keep it coming, thats the point of this PR as a draft, to get feedback!

[samsonasik]

Use pinned version 0.17.0 is better imo

[samsonasik]

This is my current config for some laminas components I run:

<?php

declare(strict_types=1);

use Rector\CodingStyle\Rector\ArrowFunction\StaticArrowFunctionRector;
use Rector\CodingStyle\Rector\Closure\StaticClosureRector;
use Rector\Config\RectorConfig;
use Rector\Php55\Rector\String_\StringClassNameToClassConstantRector;
use Rector\Php56\Rector\FunctionLike\AddDefaultValueForUndefinedVariableRector;
use Rector\Php70\Rector\FuncCall\RandomFunctionRector;
use Rector\Php71\Rector\FuncCall\CountOnNullRector;
use Rector\Php73\Rector\FuncCall\JsonThrowOnErrorRector;
use Rector\Privatization\Rector\Property\PrivatizeFinalClassPropertyRector;
use Rector\Set\ValueObject\LevelSetList;
use Rector\TypeDeclaration\Rector\ArrowFunction\AddArrowFunctionReturnTypeRector;
use Rector\TypeDeclaration\Rector\Closure\AddClosureReturnTypeRector;

return static function (RectorConfig $rectorConfig): void {
    $rectorConfig->sets([
        LevelSetList::UP_TO_PHP_80,
    ]);

    $rectorConfig->rules([
        StaticArrowFunctionRector::class,
        StaticClosureRector::class,
        AddClosureReturnTypeRector::class,
        PrivatizeFinalClassPropertyRector::class,
        AddArrowFunctionReturnTypeRector::class,
    ]);

    $rectorConfig->parallel();
    $rectorConfig->paths([
        __DIR__ . '/src',
        __DIR__ . '/test',
    ]);

    $rectorConfig->skip([
        // possibly too detail on some cases?
        CountOnNullRector::class,

        // possibly null undefined on purpose?
        AddDefaultValueForUndefinedVariableRector::class,

        // define list of services?
        StringClassNameToClassConstantRector::class,

        // not a secure lib on purpose?
        RandomFunctionRector::class,

        // probably handle after execute?
        JsonThrowOnErrorRector::class =>  [
            __DIR__ . '/src',
        ],
    ]);
};