Improve documentation of rule "TypedPropertyFromCreateMockAssignRector"

[jmfeurprier]

Like reporters of issues 9124 and 9126, I was surprised of the behavior of the new TypedPropertyFromCreateMockAssignRector rule (MockObject & ObjectClass union type being replaced by the single MockObject type).

In both ticket, the answer was:

Purpose of this rule is different, feel free to skip it.

Documentation of this rule states:

Add typed property from assigned mock

and the code example shows the rule adds MockObject when there is no type defined.

I think the documentation needs a longer explanation of the purpose, as it will, I think, drive other rector users to the issues/documentation pages due to the "surprising" behavior.

Thanks for the great tool!

[TomasVotruba]

Thanks for feedback. How exactly would you update the docs to avoid such confussion in the future?

[jmfeurprier]

Thanks for the quick answer. To be honest, I am not even sure what the purpose of the rule is.

This is the one and only rule I have to explicitly skip in all my rector config files (from the full typeDeclarations prepared set) because it introduces some inconsistencies (broken IDE auto-completion + phpstan error), as its application does not reflect the exact type returned by the createMock() method.

Instead, let me ask you: what is the exact purpose of this rule?

[TomasVotruba]

Ah, I see. This rule should not be probably part of "typeDeclarations" set, for the reason you describe.
I think better fit is PHPUnit code quality, something not mainstream, that you turn of specifically knowing what the rule does.

Purpose of this rule is to:

1. add MockObject type if missing, easy path
2. override incompatible type, e.g. SomeService, if actually MockObject is used

Based on given feedback, I think the goal is not to override MockObject&SomeService per-se. We could skip that to improve DX.

[github-actions]

This issue has been automatically locked because it has been closed for 150 days. Please open a new issue if you have a similar problem.