feature #20509 [Serializer] Allow to specify a single value in @groups (dunglas)

fabpot · fabpot · commit fe454e42e1d3 · 2016-12-02T12:58:15.000+01:00
This PR was squashed before being merged into the 3.3-dev branch (closes #20509). Discussion ---------- [Serializer] Allow to specify a single value in @groups | Q | A | ------------- | --- | Branch? | master | Bug fix? | no | New feature? | yes | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #19374 (comment) | License | MIT | Doc PR | todo Tiny DX improvement: Before: ```php use Symfony\Component\Serializer\Annotation\Groups; class Product { /** * @groups({"admins"}) */ public $itemsSold; } ``` Now allowed: ```php use Symfony\Component\Serializer\Annotation\Groups; class Product { /** * @groups("admins") */ public $itemsSold; } ``` Commits ------- 926aa48 [Serializer] Allow to specify a single value in @groups
diff --git a/src/Symfony/Component/Serializer/Annotation/Groups.php b/src/Symfony/Component/Serializer/Annotation/Groups.php
@@ -24,7 +24,7 @@
 class Groups
 {
     /**
-     * @var array
+     * @var string[]
      */
     private $groups;
 
@@ -39,23 +39,20 @@ public function __construct(array $data)
             throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', get_class($this)));
         }
 
-        if (!is_array($data['value'])) {
-            throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be an array of strings.', get_class($this)));
-        }
-
-        foreach ($data['value'] as $group) {
+        $value = (array) $data['value'];
+        foreach ($value as $group) {
             if (!is_string($group)) {
-                throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be an array of strings.', get_class($this)));
+                throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a string or an array of strings.', get_class($this)));
             }
         }
 
-        $this->groups = $data['value'];
+        $this->groups = $value;
     }
 
     /**
      * Gets groups.
      *
-     * @return array
+     * @return string[]
      */
     public function getGroups()
     {
diff --git a/src/Symfony/Component/Serializer/Tests/Annotation/GroupsTest.php b/src/Symfony/Component/Serializer/Tests/Annotation/GroupsTest.php
@@ -31,7 +31,7 @@ public function testEmptyGroupsParameter()
      */
     public function testNotAnArrayGroupsParameter()
     {
-        new Groups(array('value' => 'coopTilleuls'));
+        new Groups(array('value' => 12));
     }
 
     /**
@@ -49,4 +49,10 @@ public function testGroupsParameters()
         $groups = new Groups(array('value' => $validData));
         $this->assertEquals($validData, $groups->getGroups());
     }
+
+    public function testSingleGroup()
+    {
+        $groups = new Groups(array('value' => 'a'));
+        $this->assertEquals(array('a'), $groups->getGroups());
+    }
 }

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`class Groups`
`25`	`25`	`{`
`26`	`26`	`/**`
`27`		`- * @var array`
	`27`	`+ * @var string[]`
`28`	`28`	`*/`
`29`	`29`	`private $groups;`
`30`	`30`
`@@ -39,23 +39,20 @@ public function __construct(array $data)`
`39`	`39`	`throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" cannot be empty.', get_class($this)));`
`40`	`40`	`}`
`41`	`41`
`42`		`- if (!is_array($data['value'])) {`
`43`		`- throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be an array of strings.', get_class($this)));`
`44`		`- }`
`45`		`-`
`46`		`- foreach ($data['value'] as $group) {`
	`42`	`+ $value = (array) $data['value'];`
	`43`	`+ foreach ($value as $group) {`
`47`	`44`	`if (!is_string($group)) {`
`48`		`- throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be an array of strings.', get_class($this)));`
	`45`	`+ throw new InvalidArgumentException(sprintf('Parameter of annotation "%s" must be a string or an array of strings.', get_class($this)));`
`49`	`46`	`}`
`50`	`47`	`}`
`51`	`48`
`52`		`- $this->groups = $data['value'];`
	`49`	`+ $this->groups = $value;`
`53`	`50`	`}`
`54`	`51`
`55`	`52`	`/**`
`56`	`53`	`* Gets groups.`
`57`	`54`	`*`
`58`		`- * @return array`
	`55`	`+ * @return string[]`
`59`	`56`	`*/`
`60`	`57`	`public function getGroups()`
`61`	`58`	`{`
Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public function testEmptyGroupsParameter()`
`31`	`31`	`*/`
`32`	`32`	`public function testNotAnArrayGroupsParameter()`
`33`	`33`	`{`
`34`		`- new Groups(array('value' => 'coopTilleuls'));`
	`34`	`+ new Groups(array('value' => 12));`
`35`	`35`	`}`
`36`	`36`
`37`	`37`	`/**`
`@@ -49,4 +49,10 @@ public function testGroupsParameters()`
`49`	`49`	`$groups = new Groups(array('value' => $validData));`
`50`	`50`	`$this->assertEquals($validData, $groups->getGroups());`
`51`	`51`	`}`
	`52`	`+`
	`53`	`+ public function testSingleGroup()`
	`54`	`+ {`
	`55`	`+ $groups = new Groups(array('value' => 'a'));`
	`56`	`+ $this->assertEquals(array('a'), $groups->getGroups());`
	`57`	`+ }`
`52`	`58`	`}`