feat: support SoftDeletes methods on relations

[jdrieghe]

• Added or updated tests
• Documented user facing changes
• Updated CHANGELOG.md

Issue: #690

Changes

This introduces additional test cases to prove there is a regression issue that was introduced in version 0.6.6.
Methods from the SoftDeletes trait are not recognized on Relations even though this is supported through ForwardsCalls in Laravel.

---

Note that this PR does not yet introduce a fix but aims to clarify the issue defined in #690. I tried coming up with a solution but couldn't find it yet. Any pointers as to how to approach this would be welcome.

[canvural]

Hi,

Thanks for the failing test case.

I tried to explain a little bit what has to be done here: #690 (comment)

Let me know if you have any more questions.

[jdrieghe]

@canvural I couldn't figure out how to return the proper MethodReflection for the SoftDeletes methods as they are added through a macro. I introduced the formerly used DummyMethodReflection for now to fix the BC break introduced in 0.6.6.

If you have a good solution on how to resolve the correct MethodReflection, I'm all ears. Thanks for your insights so far.

[canvural]

Hi,

Using DummyMethodReflection is not a good solution. We would lose the type information after the call.

As I wrote in #690 (comment) we should use the EloquentBuilderMethodReflection as the method reflection.

So in hasMethod method in RelationForwardsCallsExtension class, if $returnMethodReflection is null we need to check the method in model instead. $relatedModel->hasMethod($methodName)->yes() like this, and return the result.

Then in getMethod method again we can check if $returnMethodReflection is null we can return the reflection for the method with something like:

$originalMethodReflection = $relatedModelReflection->getMethod($methodName, new OutOfClassScope());

return new EloquentBuilderMethodReflection(
    $methodName, $classReflection, $originalMethodReflection,
    ParametersAcceptorSelector::selectSingle($originalMethodReflection->getVariants())->getParameters(),
    new GenericObjectType($classReflection->getName(), [$relatedModel]),
    false
);

I can push this fix this if you want 😊

[jdrieghe]

Thanks @canvural. It's working now with the correct MethodReflection. The biggest issue I had was figuring out what scope to use, so your example with the OutOfClassScope was very helpful 👏

[canvural]

Perfect, thank you! Will merge when the build passes.

[szepeviktor]

I was waiting for this as v0.6.6 was producing SoftDelete-related errors.
Thank you!

[jdrieghe]

@szepeviktor I encountered the issue on one of our internal projects, so it was mostly out of a personal need. Happy to have helped others though.

[canvural]

Released: https://github.com/nunomaduro/larastan/releases/tag/v0.6.7