-
-
Notifications
You must be signed in to change notification settings - Fork 1.2k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Improve the way one can deprecate a Twig callable
- Loading branch information
Showing
11 changed files
with
260 additions
and
40 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,67 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of Twig. | ||
| * | ||
| * (c) Fabien Potencier | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Twig; | ||
|
|
||
| /** | ||
| * @author Fabien Potencier <[email protected]> | ||
| */ | ||
| final class DeprecatedCallableInfo | ||
| { | ||
| private string $type; | ||
| private string $name; | ||
|
|
||
| public function __construct( | ||
| private string $package, | ||
| private string $version, | ||
| private ?string $altName = null, | ||
| private ?string $altPackage = null, | ||
| private ?string $altVersion = null, | ||
| ) { | ||
| } | ||
|
|
||
| public function setType(string $type): void | ||
| { | ||
| $this->type = $type; | ||
| } | ||
|
|
||
| public function setName(string $name): void | ||
| { | ||
| $this->name = $name; | ||
| } | ||
|
|
||
| public function triggerDeprecation(?string $file = null, ?int $line = null): void | ||
| { | ||
| $message = \sprintf('Twig %s "%s" is deprecated', ucfirst($this->type), $this->name); | ||
|
|
||
| if ($this->altName) { | ||
| $message .= \sprintf('; use "%s"', $this->altName); | ||
| if ($this->altPackage) { | ||
| $message .= \sprintf(' from the "%s" package', $this->altPackage); | ||
| } | ||
| if ($this->altVersion) { | ||
| $message .= \sprintf(' (available since version %s)', $this->altVersion); | ||
| } | ||
| $message .= ' instead'; | ||
| } | ||
|
|
||
| if ($file) { | ||
| $message .= \sprintf(' in %s', $file); | ||
| if ($line) { | ||
| $message .= \sprintf(' at line %d', $line); | ||
| } | ||
| } | ||
|
|
||
| $message .= '.'; | ||
|
|
||
| trigger_deprecation($this->package, $this->version, $message); | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,80 @@ | ||
| <?php | ||
|
|
||
| namespace Twig\Tests; | ||
|
|
||
| /* | ||
| * This file is part of Twig. | ||
| * | ||
| * (c) Fabien Potencier | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Twig\DeprecatedCallableInfo; | ||
|
|
||
| class DeprecatedCallableInfoTest extends TestCase | ||
| { | ||
| /** | ||
| * @dataProvider provideTestsForTriggerDeprecation | ||
| */ | ||
| public function testTriggerDeprecation($expected, DeprecatedCallableInfo $info) | ||
| { | ||
| $info->setType('function'); | ||
| $info->setName('foo'); | ||
|
|
||
| $deprecations = []; | ||
| try { | ||
| set_error_handler(function ($type, $msg) use (&$deprecations) { | ||
| if (\E_USER_DEPRECATED === $type) { | ||
| $deprecations[] = $msg; | ||
| } | ||
|
|
||
| return false; | ||
| }); | ||
|
|
||
| $info->triggerDeprecation('foo.twig', 1); | ||
| } finally { | ||
| restore_error_handler(); | ||
| } | ||
|
|
||
| $this->assertSame([$expected], $deprecations); | ||
| } | ||
|
|
||
| public static function provideTestsForTriggerDeprecation(): iterable | ||
| { | ||
| yield ['Since foo/bar 1.1: Twig Function "foo" is deprecated in foo.twig at line 1.', new DeprecatedCallableInfo('foo/bar', '1.1')]; | ||
| yield ['Since foo/bar 1.1: Twig Function "foo" is deprecated; use "alt_foo" from the "all/bar" package (available since version 12.10) instead in foo.twig at line 1.', new DeprecatedCallableInfo('foo/bar', '1.1', 'alt_foo', 'all/bar', '12.10')]; | ||
| yield ['Since foo/bar 1.1: Twig Function "foo" is deprecated; use "alt_foo" from the "all/bar" package instead in foo.twig at line 1.', new DeprecatedCallableInfo('foo/bar', '1.1', 'alt_foo', 'all/bar')]; | ||
| yield ['Since foo/bar 1.1: Twig Function "foo" is deprecated; use "alt_foo" instead in foo.twig at line 1.', new DeprecatedCallableInfo('foo/bar', '1.1', 'alt_foo')]; | ||
| } | ||
|
|
||
| public function testTriggerDeprecationWithoutFileOrLine() | ||
| { | ||
| $info = new DeprecatedCallableInfo('foo/bar', '1.1'); | ||
| $info->setType('function'); | ||
| $info->setName('foo'); | ||
|
|
||
| $deprecations = []; | ||
| try { | ||
| set_error_handler(function ($type, $msg) use (&$deprecations) { | ||
| if (\E_USER_DEPRECATED === $type) { | ||
| $deprecations[] = $msg; | ||
| } | ||
|
|
||
| return false; | ||
| }); | ||
|
|
||
| $info->triggerDeprecation(); | ||
| $info->triggerDeprecation('foo.twig'); | ||
| } finally { | ||
| restore_error_handler(); | ||
| } | ||
|
|
||
| $this->assertSame([ | ||
| 'Since foo/bar 1.1: Twig Function "foo" is deprecated.', | ||
| 'Since foo/bar 1.1: Twig Function "foo" is deprecated in foo.twig.', | ||
| ], $deprecations); | ||
| } | ||
| } |
Oops, something went wrong.