Fabricator class

[MGatner]

Description
This is something I keep needing and finally set out to write a module for it, then realized it might be appropriate for the core framework.

Fabricator is a test utility used to create faked data based on Model definitions. Similar to Laravel's "factories" it creates instances of $model->returnType with random data generated by Faker.

Checklist:

• Add create() method for DB inserts and "faux" inserts
• Write unit tests
• Update User Guide
• Securely signed commits
• Component(s) with PHPdocs
• Conforms to style guide

[MGatner]

@lonnieezell et al, still a fair amount of work to do but please take a look at the concept and weigh in on if you consider this something for the core framework.

[lonnieezell]

@MGatner yes, I would love to have something like this. I've wanted it numerous times. :)

Only catch - it should be able to work for those who don't want to use Composer, unfortunately. Maybe a super simple class that spits out some semi-random stuff for a handful of common elements if Faker isn't present?

Another thought is to make it a Project instead. I don't have a problem with those requiring Composer.

[MGatner]

I understand the need to support non-Composer installations, but just to push back a little:

1. Faker would be a require-dev specification, and we already have a few that aren’t supported by downloads. This would be the first class that requires a Composer package outside of framework tests but it also is very specifically only for testing. I don’t feel the same need to support download-only unit tests as I do for projects, especially since the developer will already need to be downloading content (like PHPUnit).

2. It wouldn’t be hard to add a non-Composer version that always returns (say) a random string of characters. However the unit tests for this class and the code would suggest to a developer that certain formatters would return valid types (like “email”) which would then fail with our non-Composer version. I could see that being confusing.

[lonnieezell]

That's a fair point that testing already requires composer. That's convincing enough for me. :)

[MGatner]

I think this is ready! @lonnieezell take a look if you would. And anyone else who sees this, I'd appreciate feedback/suggestions/critiques. A lot harder to change things once they are released so let's make this good up front.

[lonnieezell]

All in all - I really like it. I was a little concerned at first about having to provide the formatters in each class. I could see that being a giant PITA to maintain consistency. but I think your solution of the fake() method in the model works well.

[MGatner]

Thanks! Re: formatters, I wanted to be sure there was a way people could run distinct tests without modifying models. I will probably always use extended models in Tests\Support with the fake() method like I described in the doc, but the option is there.

Looking over your comments now.

[MGatner]

Requested changes implemented!

[lonnieezell]

Looks great to me. I'm assuming nothing else you want to do to it? If so - feel free to merge!