Enhancement: Add rector config file for easy migration

[OskarStark]

This PR is based on the work of https://github.com/thecodingmachine/safe

I have a lot of projects where I want to run a continuous automated refactoring for properties to methods, so I ended up repeating the following code over and over again:

$rectorConfig->ruleWithConfiguration(
    PropertyFetchToMethodCallRector::class,
    [
        new PropertyFetchToMethodCall(Generator::class, 'boolean', 'boolean'),
        new PropertyFetchToMethodCall(Generator::class, 'city', 'city'),
        new PropertyFetchToMethodCall(Generator::class, 'dateTime', 'dateTime'),
        new PropertyFetchToMethodCall(Generator::class, 'dateTimeThisYear', 'dateTimeThisYear'),
        new PropertyFetchToMethodCall(Generator::class, 'email', 'email'),
        new PropertyFetchToMethodCall(Generator::class, 'firstName', 'firstName'),
        new PropertyFetchToMethodCall(Generator::class, 'firstNameMale', 'firstNameMale'),
        new PropertyFetchToMethodCall(Generator::class, 'lastName', 'lastName'),
        new PropertyFetchToMethodCall(Generator::class, 'name', 'name'),
        new PropertyFetchToMethodCall(Generator::class, 'password', 'password'),
        new PropertyFetchToMethodCall(Generator::class, 'phoneNumber', 'phoneNumber'),
        new PropertyFetchToMethodCall(Generator::class, 'sentence', 'sentence'),
        new PropertyFetchToMethodCall(Generator::class, 'sha256', 'sha256'),
        new PropertyFetchToMethodCall(Generator::class, 'slug', 'slug'),
        new PropertyFetchToMethodCall(Generator::class, 'text', 'text'),
        new PropertyFetchToMethodCall(Generator::class, 'url', 'url'),
        new PropertyFetchToMethodCall(Generator::class, 'word', 'word'),
        new PropertyFetchToMethodCall(Generator::class, 'words', 'words'),
    ]);

I think it is better to provide this file via the vendor itself.
Check the README for usage details

Todos

• complete the list of deprecated properties

WDYT?

friendly ping @silasjoisten @mvhirsch @localheinz

[pimjansen]

I dont think this should be part of Faker itself. It would mean Faker has a locked dependency on Rector which is not what you want.

Just publish it as separate package? I think this would be the right thing to go here though

[pierredup]

It would mean Faker has a locked dependency on Rector which is not what you want.

There is no locked dependency, it is an optional extra file. If you use Rector in your project, you can use this additional config file, but if you don't use Rector, it won't be part of any of your dependencies

[OskarStark]

There is no locked dependency, it is an optional extra file. If you use Rector in your project, you can use this additional config file, but if you don't use Rector, it won't be part of any of your dependencies

Exactly 👍

[OskarStark]

Can someone please approve the new workflow to run? Thanks

[bram-pkg]

Should be running now.

[localheinz]

👍

[localheinz]

Thank you, @bram-pkg, @OskarStark, @pierredup, and @pimjansen!

[OskarStark]

Thank you, can I expect a release soon? 🙏

[DvDty]

What is the point of running rector on each PR, if the report is ignored?