ekiwok/quick-fixtures

Generate complex fixtures based on @var annotations.

0.9.1 2017-01-16 23:55 UTC

Requires

• php: >=5.6

Requires (Dev)

• phpspec/phpspec: ^3.0

MIT

README

• Did you ever add unnecessary setter because you didn't want to use reflections in fixtures?
• Did you give up on using value objects because writing fixtures this way was messy?
• Did you create trait to help with \DateTime creation in fixtures?

If anything above applies to you you may find this helpful.

This small library may quickly generate fixtures for you based on dockblock annotations that probably already are present in your code.

Provided generator accepts associative arrays so you may keep your fixtures data in file of your choice. It might be yaml, xml, csv, etc...

Fe. prepare yaml file like this:

    "Jake Weary":
        uuid: "123e4567-e89b-12d3-a456-426655440000"
        name: "Jake Weary"
        email: "[e-mail]"
        # Notice that for single property objects it's ok to skip property name
        credit: 100

And just use this data to generate fixture:

    $jakeWearyData = /* fetch "Jake Weary" entry from yml */

    $jakeWeary = $generator->generate(Customer::class, $jakeWearyData);

Instead of writing:

    $jakeWeary = new Customer(
        '123e4567-e89b-12d3-a456-426655440000',
        'Jake Weary',
        '[e-mail]',
        new Credit(100),
    );

or:

    $jakeWeary = (new Customer())
        ->setUUID('123e4567-e89b-12d3-a456-426655440000')
        ->setName('Jake Weary')
        ->setEmail'[e-mail]')
        ->setCredit(new Credit(100))
    ;

Installation

Install with composer: composer require ekiwok/quick-fixtures

Extending

It's easily extendable by adding your own processors.

    $generator->addProcessor(new class implements \Ekiwok\QuickFixtures\Processor\PrioritisedProcessorInterface{
    
        public function getPriority()
        {
            return 1025;
        }
    
        public function process(\Ekiwok\QuickFixtures\ContextInterface $context, $payload, \Ekiwok\QuickFixtures\GeneratorInterface $generator)
        {
            return new \DateTime($payload);
        }
    
        public function applies(\Ekiwok\QuickFixtures\ContextInterface $context, $payload)
        {
            $type = $context->getType();
            
            // in real life we would also check payload to be sure it
            // also makes sense
    
            return $type->hasAnyClass()
                && $type->hasClass(\DateTime::class);
        }
    });

Processor with this priority will be run before built in processors and will set all properties these are marked as @var \DateTime.

Documentation

• Getting Started
• Processors