Dep injection (#25)

* Loader with DI added
* After test cache clearance
* Tests added
* Fixture Loaders are now private
* CS and debug
* SF 4.1 and 4.2@dev tests
* Documentation
* Branch aliases updated

Author: Spomky

.php_cs.dist

@@ -0,0 +1,59 @@
+<?php
+
+$header = 'The MIT License (MIT)
+
+Copyright (c) 2016-2018 Spomky-Labs
+
+This software may be modified and distributed under the terms
+of the MIT license.  See the LICENSE file for details.';
+
+$finder = PhpCsFixer\Finder::create()
+    ->in(__DIR__.'/src')
+;
+
+return PhpCsFixer\Config::create()
+    ->setRules([
+        '@PSR1' => true,
+        '@PSR2' => true,
+        '@Symfony' => true,
+        '@DoctrineAnnotation' => true,
+        '@PHP70Migration' => true,
+        '@PHP71Migration' => true,
+        'strict_param' => true,
+        'strict_comparison' => true,
+        'array_syntax' => ['syntax' => 'short'],
+        'array_indentation' => true,
+        'ordered_imports' => true,
+        'protected_to_private' => true,
+        'declare_strict_types' => true,
+        'native_function_invocation' => [
+            'include' => ['@compiler_optimized'],
+            'scope' => 'namespaced',
+        ],
+        'mb_str_functions' => true,
+        'linebreak_after_opening_tag' => true,
+        'combine_consecutive_issets' => true,
+        'combine_consecutive_unsets' => true,
+        'compact_nullable_typehint' => true,
+        'no_superfluous_phpdoc_tags' => true,
+        'no_superfluous_elseif' => true,
+        'phpdoc_trim_consecutive_blank_line_separation' => true,
+        'phpdoc_order' => true,
+        'pow_to_exponentiation' => true,
+        'simplified_null_return' => true,
+        'header_comment' => [
+            'header' => $header,
+        ],
+        'align_multiline_comment' => [
+            'comment_type' => 'all_multiline',
+        ],
+        'php_unit_test_annotation' => [
+            'case' => 'snake',
+            'style' => 'annotation',
+        ],
+        'php_unit_test_case_static_method_calls' => true,
+    ])
+    ->setRiskyAllowed(true)
+    ->setUsingCache(true)
+    ->setFinder($finder)
+    ;

.travis.yml

@@ -17,18 +17,16 @@ matrix:
     - php: 7.1
       env: SYMFONY_VERSION='3.4.*'
     - php: 7.1
-      env: SYMFONY_VERSION='4.0.*'
-    - php: 7.1
-      env: DEPS=dev SYMFONY_VERSION='4.1.*'
+      env: SYMFONY_VERSION='4.1.*'
     - php: 7.2
       env: SYMFONY_VERSION='4.0.*'
+    - php: 7.2
+      env: SYMFONY_VERSION='4.1.*'
     - php: nightly
-      env: DEPS=dev SYMFONY_VERSION='4.1.*'
+      env: DEPS=dev SYMFONY_VERSION='4.2.*'
   allow_failures:
-    - php: 7.1
-      env: SYMFONY_VERSION='4.1.*'
     - php: nightly
-      env: SYMFONY_VERSION='4.1.*'
+      env: DEPS=dev SYMFONY_VERSION='4.2.*'
 
 before_install:
   - composer self-update

README.md

@@ -20,7 +20,6 @@ default:
   extensions:
     BehatExtension\DoctrineDataFixturesExtension\Extension:
       lifetime:    'feature'
-      autoload:    true
       directories: ~
       fixtures:    ~
 ```
@@ -29,14 +28,15 @@ When **lifetime** is set to "feature" (or unspecified), data fixtures are reload
 when **lifetime** is set to "scenario", data fixtures are reloaded between scenarios (i.e., increased
 test isolation at the expense of increased run time).
 
-When **autoload** is true, the extension will load the data fixtures for registered bundles.
-Please note that only fixtures stored in the folder `/DataFixtures/ORM` of the bundles are loaded.
-If you want to load fixtures tagged with `doctrine.fixture.orm`, you must enable the bundle `BehatExtension\DoctrineDataFixturesExtension\Bundle\BehatDoctrineDataFixturesExtensionBundle`
-in your test `AppKernel` class.
+When **fixtures** is set, the extension will load the specified fixture classes.
+This must contain a list of fully qualified class names. Classes MUST not have any constructor arguments (or at least optional).
+If the interface `Symfony\Component\DependencyInjection\ContainerAwareInterface` is implemented, the container is set to the fixture loader.
 
-When **fixtures** is set, the DoctrineDataFixtures extension will load the specified fixture classes.
+When **directories** is set, the extension will load the data fixtures globed from the respective directories.
+Classes MUST not have any constructor arguments (or at least optional).
+If the interface `Symfony\Component\DependencyInjection\ContainerAwareInterface` is implemented, the container is set to the fixture loader.
 
-When **directories** is set, the DoctrineDataFixtures extension will load the data fixtures globed from the respective directories.
+This extension will also load every fixtures declared as services and tagged with `doctrine.fixture.orm`.
 
 ```yaml
 # behat.yml
@@ -45,7 +45,6 @@ default:
   extensions:
     BehatExtension\DoctrineDataFixturesExtension\Extension:
       lifetime: 'feature'
-      autoload: true
       directories:
         - '/project/src/AcmeAnalytics/Tests/DataFixtures/ORM'
       fixtures:
@@ -59,7 +58,10 @@ default:
 To speed up the tests, a backup system is available. The whole database will be set in cache and reloaded when needed.
 You should periodically clear the cache as it does not detect changes to the data fixture contents because the hash is based on the collection of data fixture class names.
 
-This feature is only available for the following SGDB: SQLite, MySQL, PostgreSQL.
+This feature is only available for SQLite, MySQL and PostgreSQL.
+
+* For MySQL, `mysql` and `mysqldump` must be available.
+* For PostgreSQL, `pg_restore` and `pg_dump` must be available.
 
 It is enabled by default. To disable it, you just have to set `use_backup: false` in the extension configuration:
 
@@ -70,7 +72,6 @@ default:
   extensions:
     BehatExtension\DoctrineDataFixturesExtension\Extension:
       lifetime: 'feature'
-      autoload: true
       use_backup: false
 ```
 

composer.json

@@ -27,8 +27,9 @@
     "require-dev": {
         "doctrine/doctrine-bundle": "^1.8",
         "doctrine/doctrine-fixtures-bundle": "^3.0",
-        "phpstan/phpstan": "^0.9.2",
-        "symfony/process": "^3.4|^4.0"
+        "symfony/process": "^3.4|^4.0",
+        "adamquaile/behat-command-runner-extension": "^0.1.1",
+        "symfony/var-dumper": "^3.4|^4.0"
     },
     "suggest": {
         "doctrine/migrations": "Uses DBAL to load versioned database schema and migration classes",
@@ -42,7 +43,8 @@
     },
     "extra": {
         "branch-alias": {
-            "dev-master": "5.0.x-dev"
+            "v6.0": "6.0.x-dev",
+            "v5.0": "5.0.x-dev"
         }
     }
 }

phpstan.neon

@@ -0,0 +1,5 @@
+parameters:
+    includes:
+        - %rootDir%/../phpstan-phpunit/extension.neon
+        - %rootDir%/../phpstan-phpunit/rules.neon
+        - %rootDir%/../phpstan-symfony/extension.neon

src/Bundle/BehatDoctrineDataFixturesExtensionBundle.php

@@ -20,9 +20,6 @@
 
 final class BehatDoctrineDataFixturesExtensionBundle extends Bundle
 {
-    /**
-     * {@inheritdoc}
-     */
     public function getContainerExtension()
     {
         return new class() extends Extension {

src/Context/FixtureServiceAwareContextInterface.php

@@ -15,17 +15,7 @@
 
 use BehatExtension\DoctrineDataFixturesExtension\Service\FixtureService;
 
-/**
- * Interface FixtureServiceAwareContextInterface.
- */
 interface FixtureServiceAwareContextInterface
 {
-    /**
-     * Set the FixtureService.
-     *
-     * @param FixtureService $service
-     *
-     * @return void
-     */
     public function setFixtureService(FixtureService $service): void;
 }

src/Context/Initializer/FixtureServiceAwareInitializer.php

@@ -18,29 +18,15 @@
 use BehatExtension\DoctrineDataFixturesExtension\Context\FixtureServiceAwareContextInterface;
 use BehatExtension\DoctrineDataFixturesExtension\Service\FixtureService;
 
-/**
- * Class FixtureServiceAwareInitializer.
- */
 final class FixtureServiceAwareInitializer implements ContextInitializer
 {
-    /**
-     * @var FixtureService
-     */
     private $fixtureService;
 
-    /**
-     * FixtureServiceAwareInitializer constructor.
-     *
-     * @param FixtureService $fixtureService
-     */
     public function __construct(FixtureService $fixtureService)
     {
         $this->fixtureService = $fixtureService;
     }
 
-    /**
-     * {@inheritdoc}
-     */
     public function initializeContext(Context $context)
     {
         if (!$context instanceof FixtureServiceAwareContextInterface && !$this->usesReferenceDictionary($context)) {
@@ -52,10 +38,6 @@ public function initializeContext(Context $context)
 
     /**
      * Checks whether the context uses the ReferenceDictionary trait.
-     *
-     * @param Context $context
-     *
-     * @return bool
      */
     private function usesReferenceDictionary(Context $context): bool
     {
@@ -65,6 +47,6 @@ private function usesReferenceDictionary(Context $context): bool
             return false;
         }
 
-        return in_array('BehatExtension\DoctrineDataFixturesExtension\Context\ReferenceDictionary', $refl->getTraitNames());
+        return \in_array('BehatExtension\DoctrineDataFixturesExtension\Context\ReferenceDictionary', $refl->getTraitNames(), true);
     }
 }

src/Context/ReferenceDictionary.php

@@ -15,9 +15,6 @@
 
 use BehatExtension\DoctrineDataFixturesExtension\Service\FixtureService;
 
-/**
- * Class ReferenceDictionary.
- */
 trait ReferenceDictionary
 {
     /**
@@ -27,10 +24,6 @@ trait ReferenceDictionary
 
     /**
      * Sets the Reference Repository.
-     *
-     * @param FixtureService $service
-     *
-     * @return void
      */
     public function setFixtureService(FixtureService $service): void
     {
@@ -39,8 +32,6 @@ public function setFixtureService(FixtureService $service): void
 
     /**
      * Returns the Reference Repository.
-     *
-     * @return FixtureService
      */
     public function getFixtureService(): FixtureService
     {
@@ -50,23 +41,17 @@ public function getFixtureService(): FixtureService
     /**
      * Takes a reference string and returns the entity created in fixtures.
      *
-     * @param string $reference
-     *
      * @return object
      */
-    public function getReference($reference)
+    public function getReference(string $reference)
     {
         return $this->fixtureService->getReferenceRepository()->getReference($reference);
     }
 
     /**
      * Checks if the reference is known to the Repository.
-     *
-     * @param string $reference
-     *
-     * @return bool
      */
-    public function hasReference($reference): bool
+    public function hasReference(string $reference): bool
     {
         return $this->fixtureService->getReferenceRepository()->hasReference($reference);
     }