[Config] type specific check for emptiness

xabbuh · xabbuh · commit 0199fbf5450a · 2015-07-15T19:51:32.000+02:00
diff --git a/src/Symfony/Component/Config/Definition/BooleanNode.php b/src/Symfony/Component/Config/Definition/BooleanNode.php
@@ -36,4 +36,13 @@ protected function validateType($value)
             throw $ex;
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function isValueEmpty($value)
+    {
+        // a boolean value cannot be empty
+        return false;
+    }
 }
diff --git a/src/Symfony/Component/Config/Definition/NumericNode.php b/src/Symfony/Component/Config/Definition/NumericNode.php
@@ -52,4 +52,13 @@ protected function finalizeValue($value)
 
         return $value;
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function isValueEmpty($value)
+    {
+        // a numeric value cannot be empty
+        return false;
+    }
 }
diff --git a/src/Symfony/Component/Config/Definition/ScalarNode.php b/src/Symfony/Component/Config/Definition/ScalarNode.php
@@ -43,4 +43,12 @@ protected function validateType($value)
             throw $ex;
         }
     }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function isValueEmpty($value)
+    {
+        return null === $value || '' === $value;
+    }
 }
diff --git a/src/Symfony/Component/Config/Definition/VariableNode.php b/src/Symfony/Component/Config/Definition/VariableNode.php
@@ -84,7 +84,7 @@ protected function validateType($value)
      */
     protected function finalizeValue($value)
     {
-        if (!$this->allowEmptyValue && empty($value)) {
+        if (!$this->allowEmptyValue && $this->isValueEmpty($value)) {
             $ex = new InvalidConfigurationException(sprintf(
                 'The path "%s" cannot contain an empty value, but got %s.',
                 $this->getPath(),
@@ -113,4 +113,20 @@ protected function mergeValues($leftSide, $rightSide)
     {
         return $rightSide;
     }
+
+    /**
+     * Evaluates if the given value is to be treated as empty.
+     *
+     * By default, PHP's empty() function is used to test for emptiness. This
+     * method may be overridden by subtypes to better match their understanding
+     * of empty data.
+     *
+     * @param mixed $value
+     *
+     * @return bool
+     */
+    protected function isValueEmpty($value)
+    {
+        return empty($value);
+    }
 }
diff --git a/src/Symfony/Component/Config/Tests/Definition/BooleanNodeTest.php b/src/Symfony/Component/Config/Tests/Definition/BooleanNodeTest.php
@@ -24,6 +24,19 @@ public function testNormalize($value)
         $this->assertSame($value, $node->normalize($value));
     }
 
+    /**
+     * @dataProvider getValidValues
+     *
+     * @param bool $value
+     */
+    public function testValidNonEmptyValues($value)
+    {
+        $node = new BooleanNode('test');
+        $node->setAllowEmptyValue(false);
+
+        $this->assertSame($value, $node->finalize($value));
+    }
+
     public function getValidValues()
     {
         return array(
diff --git a/src/Symfony/Component/Config/Tests/Definition/FloatNodeTest.php b/src/Symfony/Component/Config/Tests/Definition/FloatNodeTest.php
@@ -24,6 +24,19 @@ public function testNormalize($value)
         $this->assertSame($value, $node->normalize($value));
     }
 
+    /**
+     * @dataProvider getValidValues
+     *
+     * @param int $value
+     */
+    public function testValidNonEmptyValues($value)
+    {
+        $node = new FloatNode('test');
+        $node->setAllowEmptyValue(false);
+
+        $this->assertSame($value, $node->finalize($value));
+    }
+
     public function getValidValues()
     {
         return array(
diff --git a/src/Symfony/Component/Config/Tests/Definition/IntegerNodeTest.php b/src/Symfony/Component/Config/Tests/Definition/IntegerNodeTest.php
@@ -24,6 +24,19 @@ public function testNormalize($value)
         $this->assertSame($value, $node->normalize($value));
     }
 
+    /**
+     * @dataProvider getValidValues
+     *
+     * @param int $value
+     */
+    public function testValidNonEmptyValues($value)
+    {
+        $node = new IntegerNode('test');
+        $node->setAllowEmptyValue(false);
+
+        $this->assertSame($value, $node->finalize($value));
+    }
+
     public function getValidValues()
     {
         return array(
diff --git a/src/Symfony/Component/Config/Tests/Definition/ScalarNodeTest.php b/src/Symfony/Component/Config/Tests/Definition/ScalarNodeTest.php
@@ -57,4 +57,51 @@ public function getInvalidValues()
             array(new \stdClass()),
         );
     }
+
+    /**
+     * @dataProvider getValidNonEmptyValues
+     *
+     * @param mixed $value
+     */
+    public function testValidNonEmptyValues($value)
+    {
+        $node = new ScalarNode('test');
+        $node->setAllowEmptyValue(false);
+
+        $this->assertSame($value, $node->finalize($value));
+    }
+
+    public function getValidNonEmptyValues()
+    {
+        return array(
+            array(false),
+            array(true),
+            array('foo'),
+            array(0),
+            array(1),
+            array(0.0),
+            array(0.1),
+        );
+    }
+
+    /**
+     * @dataProvider getEmptyValues
+     * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
+     *
+     * @param mixed $value
+     */
+    public function testNotAllowedEmptyValuesThrowException($value)
+    {
+        $node = new ScalarNode('test');
+        $node->setAllowEmptyValue(false);
+        $node->finalize($value);
+    }
+
+    public function getEmptyValues()
+    {
+        return array(
+            array(null),
+            array(''),
+        );
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -36,4 +36,13 @@ protected function validateType($value)`
`36`	`36`	`throw $ex;`
`37`	`37`	`}`
`38`	`38`	`}`
	`39`	`+`
	`40`	`+ /**`
	`41`	`+ * {@inheritdoc}`
	`42`	`+ */`
	`43`	`+ protected function isValueEmpty($value)`
	`44`	`+ {`
	`45`	`+ // a boolean value cannot be empty`
	`46`	`+ return false;`
	`47`	`+ }`
`39`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -52,4 +52,13 @@ protected function finalizeValue($value)`
`52`	`52`
`53`	`53`	`return $value;`
`54`	`54`	`}`
	`55`	`+`
	`56`	`+ /**`
	`57`	`+ * {@inheritdoc}`
	`58`	`+ */`
	`59`	`+ protected function isValueEmpty($value)`
	`60`	`+ {`
	`61`	`+ // a numeric value cannot be empty`
	`62`	`+ return false;`
	`63`	`+ }`
`55`	`64`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,4 +43,12 @@ protected function validateType($value)`
`43`	`43`	`throw $ex;`
`44`	`44`	`}`
`45`	`45`	`}`
	`46`	`+`
	`47`	`+ /**`
	`48`	`+ * {@inheritdoc}`
	`49`	`+ */`
	`50`	`+ protected function isValueEmpty($value)`
	`51`	`+ {`
	`52`	`+ return null === $value \|\| '' === $value;`
	`53`	`+ }`
`46`	`54`	`}`