symfony · GaryPEGEOT · Mar 4, 2019 · Mar 6, 2019 · Mar 6, 2019 · Mar 6, 2019
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -13,6 +13,7 @@ CHANGELOG
  * added `ReverseContainer`: a container that turns services back to their ids
  * added ability to define an index for a tagged collection
  * added ability to define an index for services in an injected service locator argument
+ * added the `!yaml_file` YAML custom tag, allowing to inject the parsed content of a YAML file
 
 4.2.0
 -----

diff --git a/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/XmlFileLoader.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\DependencyInjection\Loader;
 
+use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\Config\Util\XmlUtils;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Argument\BoundArgument;
@@ -26,6 +27,7 @@
 use Symfony\Component\DependencyInjection\Extension\ExtensionInterface;
 use Symfony\Component\DependencyInjection\Reference;
 use Symfony\Component\ExpressionLanguage\Expression;
+use Symfony\Component\Yaml\Yaml;
 
 /**
  * XmlFileLoader loads XML files service definitions.
@@ -560,6 +562,25 @@ private function getArgumentsAsPhp(\DOMElement $node, $name, $file, $lowercase =
                 case 'constant':
                     $arguments[$key] = \constant(trim($arg->nodeValue));
                     break;
+                case 'yaml-file':
+                    if (!\class_exists('Symfony\Component\Yaml\Yaml')) {
+                        throw new \InvalidArgumentException('You need to install the YAML component to parse YAML files.');
+                    }
+
+                    if (!\is_file($filePath = $this->container->getParameterBag()->resolveValue((string) $arg->nodeValue))) {
+                        $rootDir = \dirname($file);
+
+                        if (!\is_file($filePath = "$rootDir/$filePath")) {
+                            throw new InvalidArgumentException("Unable to locate file \"{$arg->nodeValue}\". Please provide a path relative to \"$rootDir\" or an absolute path.");
+                        }
+                    }
+
+                    $this->container->addResource(new FileResource($filePath));
+
+                    $arguments[$key] = $this->container->getParameterBag()->resolveValue(
+                        Yaml::parseFile($filePath, Yaml::PARSE_CONSTANT)
+                    );
+                    break;
                 default:
                     $arguments[$key] = XmlUtils::phpize($arg->nodeValue);
             }

diff --git a/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php b/src/Symfony/Component/DependencyInjection/Loader/YamlFileLoader.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\DependencyInjection\Loader;
 
+use Symfony\Component\Config\Resource\FileResource;
 use Symfony\Component\DependencyInjection\Alias;
 use Symfony\Component\DependencyInjection\Argument\ArgumentInterface;
 use Symfony\Component\DependencyInjection\Argument\BoundArgument;
@@ -758,6 +759,19 @@ private function resolveServices($value, $file, $isParameter = false)
 
                 return new Reference($id);
             }
+            if ('yaml_file' === $value->getTag()) {
+                if (!\is_file($filePath = $this->container->getParameterBag()->resolveValue((string) $argument))) {
+                    $rootDir = \dirname($file);
+
+                    if (!\is_file($filePath = "$rootDir/$filePath")) {
+                        throw new InvalidArgumentException("Unable to locate file \"$argument\". Please provide a path relative to \"$rootDir\" or an absolute path.");
+                    }
+                }
+
+                $this->container->addResource(new FileResource($filePath));
+
+                return $this->container->getParameterBag()->resolveValue($this->yamlParser->parseFile($filePath, Yaml::PARSE_CONSTANT));
+            }
 
             throw new InvalidArgumentException(sprintf('Unsupported tag "!%s".', $value->getTag()));
         }

diff --git a/src/Symfony/Component/DependencyInjection/Loader/schema/dic/services/services-1.0.xsd b/src/Symfony/Component/DependencyInjection/Loader/schema/dic/services/services-1.0.xsd
@@ -209,6 +209,7 @@
     <xsd:attribute name="name" type="xsd:string" />
     <xsd:attribute name="on-invalid" type="invalid_sequence" />
     <xsd:attribute name="tag" type="xsd:string" />
+    <xsd:attribute name="yaml-file" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:complexType name="bind" mixed="true">
@@ -236,6 +237,7 @@
     <xsd:attribute name="tag" type="xsd:string" />
     <xsd:attribute name="index-by" type="xsd:string" />
     <xsd:attribute name="default-index-method" type="xsd:string" />
+    <xsd:attribute name="yaml-file" type="xsd:string" />
   </xsd:complexType>
 
   <xsd:complexType name="call">
@@ -265,6 +267,7 @@
       <xsd:enumeration value="service_locator" />
       <xsd:enumeration value="tagged" />
       <xsd:enumeration value="tagged_locator" />
+      <xsd:enumeration value="yaml-file" />
     </xsd:restriction>
   </xsd:simpleType>
 

diff --git a/...ony/Component/DependencyInjection/Tests/Fixtures/xml/services_with_yaml_file_argument.xml b/...ony/Component/DependencyInjection/Tests/Fixtures/xml/services_with_yaml_file_argument.xml
@@ -0,0 +1,8 @@
+<?xml version="1.0" encoding="utf-8"?>
+<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 https://symfony.com/schema/dic/services/services-1.0.xsd">
+    <services>
+        <service class="foo" id="my_awesome_service_with_yaml_inside">
+            <argument type="yaml-file">%fixture_path%/test_yaml_file.yaml</argument>
+        </service>
+    </services>
+</container>
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/baz/nested_test_yaml_file.yaml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/baz/nested_test_yaml_file.yaml
@@ -0,0 +1,3 @@
+foo:
+  bar: true
+  baz: 42
diff --git a/...Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services_with_yaml_file_tag.yml b/...Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/services_with_yaml_file_tag.yml
@@ -0,0 +1,4 @@
+services:
+  my_awesome_service_with_yaml_inside:
+    arguments:
+      - !yaml_file test_yaml_file.yaml
diff --git a/...DependencyInjection/Tests/Fixtures/yaml/services_with_yaml_file_tag_invalid_extension.yml b/...DependencyInjection/Tests/Fixtures/yaml/services_with_yaml_file_tag_invalid_extension.yml
@@ -0,0 +1,4 @@
+services:
+  my_awesome_service_with_yaml_inside:
+    arguments:
+      - !yaml_file ../xml/services1.xml
diff --git a/...nent/DependencyInjection/Tests/Fixtures/yaml/services_with_yaml_file_tag_invalid_path.yml b/...nent/DependencyInjection/Tests/Fixtures/yaml/services_with_yaml_file_tag_invalid_path.yml
@@ -0,0 +1,4 @@
+services:
+  my_awesome_service_with_yaml_inside:
+    arguments:
+      - !yaml_file file_not_found.yaml
diff --git a/...onent/DependencyInjection/Tests/Fixtures/yaml/services_with_yaml_file_tag_with_params.yml b/...onent/DependencyInjection/Tests/Fixtures/yaml/services_with_yaml_file_tag_with_params.yml
@@ -0,0 +1,4 @@
+services:
+  my_awesome_service_with_yaml_inside:
+    arguments:
+      - !yaml_file '%fixture_path%/nested_test_yaml_file.yaml'
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/test_yaml_file.yaml b/src/Symfony/Component/DependencyInjection/Tests/Fixtures/yaml/test_yaml_file.yaml
@@ -0,0 +1,3 @@
+foo:
+  bar: true
+  baz: '%meaning_of_life%'
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/XmlFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/XmlFileLoaderTest.php
@@ -897,4 +897,17 @@ public function testTsantosContainer()
         $dump = $dumper->dump();
         $this->assertStringEqualsFile(self::$fixturesPath.'/php/services_tsantos.php', $dumper->dump());
     }
+
+    public function testYamlFileTag()
+    {
+        $container = new ContainerBuilder();
+        $container->setParameter('fixture_path', realpath(self::$fixturesPath.'/yaml'));
+        $container->setParameter('meaning_of_life', 42);
+
+        $loader = new XmlFileLoader($container, new FileLocator(self::$fixturesPath.'/xml'));
+        $loader->load('services_with_yaml_file_argument.xml');
+
+        $definition = $container->getDefinition('my_awesome_service_with_yaml_inside');
+        $this->assertSame(['foo' => ['bar' => true, 'baz' => 42]], $definition->getArgument(0));
+    }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php b/src/Symfony/Component/DependencyInjection/Tests/Loader/YamlFileLoaderTest.php
@@ -21,6 +21,7 @@
 use Symfony\Component\DependencyInjection\Argument\ServiceLocatorArgument;
 use Symfony\Component\DependencyInjection\Argument\TaggedIteratorArgument;
 use Symfony\Component\DependencyInjection\ContainerBuilder;
+use Symfony\Component\DependencyInjection\Exception\InvalidArgumentException;
 use Symfony\Component\DependencyInjection\Loader\IniFileLoader;
 use Symfony\Component\DependencyInjection\Loader\PhpFileLoader;
 use Symfony\Component\DependencyInjection\Loader\XmlFileLoader;
@@ -32,6 +33,7 @@
 use Symfony\Component\DependencyInjection\Tests\Fixtures\NamedArgumentsDummy;
 use Symfony\Component\DependencyInjection\Tests\Fixtures\Prototype;
 use Symfony\Component\ExpressionLanguage\Expression;
+use Symfony\Component\Yaml\Exception\ParseException;
 
 class YamlFileLoaderTest extends TestCase
 {
@@ -800,4 +802,50 @@ public function testFqcnLazyProxy()
         $definition = $container->getDefinition('foo');
         $this->assertSame([['interface' => 'SomeInterface']], $definition->getTag('proxy'));
     }
+
+    /**
+     * @dataProvider provideYamlFileResources
+     */
+    public function testYamlFileTag(string $resource)
+    {
+        $path = self::$fixturesPath.'/yaml';
+        $container = new ContainerBuilder();
+        $container->setParameter('fixture_path', "$path/baz");
+        $container->setParameter('meaning_of_life', 42);
+
+        $loader = new YamlFileLoader($container, new FileLocator($path));
+        $loader->load($resource);
+
+        $definition = $container->getDefinition('my_awesome_service_with_yaml_inside');
+        $this->assertSame(['foo' => ['bar' => true, 'baz' => 42]], $definition->getArgument(0));
+    }
+
+    public function provideYamlFileResources(): array
+    {
+        return [
+            'Relative path' => ['services_with_yaml_file_tag.yml'],
+            'Path with parameter' => ['services_with_yaml_file_tag_with_params.yml'],
+        ];
+    }
+
+    public function testYamlFileTagNotFound()
+    {
+        $rootDir = self::$fixturesPath.'/yaml';
+
+        $this->expectException(InvalidArgumentException::class);
+        $this->expectExceptionMessage("Unable to locate file \"file_not_found.yaml\". Please provide a path relative to \"$rootDir\" or an absolute path.");
+        $container = new ContainerBuilder();
+
+        $loader = new YamlFileLoader($container, new FileLocator($rootDir));
+        $loader->load('services_with_yaml_file_tag_invalid_path.yml');
+    }
+
+    public function testYamlFileTagWithXml()
+    {
+        $this->expectException(ParseException::class);
+        $container = new ContainerBuilder();
+
+        $loader = new YamlFileLoader($container, new FileLocator(self::$fixturesPath.'/yaml'));
+        $loader->load('services_with_yaml_file_tag_invalid_extension.yml');
+    }
 }