[Mime] Deprecate Address::fromString()

fabpot · fabpot · commit 99f23ff7b547 · 2020-06-09T17:26:02.000+02:00
diff --git a/src/Symfony/Component/Mime/Address.php b/src/Symfony/Component/Mime/Address.php
@@ -89,7 +89,15 @@ public static function create($address): self
             return $address;
         }
         if (\is_string($address)) {
-            return self::fromString($address);
+            if (false === strpos($address, '<')) {
+                return new self($address);
+            }
+
+            if (!preg_match(self::FROM_STRING_PATTERN, $address, $matches)) {
+                throw new InvalidArgumentException(sprintf('Could not parse "%s" to a "%s" instance.', $address, static::class));
+            }
+
+            return new self($matches['addrSpec'], trim($matches['displayName'], ' \'"'));
         }
 
         throw new InvalidArgumentException(sprintf('An address can be an instance of Address or a string ("%s" given).', get_debug_type($address)));
@@ -110,14 +118,19 @@ public static function createArray(array $addresses): array
         return $addrs;
     }
 
+    /**
+     * @deprecated since Symfony 5.2, use "create()" instead.
+     */
     public static function fromString(string $string): self
     {
+        trigger_deprecation('symfony/mime', '5.2', '"%s()" is deprecated, use "%s::create()" instead.', __METHOD__, __CLASS__);
+
         if (false === strpos($string, '<')) {
             return new self($string, '');
         }
 
         if (!preg_match(self::FROM_STRING_PATTERN, $string, $matches)) {
-            throw new InvalidArgumentException(sprintf('Could not parse "%s" to a "%s" instance.', $string, static::class));
+            throw new InvalidArgumentException(sprintf('Could not parse "%s" to a "%s" instance.', $string, self::class));
         }
 
         return new self($matches['addrSpec'], trim($matches['displayName'], ' \'"'));
diff --git a/src/Symfony/Component/Mime/CHANGELOG.md b/src/Symfony/Component/Mime/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.2.0
+-----
+
+ * Deprecated `Address::fromString()`, use `Address::create()` instead
+
 4.4.0
 -----
 
diff --git a/src/Symfony/Component/Mime/Tests/AddressTest.php b/src/Symfony/Component/Mime/Tests/AddressTest.php
@@ -44,6 +44,19 @@ public function testCreate()
         $this->assertEquals($a, Address::create('fabien@symfony.com'));
     }
 
+    /**
+     * @dataProvider fromStringProvider
+     */
+    public function testCreateWithString($string, $displayName, $addrSpec)
+    {
+        $address = Address::create($string);
+        $this->assertEquals($displayName, $address->getName());
+        $this->assertEquals($addrSpec, $address->getAddress());
+        $fromToStringAddress = Address::create($address->toString());
+        $this->assertEquals($displayName, $fromToStringAddress->getName());
+        $this->assertEquals($addrSpec, $fromToStringAddress->getAddress());
+    }
+
     public function testCreateWrongArg()
     {
         $this->expectException(\InvalidArgumentException::class);
@@ -81,6 +94,7 @@ public function nameEmptyDataProvider(): array
 
     /**
      * @dataProvider fromStringProvider
+     * @group legacy
      */
     public function testFromString($string, $displayName, $addrSpec)
     {
@@ -92,6 +106,9 @@ public function testFromString($string, $displayName, $addrSpec)
         $this->assertEquals($addrSpec, $fromToStringAddress->getAddress());
     }
 
+    /**
+     * @group legacy
+     */
     public function testFromStringFailure()
     {
         $this->expectException(InvalidArgumentException::class);
diff --git a/src/Symfony/Component/Mime/composer.json b/src/Symfony/Component/Mime/composer.json
@@ -17,6 +17,7 @@
     ],
     "require": {
         "php": ">=7.2.5",
+        "symfony/deprecation-contracts": "^2.1",
         "symfony/polyfill-intl-idn": "^1.10",
         "symfony/polyfill-mbstring": "^1.0",
         "symfony/polyfill-php80": "^1.15"

Original file line number	Diff line number	Diff line change
`@@ -89,7 +89,15 @@ public static function create($address): self`
`89`	`89`	`return $address;`
`90`	`90`	`}`
`91`	`91`	`if (\is_string($address)) {`
`92`		`- return self::fromString($address);`
	`92`	`+ if (false === strpos($address, '<')) {`
	`93`	`+ return new self($address);`
	`94`	`+ }`
	`95`	`+`
	`96`	`+ if (!preg_match(self::FROM_STRING_PATTERN, $address, $matches)) {`
	`97`	`+ throw new InvalidArgumentException(sprintf('Could not parse "%s" to a "%s" instance.', $address, static::class));`
	`98`	`+ }`
	`99`	`+`
	`100`	`+ return new self($matches['addrSpec'], trim($matches['displayName'], ' \'"'));`
`93`	`101`	`}`
`94`	`102`
`95`	`103`	`throw new InvalidArgumentException(sprintf('An address can be an instance of Address or a string ("%s" given).', get_debug_type($address)));`
`@@ -110,14 +118,19 @@ public static function createArray(array $addresses): array`
`110`	`118`	`return $addrs;`
`111`	`119`	`}`
`112`	`120`
	`121`	`+ /**`
	`122`	`+ * @deprecated since Symfony 5.2, use "create()" instead.`
	`123`	`+ */`
`113`	`124`	`public static function fromString(string $string): self`
`114`	`125`	`{`
	`126`	`+ trigger_deprecation('symfony/mime', '5.2', '"%s()" is deprecated, use "%s::create()" instead.', __METHOD__, __CLASS__);`
	`127`	`+`
`115`	`128`	`if (false === strpos($string, '<')) {`
`116`	`129`	`return new self($string, '');`
`117`	`130`	`}`
`118`	`131`
`119`	`132`	`if (!preg_match(self::FROM_STRING_PATTERN, $string, $matches)) {`
`120`		`- throw new InvalidArgumentException(sprintf('Could not parse "%s" to a "%s" instance.', $string, static::class));`
	`133`	`+ throw new InvalidArgumentException(sprintf('Could not parse "%s" to a "%s" instance.', $string, self::class));`
`121`	`134`	`}`
`122`	`135`
`123`	`136`	`return new self($matches['addrSpec'], trim($matches['displayName'], ' \'"'));`