-
-
Notifications
You must be signed in to change notification settings - Fork 9.6k
[DI] Added support for deprecating aliases #29968
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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 hidden or 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
110 changes: 110 additions & 0 deletions
110
src/Symfony/Component/DependencyInjection/Tests/AliasTest.php
This file contains hidden or 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,110 @@ | ||
| <?php | ||
|
|
||
| /* | ||
| * This file is part of the Symfony package. | ||
| * | ||
| * (c) Fabien Potencier <[email protected]> | ||
| * | ||
| * For the full copyright and license information, please view the LICENSE | ||
| * file that was distributed with this source code. | ||
| */ | ||
|
|
||
| namespace Symfony\Component\DependencyInjection\Tests; | ||
|
|
||
| use PHPUnit\Framework\TestCase; | ||
| use Symfony\Component\DependencyInjection\Alias; | ||
|
|
||
| class AliasTest extends TestCase | ||
| { | ||
| public function testConstructor() | ||
| { | ||
| $alias = new Alias('foo'); | ||
|
|
||
| $this->assertEquals('foo', (string) $alias); | ||
| $this->assertTrue($alias->isPublic()); | ||
| } | ||
|
|
||
| public function testCanConstructANonPublicAlias() | ||
| { | ||
| $alias = new Alias('foo', false); | ||
|
|
||
| $this->assertEquals('foo', (string) $alias); | ||
| $this->assertFalse($alias->isPublic()); | ||
| } | ||
|
|
||
| public function testCanConstructAPrivateAlias() | ||
| { | ||
| $alias = new Alias('foo', false, false); | ||
|
|
||
| $this->assertEquals('foo', (string) $alias); | ||
| $this->assertFalse($alias->isPublic()); | ||
| $this->assertFalse($alias->isPrivate()); | ||
| } | ||
|
|
||
| public function testCanSetPublic() | ||
| { | ||
| $alias = new Alias('foo', false); | ||
| $alias->setPublic(true); | ||
|
|
||
| $this->assertTrue($alias->isPublic()); | ||
| } | ||
|
|
||
| public function testCanDeprecateAnAlias() | ||
| { | ||
| $alias = new Alias('foo', false); | ||
| $alias->setDeprecated(true, 'The %service_id% service is deprecated.'); | ||
|
|
||
| $this->assertTrue($alias->isDeprecated()); | ||
| } | ||
|
|
||
| public function testItHasADefaultDeprecationMessage() | ||
| { | ||
| $alias = new Alias('foo', false); | ||
| $alias->setDeprecated(); | ||
|
|
||
| $expectedMessage = 'The "foo" service alias is deprecated. You should stop using it, as it will soon be removed.'; | ||
| $this->assertEquals($expectedMessage, $alias->getDeprecationMessage('foo')); | ||
| } | ||
|
|
||
| public function testReturnsCorrectDeprecationMessage() | ||
| { | ||
| $alias = new Alias('foo', false); | ||
| $alias->setDeprecated(true, 'The "%service_id%" is deprecated.'); | ||
|
|
||
| $expectedMessage = 'The "foo" is deprecated.'; | ||
| $this->assertEquals($expectedMessage, $alias->getDeprecationMessage('foo')); | ||
| } | ||
|
|
||
| public function testCanOverrideDeprecation() | ||
| { | ||
| $alias = new Alias('foo', false); | ||
| $alias->setDeprecated(); | ||
|
|
||
| $initial = $alias->isDeprecated(); | ||
| $alias->setDeprecated(false); | ||
| $final = $alias->isDeprecated(); | ||
|
|
||
| $this->assertTrue($initial); | ||
| $this->assertFalse($final); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider invalidDeprecationMessageProvider | ||
| * @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException | ||
| */ | ||
| public function testCannotDeprecateWithAnInvalidTemplate($message) | ||
| { | ||
| $def = new Alias('foo'); | ||
| $def->setDeprecated(true, $message); | ||
| } | ||
|
|
||
| public function invalidDeprecationMessageProvider() | ||
| { | ||
| return [ | ||
| "With \rs" => ["invalid \r message %service_id%"], | ||
| "With \ns" => ["invalid \n message %service_id%"], | ||
| 'With */s' => ['invalid */ message %service_id%'], | ||
| 'message not containing required %service_id% variable' => ['this is deprecated'], | ||
| ]; | ||
| } | ||
| } |
This file contains hidden or 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
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know this PR is merged, but I've just reviewed its code and I wondered if the
%service_id%placeholder name is confusing to other people too. To me, this placeholder would be easier to understand if it was called%alias_id%.Also, this ->
... as it will soon be removed.could be ->... as it will be removed in the future.Thanks.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated in #29995, please review