BundlesLoader. Поддержка окружений при загрузке бандлов.

Author: ProklUng

src/Bundles/BundlesLoader.php

@@ -21,6 +21,7 @@
  * @since 20.12.2020 Сделать все приватные консольные команды публичными.
  * @since 04.03.2021 Возможность загрузки бандлов несколькими провайдерами.
  * @since 27.04.2021 Баг-фикс: при скомпилированном контейнере не запускался метод boot бандлов.
+ * @since 03.07.2021 Поддержка ключей окружения при загрузке бандлов.
  */
 class BundlesLoader
 {
@@ -44,14 +45,21 @@ class BundlesLoader
      */
     private static $bundlesMap = [];
 
+    /**
+     * @var string $environment Окружение.
+     */
+    private $environment;
+
     /**
      * BundlesLoader constructor.
      *
-     * @param ContainerBuilder $container  Контейнер в стадии формирования.
-     * @param string           $configPath Путь к bundles.php (конфигурация бандлов).
+     * @param ContainerBuilder $container   Контейнер в стадии формирования.
+     * @param string           $environment Окружение.
+     * @param string           $configPath  Путь к bundles.php (конфигурация бандлов).
      */
     public function __construct(
         ContainerBuilder $container,
+        string $environment,
         string $configPath = ''
     ) {
         $configPath = $configPath ?: self::PATH_BUNDLES_CONFIG;
@@ -62,6 +70,8 @@ public function __construct(
         }
 
         $this->container = $container;
+        $this->environment = $environment;
+
         static::$bundlesMap[static::class] = [];
     }
 
@@ -77,10 +87,20 @@ public function load() : void
         foreach ($this->bundles as $bundleClass => $envs) {
             if (!class_exists($bundleClass)) {
                 throw new InvalidArgumentException(
-                    sprintf(
-                        'Bundle class %s not exist.',
-                        $bundleClass
-                    )
+                    sprintf('Bundle class %s not exist.', $bundleClass)
+                );
+            }
+
+            if (!array_key_exists($this->environment, (array)$envs)
+                &&
+                !array_key_exists('all', (array)$envs)
+            ) {
+                continue;
+            }
+
+            if (!method_exists($bundleClass, 'getContainerExtension')) {
+                throw new InvalidArgumentException(
+                    sprintf('Bundle %s dont have implemented getContainerExtension method.', $bundleClass)
                 );
             }
 
@@ -107,17 +127,10 @@ public function load() : void
                 $this->container->addCompilerPass(
                     new MakePrivateCommandsPublic()
                 );
-
-                // Сохраняю инстанцированный бандл в статику.
-                static::$bundlesMap[static::class][$bundle->getName()] = $bundle;
-            } else {
-                throw new InvalidArgumentException(
-                    sprintf(
-                        'Bundle %s dont have implemented getContainerExtension method.',
-                        $bundle->getName()
-                    )
-                );
             }
+
+            // Сохраняю инстанцированный бандл в статику.
+            static::$bundlesMap[static::class][$bundle->getName()] = $bundle;
         }
     }
 

src/ServiceProvider.php

@@ -685,6 +685,7 @@ private function loadSymfonyBundles() : void
     {
         $this->bundlesLoader = new BundlesLoader(
             static::$containerBuilder,
+            $this->environment,
             $this->pathBundlesConfig
         );
 

tests/Cases/BundlesLoaderTest.php

@@ -6,6 +6,7 @@
 use Prokl\ServiceProvider\Bundles\BundlesLoader;
 use Prokl\ServiceProvider\Tests\Fixtures\DummyService;
 use Prokl\ServiceProvider\Tests\Fixtures\TestingBundle;
+use Prokl\ServiceProvider\Tests\Fixtures\TestingBundleDev;
 use Prokl\TestingTools\Base\BaseTestCase;
 use Prokl\TestingTools\Tools\PHPUnitUtils;
 use ReflectionException;
@@ -16,6 +17,7 @@
  * @package Prokl\ServiceProvider\Tests\Cases
  *
  * @since 01.06.2021
+ * @since 03.07.2021 Актуализация.
  */
 class BundlesLoaderTest extends BaseTestCase
 {
@@ -41,6 +43,7 @@ protected function setUp(): void
         $this->dummyContainer = new ContainerBuilder();
         $this->obTestObject = new BundlesLoader(
             $this->dummyContainer,
+            'dev',
             '/../Fixtures/bundles.php'
         );
     }
@@ -59,6 +62,8 @@ public function testLoad() : void
         $this->assertCount(1, $result);
         $this->assertSame('TestingBundle', array_key_first($result));
         $this->assertInstanceOf(TestingBundle::class, $result['TestingBundle']);
+        // Не загрузился ли бандл для другого окружения.
+        $this->assertArrayNotHasKey(TestingBundleDev::class, $result);
     }
 
     /**
@@ -70,6 +75,7 @@ public function testLoadDefaultPath() : void
     {
         $this->obTestObject = new BundlesLoader(
             $this->dummyContainer,
+            'dev',
             '/../Fixtures/fake.php' // Несуществующий конфиг
         );
 
@@ -80,6 +86,28 @@ public function testLoadDefaultPath() : void
         $this->assertEmpty($result);
     }
 
+    /**
+     * load(). Другое окружение.
+     *
+     * @return void
+     */
+    public function testLoadAnotherEnv() : void
+    {
+        $this->obTestObject = new BundlesLoader(
+            $this->dummyContainer,
+            'test',
+            '/../Fixtures/bundles.php'
+        );
+
+        $this->obTestObject->load();
+
+        $result = $this->obTestObject->bundles();
+
+        $this->assertArrayHasKey('TestingBundle', $result);
+        $this->assertArrayHasKey('TestingBundleDev', $result);
+        $this->assertInstanceOf(TestingBundleDev::class, $result['TestingBundleDev']);
+    }
+
     /**
      * load(). Бандл без метода RegisterExtension.
      *
@@ -89,11 +117,14 @@ public function testLoadWithoutRegisterExtension() : void
     {
         $this->obTestObject = new BundlesLoader(
             $this->dummyContainer,
+            'dev',
             '/../Fixtures/invalid_bundles.php'
         );
 
         $this->expectException(InvalidArgumentException::class);
-        $this->expectExceptionMessage('Bundle TestingInvalidBundle dont have implemented getContainerExtension method.');
+        $this->expectExceptionMessage(
+            'Bundle Prokl\ServiceProvider\Tests\Fixtures\TestingInvalidBundle dont have implemented getContainerExtension method.'
+        );
 
         $this->obTestObject->load();
     }
@@ -107,6 +138,7 @@ public function testLoadInvalidClass() : void
     {
         $this->obTestObject = new BundlesLoader(
             $this->dummyContainer,
+            'dev',
             '/../Fixtures/fake_bundles.php'
         );
 

tests/Fixtures/TestingBundleDev.php

@@ -0,0 +1,13 @@
+<?php
+
+namespace Prokl\ServiceProvider\Tests\Fixtures;
+
+use Symfony\Component\HttpKernel\Bundle\Bundle;
+
+/**
+ * Class TestingBundleDev
+ * @package Prokl\ServiceProvider\Tests\Fixtures
+ */
+class TestingBundleDev extends Bundle
+{
+}

tests/Fixtures/TestingInvalidBundle.php

@@ -2,13 +2,11 @@
 
 namespace Prokl\ServiceProvider\Tests\Fixtures;
 
-use Symfony\Component\HttpKernel\Bundle\Bundle;
-
 /**
  * Class TestingInvalidBundle
  * @package Prokl\ServiceProvider\Tests\Fixtures
  */
-class TestingInvalidBundle extends Bundle
+class TestingInvalidBundle
 {
 
 }

tests/Fixtures/bundles.php

@@ -1,4 +1,5 @@
 <?php
 return [
-    Prokl\ServiceProvider\Tests\Fixtures\TestingBundle::class => ['all' => true]
+    Prokl\ServiceProvider\Tests\Fixtures\TestingBundle::class => ['all' => true],
+    Prokl\ServiceProvider\Tests\Fixtures\TestingBundleDev::class => ['test' => true]
 ];