Fixtures documentation generator
This Symfony bundle generates and exposes a documentation of your fixtures. An action to reload your fixtures can also be configured.
The goal of this bundle is to allow testers to be independent, they can see data and reload fixtures when they want to test again.
It will generate a json file with all the data to be used in a twig page to display fixtures to the end user.
To add data to this json file you can process full manually, manually by passing the entity or full automatically. The main data to know of are : the type of the fixture (section title), the id of the fixture and the data of the fixture.
It will display a page with a menu corresponding to the different sections (with links), and data tables regrouped by section. If you used links, it will display some columns with visible links to go directly to the linked object.
When it encounter a property it can have 3 behaviors :
- If it's a simple (scalar) property, it will display it (string, bool, int, etc)
- If it's an array, it will display the total of elements in this array
- If it's an object and it got a __toString public method, it will display the result of this method. If this class is in your configuration of entities, it will add a link toward it.
Some external projects are available to see and test the behavior of this bundle. You'll have to clone it next to this bundle and follow the documentation to make it work and see the prepared result by yourself.
- The project for Manual case : if you want to manually manage your documentation
- The project for Doctrine automatic case : if you use doctrine and just want to configure entities and properties to document and let the bundle do
- The project for Alice case : if you load fixtures through Alice bundle and want to let the bundle do with your configuration
composer require --dev adlarge/fixtures-documentation-bundle
The default url to access the documentation is /fixtures/doc
Add the bundle to your
return [ // ... Adlarge\FixturesDocumentationBundle\AdlargeFixturesDocumentationBundle::class => ['dev' => true], // ... ];
Add the routing file
config/routes/dev/adlarge_fixtures_documentation.yaml and paste the following content :
AdlargeFixturesDocumentation: resource: '@AdlargeFixturesDocumentationBundle/Resources/config/routing.yml'
You can define vars by creating the file
adlarge_fixtures_documentation: title: 'Your title' reloadCommands: - php bin/console doctrine:fixtures:load - .... listenedCommand: 'doctrine:fixtures:load' enableAutoDocumentation: true fileDest: '%kernel.project_dir%/custom-folder' configEntities: Product: - id - name - category Customer: - firstname - lastname
- title - has a default value 'Fixtures documentation'
- listenedCommand - has a default value 'doctrine:fixtures:load'. For Alice bundle, you can set it to 'hautelook:fixtures:load'
- reloadCommand - is an optional array of commands you want to run from the view. If present a button to run these command will be visible in this view
- enableAutoDocumentation - is a boolean default to false. Set it to true if you want that all entities in fixtures are auto documented in postPersist
- fileDest - override default documentation file location in var folder
- configEntities - is an optional array of configurations for your entities you want to auto-document
Then you can install assets :
php bin/console assets:install --symlink
You can use 'enableAutoDocumentation' configuration. If set to 'True' this configuration will automatically document all objects according to 'configEntities' configuration when they are postPersist in database.
The postPersist is checked only where you configure the bundle (hopefully dev and test/acceptance) and when you launch the listenedCommand.
The examples are based on the following entities and properties
- 1 Customer, John Doe with
- 2 Products, linked to John Doe with
All of their properties have public getter to access them
With this example configuration
adlarge_fixtures_documentation: title: Documentation auto enableAutoDocumentation: true
You just have to persist entities in the code when your listenedCommand is resolved
$john = (new Customer()) ->setFirstname('John') ->setLastname('Doe') ->setEmail('firstname.lastname@example.org'); $manager->persist($john); $product = (new Product()) ->setName("Product 1") ->setCategory("Category 1") ->setOwner($john) ->setTags(['tag1', 'tag2']); $manager->persist($product); $product = (new Product()) ->setName("Product 2") ->setCategory("Category 2") ->setOwner($john) ->setTags(['tag2', 'tag2', 'tag3']); $manager->flush();
With this example configuration
adlarge_fixtures_documentation: title: Documentation alice enableAutoDocumentation: true listenedCommand: hautelook:fixtures:load reloadCommands: - php bin/console hautelook:fixtures:load
You can then use the yaml configuration to load entities
App\Entity\Customer: john: firstname: John lastname: Doe email: email@example.com App\Entity\Product: product1: name: product 1 owner: '@john' product2: name: product 2 owner: '@john'
Both ways will follow this rule to auto document your entities :
It will take all public methods starting with 'get' and use them to document each entity.
More configuration options are available in this doc
To generate the doc you only have to run
php bin/console doctrine:fixtures:load or the command you've configured on your project.
To make it run on your environment you have to install :
composer php (7.1 or higher) PHP extensions * php-xml * php-mbstring * php-xdebug
To run tests on your env, run these commands. Each dev must cover 100% of code before PR
make test make coverage