Add fluent builder for Laravel

[GromNaN]

Related to PHPORM-103

Reopen #65

Create a fluent pipeline builder that can be used like this:

        $pipeline = (new class { use FluentFactoryTrait; })
            ->match(x: Query::eq(1))
            ->project(_id: false, x: true)
            ->sort(x: Sort::Asc)
            ->getPipeline();

[jmikola]

Would it make sense to throw here? What is the legitimate case where the method already exists and you'd want to NOP?

[GromNaN]

The method match is redefined in the Stage class. The generated version from the trait must be ignored.

[jmikola]

Noted. In this case, a comment would be helpful to clarify that you're giving preference to the redefined Stage methods instead of those from the trait. And this assumes you add the Stage methods before the trait (no need to repeat that, it's clear from the order of addMethod() calls in the generation method).

[GromNaN]

That's essentially what I said in the comment above.

[jmikola]

Oh, my mistake. I just realized this entire thread was incorrectly applied to the early return for non-public methods.

I see the comment below for skipping overridden methods. 👍

[GromNaN]

I converted the class to a trait, this allows to rename or change visibility of a method if necessary, and avoid issues that can be caused by inheritance.

[jmikola]

LGTM with the class/trait name replacements. Also note a suggestion to comment the addMethod() return statement.

[jmikola]

Suggested change

	* Generates a fluent factory class for aggregation pipeline stages.
	* Generates a fluent factory trait for aggregation pipeline stages.

Make a note to update other references of "class" to "trait" below. For instance, createFluentFactoryClass() should now be createFluentFactoryTrait().

This very class might also be better named FluentFactoryTraitGenerator().

[GromNaN]

I want to keep "Stage" in the generator class name.

[jmikola]

Should the generated file be FluentStageFactoryTrait.php in that case? I'll defer to you, as I'm not sure if you have future plans for more traits.

[GromNaN]

The file is in the Stage namespace.

[jmikola]

If this file is auto-generated, should it be labeled as such in .gitattributes?

[GromNaN]

We already have /src/Builder/Stage/*.php linguist-generated=true

[jmikola]

Noted. I'm not sure why GitHub opted not to present that explanation for hiding the file (maybe "large diffs" take precedence).