Merge remote branch 'weaverryan/config_definition_changes'

* weaverryan/config_definition_changes: [SecurityBundle] Allowing the main Configuration tree to allow "factories" without a validation exception. [SecurityBundle] Removing an old configuration key in a test - caught by the Configuration validation. [SecurityBundle] Adding the ignoreExtraFields option to the factories tree so that there aren't validation errors on all the other unknown fields. [Config] Adding an ignoreExtraKeys options, which allows you to let options simply be ignore without throwing a validation exception. [Config] Reverting some meaningless changes that are no longer needed to minimize the true diff of the changes. Increasing the test precision. [Config] Reverting the preventExtraKeys option. This is a revert of functionality that would have allowed "unnamed" children to be added to an array node. [Config] Moving the removal of the key attribute on ArrayNode onto the setKeyAttribute() method per Johannes. [Config] Renaming the key attribute removal property for consistency per Johannes' recommendation. Also fixing a PHPDoc typo per Stof. [SwiftmailerBundle] Removing unnecessary "enabled" key in a test. [FrameworkBundle] Removing the "namespace" key when it's defined in its own weird location in XML. This prevents that key, which we move in this same location, from looking like an invalid option during validation. [Config] Renaming NodeBuilder::nodeBuilder() to NodeBuilder::builder() due to the fact that PHP can get confused when you have a __construct() method *and* a method that has the same name as the class (looks like two constructors to PHP). [Config] Making the option to remove a key attribute optional. [Config] Renaming the NodeBuilder::addNodeBuilder() to simply NodeBuilder::nodeBuilder() to be consistent with the other names: node(), arrayNode(). [Config] Making changes per the recent movement of the Config builder into the Config component. [DependencyInjection] Renaming allowUnnamedChildren to preventExtraKeys. Also moved the place where validation of extra configs occurs. [DependencyInjection] Being sure to remove XML-remapped singular options and key attribute options after processing. [DependencyInjection] Adding a NodeBuilder::addNodeBuilder() method that helps achieve a fluid interface when a pre-built NodeBuilder needs to be added. [DependencyInjection] Initial implementation of an allowUnnamedChildren method on NodeBuilder. Also added an "extra field" exception.

Author: fabpot

src/Symfony/Bundle/FrameworkBundle/DependencyInjection/Configuration.php

@@ -195,6 +195,7 @@ private function addValidationSection(NodeBuilder $rootNode)
  ->ifTrue(function($v) { return is_array($v) && !empty($v['annotations']) && !empty($v['namespace']); })
  ->then(function($v){
  $v['annotations'] = array('namespace' => $v['namespace']);
+ unset($v['namespace']);
  return $v;
  })
  ->end()

src/Symfony/Bundle/SecurityBundle/DependencyInjection/Configuration.php

@@ -23,6 +23,7 @@ public function getFactoryConfigTree()
 
  return $tb
  ->root('security', 'array')
+ ->ignoreExtraKeys()
  ->fixXmlConfig('factory', 'factories')
  ->arrayNode('factories')
  ->prototype('scalar')->end()
@@ -39,6 +40,12 @@ public function getMainConfigTree(array $factories)
  $rootNode
  ->scalarNode('access_denied_url')->defaultNull()->end()
  ->scalarNode('session_fixation_strategy')->cannotBeEmpty()->defaultValue('migrate')->end()
+
+ // add a faux-entry for factories, so that no validation error is thrown
+ ->fixXmlConfig('factory', 'factories')
+ ->arrayNode('factories')
+ ->ignoreExtraKeys()
+ ->end()
  ;
 
  $this->addAclSection($rootNode);

src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/ConfigurationTest.php

@@ -0,0 +1,53 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien.potencier@symfony-project.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Bundle\SecurityBundle\Tests\DependencyInjection;
+
+use Symfony\Bundle\SecurityBundle\DependencyInjection\Configuration;
+use Symfony\Component\Config\Definition\Processor;
+
+class ConfigurationTest extends \PHPUnit_Framework_TestCase
+{
+ /**
+ * The minimal, required config needed to not have any required validation
+ * issues.
+ *
+ * @var array
+ */
+ protected static $minimalConfig = array(
+ 'providers' => array(
+ 'stub' => array(),
+ ),
+ 'firewalls' => array(
+ 'stub' => array(),
+ ),
+ );
+
+ /**
+ * Test that the main tree is OK to be passed a factory or factories
+ * key, without throwing any validation errors.
+ */
+ public function testMainConfigTreeWithFactories()
+ {
+ $config = array_merge(self::$minimalConfig, array(
+ 'factory' => array('foo' => 'bar'),
+ 'factories' => array('lorem' => 'ipsum'),
+ ));
+ 
+ $configuration = new Configuration();
+ $processor = new Processor();
+ $tree = $configuration->getMainConfigTree(array());
+ $config = $processor->process($tree, array($config));
+
+ $this->assertFalse(array_key_exists('factory', $config), 'The factory key is silently removed without an exception');
+ $this->assertEquals(array(), $config['factories'], 'The factories key is jsut an empty array');
+ }
+}

src/Symfony/Bundle/SecurityBundle/Tests/DependencyInjection/Fixtures/yml/container1.yml

@@ -18,7 +18,6 @@ security:
  users:
  foo: { password: foo, roles: 'ROLE_USER, ROLE_ADMIN' }
  basic:
- password_encoder: sha1
  users:
  foo: { password: 0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33, roles: ROLE_SUPER_ADMIN }
  bar: { password: 0beec7b5ea3f0fdbc95d0dd47f3c5bc275da8a33, roles: [ROLE_USER, ROLE_ADMIN] }

src/Symfony/Bundle/SwiftmailerBundle/Tests/DependencyInjection/SwiftmailerExtensionTest.php

@@ -39,7 +39,7 @@ public function testSpool()
  $container = new ContainerBuilder();
  $loader = new SwiftmailerExtension();
 
- $loader->load(array(array('spool' => array ('enabled' => true))), $container);
+ $loader->load(array(array('spool' => array())), $container);
  $this->assertEquals('swiftmailer.transport.spool', (string) $container->getAlias('swiftmailer.transport'));
  $this->assertEquals('swiftmailer.transport.smtp', (string) $container->getAlias('swiftmailer.transport.real'));
  }

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

@@ -28,12 +28,14 @@ class ArrayNode extends BaseNode implements PrototypeNodeInterface
  protected $children;
  protected $prototype;
  protected $keyAttribute;
+ protected $removeKeyAttribute;
  protected $allowFalse;
  protected $allowNewKeys;
  protected $addIfNotSet;
  protected $minNumberOfElements;
  protected $performDeepMerging;
  protected $defaultValue;
+ protected $ignoreExtraKeys;
 
  /**
  * Constructor.
@@ -47,6 +49,7 @@ public function __construct($name, NodeInterface $parent = null)
 
  $this->children = array();
  $this->xmlRemappings = array();
+ $this->removeKeyAttribute = true;
  $this->allowFalse = false;
  $this->addIfNotSet = false;
  $this->allowNewKeys = true;
@@ -83,12 +86,25 @@ public function setMinNumberOfElements($number)
  * This is only relevant for XML configurations, and only in combination
  * with a prototype based node.
  *
- * @param string $attribute
+ * For example, if "id" is the keyAttribute, then:
+ *
+ * array('id' => 'my_name', 'foo' => 'bar')
+ *
+ * becomes
+ *
+ * 'id' => array('foo' => 'bar')
+ *
+ * If $remove is false, the resulting array will still have the
+ * "'id' => 'my_name'" item in it.
+ *
+ * @param string $attribute The name of the attribute to use as a key
+ * @param Boolean $remove Whether or not to remove the key
  * @return void
  */
- public function setKeyAttribute($attribute)
+ public function setKeyAttribute($attribute, $remove = true)
  {
  $this->keyAttribute = $attribute;
+ $this->removeKeyAttribute = $remove;
  }
 
  /**
@@ -129,13 +145,23 @@ public function setAllowNewKeys($allow)
  /**
  * Sets if deep merging should occur.
  *
- * @param boolean $boolean
+ * @param Boolean $boolean
  */
  public function setPerformDeepMerging($boolean)
  {
  $this->performDeepMerging = (Boolean) $boolean;
  }
 
+ /**
+ * Whether extra keys should just be ignore without an exception.
+ *
+ * @param Boolean $boolean To allow extra keys
+ */
+ public function setIgnoreExtraKeys($boolean)
+ {
+ $this->ignoreExtraKeys = (Boolean) $boolean;
+ }
+
  /**
  * Sets the node Name.
  *
@@ -348,6 +374,7 @@ protected function normalizeValue($value)
  }
 
  $value[$plural] = Extension::normalizeConfig($value, $singular, $plural);
+ unset($value[$singular]);
  }
 
  if (null !== $this->prototype) {
@@ -362,6 +389,11 @@ protected function normalizeValue($value)
  ));
  } else if (isset($v[$this->keyAttribute])) {
  $k = $v[$this->keyAttribute];
+
+ // remove the key attribute if configured to
+ if ($this->removeKeyAttribute) {
+ unset($v[$this->keyAttribute]);
+ }
  }
 
  if (array_key_exists($k, $normalized)) {
@@ -391,6 +423,14 @@ protected function normalizeValue($value)
  }
 
  $normalized[$name] = $child->normalize($value[$name]);
+ unset($value[$name]);
+ }
+
+ // if extra fields are present, throw exception
+ if (count($value) && !$this->ignoreExtraKeys) {
+ $msg = sprintf('Unrecognized options "%s" under "%s"', implode(', ', array_keys($value)), $this->getPath());
+
+ throw new InvalidConfigurationException($msg);
  }
 
  return $normalized;

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

@@ -24,6 +24,7 @@ class NodeBuilder
  public $name;
  public $type;
  public $key;
+ public $removeKeyItem;
  public $parent;
  public $children;
  public $prototype;
@@ -42,6 +43,7 @@ class NodeBuilder
  public $trueEquivalent;
  public $falseEquivalent;
  public $performDeepMerging;
+ public $ignoreExtraKeys;
 
  /**
  * Constructor
@@ -99,6 +101,29 @@ public function node($name, $type)
  return $this->children[$name] = $node;
  }
 
+ /**
+ * Add a NodeBuilder instance directly.
+ *
+ * This helps achieve a fluid interface when a method on your Configuration
+ * class returns a pre-build NodeBuilder instance on your behalf:
+ *
+ * $root = new NodeBuilder();
+ * ->node('foo', 'scalar')
+ * ->addNodeBuilder($this->getBarNodeBuilder())
+ * ->node('baz', 'scalar')
+ * ;
+ *
+ * @return Symfony\Component\DependencyInjection\Configuration\Builder\NodeBuilder This builder node
+ */
+ public function builder(NodeBuilder $node)
+ {
+ $node->parent = $this;
+
+ $this->children[$node->name] = $node;
+
+ return $this;
+ }
+
  /**
  * Creates a child array node
  *
@@ -314,13 +339,33 @@ public function fixXmlConfig($singular, $plural = null)
  /**
  * Sets an attribute to use as key.
  *
- * @param string $name
+ * This is useful when you have an indexed array that should be an
+ * associative array. You can select an item from within the array
+ * to be the key of the particular item. For example, if "id" is the
+ * "key", then:
+ *
+ * array(
+ * array('id' => 'my_name', 'foo' => 'bar'),
+ * )
+ *
+ * becomes
+ *
+ * array(
+ * 'id' => array('foo' => 'bar'),
+ * )
+ *
+ * If you'd like "'id' => 'my_name'" to still be present in the resulting
+ * array, then you can set the second argument of this method to false.
+ *
+ * @param string $name The name of the key
+ * @param Boolean $removeKeyItem Whether or not the key item should be removed.
  *
  * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
  */
- public function useAttributeAsKey($name)
+ public function useAttributeAsKey($name, $removeKeyItem = true)
  {
  $this->key = $name;
+ $this->removeKeyItem = $removeKeyItem;
 
  return $this;
  }
@@ -440,4 +485,21 @@ public function end()
  {
  return $this->parent;
  }
+
+ /**
+ * Allows extra config keys to be specified under an array without
+ * throwing an exception.
+ *
+ * Those config values are simply ignored. This should be used only
+ * in special cases where you want to send an entire configuration
+ * array through a special tree that processes only part of the array.
+ *
+ * @return Symfony\Component\Config\Definition\Builder\NodeBuilder
+ */
+ public function ignoreExtraKeys()
+ {
+ $this->ignoreExtraKeys = true;
+
+ return $this;
+ }
 }

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

@@ -163,9 +163,10 @@ protected function createArrayConfigNode(NodeBuilder $node)
  $configNode->addEquivalentValue(false, $node->falseEquivalent);
  $configNode->setPerformDeepMerging($node->performDeepMerging);
  $configNode->setRequired($node->required);
+ $configNode->setIgnoreExtraKeys($node->ignoreExtraKeys);
 
  if (null !== $node->key) {
- $configNode->setKeyAttribute($node->key);
+ $configNode->setKeyAttribute($node->key, $node->removeKeyItem);
  }
 
  if (true === $node->atLeastOne) {