Add support for service factories (#283)

* Add support for service factories
* Housekeeping

Author: theofidry

.php_cs

@@ -16,6 +16,11 @@ env:
     - PHPUNIT_CONFIG='phpunit.xml.dist'
     - PHPUNIT_FLAGS='--stop-on-failure --verbose'
 
+cache:
+  directories:
+    - $HOME/.composer/cache/files
+    - $HOME/.bin/
+
 services:
   - mysql
 
@@ -26,7 +31,7 @@ matrix:
       env:
         - COMPOSER_FLAGS="--prefer-lowest"
         - COVERAGE="true"
-        - PHPUNIT_FLAGS="--coverage-text --coverage-clover=coverage.xml"
+        - PHPUNIT_FLAGS="--stop-on-failure --verbose --coverage-text --coverage-clover=coverage.xml"
         - SYMFONY_VERSION="~3.1.0"
     - php: '7.0'
       env: SYMFONY_VERSION='~3.2.0@dev'
@@ -35,11 +40,6 @@ matrix:
     - php: '7.1'
     - env: SYMFONY_VERSION='~3.2.0@dev'
 
-cache:
-  directories:
-    - $HOME/.composer/cache/files
-    - $HOME/.bin/
-
 before_install:
   - set -eo pipefail
   - echo "memory_limit=-1" >> ~/.phpenv/versions/$(phpenv version-name)/etc/conf.d/travis.ini

.styleci.yml

@@ -25,9 +25,10 @@ project to know which database/ORM is supported.
 3. [Advanced usage](doc/advanced-usage.md)
     1. [Enabling databases](doc/advanced-usage.md#enabling-databases)
     2. [Environment specific fixtures](doc/advanced-usage.md#environment-specific-fixtures)
-    2. [Fixtures parameters](doc/advanced-usage.md#fixtures-parameters)
+    3. [Fixtures parameters](doc/advanced-usage.md#fixtures-parameters)
         1. [Alice parameters](doc/advanced-usage.md#alice-parameters)
-        1. [Application parameters](doc/advanced-usage.md#application-parameters)
+        2. [Application parameters](doc/advanced-usage.md#application-parameters)
+    4. [Use service factories](doc/advanced-usage.md#use-service-factories)
 4. [Custom Faker Providers](doc/faker-providers.md)
 5. [Custom Alice Processors](doc/alice-processors.md)
 7. [Resources](#resources)

.travis.yml

@@ -0,0 +1,12 @@
+#!/usr/bin/env bash
+
+#
+# This file is part of the Hautelook\AliceBundle package.
+#
+# (c) Baldur Rensch <[email protected]>
+#
+# For the full copyright and license information, please view the LICENSE
+# file that was distributed with this source code.
+#
+
+rm -rf fixtures/Functional/cache/*ch

README.md

@@ -33,32 +33,16 @@
         "symfony/finder": "^2.7||^3.0"
     },
     "require-dev": {
-        "sllh/php-cs-fixer-styleci-bridge": "^1.0",
-        "symfony/console": "^2.3||~3.0",
-        "symfony/framework-bundle": "^2.3||^3.0",
-        "symfony/phpunit-bridge": "^2.7.4||^3.0",
-        "symfony/yaml": "^2.3||^3.0",
-        "symfony/validator": "^2.3|^3.0",
-        "bamarni/composer-bin-plugin": "dev-master",
-        "theofidry/alice-data-fixtures": "^1.0@dev",
-        "doctrine/orm": "^2.5",
-        "doctrine/doctrine-bundle": "^1.6",
         "doctrine/data-fixtures": "^1.2",
+        "doctrine/doctrine-bundle": "^1.6",
+        "doctrine/orm": "^2.5",
         "phpunit/phpunit": "^5.6",
-        "theofidry/psysh-bundle": "^2.0",
-        "symfony/monolog-bundle": "^2.11",
-        "easycorp/easy-log-handler": "^1.0"
+        "symfony/symfony": "^2.3||~3.0",
+        "symfony/phpunit-bridge": "^3.1",
+        "theofidry/alice-data-fixtures": "^1.0@dev"
     },
     "suggest": {
-        "theofidry/alice-bundle-extension": "Behat extension for HautelookAliceBundle",
-        "doctrine/data-fixtures": "To use Doctrine fixtures loader",
-        "doctrine/orm": "To use Doctrine ORM",
-        "doctrine/doctrine-bundle": "To use Doctrine with Symfony",
-        "doctrine/mongodb-odm": "To use Doctrine MongoDB",
-        "doctrine/mongodb-odm-bundle": "To use Doctrine MongoDB with Symfony",
-        "jackalope/jackalope-doctrine-dbal": "To use Doctrine PHPCR",
-        "doctrine/phpcr-odm": "To use Doctrine PHPCR ODM",
-        "doctrine/phpcr-bundle": "To use Doctrine PHPCR ODM with Symfony"
+        "theofidry/alice-bundle-extension": "Behat extension for HautelookAliceBundle"
     },
     "extra": {
         "branch-alias": {

bin/clear_cache.sh

@@ -72,7 +72,7 @@ For more, check [Alice documentation](https://github.com/nelmio/alice#table-of-c
 You can access out of the box to your application parameters:
 
 ```yaml
-# AppBundle/DataFixtures/ORM/dummy.yml
+# app/Resources/fixtures/orm/dummy.yml
 
 AppBundle\Entity\Dummy:
     dummy_0:
@@ -83,5 +83,20 @@ Alice parameters will **not** be injected in your application `ParameterBag`, i.
 fixtures.
 
 
+# Use service factories
+
+If your entity `AppBundle\Entity\Dummy` requires a factory registered as a service (Alice already supports [static
+factories](https://github.com/nelmio/alice/blob/master/doc/complete-reference.md#specifying-constructor-arguments)) to
+`dummy_factory` be instantiated, you can specify it as a constructor:
+
+```yaml
+# app/Resources/fixtures/orm/dummy.yml
+
+AppBundle\Entity\Dummy:
+    dummy_0:
+        __construct: { '@dummy_factory::create': ['<username()>'] }
+```
+
+
 Previous chapter: [Basic usage](../README.md#basic-usage)<br />
 Next chapter: [Custom Faker Providers](faker-providers.md)

composer.json

@@ -13,11 +13,9 @@
 
 use Doctrine\Bundle\DoctrineBundle\DoctrineBundle;
 use Fidry\AliceDataFixtures\Bridge\Symfony\FidryAliceDataFixturesBundle;
-use Fidry\PsyshBundle\PsyshBundle;
 use Hautelook\AliceBundle\HautelookAliceBundle;
 use Nelmio\Alice\Bridge\Symfony\NelmioAliceBundle;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
-use Symfony\Bundle\MonologBundle\MonologBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\HttpKernel\Kernel;
 
@@ -30,12 +28,10 @@ public function registerBundles()
     {
         return [
             new FrameworkBundle(),
-            new MonologBundle(),
             new NelmioAliceBundle(),
             new FidryAliceDataFixturesBundle(),
             new DoctrineBundle(),
             new HautelookAliceBundle(),
-            new PsyshBundle(),
         ];
     }
 

doc/advanced-usage.md

@@ -13,7 +13,6 @@
 
 use Hautelook\AliceBundle\HautelookAliceBundle;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
-use Symfony\Bundle\MonologBundle\MonologBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\HttpKernel\Bundle\Bundle;
 use Symfony\Component\HttpKernel\Kernel;
@@ -33,7 +32,6 @@ public function registerBundles()
         return array_merge(
             [
                 new FrameworkBundle(),
-                new MonologBundle(),
                 new HautelookAliceBundle(),
             ],
             $this->addedBundles

fixtures/Functional/AppKernel.php

@@ -0,0 +1,28 @@
+<?php
+
+/*
+ * This file is part of the Hautelook\AliceBundle package.
+ *
+ * (c) Baldur Rensch <[email protected]>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+declare(strict_types = 1);
+
+namespace Hautelook\AliceBundle\Functional\TestBundle\Entity;
+
+/**
+ * @author Théo FIDRY <[email protected]>
+ */
+class CityFactory
+{
+    public function create(string $name): City
+    {
+        $instance = new City();
+        $instance->name = $name;
+
+        return $instance;
+    }
+}

fixtures/Functional/ConfigurableKernel.php

@@ -20,7 +20,6 @@
 use Hautelook\AliceBundle\Functional\TestBundle\TestBundle;
 use Nelmio\Alice\Bridge\Symfony\NelmioAliceBundle;
 use Symfony\Bundle\FrameworkBundle\FrameworkBundle;
-use Symfony\Bundle\MonologBundle\MonologBundle;
 use Symfony\Component\Config\Loader\LoaderInterface;
 use Symfony\Component\HttpKernel\Kernel;
 
@@ -33,7 +32,6 @@ public function registerBundles()
     {
         return [
             new FrameworkBundle(),
-            new MonologBundle(),
             new NelmioAliceBundle(),
             new FidryAliceDataFixturesBundle(),
             new DoctrineBundle(),

fixtures/Functional/TestBundle/Entity/CityFactory.php

@@ -13,24 +13,13 @@ framework:
     session: ~
     test: ~
 
-monolog:
-    handlers:
-        buffered:
-            type: buffer
-            handler: easylog
-            level: debug
-        easylog:
-            type: service
-            id: easycorp.easylog.handler
-        console:
-            type:   console
-
 services:
     data_fixtures.faker.provider.foo:
         class: Hautelook\AliceBundle\Functional\TestBundle\DataFixtures\Faker\Provider\FooProvider
         tags: [ { name: nelmio_alice.faker.provider } ]
 
-    easycorp.easylog.handler:
-        class: EasyCorp\EasyLog\EasyLogHandler
-        arguments:
-            - '%kernel.logs_dir%/%kernel.environment%.log'
+    app.city_factory:
+        class: Hautelook\AliceBundle\Functional\TestBundle\Entity\CityFactory
+
+    logger:
+        class: Psr\Log\NullLogger

fixtures/Functional/TestKernel.php

@@ -172,4 +172,13 @@ public function getLogDir()
     public function getCharset()
     {
         $this->__call(__METHOD__, func_get_args());
-}}
+    }
+
+    /**
+     * @inheritdoc
+     */
+    public function isClassInActiveBundle($class)
+    {
+        $this->__call(__METHOD__, func_get_args());
+    }
+}

fixtures/Functional/config/config.yml

@@ -0,0 +1,5 @@
+Hautelook\AliceBundle\Functional\TestBundle\Entity\City:
+    city_{0..10}:
+        __construct:
+            '@app.city_factory::create':
+                - <current()>

fixtures/HttpKernel/DummyKernel.php

@@ -0,0 +1,18 @@
+<?xml version="1.0" ?>
+<container xmlns="http://symfony.com/schema/dic/services"
+           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+           xsi:schemaLocation="http://symfony.com/schema/dic/services http://symfony.com/schema/dic/services/services-1.0.xsd">
+<services>
+
+    <service id="hautelook_alice.alice.generator.instantiator.chainable.instantiated_reference_instantiator"
+             class="Hautelook\AliceBundle\Alice\Generator\Instantiator\Chainable\InstantiatedReferenceInstantiator">
+        <call method="setContainer">
+            <argument type="service" id="service_container" />
+        </call>
+
+        <tag name="nelmio_alice.generator.instantiator.chainable_instantiator" />
+    </service>
+
+</services>
+
+</container>