Story pools

[kbond]

Closes #250.

Adds the following API to Story's:

final class ProvinceStory extends Story
{
    public function build(): void
    {
        // add collection to a "pool"
        $this->addToPool('be', ProvinceFactory::createMany(5, ['country' => 'BE']));

        // equivalent to above
        $this->addToPool('be', ProvinceFactory::new(['country' => 'BE'])->many(5));

        // add single object to a pool
        $this->addToPool('be', ProvinceFactory::createOne(['country' => 'BE']));

        // add single object to single pool and make available as "state"
        $this->addState('be-1', ProvinceFactory::createOne(['country' => 'BE']), 'be');
    }
}

Usage:

ProvinceStory::getRandom('be'); // random Proxy from "be" pool
ProvinceStory::getRandomSet('be', 3); // 3 random Proxy's from "be" pool
ProvinceStory::getRandomRange('be', 1, 4); // between 1 and 4 random Proxy's from "be" pool

TODO:

• Tests
• Docs

[kbond]

I believe this to be ready, @jmsche, @wouterj: mind giving a final review?

[kbond]

Thanks for the review @jmsche! Would you say this adequately solves #250 for you?

[jmsche]

Would you say this adequately solves #250 for you?

Yes, I think it should solve this issue.

Thanks for the review @jmsche!

And thank you for everything :)

[jmsche]

Hi Kevin, do you think you can create a new release including this new feature? Or are you waiting to finish an other PR first?

[kbond]

Done! https://github.com/zenstruck/foundry/releases/tag/v1.17.0

[jmsche]

Thank you for your fast reaction :)