bug symfony#24083 Fix ability to deprecate a config node (chalasr)

This PR was merged into the 3.4 branch.

Discussion
----------

Fix ability to deprecate a config node

| Q             | A
| ------------- | ---
| Branch?       | 3.4
| Bug fix?      | not yet released
| New feature?  | no
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | symfony#22382
| License       | MIT
| Doc PR        | n/a

Unlocks symfony#24025

Commits
-------

fc91869 Fix ability to deprecate a config node

Author: nicolas-grekas

src/Symfony/Component/Config/Definition/Builder/ArrayNodeDefinition.php

@@ -453,6 +453,7 @@ protected function createNode()
         $node->addEquivalentValue(false, $this->falseEquivalent);
         $node->setPerformDeepMerging($this->performDeepMerging);
         $node->setRequired($this->required);
+        $node->setDeprecated($this->deprecationMessage);
         $node->setIgnoreExtraKeys($this->ignoreExtraKeys, $this->removeExtraKeys);
         $node->setNormalizeKeys($this->normalizeKeys);
 

src/Symfony/Component/Config/Definition/VariableNode.php

@@ -84,6 +84,10 @@ protected function validateType($value)
      */
     protected function finalizeValue($value)
     {
+        if ($this->deprecationMessage) {
+            @trigger_error($this->getDeprecationMessage($this->getName(), $this->getPath()), E_USER_DEPRECATED);
+        }
+
         if (!$this->allowEmptyValue && $this->isValueEmpty($value)) {
             $ex = new InvalidConfigurationException(sprintf(
                 'The path "%s" cannot contain an empty value, but got %s.',

src/Symfony/Component/Config/Tests/Definition/ArrayNodeTest.php

@@ -216,4 +216,13 @@ public function testGetDefaultValueWithoutDefaultValue()
         $node = new ArrayNode('foo');
         $node->getDefaultValue();
     }
+
+    public function testSetDeprecated()
+    {
+        $node = new ArrayNode('foo');
+        $node->setDeprecated('"%node%" is deprecated');
+
+        $this->assertTrue($node->isDeprecated());
+        $this->assertSame('"foo" is deprecated', $node->getDeprecationMessage($node->getName(), $node->getPath()));
+    }
 }

src/Symfony/Component/Config/Tests/Definition/Builder/ArrayNodeDefinitionTest.php

@@ -298,6 +298,20 @@ public function testRequiresAtLeastOneElement()
         $this->addToAssertionCount(1);
     }
 
+    public function testSetDeprecated()
+    {
+        $node = new ArrayNodeDefinition('root');
+        $node
+            ->children()
+                ->arrayNode('foo')->setDeprecated('The "%path%" node is deprecated.')->end()
+            ->end()
+        ;
+        $deprecatedNode = $node->getNode()->getChildren()['foo'];
+
+        $this->assertTrue($deprecatedNode->isDeprecated());
+        $this->assertSame('The "root.foo" node is deprecated.', $deprecatedNode->getDeprecationMessage($deprecatedNode->getName(), $deprecatedNode->getPath()));
+    }
+
     /**
      * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
      * @expectedExceptionMessage The path "root" should have at least 1 element(s) defined.

src/Symfony/Component/Config/Tests/Definition/Builder/BooleanNodeDefinitionTest.php

@@ -25,4 +25,15 @@ public function testCannotBeEmptyThrowsAnException()
         $def = new BooleanNodeDefinition('foo');
         $def->cannotBeEmpty();
     }
+
+    public function testSetDeprecated()
+    {
+        $def = new BooleanNodeDefinition('foo');
+        $def->setDeprecated('The "%path%" node is deprecated.');
+
+        $node = $def->getNode();
+
+        $this->assertTrue($node->isDeprecated());
+        $this->assertSame('The "foo" node is deprecated.', $node->getDeprecationMessage($node->getName(), $node->getPath()));
+    }
 }

src/Symfony/Component/Config/Tests/Definition/Builder/EnumNodeDefinitionTest.php

@@ -62,4 +62,16 @@ public function testGetNode()
         $node = $def->getNode();
         $this->assertEquals(array('foo', 'bar'), $node->getValues());
     }
+
+    public function testSetDeprecated()
+    {
+        $def = new EnumNodeDefinition('foo');
+        $def->values(array('foo', 'bar'));
+        $def->setDeprecated('The "%path%" node is deprecated.');
+
+        $node = $def->getNode();
+
+        $this->assertTrue($node->isDeprecated());
+        $this->assertSame('The "foo" node is deprecated.', $def->getNode()->getDeprecationMessage($node->getName(), $node->getPath()));
+    }
 }

src/Symfony/Component/Config/Tests/Definition/ScalarNodeTest.php

@@ -40,6 +40,15 @@ public function getValidValues()
         );
     }
 
+    public function testSetDeprecated()
+    {
+        $node = new ScalarNode('foo');
+        $node->setDeprecated('"%node%" is deprecated');
+
+        $this->assertTrue($node->isDeprecated());
+        $this->assertSame('"foo" is deprecated', $node->getDeprecationMessage($node->getName(), $node->getPath()));
+    }
+
     /**
      * @dataProvider getInvalidValues
      * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException