feat: negated env var processor

bpolaszek · bpolaszek · commit bf08da70f3af · 2021-02-12T22:36:57.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php b/src/Symfony/Component/DependencyInjection/EnvVarProcessor.php
@@ -55,6 +55,7 @@ public static function getProvidedTypes()
             'string' => 'string',
             'trim' => 'string',
             'require' => 'bool|int|float|string|array',
+            'not' => 'bool',
         ];
     }
 
@@ -79,7 +80,7 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)
             }
 
             if (!isset($array[$key]) && !\array_key_exists($key, $array)) {
-                throw new EnvNotFoundException(sprintf('Key "%s" not found in %s (resolved from "%s").', $key, json_encode($array), $next));
+                throw new EnvNotFoundException(sprintf('Key "%s" not found in "%s" (resolved from "%s").', $key, json_encode($array), $next));
             }
 
             return $array[$key];
@@ -290,6 +291,14 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)
             return trim($env);
         }
 
+        if ('not' === $prefix) {
+            if (false === \is_bool($env)) {
+                throw new RuntimeException(sprintf('Env var `%s` has not been resolved to a boolean type. Please prefix with `bool:` first.', $name));
+            }
+
+            return !$env;
+        }
+
         throw new RuntimeException(sprintf('Unsupported env var prefix "%s" for env name "%s".', $prefix, $name));
     }
 }
diff --git a/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterEnvVarProcessorsPassTest.php b/src/Symfony/Component/DependencyInjection/Tests/Compiler/RegisterEnvVarProcessorsPassTest.php
@@ -47,6 +47,7 @@ public function testSimpleProcessor()
             'string' => ['string'],
             'trim' => ['string'],
             'require' => ['bool', 'int', 'float', 'string', 'array'],
+            'not' => ['bool'],
         ];
 
         $this->assertSame($expected, $container->getParameterBag()->getProvidedTypes());
diff --git a/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php b/src/Symfony/Component/DependencyInjection/Tests/EnvVarProcessorTest.php
@@ -610,4 +610,33 @@ public function testGetEnvInvalidPrefixWithDefault()
             return null;
         });
     }
+
+    public function testGetEnvNot()
+    {
+        $processor = new EnvVarProcessor(new Container());
+
+        $result = $processor->getEnv('not', 'foo', function ($name) {
+            $this->assertSame('foo', $name);
+
+            return true;
+        });
+
+        $this->assertFalse($result);
+
+        $result = $processor->getEnv('not', 'foo', function () { return false; });
+        $this->assertTrue($result);
+    }
+
+    public function testGetEnvNotWithInvalidType()
+    {
+        $processor = new EnvVarProcessor(new Container());
+
+        $this->expectException(RuntimeException::class);
+        $this->expectExceptionMessage('Env var `foo` has not been resolved to a boolean type. Please prefix with `bool:` first.');
+        $processor->getEnv('not', 'foo', function ($name) {
+            $this->assertSame('foo', $name);
+
+            return 'bar';
+        });
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -55,6 +55,7 @@ public static function getProvidedTypes()`
`55`	`55`	`'string' => 'string',`
`56`	`56`	`'trim' => 'string',`
`57`	`57`	`'require' => 'bool\|int\|float\|string\|array',`
	`58`	`+ 'not' => 'bool',`
`58`	`59`	`];`
`59`	`60`	`}`
`60`	`61`
`@@ -79,7 +80,7 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)`
`79`	`80`	`}`
`80`	`81`
`81`	`82`	`if (!isset($array[$key]) && !\array_key_exists($key, $array)) {`
`82`		`- throw new EnvNotFoundException(sprintf('Key "%s" not found in %s (resolved from "%s").', $key, json_encode($array), $next));`
	`83`	`+ throw new EnvNotFoundException(sprintf('Key "%s" not found in "%s" (resolved from "%s").', $key, json_encode($array), $next));`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`return $array[$key];`
`@@ -290,6 +291,14 @@ public function getEnv(string $prefix, string $name, \Closure $getEnv)`
`290`	`291`	`return trim($env);`
`291`	`292`	`}`
`292`	`293`
	`294`	`+ if ('not' === $prefix) {`
	`295`	`+ if (false === \is_bool($env)) {`
	`296`	+ throw new RuntimeException(sprintf('Env var `%s` has not been resolved to a boolean type. Please prefix with `bool:` first.', $name));
	`297`	`+ }`
	`298`	`+`
	`299`	`+ return !$env;`
	`300`	`+ }`
	`301`	`+`
`293`	`302`	`throw new RuntimeException(sprintf('Unsupported env var prefix "%s" for env name "%s".', $prefix, $name));`
`294`	`303`	`}`
`295`	`304`	`}`