Added a castToArray() config helper

javiereguiluz · fabpot · commit 3a589df5cbff · 2017-03-06T08:50:45.000-08:00
diff --git a/src/Symfony/Component/Config/CHANGELOG.md b/src/Symfony/Component/Config/CHANGELOG.md
@@ -8,6 +8,7 @@ CHANGELOG
  * added second `$exists` constructor argument to `ClassExistenceResource`
  * made `ClassExistenceResource` work with interfaces and traits
  * added `ConfigCachePass` (originally in FrameworkBundle)
+ * added `castToArray()` helper to turn any config value into an array
 
 3.0.0
 -----
@@ -36,7 +37,7 @@ Before: `InvalidArgumentException` (variable must contain at least two
 distinct elements).
 After: the code will work as expected and it will restrict the values of the
 `variable` option to just `value`.
- 
+
  * deprecated the `ResourceInterface::isFresh()` method. If you implement custom resource types and they
    can be validated that way, make them implement the new `SelfCheckingResourceInterface`.
  * deprecated the getResource() method in ResourceInterface. You can still call this method
@@ -49,7 +50,7 @@ After: the code will work as expected and it will restrict the values of the
 
  * added `ConfigCacheInterface`, `ConfigCacheFactoryInterface` and a basic `ConfigCacheFactory`
    implementation to delegate creation of ConfigCache instances
-   
+
 2.2.0
 -----
 
diff --git a/src/Symfony/Component/Config/Definition/Builder/ExprBuilder.php b/src/Symfony/Component/Config/Definition/Builder/ExprBuilder.php
@@ -149,6 +149,19 @@ public function ifNotInArray(array $array)
         return $this;
     }
 
+    /**
+     * Transforms variables of any type into an array.
+     *
+     * @return $this
+     */
+    public function castToArray()
+    {
+        $this->ifPart = function ($v) { return !is_array($v); };
+        $this->thenPart = function ($v) { return array($v); };
+
+        return $this;
+    }
+
     /**
      * Sets the closure to run if the test pass.
      *
diff --git a/src/Symfony/Component/Config/Tests/Definition/Builder/ExprBuilderTest.php b/src/Symfony/Component/Config/Tests/Definition/Builder/ExprBuilderTest.php
@@ -145,6 +145,25 @@ public function testThenEmptyArrayExpression()
         $this->assertFinalizedValueIs(array(), $test);
     }
 
+    /**
+     * @dataProvider castToArrayValues
+     */
+    public function testcastToArrayExpression($configValue, $expectedValue)
+    {
+        $test = $this->getTestBuilder()
+            ->castToArray()
+        ->end();
+        $this->assertFinalizedValueIs($expectedValue, $test, array('key' => $configValue));
+    }
+
+    public function castToArrayValues()
+    {
+        yield array('value', array('value'));
+        yield array(-3.14, array(-3.14));
+        yield array(null, array(null));
+        yield array(array('value'), array('value'));
+    }
+
     /**
      * @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
      */
