Skip to content

Latest commit

 

History

History
executable file
·
133 lines (88 loc) · 3.1 KB

README.md

File metadata and controls

executable file
·
133 lines (88 loc) · 3.1 KB

Doctrine Fixtures

Build Status Quality Score Code Coverage Downloads Latest stable

Integration of nelmio/alice to Nette DI. This package adds .neon support to Alice.

Alice uses fzaninotto/Faker to generate fake data, so be sure to check that too.

Install

composer require zenify/doctrine-fixtures

Register extensions:

# app/config/config.neon
extensions:
	- Kdyby\Annotations\DI\AnnotationsExtension
	- Kdyby\Events\DI\EventsExtension
	doctrine: Kdyby\Doctrine\DI\OrmExtension
	fixtures: Zenify\DoctrineFixtures\DI\FixturesExtension

Configuration

# default values
fixtures:
	locale: "cs_CZ" # e.g. change to en_US in case you want to use English
	seed: 1

For all supported locales, just check Faker Providers.

Usage

We can load .neon/.yaml with specific fixtures structure. Alice turns them into entities and inserts them to database. To understand fixture files, just check the README of nelmio/alice.

For example, this fixture will create 100 products with generated name:

fixtures/products.neon

Zenify\DoctrineFixtures\Tests\Entity\Product:
	"product{1..100}":
		__construct: ["<shortName()>"]

You can also include other fixtures

fixtures/products.neon

include:
	- categories.neon

Zenify\DoctrineFixtures\Tests\Entity\Product:
	"product{1..100}":
		__construct: ["<shortName()>"]
		category: "@category@brand<numberBetween(1, 10)>"

fixtures/categories.neon

Zenify\DoctrineFixtures\Tests\Entity\Category:
	"category{1..10}":
		__construct: ["<shortName()>"]

And then we can load them:

use Zenify\DoctrineFixtures\Contract\Alice\AliceLoaderInterface;


class SomeClass
{

	/**
	 * @var AliceLoaderInterface
	 */
	private $aliceLoader;


	public function __construct(AliceLoaderInterface $aliceLoader)
	{
		$this->aliceLoader = $aliceLoader;
	}
	
	
	public function loadFixtures()
	{
		// arg can be used file(s) or dir(s) with fixtures
		$entities = $this->aliceLoader->load(__DIR__ . '/fixtures');
		// ...
	}

}

That's it!

Testing

composer check-cs
vendor/bin/phpunit

Contributing

Rules are simple:

  • new feature needs tests
  • all tests must pass
  • 1 feature per PR

We would be happy to merge your feature then!