[DependencyInjection] Add shuffle env processor

ostrolucky · ostrolucky · commit a921ed48839b · 2022-07-09T10:54:55.000+02:00
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -6,6 +6,7 @@ CHANGELOG
 
  * Add argument `&$asGhostObject` to LazyProxy's `DumperInterface` to allow using ghost objects for lazy loading services
  * Add `enum` env var processor
+ * Add `shuffle` env var processor
 
 6.1
 ---
diff --git a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php
@@ -58,6 +58,7 @@ public static function getProvidedTypes(): array
             'trim' => 'string',
             'require' => 'bool|int|float|string|array',
             'enum' => \BackedEnum::class,
+            'shuffle' => 'array',
         ];
     }
 
@@ -206,6 +207,12 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv): mixed
             return null;
         }
 
+        if ('shuffle' === $prefix) {
+            \is_array($env) ? shuffle($env) : throw new RuntimeException(sprintf('Env var "%s" cannot be shuffled because its value "%s" is not an array.', $name, $env));
+
+            return $env;
+        }
+
         if (!\is_scalar($env)) {
             throw new RuntimeException(sprintf('Non-scalar env var "%s" cannot be cast to "%s".', $name, $prefix));
         }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php b/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php
@@ -708,6 +708,23 @@ public function testGetEnvCsv($value, $processed)
         $this->assertSame($processed, $result);
     }
 
+    public function testGetEnvShuffle()
+    {
+        mt_srand(2);
+
+        $this->assertSame(
+            ['bar', 'foo'],
+            (new EnvVarProcessor(new Container()))->getEnv('shuffle', '', fn () => ['foo', 'bar']),
+        );
+    }
+
+    public function testGetEnvShuffleInvalid()
+    {
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Env var "foo" cannot be shuffled because its value "bar" is not an array');
+        (new EnvVarProcessor(new Container()))->getEnv('shuffle', 'foo', fn () => 'bar');
+    }
+
     public function validCsv()
     {
         $complex = <<<'CSV'

Original file line number	Diff line number	Diff line change
`@@ -58,6 +58,7 @@ public static function getProvidedTypes(): array`
`58`	`58`	`'trim' => 'string',`
`59`	`59`	`'require' => 'bool\|int\|float\|string\|array',`
`60`	`60`	`'enum' => \BackedEnum::class,`
	`61`	`+ 'shuffle' => 'array',`
`61`	`62`	`];`
`62`	`63`	`}`
`63`	`64`
`@@ -206,6 +207,12 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv): mixed`
`206`	`207`	`return null;`
`207`	`208`	`}`
`208`	`209`
	`210`	`+ if ('shuffle' === $prefix) {`
	`211`	`+ \is_array($env) ? shuffle($env) : throw new RuntimeException(sprintf('Env var "%s" cannot be shuffled because its value "%s" is not an array.', $name, $env));`
	`212`	`+`
	`213`	`+ return $env;`
	`214`	`+ }`
	`215`	`+`
`209`	`216`	`if (!\is_scalar($env)) {`
`210`	`217`	`throw new RuntimeException(sprintf('Non-scalar env var "%s" cannot be cast to "%s".', $name, $prefix));`
`211`	`218`	`}`