NewObjectToFactoryCreateRector

[JanMikes]

Closes #981

Before

<?php

public function xyz()
{
    $a = new MyClass();
}

After

/** @var MyClassFactory */
private $myClassFactory;

public function xyz()
{
    $a = $this->myClassFactory->createMyClass();
}

[JanMikes]

@TomasVotruba please could you check my code?

I am getting weird error with this config:

Symfony\Component\DependencyInjection\Exception\InvalidArgumentException : The configuration key "Rector\Tests\Rector\Architecture\Factory\NewObjectToFactoryCreateRector\Source\MyClass" is unsupported for definition "Rector\Rector\Architecture\Factory\NewObjectToFactoryCreateRector" in "/Users/janmikes/Sites/rector/tests/Rector/Architecture/Factory/NewObjectToFactoryCreateRector/config.yml". Allowed configuration keys are "alias", "parent", "class", "shared", "synthetic", "lazy", "public", "abstract", "deprecated", "factory", "file", "arguments", "properties", "configurator", "calls", "tags", "decorates", "decoration_inner_name", "decoration_priority", "autowire", "autoconfigure", "bind".
 /Users/janmikes/Sites/rector/vendor/symfony/dependency-injection/Loader/YamlFileLoader.php:813
 /Users/janmikes/Sites/rector/vendor/symfony/dependency-injection/Loader/YamlFileLoader.php:341
 /Users/janmikes/Sites/rector/vendor/symfony/dependency-injection/Loader/YamlFileLoader.php:229
 /Users/janmikes/Sites/rector/vendor/symplify/package-builder/src/Reflection/PrivatesCaller.php:23
 /Users/janmikes/Sites/rector/vendor/symplify/package-builder/src/Yaml/FileLoader/AbstractParameterMergingYamlFileLoader.php:106
 /Users/janmikes/Sites/rector/vendor/symfony/config/Loader/DelegatingLoader.php:40
 /Users/janmikes/Sites/rector/src/DependencyInjection/RectorKernel.php:50
 /Users/janmikes/Sites/rector/vendor/symfony/http-kernel/Kernel.php:653
 /Users/janmikes/Sites/rector/vendor/symfony/http-kernel/Kernel.php:543
 /Users/janmikes/Sites/rector/vendor/symfony/http-kernel/Kernel.php:133
 /Users/janmikes/Sites/rector/src/DependencyInjection/ContainerFactory.php:26
 /Users/janmikes/Sites/rector/src/Testing/PHPUnit/AbstractRectorTestCase.php:142
 /Users/janmikes/Sites/rector/src/Testing/PHPUnit/AbstractRectorTestCase.php:64

[JanMikes]

Nevermind, i fixed that. Not using provideConfig() but getRectorConfiguration() did the trick 👍

[JanMikes]

@TomasVotruba call for help again, i digged into it a bit and found out that it does not matter whether i use provideConfig() or getRectorConfiguration() -> it does the same thing with only different syntax.

The problem is when using array in config:

services:
  Rector\Rector\Architecture\Factory\NewObjectToFactoryCreateRector:
    Rector\Tests\Rector\Architecture\Factory\NewObjectToFactoryCreateRector\Source\MyClass: []

It stops working. Could you please have a quick look at that?

[TomasVotruba]

The issue is, there is no constructor to autowire parameters to.

services:
    Rector\Rector\Architecture\Factory\NewObjectToFactoryCreateRector:
        anything...

is shortcut for

services:
    Rector\Rector\Architecture\Factory\NewObjectToFactoryCreateRector:
        arguments:
            anything...

Your Rector needs constructor to pass configuration into.

Inspire here:

rector/src/Rector/Class_/ClassReplacerRector.php

Lines 22 to 28 in 3872fa4

	/**
	* @param string[] $oldToNewClasses
	*/
	public function __construct(array $oldToNewClasses)
	{
	$this->oldToNewClasses = $oldToNewClasses;
	}

[TomasVotruba]

The issue is, there is no constructor to autowire parameters to.

services:
    Rector\Rector\Architecture\Factory\NewObjectToFactoryCreateRector:
        anything...

is shortcut for

services:
    Rector\Rector\Architecture\Factory\NewObjectToFactoryCreateRector:
        arguments:
            anything...

Your Rector needs constructor to pass configuration into.

Inspire here:

rector/src/Rector/Class_/ClassReplacerRector.php

Lines 22 to 28 in 3872fa4

	/**
	* @param string[] $oldToNewClasses
	*/
	public function __construct(array $oldToNewClasses)
	{
	$this->oldToNewClasses = $oldToNewClasses;
	}

[TomasVotruba]

<?php

final class NewObjectToFactoryCreateRector extends AbstractRector
{
    /**
     * @var string[][]
     */
    private $factoryWithMethodByObject;

    /**
     * @param string[][] $factoryWithMethodByObject
     */
    public function __construct(array $factoryWithMethodByObject)
    {
        $this->factoryWithMethodByObject = $factoryWithMethodByObject;
    }
    
    /**
     * @return string[]
     */
    public function getNodeTypes(): array
    {
        return [New_::class];
    }

    /**
     * @param New_ $node
     */
    public function refactor(Node $node): ?Node
    {
        foreach ($this->factoryWithMethodByObject as $type => $factoryWithMethod) {
            if (! $this->isType($node, $type)) {
                continue;
            }

            // refactor to MethodCall
            // add property
        }

        return $node;
    }
}

This will be then configured in config:

# rector.yml
services:
    NewObjectToFactoryCreateRector: # ← rector class
        # configuration array that will be passed as $factoryWithMethodByObject
        FirstObject: ['FirstFactory', 'method']
        SecondObject: ['SecondFactory', 'method']

↓ full syntax without magic. Normally people would have to write all this manually and be careful about typos in "factoryWithMethodByObject", which can be really annoying, because there is no error on typo of argument name.

services:
    NewObjectToFactoryCreateRector: # ← rector class
        arguments:
            $factoryWithMethodByObject:
                FirstObject: ['FirstFactory', 'method']
                SecondObject: ['SecondFactory', 'method']

[JanMikes]

Just to let you know, I have tried this and this does not work, that is why i asked and felt so weird:

# rector.yml
services:
    NewObjectToFactoryCreateRector: # ← rector class
        # configuration array that will be passed as $factoryWithMethodByObject
        FirstObject: ['FirstFactory', 'method']
        SecondObject: ['SecondFactory', 'method']

[TomasVotruba]

Could you push it? Now there is no array in constructor to put it to

[TomasVotruba]

It works as expected. Here is the change in code: https://github.com/rectorphp/rector/compare/new-object-to-factory-method-rector...quick-example?expand=1

[JanMikes]

@TomasVotruba working, rebased on master (solved conflicts) and ready to merge 😉

As well i squashed commits so all new feature is just in one commit: da068fd

[JanMikes]

Btw i did not test/cover edge cases - property already exists, factory already exists in different property in class etc.

[TomasVotruba]

@JanMikes I see some commits already in master. Could you rebase on it?

[TomasVotruba]

Feature works, nice 👍

Testing edge cases would be nice to have, but not neccesary. It's up to you.
I think we'll find them when using on Entrydo.

Also there is 1 fail on static analysis, please fix it:

https://travis-ci.org/rectorphp/rector/jobs/483997841#L661

[JanMikes]

Thank you, i fixed that and i will as well cover the edge cases, while i am already in it 😉

I think that history must be mistaken, i have just checked it and there are no commits in master yet -> i rebased this branch on master. Last my commit i can see in master is 31a5e9bcd2c44a1553fd7f17f4d4c563c138af3b

[TomasVotruba]

You pushed 10 minutes ago, that fixed the commits 👍

[TomasVotruba]

I will as well cover the edge cases, while i am already in it

Great 👍

[JanMikes]

This edge case covered by: https://github.com/rectorphp/rector/blob/43de77013c5ca172fb53a87cb35ec13e2391c289/tests/Rector/Architecture/Factory/NewObjectToFactoryCreateRector/Fixture/fixture2.php.inc

Now it is finally ready to merge 😉

Any feedback/code review is very appreciated

[TomasVotruba]

I'm on it :)

[TomasVotruba]

Btw, no need to rebase after each commit, just once in the end.
Now I don't know what's new since the last review and have to read whole code.

[TomasVotruba]

I've added what I could find. Very good job in effective code 👍

[TomasVotruba]

I've added what I could find. Very good job in effective code 👍

[TomasVotruba]

Great! Ready to merge for me 👍

[TomasVotruba]

Kaboom 🚀

[JanMikes]

Looking forward to get this tagged 😉 for now i will use dev-master dependency.