[Config] Allow using defaultNull() on BooleanNodeDefinition

alexandre-daubois · alexandre-daubois · commit 9f8f8f183c5e · 2024-10-08T12:58:24.000+02:00
diff --git a/src/Symfony/Component/Config/CHANGELOG.md b/src/Symfony/Component/Config/CHANGELOG.md
@@ -7,6 +7,7 @@ CHANGELOG
  * Add `#[WhenNot]` attribute to prevent service from being registered in a specific environment
  * Generate a meta file in JSON format for resource tracking
  * Add `SkippingResourceChecker`
+ * Add support for `defaultNull()` on `BooleanNode`
 
 7.1
 ---
diff --git a/src/Symfony/Component/Config/Definition/BooleanNode.php b/src/Symfony/Component/Config/Definition/BooleanNode.php
@@ -20,10 +20,23 @@
  */
 class BooleanNode extends ScalarNode
 {
+    public function __construct(
+        ?string $name,
+        ?NodeInterface $parent = null,
+        string $pathSeparator = self::DEFAULT_PATH_SEPARATOR,
+        protected bool $nullable = false
+    ) {
+        parent::__construct($name, $parent, $pathSeparator);
+    }
+
     protected function validateType(mixed $value): void
     {
         if (!\is_bool($value)) {
-            $ex = new InvalidTypeException(\sprintf('Invalid type for path "%s". Expected "bool", but got "%s".', $this->getPath(), get_debug_type($value)));
+            if (null === $value && $this->nullable) {
+                return;
+            }
+
+            $ex = new InvalidTypeException(\sprintf('Invalid type for path "%s". Expected "%sbool", but got "%s".', $this->getPath(), $this->nullable ? '?' : '', get_debug_type($value)));
             if ($hint = $this->getInfo()) {
                 $ex->addHint($hint);
             }
diff --git a/src/Symfony/Component/Config/Definition/Builder/BooleanNodeDefinition.php b/src/Symfony/Component/Config/Definition/Builder/BooleanNodeDefinition.php
@@ -33,7 +33,7 @@ public function __construct(?string $name, ?NodeParentInterface $parent = null)
      */
     protected function instantiateNode(): BooleanNode
     {
-        return new BooleanNode($this->name, $this->parent, $this->pathSeparator);
+        return new BooleanNode($this->name, $this->parent, $this->pathSeparator, null === $this->nullEquivalent);
     }
 
     /**
@@ -43,4 +43,20 @@ public function cannotBeEmpty(): static
     {
         throw new InvalidDefinitionException('->cannotBeEmpty() is not applicable to BooleanNodeDefinition.');
     }
+
+    public function defaultNull(): static
+    {
+        $this->nullEquivalent = null;
+
+        return parent::defaultNull();
+    }
+
+    public function defaultValue(mixed $value): static
+    {
+        if (null === $value) {
+            $this->nullEquivalent = null;
+        }
+
+        return parent::defaultValue($value);
+    }
 }
diff --git a/src/Symfony/Component/Config/Tests/Definition/BooleanNodeTest.php b/src/Symfony/Component/Config/Tests/Definition/BooleanNodeTest.php
@@ -26,6 +26,33 @@ public function testNormalize(bool $value)
         $this->assertSame($value, $node->normalize($value));
     }
 
+    public function testNullValueOnNullable()
+    {
+        $node = new BooleanNode('test', null, '.', true);
+
+        $this->assertNull($node->normalize(null));
+    }
+
+    public function testNullValueOnNotNullable()
+    {
+        $node = new BooleanNode('test', null, '.', false);
+
+        $this->expectException(InvalidTypeException::class);
+        $this->expectExceptionMessage('Invalid type for path "test". Expected "bool", but got "null".');
+
+        $this->assertNull($node->normalize(null));
+    }
+
+    public function testInvalidValueOnNullable()
+    {
+        $node = new BooleanNode('test', null, '.', true);
+
+        $this->expectException(InvalidTypeException::class);
+        $this->expectExceptionMessage('Invalid type for path "test". Expected "?bool", but got "int".');
+
+        $node->normalize(123);
+    }
+
     /**
      * @dataProvider getValidValues
      */
@@ -60,7 +87,6 @@ public function testNormalizeThrowsExceptionOnInvalidValues($value)
     public static function getInvalidValues(): array
     {
         return [
-            [null],
             [''],
             ['foo'],
             [0],
diff --git a/src/Symfony/Component/Config/Tests/Definition/Builder/BooleanNodeDefinitionTest.php b/src/Symfony/Component/Config/Tests/Definition/Builder/BooleanNodeDefinitionTest.php
@@ -25,6 +25,30 @@ public function testCannotBeEmptyThrowsAnException()
         $def->cannotBeEmpty();
     }
 
+    public function testBooleanNodeWithDefaultNull()
+    {
+        $def = new BooleanNodeDefinition('foo');
+        $def->defaultNull();
+
+        $node = $def->getNode();
+        $this->assertTrue($node->hasDefaultValue());
+        $this->assertNull($node->getDefaultValue());
+
+        $this->assertNull($node->normalize(null));
+    }
+
+    public function testBooleanNodeWithDefaultValueAtNull()
+    {
+        $def = new BooleanNodeDefinition('foo');
+        $def->defaultValue(null);
+
+        $node = $def->getNode();
+        $this->assertTrue($node->hasDefaultValue());
+        $this->assertNull($node->getDefaultValue());
+
+        $this->assertNull($node->normalize(null));
+    }
+
     public function testSetDeprecated()
     {
         $def = new BooleanNodeDefinition('foo');

Original file line number	Diff line number	Diff line change
`@@ -33,7 +33,7 @@ public function __construct(?string $name, ?NodeParentInterface $parent = null)`
`33`	`33`	`*/`
`34`	`34`	`protected function instantiateNode(): BooleanNode`
`35`	`35`	`{`
`36`		`- return new BooleanNode($this->name, $this->parent, $this->pathSeparator);`
	`36`	`+ return new BooleanNode($this->name, $this->parent, $this->pathSeparator, null === $this->nullEquivalent);`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`/**`
`@@ -43,4 +43,20 @@ public function cannotBeEmpty(): static`
`43`	`43`	`{`
`44`	`44`	`throw new InvalidDefinitionException('->cannotBeEmpty() is not applicable to BooleanNodeDefinition.');`
`45`	`45`	`}`
	`46`	`+`
	`47`	`+ public function defaultNull(): static`
	`48`	`+ {`
	`49`	`+ $this->nullEquivalent = null;`
	`50`	`+`
	`51`	`+ return parent::defaultNull();`
	`52`	`+ }`
	`53`	`+`
	`54`	`+ public function defaultValue(mixed $value): static`
	`55`	`+ {`
	`56`	`+ if (null === $value) {`
	`57`	`+ $this->nullEquivalent = null;`
	`58`	`+ }`
	`59`	`+`
	`60`	`+ return parent::defaultValue($value);`
	`61`	`+ }`
`46`	`62`	`}`